Skip to content

feat(x/tx): Sort JSON attributes for "inline_json" encoder#20049

Merged
tac0turtle merged 3 commits into
cosmos:mainfrom
pinosu:sort_json_attributes_encoder
Apr 18, 2024
Merged

feat(x/tx): Sort JSON attributes for "inline_json" encoder#20049
tac0turtle merged 3 commits into
cosmos:mainfrom
pinosu:sort_json_attributes_encoder

Conversation

@pinosu
Copy link
Copy Markdown
Contributor

@pinosu pinosu commented Apr 15, 2024

Follow up on #19919

This PR fixes the "inline_json" encoder implementation by adding recursive sorting of the JSON fields and formatting (remove white spaces)


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

  • New Features
    • Enhanced JSON processing to ensure outputs are consistently sorted, improving readability and standardization across different systems.

@pinosu pinosu requested a review from a team April 15, 2024 20:24
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 15, 2024

Walkthrough

Walkthrough

The recent updates focus on enhancing JSON handling in a Cosmos SDK module by introducing functions to sort JSON objects by keys before conversion to strings. This ensures consistent JSON formatting throughout the module. The changes include the addition of sorting functions and adjustments to unit tests to accommodate and validate the new JSON normalization behavior.

Changes

File Path Change Summary
.../aminojson/encoder.go Introduced sortedJsonStringify for sorting JSON objects by keys before stringification and added sortedObject to recursively sort maps within the JSON structure.
.../aminojson/encoder_test.go Updated TestCosmosInlineJSON to reflect the new JSON format and included TestSortedJsonStringify to test the sorting functionality.

Recent Review Details

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between c852ca0 and 51939f1.
Files selected for processing (1)
  • x/tx/signing/aminojson/encoder.go (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • x/tx/signing/aminojson/encoder.go

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.

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

Comment thread x/tx/signing/aminojson/encoder.go Outdated
Comment thread x/tx/signing/aminojson/encoder.go Outdated
@webmaster128
Copy link
Copy Markdown
Contributor

Confirming that this PR restores the old JSON normalization behaviour such that existing clients can create correct Amino JSON for CosmWasm messages using Cosmos SDK 0.50+ after this PR is in.

Copy link
Copy Markdown
Contributor

@kocubinski kocubinski left a comment

Choose a reason for hiding this comment

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

LGTM

@tac0turtle tac0turtle added this pull request to the merge queue Apr 18, 2024
Merged via the queue into cosmos:main with commit aa64827 Apr 18, 2024
@julienrbrt
Copy link
Copy Markdown
Contributor

Note to myself to tag x/tx when I tag 0.50.6.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants