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

chore: fix malformed struct tag #20142

Merged
merged 1 commit into from
Apr 24, 2024

Conversation

ipangpang
Copy link
Contributor

@ipangpang ipangpang commented Apr 22, 2024

Description

In a Go struct, private fields are not exported even without the json:"-" struct tag. If a struct tag json:"-" is present, even public fields will not be exported.


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

  • Bug Fixes
    • Corrected field naming inconsistencies in proposal submission functions, ensuring accurate data handling.
  • Refactor
    • Updated JSON marshaling settings for configuration parsing, improving data representation and storage.
  • Documentation
    • Updated workflow concurrency settings and job configurations for improved workflow execution.
    • Removed embedded grpc-web proxy in favor of standalone proxy for enhanced server functionality.
  • Tests
    • Added new test suites and utilities for end-to-end testing of lockup functionality in the accounts module.
  • Chores
    • Adjusted Makefile targets and removed gRPC-Web configurations for cleaner build processes.

@ipangpang ipangpang requested a review from a team as a code owner April 22, 2024 15:00
Copy link
Contributor

coderabbitai bot commented Apr 22, 2024

Walkthrough

Walkthrough

The changes involve standardizing field names by renaming proposalType to ProposalType in the governance module's client CLI code for consistency. Additionally, adjustments were made in the upgrade module, such as removing the json:"-" tag from the parseConfig field, potentially affecting JSON serialization.

Changes

File(s) Change Summary
x/gov/client/cli/util.go Renamed proposalType to ProposalType in the proposal struct. Updated field assignment in parseSubmitProposal.
x/upgrade/plan/info.go Removed json:"-" tag from parseConfig field, impacting JSON serialization.

Recent Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 11d4e74 and 9daa715.
Files selected for processing (2)
  • x/gov/client/cli/util.go (1 hunks)
  • x/upgrade/plan/info.go (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • x/gov/client/cli/util.go
  • x/upgrade/plan/info.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.

@ipangpang ipangpang changed the title fix: malformed struct tag chore: malformed struct tag Apr 22, 2024
@ipangpang ipangpang changed the title chore: malformed struct tag chore: fix malformed struct tag Apr 22, 2024
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.

Thank you!
Could you bring back proposalType private?

@ipangpang ipangpang force-pushed the bugfix/fix-malformed-struct-tag branch 2 times, most recently from c53c869 to 4a92947 Compare April 23, 2024 03:32
@ipangpang
Copy link
Contributor Author

Thank you! Could you bring back proposalType private?

Sure, I have reverted proposalType back to private.

auto-merge was automatically disabled April 24, 2024 07:40

Head branch was pushed to by a user without write access

@ipangpang ipangpang force-pushed the bugfix/fix-malformed-struct-tag branch from 21f13c1 to dd957ce Compare April 24, 2024 07:40
Signed-off-by: ipangpang <arronipangpang@gmail.com>
@ipangpang ipangpang force-pushed the bugfix/fix-malformed-struct-tag branch from dd957ce to 9daa715 Compare April 24, 2024 07:43
@tac0turtle tac0turtle added this pull request to the merge queue Apr 24, 2024
Merged via the queue into cosmos:main with commit ae80bba Apr 24, 2024
60 of 61 checks passed
meetrick pushed a commit to meetrick/cosmos-sdk that referenced this pull request Apr 29, 2024
Signed-off-by: ipangpang <arronipangpang@gmail.com>
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.

4 participants