search

onflow / flow-evm-gateway

FlowEVM Gateway implements an Ethereum-equivalent JSON-RPC API for EVM clients to use
https://developers.flow.com/evm/about
Apache License 2.0
11 stars 10 forks source link

Improve API error handling #370

Closed sideninja closed 3 months ago

sideninja commented 4 months ago

Smaller improvements to API error handling and logging.

For contributor use:

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

[!WARNING]

Rate limit exceeded

@sideninja has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 14 minutes and 29 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 c52bbf05a9d01b426aa7c33db12105b4498f5031 and fc2919a60602c67d500808e2e339c0f1e5d96a86.

Walkthrough

The recent changes enhance the BlockChainAPI and error handling in the server's response logging. Key functions for retrieving blockchain data were removed, suggesting a new approach to access this information. Error handling has been standardized across several methods, improving consistency and clarity. Additionally, a new test was added to validate the handling of non-existing blocks in Web3, strengthening the overall robustness of the API.

Changes

Files Change Summary
api/api.go Removed functions: ChainId, Coinbase, GasPrice. Standardized error handling in methods like Syncing, GetBlockReceipts, improving logging consistency.
api/server.go Enhanced error logging in Write method. Introduced errorIs function for clearer error checking.
tests/web3js/eth_non_interactive_test.js Added a test for web3.eth.getBlock and web3.eth.getTransactionFromBlock to handle non-existing block heights, ensuring robust error handling.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant Logger

    Client->>API: Request blockchain data
    API->>Logger: Log request
    API->>Client: Return data
    alt Error occurs
        API->>Logger: Log error
        API-->>Client: Return error response
    end

🐇 "In the code where bunnies hop,
Functions change and errors stop.
New tests ensure that all is right,
In our world of code so bright!
Through the logs, we dance with glee,
Robust and happy, as we should be!" 🌼

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.
m-Peter commented 3 months ago 
diff --git a/api/api.go b/api/api.go
index 85648ab..7f14441 100644
--- a/api/api.go
+++ b/api/api.go
@@ -879,6 +879,7 @@ func handleError[T any](log zerolog.Logger, err error) (T, error) {
        var (
                zero              T
                errGasPriceTooLow *errs.GasPriceTooLowError
+               revertError       *errs.RevertError
        )

        switch {
@@ -895,6 +896,8 @@ func handleError[T any](log zerolog.Logger, err error) (T, error) {
                return zero, err
        case errors.As(err, &errGasPriceTooLow):
                return zero, errGasPriceTooLow
+       case errors.As(err, &revertError):
+               return zero, revertError
        default:
                log.Error().Err(err).Msg("api error")
                return zero, errs.ErrInternal
(END)

@sideninja We need the above change, to properly handle revert errors in eth_sendRawTransaction / eth_call / eth_estimateGas.