search

onflow / flow-jvm-sdk

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

#107/ Update GetNodeVersionInfo response object #117

Closed lealobanov closed 1 month ago

lealobanov commented 1 month ago

Closes: #107

Description

Setup classes to model protobuf objects:

The JVM SDK currently does not support the Access API endpoint:

func (c *Client) GetNodeVersionInfo(ctx context.Context) (*flow.NodeVersionInfo, error) {
    return c.grpc.GetNodeVersionInfo(ctx)
}

PR to update protobuf files: https://github.com/onflow/flow/pull/1516

To-do:

For contributor use:

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 1 month ago

Walkthrough

A new Java class GetNodeVersionInfoAccessAPIConnector and a corresponding Kotlin class have been introduced to interact with the Flow Access API for retrieving node version information. Both classes include methods to fetch this information and handle responses appropriately. Additionally, new test classes for both Java and Kotlin implementations have been created to ensure the functionality works as expected. The SDK has also been updated to include new methods in the FlowAccessApi and AsyncFlowAccessApi interfaces, along with associated data classes for handling node version details.

Changes

File Change Summary
java-example/src/main/java/org/onflow/examples/java/getNodeVersionInfo/GetNodeVersionInfoAccessAPIConnector.java Added GetNodeVersionInfoAccessAPIConnector class with method getNodeVersionInfo().
java-example/src/test/java/org/onflow/examples/java/getNodeVersionInfo/GetNodeVersionInfoAccessAPIConnectorTest.java Created test class for GetNodeVersionInfoAccessAPIConnector with method canFetchNodeVersionInfo.
kotlin-example/src/main/kotlin/org/onflow/examples/kotlin/getNodeVersionInfo/GetNodeVersionInfoAccessAPIConnector.kt Added GetNodeVersionInfoAccessAPIConnector class with method getNodeVersionInfo().
kotlin-example/src/test/kotlin/org/onflow/examples/kotlin/getNodeVersionInfo/GetNodeVersionInfoAccessAPIConnectorTest.kt Created test class for Kotlin implementation with method Can fetch node version info.
sdk/build.gradle.kts Updated org.onflow:flow dependency version from 1.0.0 to 1.1.0.
sdk/src/main/kotlin/org/onflow/flow/sdk/AsyncFlowAccessApi.kt Added getNodeVersionInfo() method to AsyncFlowAccessApi interface.
sdk/src/main/kotlin/org/onflow/flow/sdk/FlowAccessApi.kt Added getNodeVersionInfo() method to FlowAccessApi interface.
sdk/src/main/kotlin/org/onflow/flow/sdk/impl/AsyncFlowAccessApiImpl.kt Implemented getNodeVersionInfo() method in AsyncFlowAccessApiImpl.
sdk/src/main/kotlin/org/onflow/flow/sdk/impl/FlowAccessApiImpl.kt Implemented getNodeVersionInfo() method in FlowAccessApiImpl.
sdk/src/main/kotlin/org/onflow/flow/sdk/models.kt Added FlowCompatibleRange and FlowNodeVersionInfo data classes.
sdk/src/test/kotlin/org/onflow/flow/sdk/impl/AsyncFlowAccessApiImplTest.kt Added test method for getNodeVersionInfo() in AsyncFlowAccessApiImplTest.
sdk/src/test/kotlin/org/onflow/flow/sdk/impl/FlowAccessApiImplTest.kt Added test method for getNodeVersionInfo() in FlowAccessApiImplTest.
sdk/src/test/kotlin/org/onflow/flow/sdk/models/FlowNodeVersionInfoTest.kt Created tests for FlowNodeVersionInfo and FlowCompatibleRange classes.

Assessment against linked issues

Objective Addressed Explanation
Update GetNodeVersionInfo response object (#107) ✅

Possibly related issues

Possibly related PRs

Suggested reviewers

🐰 In the meadow, I hop and play,
New classes bloom in a bright array.
Fetching versions, swift and neat,
With tests in place, our work's complete!
Hooray for code, so fresh and new,
A joyful leap, just for you! 🌼

📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Files that changed from the base of the PR and between fc88f836df4719699e69764bb58b3ef7279b8913 and 7bd30787f5882e3968ec5b85e5efd591beb1b80f.
📒 Files selected for processing (1) * .gitignore (1 hunks)
✅ Files skipped from review due to trivial changes (1) * .gitignore
--- 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 , please review it.` - `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### 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](http://discord.gg/coderabbit) 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 1 month ago

Unit Test Results

  60 files  ±0    60 suites  ±0   24s :stopwatch: ±0s 340 tests ±0  339 :heavy_check_mark: ±0  0 :zzz: ±0  1 :x: ±0 

For more details on these failures, see this check.

Results for commit db9e3d1e. ± Comparison against base commit db9e3d1e.

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

github-actions[bot] commented 1 month ago

Integration Test Results

0 files  ±0  0 suites  ±0   0s :stopwatch: ±0s 0 tests ±0  0 :heavy_check_mark: ±0  0 :zzz: ±0  0 :x: ±0 

Results for commit db9e3d1e. ± Comparison against base commit db9e3d1e.

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

github-actions[bot] commented 1 month ago

SDK Examples Unit Test Results

37 files  37 suites   6m 18s :stopwatch: 70 tests 70 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit fc88f836.

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

github-actions[bot] commented 1 month ago

Common Integration Test Results

1 files  1 suites   7s :stopwatch: 1 tests 1 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit fc88f836.

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