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: wrap errors in auto CLI service registration #20493

Merged
merged 3 commits into from
May 31, 2024

Conversation

mark-rushakoff
Copy link
Member

@mark-rushakoff mark-rushakoff commented May 30, 2024

The current code in #20412, when attempting to run simd, was failing with the error:

panic: proto: not found"

Wrapping the error returned by FindDescriptorByName gave a more informative error:

panic: failed to find descriptor for "cosmos.accounts.v1.Msg": proto: not found

However, there is an earlier root cause. The a.err field was set due to a failure in proto.MergedRegistry but later overridden. Fixing that early return now shows the root cause:

panic: failed to build registry cache: proto: could not resolve import "tendermint/abci/types.proto": not found

Helps #20492.

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

  • Bug Fixes
    • Improved error handling for registry cache building and descriptor finding, providing clearer error messages.

The current code in #20412, when attempting to run simd, was failing
with the error:

panic: proto: not found"

Wrapping the error returned by FindDescriptorByName gave a more
informative error:

panic: failed to find descriptor for "cosmos.accounts.v1.Msg": proto: not found

However, there is an earlier root cause. The a.err field was set due to
a failure in proto.MergedRegistry but later overridden. Fixing that
early return now shows the root cause:

panic: failed to build registry cache: proto: could not resolve import "tendermint/abci/types.proto": not found

Helps #20492.
@mark-rushakoff mark-rushakoff requested a review from a team as a code owner May 30, 2024 18:58
Copy link
Contributor

coderabbitai bot commented May 30, 2024

Walkthrough

The recent changes in the autocli.go file enhance error handling by explicitly managing errors when building the registry cache and finding descriptors. This improvement involves using fmt.Errorf to format error messages, ensuring clearer and more informative error reporting.

Changes

File Path Change Summary
runtime/v2/services/autocli.go Improved error handling by explicitly managing errors and using fmt.Errorf for error message formatting.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant AutoCLI
    participant RegistryCache
    participant Descriptor

    User->>AutoCLI: Invoke command
    AutoCLI->>RegistryCache: Build registry cache
    RegistryCache-->>AutoCLI: Success/Error
    alt Cache Error
        AutoCLI->>User: Return formatted error message
    else Cache Success
        AutoCLI->>Descriptor: Find descriptor
        Descriptor-->>AutoCLI: Success/Error
        alt Descriptor Error
            AutoCLI->>User: Return formatted error message
        else Descriptor Success
            AutoCLI->>User: Return command result
        end
    end
Loading

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

@mark-rushakoff your pull request is missing a 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.

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4d4b706 and d95b4bc.

Files selected for processing (1)
  • runtime/v2/services/autocli.go (2 hunks)
Additional context used
Path-based instructions (1)
runtime/v2/services/autocli.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

Additional comments not posted (2)
runtime/v2/services/autocli.go (2)

108-111: Improve error handling by wrapping the original error.

This change enhances the error message by wrapping the original error with a more descriptive message, which aligns with the PR's objective to provide clearer error outputs. This is a good use of Go's error wrapping feature to preserve the error chain.


117-117: Ensure error messages are informative and actionable.

The addition of a formatted error message here is crucial for debugging. It provides a clear indication of what went wrong and where, which is particularly useful given the complexity of service registration and proto handling in this context.

@kocubinski kocubinski self-assigned this May 30, 2024
@tac0turtle
Copy link
Member

Thank you for the contribution!! Glad to see you here ❤️

Copy link
Member

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

Thank you @mark-rushakoff for the improvement

@tac0turtle tac0turtle enabled auto-merge May 31, 2024 08:43
@tac0turtle tac0turtle added this pull request to the merge queue May 31, 2024
Merged via the queue into main with commit 0256369 May 31, 2024
60 of 61 checks passed
@tac0turtle tac0turtle deleted the fix/autocli-error-wrapping branch May 31, 2024 08:55
alpe added a commit that referenced this pull request May 31, 2024
* main: (120 commits)
  chore: update protoc-gen-swagger to protoc-gen-openapiv2 (#20448)
  ci: Add GitHub Action for go mod tidy and mocks (#20501)
  chore: Address linter issues (#20486)
  fix: wrap errors in auto CLI service registration (#20493)
  chore: fix comment (#20498)
  chore: fix the note box syntax error (#20499)
  feat(server/v2): introduce cometbft v2 (#20483)
  refactor(x/upgrade): migrate to appmodule.VersionMap (#20485)
  docs: code guidelines changes (#20482)
  feat(cosmovisor): load cosmovisor configuration from toml file (#19995)
  perf(math): Significantly speedup Dec quo truncate and quo Roundup (#20034)
  fix: Bump CometBFT versions (#20481)
  refactor(core): remove redundant ExecMode (#20322)
  feat(store/v2): pruning manager (#20430)
  chore: force reload sonar cloud  (#20480)
  refactor(x/accounts): reuse calculated sum in `func safeAdd` (#20458)
  refactor: remove `defer` in loop (#20223)
  ci: remove livness test (#20474)
  build(deps): Bump bufbuild/buf-setup-action from 1.32.1 to 1.32.2 (#20477)
  chore: migrate a few diagrams to mermaid (#20473)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants