fix(simapp/v2): failed to start HTTP server on port 8080 conflict #22687

mmsqe · 2024-11-28T15:07:16Z

prevent simdv2 panic on restart when access db closed by fail server start

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

New Features
- Enhanced testnet functionality to support RESTful interactions alongside the existing gRPC server.
- Introduced a dedicated port for the REST server, set to 8080.
Bug Fixes
- Adjusted handling of the singleMachine flag for improved REST server operation in single-host configurations.

prevent simd panic on restart when access db closed by fail server start

coderabbitai · 2024-11-28T15:07:23Z

📝 Walkthrough

Walkthrough

The changes in this pull request enhance the testnet.go file by integrating REST server functionality alongside the existing gRPC server. A new import for the REST API package has been added, and the initTestnetFiles function has been updated to create and configure a REST server with a dedicated port. The server setup has been modified to include this new REST server, ensuring it operates correctly in both multi-host and single-host configurations. Additionally, a temporary function for handling bank genesis files has been introduced.

Changes

File Path	Change Summary
simapp/v2/simdv2/cmd/testnet.go	- Updated `initTestnetFiles` to configure a REST server. - Modified `NewServer` to include the REST server. - Added constant `restPort = 8080` for REST server port. - Updated `collectGenFiles` for additional server configurations. - Introduced temporary method `getBankV2GenesisFromV1`.

Possibly related PRs

fix(sims): Skip sims test when running dry on validators #21906: This PR addresses issues related to the simulation loop and tests when there are no available validators, which may indirectly relate to the overall server functionality and initialization processes, similar to the enhancements made in the main PR for the testnet initialization.
fix(server/v2): respect context cancellation in start command #22346: This PR improves the server's responsiveness to context cancellation, which is relevant to the server setup changes in the main PR that involve initializing a REST server alongside the gRPC server.

Suggested labels

C:server/v2, backport/v0.50.x, backport/v0.52.x

Suggested reviewers

julienrbrt
akhilkumarpilli
testinginprod

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

julienrbrt · 2024-11-29T08:28:54Z

server/config/config.go

@@ -141,6 +141,15 @@ type GRPCConfig struct {
 	MaxSendMsgSize int `mapstructure:"max-send-msg-size"`
 }

+// RESTConfig defines configuration for the rest server.


What is it used for? That new server is only used in v2. I think the changes are only needed for simappv2 then

julienrbrt

Makes sense, thanks!

coderabbitai

Actionable comments posted: 2

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 6fb8299 and 794675a.

📒 Files selected for processing (1)

