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/consensus): fix .proto file placement #20646

Merged
merged 4 commits into from
Jun 12, 2024
Merged

Conversation

kocubinski
Copy link
Member

@kocubinski kocubinski commented Jun 12, 2024

Description

Recently I've noticed a difference in output of running make protogen and scripts/protocgen.sh, and will be opening a few PRs correcting that.

This PR places all x/consensus proto files in the proper location, which we decided was the within the module and not the top-level proto/ folder.

Before this patch, make proto-gen leaves behind some files in a top-level cosmossdk.io folder (note these files are supposed to get moved by scripts/protocgen.sh):

❯ tree cosmossdk.io/
cosmossdk.io/
├── server
│   └── v2
│       └── streaming
│           └── grpc.pb.go
├── store
│   ├── snapshots
│   │   └── types
│   │       └── snapshot.pb.go
│   ├── streaming
│   │   └── abci
│   │       └── grpc.pb.go
│   └── types
│       ├── commit_info.pb.go
│       └── listening.pb.go
└── x
    └── consensus
        └── types
            └── consensus.pb.go

After:

❯ tree cosmossdk.io/
cosmossdk.io/
├── server
│   └── v2
│       └── streaming
│           └── grpc.pb.go
└── store
    ├── snapshots
    │   └── types
    │       └── snapshot.pb.go
    ├── streaming
    │   └── abci
    │       └── grpc.pb.go
    └── types
        ├── commit_info.pb.go
        └── listening.pb.go

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, you can find examples of the prefixes below:
  • 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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

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

  • Chores
    • Improved script reliability by modifying error handling in the linting script.

@kocubinski kocubinski requested a review from a team as a code owner June 12, 2024 15:56
Copy link
Contributor

coderabbitai bot commented Jun 12, 2024

Walkthrough

The script go-lint-all.bash has been modified to change its error handling behavior. Specifically, the -o pipefail option was removed from the set command, which now only uses -e. This alters how the script handles errors in piped commands, potentially allowing the script to continue running even if a command in a pipeline fails.

Changes

File Change Summary
scripts/go-lint-all.bash Removed the -o pipefail option from set -e -o pipefail, now using set -e only.

Sequence Diagram(s)

The changes do not significantly alter the control flow or introduce new features requiring sequence diagrams.


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

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.

Copy link
Contributor

@kocubinski your pull request is missing a changelog!

@kocubinski
Copy link
Member Author

Right now check golangci-lint is failing without any error or even linting anything it would seem. I am unable to reproduce locally.

--> Running linter
make lint-install
make[1]: Entering directory '/home/runner/work/cosmos-sdk/cosmos-sdk'
--> Installing golangci-lint v1.59.0
make[1]: Leaving directory '/home/runner/work/cosmos-sdk/cosmos-sdk'
grep: warning: stray \ before /
make: *** [Makefile:422: lint] Error 1
Error: Process completed with exit code 2.

@kocubinski
Copy link
Member Author

Ok, combing the logs for env vars I was able to reproduce:

❯ LINT_DIFF=1 GIT_DIFF='x/consensus/types/consensus.pb.go' make lint
--> Running linter
/Library/Developer/CommandLineTools/usr/bin/make lint-install
--> Installing golangci-lint v1.59.0
make: *** [lint] Error 1

seems it may be a logic error in go-lint-all.bash

@@ -1,6 +1,6 @@
#!/usr/bin/env bash

set -e -o pipefail
set -e
Copy link
Member Author

Choose a reason for hiding this comment

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

I am removing pipefail because none of the pipe logic seems to require that a non-terminal expression should produce a global error; the existing case (ln 45) was a false negative.

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: 1

Outside diff range and nitpick comments (2)
scripts/go-lint-all.bash (2)

Line range hint 48-48: Double quote array expansions to avoid re-splitting elements.

-  for dir in ${GIT_DIFF[@]}; do
+  for dir in "${GIT_DIFF[@]}"; do

This change ensures that each element in the array is treated as a single word, which is crucial when directory names contain spaces.


Line range hint 48-48: Refactor the handling of GIT_DIFF for clarity and robustness.

-  GIT_DIFF=$(echo $GIT_DIFF | tr -d "'" | tr ' ' '\n' | grep '\.go$' | grep -v '\.pb\.go$' | grep -Eo '^[^/]+\/[^/]+' | uniq)
+  GIT_DIFF=$(echo "$GIT_DIFF" | tr -d "'" | tr ' ' '\n' | grep -E '\.go$' | grep -vE '\.pb\.go$' | grep -Eo '^[^/]+\/[^/]+' | sort -u)

This version ensures proper quoting and uses sort -u instead of uniq for better reliability in sorting and deduplication.

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between abeb7ee and 76832ae.

Files ignored due to path filters (1)
  • x/consensus/types/consensus.pb.go is excluded by !**/*.pb.go
Files selected for processing (1)
  • scripts/go-lint-all.bash (1 hunks)
Additional context used
Shellcheck
scripts/go-lint-all.bash

[error] 48-48: Double quote array expansions to avoid re-splitting elements. (SC2068)

@@ -1,6 +1,6 @@
#!/usr/bin/env bash

set -e -o pipefail
set -e
Copy link
Contributor

Choose a reason for hiding this comment

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

The change from set -e -o pipefail to set -e affects error handling in pipelines.

This modification might cause the script to not exit on errors in a pipeline, which could lead to silent failures. Consider restoring set -o pipefail if the script relies on the correct status codes from piped commands.

@kocubinski kocubinski added this pull request to the merge queue Jun 12, 2024
Merged via the queue into main with commit c36edbd Jun 12, 2024
65 of 67 checks passed
@kocubinski kocubinski deleted the kocu/proto-clean-pt1 branch June 12, 2024 18:11
alpe added a commit that referenced this pull request Jun 13, 2024
* main:
  fix(x/staking): stop validators from rotating to the same key on the same block (#20649)
  perf: add cache to address codec (#20122)
  build(deps): Bump google.golang.org/protobuf from 1.34.1 to 1.34.2 (#20632)
  fix: remove recipient amount from map (#20625)
  fix(proto): remove conditional preventing proper generated file placement (#20650)
  (serverv2/cometbft) Read config from commands & handle `FlagNode` (#20621)
  fix(x/consensus): fix .proto file placement (#20646)
  fix(store): avoid nil error on not exhausted payload stream (#20644)
  fix (x/accounts): Fix genesis condition check (#20645)
  feat(accounts): add genesis account initialization (#20642)
  fix(x/gov): limit execution in gov (#20348)
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.

6 participants