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: default comet port #23343

Merged
merged 4 commits into from
Jan 13, 2025
Merged

fix: default comet port #23343

merged 4 commits into from
Jan 13, 2025

Conversation

tac0turtle
Copy link
Member

@tac0turtle tac0turtle commented Jan 13, 2025

Description

Closes: #23329

fix comet defult port


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

  • Configuration Update
    • Modified RPC client configuration source
    • Updated node connection settings to use a different configuration field for listen address

Copy link
Contributor

coderabbitai bot commented Jan 13, 2025

📝 Walkthrough

Walkthrough

The pull request modifies the RPC client instantiation in the server/v2/cometbft/grpc.go file. The change updates the configuration source for creating the RPC client, switching from using AppTomlConfig.Address to ConfigTomlConfig.RPC.ListenAddress. This modification addresses a potential mismatch in the Comet RPC connection, specifically changing the source of the RPC address used for client connections.

Changes

File Change Summary
server/v2/cometbft/grpc.go Updated RPC client creation to use ConfigTomlConfig.RPC.ListenAddress instead of AppTomlConfig.Address

Assessment against linked issues

Objective Addressed Explanation
Fix RPC client and App Comet RPC mismatch [#23329]

Possibly related PRs

Suggested reviewers

  • kocubinski
  • julienrbrt
  • auricom

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@github-actions github-actions bot added C:server/v2 Issues related to server/v2 C:server/v2 cometbft labels Jan 13, 2025
@tac0turtle tac0turtle marked this pull request as ready for review January 13, 2025 10:30
@tac0turtle tac0turtle requested a review from a team as a code owner January 13, 2025 10:30
Copy link
Contributor

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

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c79e19d and ef3fb29.

📒 Files selected for processing (1)
  • server/v2/cometbft/config.go (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
server/v2/cometbft/config.go (1)

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

⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: tests (00)
  • GitHub Check: test-system-v2
  • GitHub Check: Analyze
  • GitHub Check: Summary
🔇 Additional comments (2)
server/v2/cometbft/config.go (2)

21-21: LGTM on the implementation.

The port change implementation itself is clean and the configuration struct is well-documented with appropriate comments.


21-21: Verify the default port against CometBFT documentation.

The change from port 26658 to 26656 appears to align with CometBFT's standard port configuration. Let's verify this against the official documentation.

✅ Verification successful

Port change to 26656 is correct and matches CometBFT documentation

The change aligns with CometBFT's documented standard P2P port (26656) as confirmed in multiple documentation files, including the production setup guide.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for port configuration in CometBFT documentation and code
# Expected: Find evidence that 26656 is the correct default port

# Search for port references in markdown files
rg -A 5 "26656|26658" --type md

# Search for default port configurations in Go files
ast-grep --pattern 'Address.*=.*"tcp://.*:26656"'

Length of output: 1013

@@ -18,7 +18,7 @@ func DefaultAppTomlConfig() *AppTomlConfig {
MinRetainBlocks: 0,
HaltHeight: 0,
HaltTime: 0,
Address: "tcp://127.0.0.1:26658",
Address: "tcp://127.0.0.1:26656",
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Breaking Change: Default RPC server port has changed.

Changing the default port from 26658 to 26656 is a breaking change that might affect systems relying on the previous default configuration. This should be documented in the changelog.

Please ensure to:

  1. Add a breaking change entry to the CHANGELOG.md
  2. Consider adding a migration guide for users

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.

Can you update in tools/confix/data/v2-app.toml?

@julienrbrt
Copy link
Member

Probably should be changed here too:

flags.String(FlagAddress, "tcp://127.0.0.1:26658", "Listen address")

@julienrbrt julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Jan 13, 2025
@tac0turtle tac0turtle added this pull request to the merge queue Jan 13, 2025
@tac0turtle tac0turtle removed this pull request from the merge queue due to a manual request Jan 13, 2025
github-merge-queue bot pushed a commit that referenced this pull request Jan 13, 2025
@tac0turtle
Copy link
Member Author

Probably should be changed here too:

flags.String(FlagAddress, "tcp://127.0.0.1:26658", "Listen address")

wrong flag, pushed the actual fix, this endpoint is for out of process

@tac0turtle tac0turtle enabled auto-merge January 13, 2025 14:20
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

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ef3fb29 and 93d6af1.

📒 Files selected for processing (1)
  • server/v2/cometbft/grpc.go (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
server/v2/cometbft/grpc.go (1)

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

⏰ Context from checks skipped due to timeout of 90000ms (8)
  • GitHub Check: tests (00)
  • GitHub Check: test-simapp-v2
  • GitHub Check: test-system-v2
  • GitHub Check: test-sim-nondeterminism
  • GitHub Check: test-integration
  • GitHub Check: Analyze
  • GitHub Check: build (amd64)
  • GitHub Check: Summary
🔇 Additional comments (2)
server/v2/cometbft/grpc.go (2)

527-527: LGTM! Configuration source change looks correct.

The change from AppTomlConfig.Address to ConfigTomlConfig.RPC.ListenAddress aligns with the PR objective to fix the default Comet port.


527-527: Verify related changes in server.go.

As suggested in the PR comments, there might be related changes needed in server.go.

Let's verify if there are any inconsistencies in the server configuration:

✅ Verification successful

No changes needed in server.go

The configurations in server.go and grpc.go serve different purposes:

  • server.go uses AppTomlConfig.Address for ABCI server creation
  • grpc.go uses ConfigTomlConfig.RPC.ListenAddress for RPC client creation
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any other occurrences of AppTomlConfig.Address in the codebase
rg -A 5 "AppTomlConfig.Address"

# Search for any other RPC client creation patterns
ast-grep --pattern 'client.NewClientFromNode($_)'

Length of output: 1220

@@ -524,7 +524,7 @@ func (c *consensus[T]) maybeHandleExternalServices(ctx context.Context, req *abc

// Handle tx service
if strings.HasPrefix(req.Path, "/cosmos.tx.v1beta1.Service") {
rpcClient, _ := client.NewClientFromNode(c.cfg.AppTomlConfig.Address)
rpcClient, _ := client.NewClientFromNode(c.cfg.ConfigTomlConfig.RPC.ListenAddress)
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Handle potential errors from NewClientFromNode.

The error from NewClientFromNode is being ignored which could lead to nil pointer dereferences if the client creation fails.

Apply this diff to handle the error:

-		rpcClient, _ := client.NewClientFromNode(c.cfg.ConfigTomlConfig.RPC.ListenAddress)
+		rpcClient, err := client.NewClientFromNode(c.cfg.ConfigTomlConfig.RPC.ListenAddress)
+		if err != nil {
+			return nil, fmt.Errorf("failed to create RPC client: %w", err)
+		}
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
rpcClient, _ := client.NewClientFromNode(c.cfg.ConfigTomlConfig.RPC.ListenAddress)
rpcClient, err := client.NewClientFromNode(c.cfg.ConfigTomlConfig.RPC.ListenAddress)
if err != nil {
return nil, fmt.Errorf("failed to create RPC client: %w", err)
}

@tac0turtle tac0turtle added this pull request to the merge queue Jan 13, 2025
Merged via the queue into main with commit 9f048eb Jan 13, 2025
70 of 71 checks passed
@tac0turtle tac0turtle deleted the marko/23329 branch January 13, 2025 17:38
mergify bot pushed a commit that referenced this pull request Jan 13, 2025
Co-authored-by: Alex | Interchain Labs <alex@skip.money>
Co-authored-by: Julien Robert <julien@rbrt.fr>
(cherry picked from commit 9f048eb)
@mergify mergify bot mentioned this pull request Jan 13, 2025
12 tasks
julienrbrt pushed a commit that referenced this pull request Jan 13, 2025
Co-authored-by: Marko <marko@baricevic.me>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release C:server/v2 cometbft C:server/v2 Issues related to server/v2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Client and App Comet RPC are mismatched in simdv2
4 participants