axone-protocol / axoned

⛓️ Axone blockchain 💫
https://axone.xyz
Apache License 2.0
162 stars 121 forks source link

Improve `ErrorOutOfGas` handling in predicate execution #694

Closed bdeneux closed 1 month ago

bdeneux commented 2 months ago

Fixe #692, see issue description for complete details.

Note: I was forced to move QueryInterpreter utility method into the keeper since using the common ResourceGas predicate error coming from keeper package lead to a cycle import between utils and prolog packages.

EDIT: Now all OutOfGas errors that occurs in the interpreter or at predicate cost will return an GRPC error instead of a predicate prolog error.

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes across various files focus on enhancing error handling related to gas management and bank operations, improving test case clarity, and removing obsolete functions. These updates aim to boost the reliability and maintainability of the codebase while providing more context in error messages.

Changes

File Path Change Summary
x/logic/keeper/grpc_query_ask_test.go Added imports for Cosmos SDK types and bank types, updated test cases with new queries and errors, and included a new test case for bank balances.
x/logic/keeper/interpreter.go Added import for sdkerrors, modified error handling in newInterpreter using a switch statement, and specifically addressed out-of-gas errors.
x/logic/prolog/error.go Removed imports related to store types, eliminated the AtomResourceGas and ResourceGas functions.
x/logic/util/prolog.go Added imports for error handling and SDK types, and modified logic to include checks for out-of-gas errors in solutions.

Sequence Diagram(s)

Not applicable for these changes as they are too varied and do not introduce new features or control flow modifications.

Poem

In the code, where logic weaves,
Errors now are caught with ease,
Gas is handled with a care,
Bank balances checked, oh so fair.
Out-of-gas, no more fear,
Error handling, crystal clear.
Coding changes, oh so bright,
Bringing clarity, day and night.


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.
codecov[bot] commented 2 months ago

Codecov Report

Attention: Patch coverage is 30.00000% with 14 lines in your changes missing coverage. Please review.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #694      +/-   ##
==========================================
- Coverage   54.35%   54.23%   -0.12%     
==========================================
  Files          74       74              
  Lines        2896     2906      +10     
==========================================
+ Hits         1574     1576       +2     
- Misses       1226     1234       +8     
  Partials       96       96              
Files Coverage Δ
x/logic/prolog/error.go 0.00% <ø> (ø)
x/logic/keeper/interpreter.go 93.10% <75.00%> (-0.95%) :arrow_down:
x/logic/util/prolog.go 0.00% <0.00%> (ø)
amimart commented 2 months ago

@bdeneux Thanks!

I wonder why we've integrated the out of gas as a prolog error, it creates a discrepancy in the way the ask query answers: either as a gRPC error or a success containing a prolog error. Moreover, out of gas errors having a sense at the sdk level this feels a bit wrong to me.

@ccamel I'd be really interested in your insights on that, I may be missing something :)