fix(client/v2): fix comment parsing

[julienrbrt]

Description

ref: #19376

Follow-up of #18324

---

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

  • Introduced new message structures for signing arbitrary data, enhancing the protocol's flexibility.
  • Added sample request message functionality and related definitions to improve testing and development workflows.
  • Implemented version information and method name constants for improved code clarity and maintenance.

• Documentation

  • Added descriptive comments to sample request messages for better understanding and usage.

• Refactor

  • Updated logic in utility functions to handle edge cases more effectively, ensuring robust support determination.
  • Refactored test cases for increased readability and efficiency.

• Tests

  • Expanded testing suite with new tests and test cases for utility functions, bolstering code reliability.

[coderabbitai]

Walkthrough

The changes encompass updates across various files in the client's internal codebase, focusing on enhancing protobuf message structures, refining gRPC method naming, and improving utility functions. Key highlights include the introduction of new message structures for signing arbitrary data, additions of sample request messages, inclusion of version information in generated code comments, and enhancements to utility function logic. These alterations aim to boost code clarity, maintainability, and the handling of protocol buffers.

Changes

Files	Change Summary
.../offchain/msgSignArbitraryData.pulsar.go	Introduces new protobuf message structures and fields for signing arbitrary data.
.../testpb/msg.proto	Adds a comment describing MsgRequest as a sample request message.
.../testpb/msg.pulsar.go	Adds MsgRequest as a sample request message and incorporates various message definition modifications.
.../testpb/msg_grpc.pb.go	Includes version information and constants for method names in Msg_Send.
.../testpb/query_grpc.pb.go	Adds version information and defines constants for full method names. Updates method calls to use these constants.
.../util/util.go	Updates isSupportedVersion logic, removes a TODO comment in DescriptorDocs.
.../util/util_test.go	Adds new tests, refactors existing ones, introduces protoreflect and testpb package imports.

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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.

[julienrbrt]

We need to fix this, which never worked it seems, so that we can use latest api module into release/v0.50 (#19376)

[julienrbrt]

It seems that SourceCodeInfo is never included in the descriptor: golang/protobuf#1134 and neither in our pulsar generator.
We should add them.

[julienrbrt]

cosmos/cosmos-proto#131

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between defab1a and 88c3a9c.

Files selected for processing (8)

• client/v2/internal/offchain/msgSignArbitraryData.pulsar.go (1 hunks)
• client/v2/internal/testpb/msg.proto (1 hunks)
• client/v2/internal/testpb/msg.pulsar.go (2 hunks)
• client/v2/internal/testpb/msg_grpc.pb.go (4 hunks)
• client/v2/internal/testpb/query.pulsar.go (1 hunks)
• client/v2/internal/testpb/query_grpc.pb.go (4 hunks)
• client/v2/internal/util/util.go (4 hunks)
• client/v2/internal/util/util_test.go (3 hunks)

Files not summarized due to errors (1)

• client/v2/internal/testpb/query.pulsar.go: Error: Message exceeds token limit

Additional comments: 13

client/v2/internal/testpb/msg.proto (1)

• 17-17: The comment added to describe MsgRequest as a sample request message is clear and improves the documentation. Good job on enhancing code readability and maintainability.

client/v2/internal/util/util.go (1)

• 63-73: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [54-70]

The update to the isSupportedVersion function to handle cases where the module name or version is empty improves the function's robustness. Ensure that this logic correctly identifies supported versions in all expected scenarios.

client/v2/internal/testpb/msg_grpc.pb.go (1)

• 21-23: The introduction of Msg_Send_FullMethodName as a constant for the full method name and its usage in the Msg_Send function is a good practice for code maintainability and readability.

client/v2/internal/testpb/query_grpc.pb.go (1)

• 21-23: The addition of Query_Echo_FullMethodName as a constant for the full method name and its usage in the Query_Echo function follows best practices for code maintainability and readability.

client/v2/internal/util/util_test.go (4)

• 6-9: The addition of imports for protoreflect and testpb packages is necessary for the new tests. Good job on keeping the test dependencies updated.
• 81-86: Refactoring test cases in TestIsSupportedVersion to use t.Run improves test structure and readability. This is a good practice for organizing tests and making them more maintainable.
• 154-163: Refactoring test cases in TestParseSinceComment to use t.Run is also commendable for the same reasons as above. It enhances test readability and maintainability.
• 166-198: The new test function TestDescriptorDocs is temporarily skipped. Ensure to unskip and finalize this test once the related work (feat: add source code info in descriptor cosmos-proto#131) is completed. It's crucial to have coverage for the DescriptorDocs function.

client/v2/internal/offchain/msgSignArbitraryData.pulsar.go (2)

• 665-705: The protobuf message definition for MsgSignArbitraryData is well-structured and correctly utilizes custom options for the signer field to enforce specific data formats. This is a good practice within the Cosmos SDK ecosystem.
• 662-708: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-664]

The generated code section adheres to the standards and practices of the protobuf compiler and protoc-gen-go-pulsar, with no manual modifications or custom logic added. This maintains the integrity of the code generation process and eases future updates.

client/v2/internal/testpb/msg.pulsar.go (3)

• 3153-3159: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [3156-3536]

The message structures MsgRequest and MsgResponse are well-defined with appropriate protobuf field annotations.

• 3542-3549: The service definition Msg with the method Send correctly specifies input and output types.
• 3533-3667: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [3156-3664]

The protobuf field annotations for message structures and the service method are correctly defined.

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between 88c3a9c and 9e90e33.

Files selected for processing (1)

• client/v2/CHANGELOG.md (1 hunks)

Additional comments: 1

client/v2/CHANGELOG.md (1)

• 56-56: The entry for PR #19377 mentions "Partly fix comment parsing in autocli." It's clear and concise, directly linking to the PR for more details. However, the term "autocli" is consistently flagged by static analysis as a possible spelling mistake, suggesting "AutoCAD" as a replacement. While this is a false positive, it's important to ensure that "autocli" is the correct term used throughout the Cosmos SDK documentation and codebase to avoid confusion.

Verification successful

---

The search results confirm that "autocli" is consistently used across the Cosmos SDK documentation and codebase. It appears in various contexts, including CHANGELOG entries, Go source files, and Markdown documentation, indicating that it is a well-established term within the project. The term "autocli" refers to a specific feature or component within the Cosmos SDK, and its usage is not a spelling mistake or typographical error. Therefore, the original review comment about ensuring "autocli" is the correct term used throughout the Cosmos SDK documentation and codebase is validated by the search results.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Verify the consistent use of "autocli" across the Cosmos SDK documentation and codebase.
rg --type md --type go 'autocli'

Length of output: 99145

[coderabbitai]

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [61-61]

The entry regarding the removal of address codecs from autocli.AppOptions and flag.Builder is clear and informative. However, the static analysis has flagged a potential issue with the lack of a comma after "Instead," which is used as a conjunctive adverb here. Adding a comma would improve the readability of the sentence.

- Instead client/v2 uses the address codecs present in the context
+ Instead, client/v2 uses the address codecs present in the context

Additionally, ensure there's a space after periods for proper sentence separation, as flagged by the static analysis.