Examples use-cases - get execution data

lealobanov commented 1 month ago

Description

This PR is now up to date, however it looks like emulator is still missing the getExecutionResultByBlockId method. Will follow up with the emulator team.

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 the GetCollectionAccessAPIConnector class to facilitate collection retrieval from the Flow Access API.
- Added the GetExecutionDataAccessAPIConnector class for fetching execution data based on block IDs.
Tests
- Created unit tests for GetCollectionAccessAPIConnector and GetExecutionDataAccessAPIConnector to validate their functionalities in a simulated environment.
Bug Fixes
- Minor formatting adjustments made across various classes for improved code readability without impacting functionality.

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent changes involve minor formatting adjustments, primarily the removal of unnecessary blank lines across several Java and Kotlin classes related to the Flow Access API connectors and their corresponding tests. Additionally, new Kotlin classes and tests have been introduced to enhance functionality for accessing collections and execution data within the Flow ecosystem. These updates ensure better code readability and maintainability without altering existing logic or behavior.

Changes

Files	Change Summary
`java-example/src/main/java/org/onflow/examples/java/getAccount/GetAccountAccessAPIConnector.java`, `java-example/src/main/java/org/onflow/examples/java/getBlock/GetBlockAccessAPIConnector.java`, `java-example/src/main/java/org/onflow/examples/java/getNetworkParams/GetNetworkParametersAccessAPIConnector.java`, `java-example/src/main/java/org/onflow/examples/java/getTransaction/GetTransactionAccessAPIConnector.java`, `java-example/src/test/java/org/onflow/examples/java/getBlock/GetBlockAccessAPIConnectorTest.java`, `java-example/src/test/java/org/onflow/examples/java/getNetworkParams/GetNetworkParametersAccessAPIConnectorTest.java`, `java-example/src/test/java/org/onflow/examples/java/getTransaction/GetTransactionAccessAPIConnectorTest.java`	Minor formatting changes, specifically the removal of blank lines. These adjustments do not impact functionality or logic.
`java-example/src/main/java/org/onflow/examples/java/getCollection/GetCollectionAccessAPIConnector.java`	New file introducing `GetCollectionAccessAPIConnector`, enabling access to Flow collections via the Flow Access API, including a method to fetch collections by ID and handle API responses effectively.
`java-example/src/test/java/org/onflow/examples/java/getCollection/GetCollectionAccessAPIConnectorTest.java`	New test file for `GetCollectionAccessAPIConnector`, using JUnit to validate functionality by testing retrieval of collections by ID, ensuring responses are correctly handled and verified.
`kotlin-example/src/main/kotlin/org/onflow/examples/kotlin/getCollection/GetCollectionAccessAPIConnector.kt`	New file defining `GetCollectionAccessAPIConnector` in Kotlin, facilitating collection retrieval from the Flow Access API with appropriate error handling for API responses.
`kotlin-example/src/main/kotlin/org/onflow/examples/kotlin/getExecutionData/GetExecutionDataAccessAPIConnector.kt`	New file introducing `GetExecutionDataAccessAPIConnector`, allowing retrieval of execution data based on block ID, with structured error handling for API interactions.
`kotlin-example/src/test/kotlin/org/onflow/examples/kotlin/getCollection/GetCollectionAccessAPIConnectorTest.kt`	New test file for `GetCollectionAccessAPIConnector` in Kotlin, ensuring the connector's functionality is validated through unit tests that assert correct behavior when fetching collections by ID.
`kotlin-example/src/test/kotlin/org/onflow/examples/kotlin/getExecutionData/GetExecutionDataAccessAPIConnectorTest.kt`	New test file for `GetExecutionDataAccessAPIConnector`, validating functionality in fetching execution data from the Flow API, with assertions to confirm expected behavior and data integrity.

Possibly related PRs