simapp/v2/simdv2/cmd/testnet.go (5 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

simapp/v2/simdv2/cmd/testnet.go (1)

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

🔇 Additional comments (3)

simapp/v2/simdv2/cmd/testnet.go (3)

23-23: Importing REST API package is appropriate

The added import statement for the REST API package is necessary for configuring the REST server functionality.

197-197: Initializing REST server configuration is appropriate

Initializing restConfig with rest.DefaultConfig() correctly sets up the default configuration for the REST server.

349-350: Integrating REST server into server configuration is appropriate

Including the restServer in the server initialization ensures that the REST API is properly set up alongside other services.

coderabbitai · 2024-11-29T16:11:48Z

simapp/v2/simdv2/cmd/testnet.go

@@ -184,6 +185,7 @@ func initTestnetFiles[T transaction.Tx](
 		rpcPort  = 26657
 		apiPort  = 1317
 		grpcPort = 9090
+		restPort = 8080


⚠️ Potential issue

Using fixed port 8080 for REST server may cause port conflicts

Defining restPort as a constant with the value 8080 could lead to port conflicts since port 8080 is commonly used by other services. Consider making the REST port configurable or choosing an uncommon default port to avoid potential conflicts.

coderabbitai · 2024-11-29T16:11:48Z

simapp/v2/simdv2/cmd/testnet.go

+
+			restConfig = &rest.Config{
+				Enable:  true,
+				Address: fmt.Sprintf("127.0.0.1:%d", restPort+portOffset),
+			}


🛠️ Refactor suggestion

⚠️ Potential issue

Potential port conflicts in multi-host configurations

The REST server is configured to listen on 127.0.0.1 at port restPort + portOffset when singleMachine is set to true, which helps avoid port conflicts on a single machine. However, when singleMachine is false, the portOffset is not applied, and all instances will listen on the same restPort (port 8080) on their respective hosts. If multiple instances are running on the same host or if port 8080 is already in use on any host, this could cause port conflicts.

Suggestion: Make the REST port configurable or apply portOffset in multi-host setups

To prevent potential port conflicts in multi-host configurations, consider making the REST port configurable regardless of the singleMachine flag or apply the portOffset in both scenarios.

tac0turtle · 2024-12-02T09:36:28Z

seems there is a suplicate import, can you fix and then we can merge it

…2687) (cherry picked from commit e7fe651)

…ckport #22687) (#22711) Co-authored-by: mmsqe <[email protected]>

fix(test): failed to start HTTP server on port 8080 conflict

d5cb12b

prevent simd panic on restart when access db closed by fail server start

julienrbrt reviewed Nov 29, 2024

View reviewed changes

mmsqe added 3 commits November 29, 2024 18:45

revert rest config

9f6d375

Merge remote-tracking branch 'origin/main' into rest_port

488d316

cleanup

794675a

mmsqe marked this pull request as ready for review November 29, 2024 16:00

mmsqe requested review from kocubinski and a team as code owners November 29, 2024 16:00

julienrbrt changed the title ~~fix(test): failed to start HTTP server on port 8080 conflict~~ fix(simapp/v2): failed to start HTTP server on port 8080 conflict Nov 29, 2024

julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Nov 29, 2024

julienrbrt approved these changes Nov 29, 2024

View reviewed changes

coderabbitai bot reviewed Nov 29, 2024

View reviewed changes

tac0turtle approved these changes Dec 2, 2024

View reviewed changes

tac0turtle enabled auto-merge December 2, 2024 08:51

Merge branch 'main' into rest_port

33a74d0

tac0turtle added this pull request to the merge queue Dec 2, 2024

Merged via the queue into cosmos:main with commit e7fe651 Dec 2, 2024
68 of 71 checks passed

mergify bot pushed a commit that referenced this pull request Dec 2, 2024

fix(simapp/v2): failed to start HTTP server on port 8080 conflict (#2…

ff5db8e

…2687) (cherry picked from commit e7fe651)

mergify bot mentioned this pull request Dec 2, 2024

fix(simapp/v2): failed to start HTTP server on port 8080 conflict (backport #22687) #22711

Merged

12 tasks

julienrbrt pushed a commit that referenced this pull request Dec 2, 2024

fix(simapp/v2): failed to start HTTP server on port 8080 conflict (ba…

b357013

…ckport #22687) (#22711) Co-authored-by: mmsqe <[email protected]>

This was referenced Dec 2, 2024

feat(server/v2/grpcgateway): register grpcgateway server and module endpoints #22701

Merged

refactor(tests/integration): Port distribution integration tests to server v2 #22667

Merged

test(integration): port x/evidence tests to server v2 #22709

Merged

coderabbitai bot mentioned this pull request Dec 10, 2024

fix(systemtests): avoid HTTP server on port 8080 conflict when AddFullnode #22810

Merged

12 tasks

This was referenced Dec 19, 2024

test: investigate test failure due to wal log #22679

Merged

fix(server/v2/api/telemetry): avoid panic due to no telemetry address #23022

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(simapp/v2): failed to start HTTP server on port 8080 conflict #22687

fix(simapp/v2): failed to start HTTP server on port 8080 conflict #22687

mmsqe commented Nov 28, 2024 •

edited

Loading

coderabbitai bot commented Nov 28, 2024 •

edited

Loading

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

julienrbrt Nov 29, 2024

julienrbrt left a comment

coderabbitai bot left a comment

coderabbitai bot Nov 29, 2024

coderabbitai bot Nov 29, 2024

tac0turtle commented Dec 2, 2024

fix(simapp/v2): failed to start HTTP server on port 8080 conflict #22687

fix(simapp/v2): failed to start HTTP server on port 8080 conflict #22687

Conversation

mmsqe commented Nov 28, 2024 • edited Loading

Description

Author Checklist

Reviewers Checklist

Summary by CodeRabbit

coderabbitai bot commented Nov 28, 2024 • edited Loading

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

julienrbrt Nov 29, 2024

Choose a reason for hiding this comment

julienrbrt left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Nov 29, 2024

Choose a reason for hiding this comment

coderabbitai bot Nov 29, 2024

Choose a reason for hiding this comment

tac0turtle commented Dec 2, 2024

mmsqe commented Nov 28, 2024 •

edited

Loading

coderabbitai bot commented Nov 28, 2024 •

edited

Loading