Examples use-case - Access API subscription endpoints - Kotlin

lealobanov commented 2 months ago

Description

Streaming

Streaming events : https://github.com/onflow/flow-go-sdk/tree/master/examples/stream_events
Streaming events and handling a reconnect when errors encountered in the stream : https://github.com/onflow/flow-go-sdk/tree/master/examples/stream_events_reconnect
Streaming execution data : https://github.com/onflow/flow-go-sdk/tree/master/examples/stream_execution_data

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
- Introduced classes for subscribing to and processing events and execution data from the Flow blockchain.
- Added methods for handling streaming of events and execution data with improved concurrency management.
Tests
- Implemented new test classes to validate the functionality of event streaming within the Flow environment.
Bug Fixes
- Updated subscription methods to enhance lifecycle control for event and execution data subscriptions.

coderabbitai[bot] commented 2 months ago

[!WARNING]

Rate limit exceeded

@lealobanov has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 8 minutes and 17 seconds before requesting another review.

⌛ How to resolve this issue?
After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?
CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.

📥 Commits
Files that changed from the base of the PR and between 703a5f641fa0737dc76b127afcae1cdeee98f8fa and dec4cf5b0ad0956da64d4698119c33d8f787c5ca.

Walkthrough

This pull request introduces new classes for subscribing to and processing events and execution data from the Flow blockchain using Kotlin coroutines. The SubscribeEventsExample and SubscribeExecutionDataExample classes implement methods for streaming respective data types. Additionally, a test class for each new feature is included to validate functionality in a Flow emulator environment. The changes also enhance the FlowAccessApi interface to support these new streaming capabilities.

Changes

Files	Change Summary
`kotlin-example/src/main/kotlin/org/onflow/examples/kotlin/streaming/streamEvents/SubscribeEventsExample.kt`	Added `SubscribeEventsExample` class for streaming events with a `streamEvents` method and a `processEvents` method.
`kotlin-example/src/main/kotlin/org/onflow/examples/kotlin/streaming/streamExecutionData/SubscribeExecutionDataExample.kt`	Added `SubscribeExecutionDataExample` class for streaming execution data with a `streamExecutionData` method.
`kotlin-example/src/test/kotlin/org/onflow/examples/kotlin/streaming/streamEvents/SubscribeEventsExampleTest.kt`	Introduced tests for `SubscribeEventsExample` to validate event streaming functionality.
`kotlin-example/src/test/kotlin/org/onflow/examples/kotlin/streaming/streamExecutionData/SubscribeExecutionDataExampleTest.kt`	Introduced tests for `SubscribeExecutionDataExample` to validate execution data streaming functionality.

Possibly related PRs

#58: Introduces new subscription methods in the FlowAccessApi interface for subscribing to events and execution data, which directly relates to the streamEvents method in the SubscribeEventsExample class.
#58: The addition of subscribeEventsByBlockId and subscribeEventsByBlockHeight methods in the FlowAccessApi interface aligns with the event subscription functionality implemented in the SubscribeEventsExample class.
#58: Changes in FlowAccessApiImpl to support new subscription methods for events and execution data are relevant as they enhance the underlying API that the SubscribeEventsExample class interacts with.
#58: The introduction of channels for handling event data and errors in the subscription methods complements the coroutine-based event processing in the processEvents method of the SubscribeEventsExample class.
#58: The overall focus on asynchronous programming and coroutine support in this PR aligns with the use of Kotlin coroutines in the main PR's implementation of event streaming.

Suggested reviewers

franklywatson

Poem

In the meadow where events bloom,
A rabbit hops, dispelling gloom.
With streams of data, swift and bright,
We dance through code, a joyful sight!
Reconnect and flow, we leap with glee,
In the world of Kotlin, wild and free! 🐇✨

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

SDK Examples Unit Test Results

35 files 35 suites 6m 9s :stopwatch: 68 tests 68 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit dec4cf5b.

: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 310 tests ±0 310 :heavy_check_mark: ±0 0 :zzz: ±0 0 :x: ±0

Results for commit 7d844d75. ± Comparison against base commit 7d844d75.

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

github-actions[bot] commented 2 months ago

Common Integration Test Results

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

Results for commit dec4cf5b.

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

github-actions[bot] commented 2 months ago

Integration Test Results

  6 files ±0   6 suites ±0 2m 35s :stopwatch: ±0s 30 tests ±0 30 :heavy_check_mark: ±0 0 :zzz: ±0 0 :x: ±0

Results for commit 7d844d75. ± Comparison against base commit 7d844d75.

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

onflow / flow-jvm-sdk