#55: This PR introduces new methods for retrieving transactions and execution results by block ID, which relates to the main PR's focus on API connectors that may utilize similar underlying functionality.
#63: This PR adds new functions to the FlowAccessApi interface for retrieving transactions and execution results by block ID, which aligns with the main PR's changes in API connectors.
#88: The introduction of the GetCollectionAccessAPIConnector class provides functionality for accessing collections, which is relevant to the main PR's focus on API connectors.
#90: The ExecuteScriptAccessAPIConnector class enhances the ability to execute scripts, which may relate to the main PR's changes in API connectors that handle various interactions with the Flow blockchain.
#93: This PR introduces examples related to transaction signing, which may connect to the main PR's focus on API connectors that facilitate transaction management.
#99: The updates to the README files improve documentation related to the SDK's functionalities, which may include the changes made in the main PR regarding API connectors.

Suggested reviewers

franklywatson

🐰In the meadow, bright and clear,
Code changes hop, bringing cheer!
Blank lines vanish, neat and spry,
New connectors wave as they fly.
Tests are crafted, all in line,
In Flow’s garden, code will shine! 🌼

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

  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 bdebe650. ± Comparison against base commit bdebe650.

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

github-actions[bot] commented 1 month 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 bdebe650. ± Comparison against base commit bdebe650.

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

github-actions[bot] commented 1 month ago

SDK Examples Unit Test Results

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

Results for commit b5fdec1e.

: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 b5fdec1e.

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

franklywatson commented 1 month ago

When I run the build locally I get 2 test failures. There's also a linting failure in CI whcih I don't seem to get locally which is odd.

GetCollectionAccessAPIConnectorTest > canFetchCollectionById() FAILED
    java.lang.IndexOutOfBoundsException: Index 0 out of bounds for length 0
        at java.base/jdk.internal.util.Preconditions.outOfBounds(Preconditions.java:100)
        at java.base/jdk.internal.util.Preconditions.outOfBoundsCheckIndex(Preconditions.java:106)
        at java.base/jdk.internal.util.Preconditions.checkIndex(Preconditions.java:302)
        at java.base/java.util.Objects.checkIndex(Objects.java:385)
        at java.base/java.util.ArrayList.get(ArrayList.java:427)
        at org.onflow.examples.java.getCollection.GetCollectionAccessAPIConnectorTest.setup(GetCollectionAccessAPIConnectorTest.java:29)

GetExecutionDataAccessAPIConnectorTest > canFetchExecutionDataByBlockId() FAILED
    java.lang.RuntimeException: Failed to get execution result by block ID
        at org.onflow.examples.java.getExecutionData.GetExecutionDataAccessAPIConnector.getExecutionDataByBlockId(GetExecutionDataAccessAPIConnector.java:21)
        at org.onflow.examples.java.getExecutionData.GetExecutionDataAccessAPIConnectorTest.canFetchExecutionDataByBlockId(GetExecutionDataAccessAPIConnectorTest.java:38)

        Caused by:
        io.grpc.StatusRuntimeException: UNAVAILABLE: Network closed for unknown reason
            at app//io.grpc.stub.ClientCalls.toStatusRuntimeException(ClientCalls.java:262)
            at app//io.grpc.stub.ClientCalls.getUnchecked(ClientCalls.java:243)
            at app//io.grpc.stub.ClientCalls.blockingUnaryCall(ClientCalls.java:156)
            at app//org.onflow.protobuf.access.AccessAPIGrpc$AccessAPIBlockingStub.getExecutionResultByID(AccessAPIGrpc.java:3052)
            at app//org.onflow.flow.sdk.impl.FlowAccessApiImpl.getExecutionResultByBlockId(FlowAccessApiImpl.kt:374)
            at app//org.onflow.examples.java.getExecutionData.GetExecutionDataAccessAPIConnector.getExecutionDataByBlockId(GetExecutionDataAccessAPIConnector.java:16)
            ... 1 more

lealobanov commented 1 month ago

Yup, getting the same issues locally, working on debugging these. The GetCollectionAccessAPIConnectorTest > canFetchCollectionById() test is failing from the parent branch

onflow / flow-jvm-sdk