fix(simapp/v2): wire swagger in testnet cmd #23570
Conversation
|
Warning There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure. 🔧 golangci-lint (1.62.2)level=warning msg="[runner] Can't run linter goanalysis_metalinter: buildir: failed to load package sqlite3: could not load export data: no export data for "github.com/bvinc/go-sqlite-lite/sqlite3"" 📝 WalkthroughWalkthroughThe pull request introduces a new method Changes
Sequence DiagramsequenceDiagram
participant Developer
participant TestnetInit
participant SwaggerServer
participant ServerConfig
Developer->>TestnetInit: Initiate testnet
TestnetInit->>SwaggerServer: NewWithConfigOptions()
SwaggerServer-->>ServerConfig: Configure with options
ServerConfig-->>TestnetInit: Return configured server
TestnetInit->>TestnetInit: Add Swagger server to server list
Possibly related PRs
Suggested labels
Suggested reviewers
✨ Finishing Touches
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
github-actions
bot
added
C:server/v2
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
simapp/v2/simdv2/cmd/testnet.go (1)
375-376: Consider adding error handling for server configuration.While the implementation is correct, it might be good to add error handling for the server configuration to maintain consistency with production standards.
- swaggerServer := swagger.NewWithConfigOptions[T](swagger.OverwriteDefaultConfig(swaggerConfig)) - server := serverv2.NewServer[T](serverCfg, cometServer, storeServer, grpcServer, grpcgatewayServer, restServer, telemetryServer, swaggerServer) + swaggerServer, err := swagger.NewWithConfigOptions[T](swagger.OverwriteDefaultConfig(swaggerConfig)) + if err != nil { + return fmt.Errorf("failed to create swagger server: %w", err) + } + server, err := serverv2.NewServer[T](serverCfg, cometServer, storeServer, grpcServer, grpcgatewayServer, restServer, telemetryServer, swaggerServer) + if err != nil { + return fmt.Errorf("failed to create server: %w", err) + }
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
server/v2/api/swagger/server.go(1 hunks)simapp/v2/simdv2/cmd/testnet.go(5 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
server/v2/api/swagger/server.go (1)
Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
simapp/v2/simdv2/cmd/testnet.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 (6)
- GitHub Check: tests (00)
- GitHub Check: test-simapp-v2
- GitHub Check: test-system-v2
- GitHub Check: Analyze
- GitHub Check: golangci-lint
- GitHub Check: Summary
🔇 Additional comments (4)
server/v2/api/swagger/server.go (1)
67-74: LGTM! Clean and well-documented implementation.The new constructor method follows Go's idiomatic patterns and clearly documents its limitations.
simapp/v2/simdv2/cmd/testnet.go (3)
192-192: LGTM! Port number choice is appropriate.The Swagger port (8090) is well-chosen as it doesn't conflict with other service ports.
235-238: LGTM! Single machine configuration is properly handled.The Swagger configuration correctly handles port offsets for single machine setups, maintaining consistency with other services.
375-376: LGTM! Server integration is clean and consistent.The Swagger server is properly integrated into the server list, following the same pattern as other server components.
Description
Fixes error when using simapp testnet command.
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...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers 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...
Summary by CodeRabbit
New Features
Improvements