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

Revert "Decode legacy receipts" #485

Merged
merged 2 commits into from
Aug 29, 2024

Conversation

sideninja
Copy link
Contributor

@sideninja sideninja commented Aug 28, 2024

Reverts #474

This can be reverted after we reindexed.

Summary by CodeRabbit

  • New Features
    • Streamlined error handling for receipt data processing, enhancing performance and maintainability.
  • Bug Fixes
    • Improved reliability by removing legacy receipt decoding, reducing potential points of failure.
  • Refactor
    • Simplified control flow in receipt processing, focusing on current data formats only.

@sideninja sideninja self-assigned this Aug 28, 2024
Copy link
Contributor

coderabbitai bot commented Aug 28, 2024

Walkthrough

The changes involve the removal of the legacyReceiptFromBytes function and the receiptV0 type from the models/receipt.go file. The ReceiptsFromBytes function has been simplified to eliminate legacy decoding, focusing solely on the current receipt format. This streamlining enhances error handling by directly returning errors on decoding failures without attempting recovery from legacy formats.

Changes

Files Change Summary
models/receipt.go Removed legacyReceiptFromBytes function and receiptV0 type. Simplified ReceiptsFromBytes function by eliminating legacy decoding fallback.

Poem

🐇 In the code, we hop and play,
With legacy paths now gone away.
Simplified our way to decode,
A brighter path on this new road.
Hooray for changes, let's rejoice,
In modern code, we find our voice! 🌟


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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • 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 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@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.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f12df5f and 6fefc06.

Files selected for processing (1)
  • models/receipt.go (2 hunks)
Additional comments not posted (1)
models/receipt.go (1)

Line range hint 73-76: Simplification of ReceiptsFromBytes function looks good.

The function now directly returns an error if RLP decoding fails, which simplifies the error handling process. This change aligns with the PR objectives.

The code changes are approved.

Verify that the error handling is sufficient and that no additional error recovery mechanisms are needed:

Verification successful

Simplified error handling in ReceiptsFromBytes is appropriate.

The function directly returns a formatted error if RLP decoding fails, aligning with the PR's objective to simplify the code. This approach is sufficient for the current requirements and provides clear error context.

  • The error handling is straightforward and does not require additional recovery mechanisms.
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify error handling in `ReceiptsFromBytes`.

# Test: Search for error handling patterns in the function. Expect: Direct return of errors without recovery mechanisms.
rg --type go -A 5 $'ReceiptsFromBytes' models/receipt.go

Length of output: 304

Copy link
Collaborator

@m-Peter m-Peter left a comment

Choose a reason for hiding this comment

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

LGTM!

@m-Peter
Copy link
Collaborator

m-Peter commented Aug 29, 2024

If we have to re-index, for whatever reason, does this mean we have to bring back this piece of code? 🤔

@sideninja
Copy link
Contributor Author

have to bring back this piece of code?

No, after reindexing this code is no longer needed, this was only needed before we reindexed

@sideninja sideninja merged commit 1cbd56c into main Aug 29, 2024
2 checks passed
@m-Peter m-Peter deleted the revert-474-gregor/receipt-decode-legacy branch August 29, 2024 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants