Access api subscription endpoints

lealobanov commented 5 months ago

Description

SubscribeExecutionDataByBlockID
SubscribeExecutionDataByBlockHeight
SubscribeEventsByBlockID
SubscribeEventsByBlockHeight
Create structs for ExecutionData API
Updates to tests

ExecutionData fields: https://github.com/onflow/flow/blob/3d7cfcfd52ac2532ebe244f9f66ecc8d76bd9fed/protobuf/flow/entities/block_execution_data.proto

For contributor use:

[ ] Targeted PR against master branch
[ ] Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
[ ] Code follows the standards mentioned here.
[ ] Updated relevant documentation
[ ] Re-reviewed Files changed in the Github PR explorer
[ ] Added appropriate labels

Summary by CodeRabbit

New Features
- Enhanced transaction and execution result retrieval capabilities with new methods for accessing data by block ID and block height.
- Subscription functionality added for execution data and events based on block ID and height, enabling real-time updates.
- Added support for asynchronous programming through new coroutine dependencies.
Bug Fixes
- Improved error handling and response validation in transaction retrieval and subscription methods.
Tests
- Added comprehensive test cases for new functionalities, ensuring robust coverage of transaction retrieval and event subscriptions.

coderabbitai[bot] commented 5 months ago

Walkthrough

The recent updates significantly enhance the Flow SDK, focusing on asynchronous programming and improved data access. Key changes include the introduction of new subscription methods for execution data and events based on block ID and height. The integration of Kotlin coroutines streamlines concurrent processing, boosting the SDK's efficiency and usability while enabling real-time data handling.

Changes

Files	Change Summary
`sdk/build.gradle.kts`	Added dependencies for Kotlin coroutines (`1.5.2`), enhancing asynchronous capabilities.
`sdk/src/main/kotlin/org/onflow/flow/sdk/Flow.kt`	Updated `newAccessApi` to handle an additional `ExecutionDataAPIGrpc` parameter for enhanced functionality.
`sdk/src/main/kotlin/org/onflow/flow/sdk/FlowAccessApi.kt`, `sdk/src/main/kotlin/org/onflow/flow/sdk/impl/FlowAccessApiImpl.kt`	Introduced methods for subscribing to execution data and events based on block ID and height, improving real-time data access.
`sdk/src/test/kotlin/org/onflow/flow/sdk/FlowAccessApiTest.kt`, `sdk/src/test/kotlin/org/onflow/flow/sdk/impl/FlowAccessApiImplTest.kt`	Expanded test suites, adding tests for new subscription functionalities in both access APIs.

Poem

A Rabbit's Poem:

🐇 In fields of code where bunnies hop,
New methods bloom, we never stop.
With coroutines swift, our tasks delight,
As transactions dance in the moonlight.
Hooray for changes, bright and clear,
The Flow SDK shines, let’s give a cheer! 🌟

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 5 months ago

Unit Test Results

  53 files ±  0   53 suites ±0 23s :stopwatch: ±0s 310 tests +12 310 :heavy_check_mark: +12 0 :zzz: ±0 0 :x: ±0

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

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

github-actions[bot] commented 5 months ago

Integration Test Results

2 files -   3 2 suites - 3 12s :stopwatch: - 1m 39s 2 tests - 29 2 :heavy_check_mark: - 29 0 :zzz: ±0 0 :x: ±0

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

This pull request removes 31 and adds 2 tests. Note that renamed tests count towards both.

``` org.onflow.flow.sdk.cadence.JsonCadenceTest ‑ Can parse new JSON Cadence() org.onflow.flow.sdk.cadence.JsonCadenceTest ‑ decodeArray() org.onflow.flow.sdk.cadence.JsonCadenceTest ‑ decodeBoolean() org.onflow.flow.sdk.cadence.JsonCadenceTest ‑ decodeComplexDict() org.onflow.flow.sdk.cadence.JsonCadenceTest ‑ decodeEnum() org.onflow.flow.sdk.cadence.JsonCadenceTest ‑ decodeOptional() org.onflow.flow.sdk.cadence.JsonCadenceTest ‑ decodeOptional2() org.onflow.flow.sdk.cadence.JsonCadenceTest ‑ decodeReference() org.onflow.flow.sdk.cadence.JsonCadenceTest ‑ decodeResource() org.onflow.flow.sdk.cadence.JsonCadenceTest ‑ decodeStruct() … ``` ``` org.onflow.flow.common.extensions.ProjectTestExtensionsTest ‑ Test extensions work() org.onflow.flow.sdk.extensions.TestExtensionsTest ‑ Test extensions work() ```

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

github-actions[bot] commented 4 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 10f1de86.

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

lealobanov commented 4 months ago

Thank you, will follow up on these shortly!

onflow / flow-jvm-sdk