Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enclave: no panic for bad rlp format #1679

Merged
merged 1 commit into from
Dec 5, 2023

Conversation

BedrockSquirrel
Copy link
Collaborator

Why this change is needed

We don't want to fail for badly formatted requests, we want to log the error and allow chance to recover.

Currently we panic and this recently took down the sepolia testnet. (Investigation of the root cause of that is ongoing).

PR checks pre-merging

Please indicate below by ticking the checkbox that you have read and performed the required
PR checks

  • PR checks reviewed and performed

Copy link

coderabbitai bot commented Dec 4, 2023

Walkthrough

The changes involve enhancing error handling and logging within the RPCServer's SubmitL1Block method. The decodeBlock and decodeReceipts methods now return errors alongside their original return types, indicating a move towards more defensive coding practices to better manage and report issues that may occur during the decoding process.

Changes

File Path Change Summary
go/enclave/rpc_server.go Updated SubmitL1Block method to handle errors and logging for decodeBlock and decodeReceipts. Changed return types of these methods to include errors.

Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 7a2bbaf and bdb3405.
Files selected for processing (1)
  • go/enclave/rpc_server.go (2 hunks)
Additional comments: 4
go/enclave/rpc_server.go (4)
  • 110-123: The changes in the SubmitL1Block method correctly implement error handling for the decoding of blocks and receipts, logging errors instead of causing a panic, which aligns with the PR's objective to improve robustness and prevent system outages.

  • 450-456: The decodeBlock method has been correctly updated to return an error along with the block, which allows for proper error handling in the SubmitL1Block method.

  • 459-468: The decodeReceipts method has been correctly updated to return an error along with the receipts, which allows for proper error handling in the SubmitL1Block method.

  • 447-448: The EnclavePublicConfig method does not include any changes related to error handling or logging, which is inconsistent with the PR's objective to improve robustness by preventing panics due to badly formatted requests. Please verify if this method should also include error handling improvements.

Copy link
Collaborator

@tudor-malene tudor-malene left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@BedrockSquirrel BedrockSquirrel merged commit 4551c81 into main Dec 5, 2023
2 checks passed
@BedrockSquirrel BedrockSquirrel deleted the matt/fix-receipt-parsing-crit branch December 5, 2023 10:00
tudor-malene pushed a commit that referenced this pull request Dec 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants