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

fix(x/tx): default to using gogoproto.HybridResolver wherever possible #19845

Merged
merged 4 commits into from
Mar 25, 2024

Conversation

aaronc
Copy link
Member

@aaronc aaronc commented Mar 24, 2024

Description

Closes: #XXXX


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • Refactor
    • Improved key handling in database interactions for enhanced performance and flexibility.
  • New Features
    • Introduced a hybrid resolver for transaction signing, optimizing compatibility and efficiency.
  • Documentation
    • Updated CHANGELOG with details on API changes and improvements in v0.6.0.

Copy link
Contributor

coderabbitai bot commented Mar 24, 2024

Walkthrough

The changes in this update aim to improve key handling within interfaces and structs across the codebase. Additionally, there are adjustments to database handling functions and testing setups for better organization and efficiency. Import statement reorganization and the adoption of gogoproto.HybridResolver for assignments signify a move towards standardized coding practices.

Changes

Files Change Summary
store/.../batch.go, store/database.go Modified method signatures in Reader and Writer interfaces and Batch struct to enhance key handling with additional parameters.
store/storage/pebbledb/db.go, store/storage/sqlite/db_test.go Separated storeKey from key in key processing functions and improved test setup in database handling.
store/internal/encoding/changeset_test.go Reorganized import statements to enhance clarity and organization within the test file.
x/tx/signing/.../aminojson.go, x/tx/signing/.../json_marshal.go, x/tx/signing/.../context.go, x/tx/signing/.../handler.go Added github.com/cosmos/gogoproto/proto import and switched to using gogoproto.HybridResolver for more standardized assignments.

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-tests 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 tests 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 tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@aaronc aaronc marked this pull request as ready for review March 24, 2024 16:49
@aaronc aaronc requested a review from a team as a code owner March 24, 2024 16:49

This comment has been minimized.

Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

lgtm! +1 for changelog

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.

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between 4599439 and c86eb43.
Files selected for processing (10)
  • store/database.go (1 hunks)
  • store/internal/encoding/changeset_test.go (1 hunks)
  • store/storage/pebbledb/batch.go (1 hunks)
  • store/storage/pebbledb/db.go (2 hunks)
  • store/storage/sqlite/batch.go (1 hunks)
  • store/storage/sqlite/db_test.go (1 hunks)
  • x/tx/signing/aminojson/aminojson.go (2 hunks)
  • x/tx/signing/aminojson/json_marshal.go (2 hunks)
  • x/tx/signing/context.go (2 hunks)
  • x/tx/signing/textual/handler.go (2 hunks)
Files skipped from review due to trivial changes (1)
  • store/storage/sqlite/db_test.go
Additional comments: 10
store/storage/pebbledb/batch.go (2)
  • 60-60: The addition of the storeKey parameter in the Set method aligns well with the PR's objectives and doesn't introduce any apparent issues.
  • 64-64: The addition of the storeKey parameter in the Delete method is consistent with the PR's goal to improve key handling, and the use of a tombstone value is a standard practice.
store/storage/sqlite/batch.go (2)
  • 65-65: The addition of the storeKey parameter in the Set method aligns well with the PR's objectives and doesn't introduce any apparent issues.
  • 71-71: The addition of the storeKey parameter in the Delete method is consistent with the PR's goal to improve key handling.
store/internal/encoding/changeset_test.go (1)
  • 7-8: Reordering the imports to group standard library, third-party, and project-specific imports separately improves readability and maintainability.
x/tx/signing/aminojson/aminojson.go (2)
  • 8-8: The addition of the gogoproto import is necessary for the use of gogoproto.HybridResolver and is correctly placed in the import section.
  • 35-35: Changing the default assignment of fileResolver to gogoproto.HybridResolver in the NewSignModeHandler function aligns with the PR's objectives and enhances flexibility.
x/tx/signing/aminojson/json_marshal.go (2)
  • 10-10: The addition of gogoproto "github.com/cosmos/gogoproto/proto" is consistent with the PR's objective to adopt gogoproto.HybridResolver across various components. This change is correctly implemented.
  • 59-59: Changing the assignment of options.FileResolver to gogoproto.HybridResolver aligns with the PR's goal of enhancing serialization and deserialization efficiency. Ensure to verify the impact of this change on the overall functionality and performance.
x/tx/signing/context.go (1)
  • 83-83: The change from protoregistry.GlobalFiles to gogoproto.HybridResolver aligns with the PR's objective to enhance serialization and deserialization processes. This switch to gogoproto.HybridResolver is a strategic move to potentially offer performance benefits and better compatibility with different protobuf versions or configurations. However, it's crucial to ensure that this change does not introduce any unintended side effects, especially in terms of compatibility with existing protobuf files and their resolution.

Ensure thorough testing is conducted to verify that the switch to gogoproto.HybridResolver does not negatively impact the resolution of protobuf files, especially in complex scenarios involving multiple protobuf versions or custom configurations.

@tac0turtle tac0turtle added this pull request to the merge queue Mar 25, 2024
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.

Review Status

Actionable comments generated: 1

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between c86eb43 and 2e8a3ef.
Files selected for processing (1)
  • x/tx/CHANGELOG.md (2 hunks)
Additional comments: 1
x/tx/CHANGELOG.md (1)
  • 36-36: The entry for the hybrid resolver improvement is correctly placed under the "Improvements" section, aligning with the changelog's guiding principles.

x/tx/CHANGELOG.md Show resolved Hide resolved
Merged via the queue into main with commit adc3432 Mar 25, 2024
62 of 65 checks passed
@tac0turtle tac0turtle deleted the aaronc/default-hybrid-resolver branch March 25, 2024 09:49
meetrick pushed a commit to meetrick/cosmos-sdk that referenced this pull request Mar 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants