search

onflow / flow-jvm-sdk

Flow JVM SDK
Apache License 2.0
16 stars 16 forks source link

Refactor common utils #73

Closed lealobanov closed 2 months ago

lealobanov commented 2 months ago

Description

For contributor use:

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The recent changes enhance the project's structure by introducing a new common module, updating dependencies across various Gradle build files, and improving integration testing capabilities. The project now targets Java 21, facilitating better performance and compatibility. Additionally, several utility functions and import statements have been refactored, promoting a more streamlined testing process. Overall, these updates aim to improve maintainability and modularity within the codebase.

Changes

Files Change Summary
.github/workflows/ci-examples-pull-request.yml Added jobs for running integration tests and publishing their results.
build.gradle.kts, java-example/build.gradle.kts, Updated dependencies to replace sdk project references with common.
kotlin-example/build.gradle.kts, sdk/build.gradle.kts Changed kotlinOptions.jvmTarget to 21; added common as test implementation dependency.
common/build.gradle.kts Introduced a new Gradle build configuration for the common module with specific settings.
common/src/intTest/... Restructured test packages and updated how contracts are referenced in tests.
sdk/src/intTest/..., sdk/src/test/... Updated import statements to point to common.test instead of sdk.test and modified script loading.
settings.gradle.kts Added foojay-resolver-convention plugin for toolchain management and included the new common module.
java-example/src/main/java/.../AccessAPIConnector.java Removed unused import of com.google.common.io.BaseEncoding, simplifying dependencies.

Sequence Diagram(s)

sequenceDiagram
    participant CI as CI Workflow
    participant IT as Integration Tests
    participant PR as Publish Results

    CI->>IT: Run Integration Tests
    IT-->>CI: Test Results
    CI->>PR: Publish Results
    PR-->>CI: Results Published

🐇 In the code’s warren, changes take flight,
New paths and modules make everything right.
With tests updated and imports anew,
Our project hops high, as it’s meant to do!
Let’s cheer for the code, for it grows and it glows,
A brighter future is what this change sows! 🌟

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
github-actions[bot] commented 2 months ago

SDK Examples Unit Test Results

2 files  2 suites   34s :stopwatch: 6 tests 6 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit d337f4ee.

:recycle: This comment has been updated with latest results.

github-actions[bot] commented 2 months ago

Unit Test Results

  53 files  ±0    53 suites  ±0   23s :stopwatch: ±0s 298 tests ±0  298 :heavy_check_mark: ±0  0 :zzz: ±0  0 :x: ±0 

Results for commit 2feb1f72. ± Comparison against base commit 2feb1f72.

:recycle: This comment has been updated with latest results.

github-actions[bot] commented 2 months ago

Integration Test Results

  5 files  ±0    5 suites  ±0   1m 51s :stopwatch: ±0s 31 tests ±0  31 :heavy_check_mark: ±0  0 :zzz: ±0  0 :x: ±0 

Results for commit 2feb1f72. ± Comparison against base commit 2feb1f72.

:recycle: This comment has been updated with latest results.