fix: fix swagger page and ci #1333
Conversation
WalkthroughThe recent changes focus on enhancing the management of Protobuf dependencies and Swagger file generation for Cosmos SDK and IBC protocols. This includes updates to the Changes
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
| SWAGGER_THIRD_PARTY_DIR=$(SWAGGER_PROTO_DIR)/third_party | ||
| SWAGGER_COSMOS_SDK_BRANCH=release/v0.47.x | ||
| SWAGGER_IBC_BRANCH=release/v7.4.x | ||
| proto-download-deps: |
There was a problem hiding this comment.
To include cosmos-sdk and other third party queries and services into swagger, it requires download the raw proto files for generating proper swagger files.
| @@ -110,6 +110,8 @@ import ( | |||
| "github.com/CosmWasm/wasmd/x/wasm" | |||
| wasmkeeper "github.com/CosmWasm/wasmd/x/wasm/keeper" | |||
| wasmtypes "github.com/CosmWasm/wasmd/x/wasm/types" | |||
|
|
|||
| _ "github.com/desmos-labs/desmos/v7/client/docs/statik" | |||
There was a problem hiding this comment.
Overwrite the swagger static files.
![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
Out of diff range and nitpick comments (1)
scripts/protoc-swagger-gen.sh (1)
Line range hint
22-27: Consider simplifying the condition check and ensure proper handling of variables to prevent issues like word splitting.- if [[ ! -z "$query_file" ]]; then + if [[ -n "$query_file" ]]; then - buf generate --template buf.gen.swagger.yaml $query_file + buf generate --template buf.gen.swagger.yaml "$query_file"
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (9)
client/docs/swagger-ui/favicon-16x16.pngis excluded by!**/*.pngclient/docs/swagger-ui/favicon-32x32.pngis excluded by!**/*.pngclient/docs/swagger-ui/swagger-ui-bundle.js.mapis excluded by!**/*.mapclient/docs/swagger-ui/swagger-ui-es-bundle-core.js.mapis excluded by!**/*.mapclient/docs/swagger-ui/swagger-ui-es-bundle.js.mapis excluded by!**/*.mapclient/docs/swagger-ui/swagger-ui-standalone-preset.js.mapis excluded by!**/*.mapclient/docs/swagger-ui/swagger-ui.css.mapis excluded by!**/*.mapclient/docs/swagger-ui/swagger-ui.js.mapis excluded by!**/*.mapproto/buf.lockis excluded by!**/*.lock
Files selected for processing (6)
- Makefile (1 hunks)
- app/app.go (1 hunks)
- client/docs/config.json (1 hunks)
- client/docs/swagger-ui/index.html (1 hunks)
- client/docs/swagger-ui/oauth2-redirect.html (1 hunks)
- scripts/protoc-swagger-gen.sh (2 hunks)
Files not reviewed due to errors (3)
- client/docs/swagger-ui/oauth2-redirect.html (no review received)
- client/docs/config.json (no review received)
- Makefile (no review received)
Files skipped from review due to trivial changes (1)
- client/docs/swagger-ui/index.html
Additional Context Used
ShellCheck (2)
scripts/protoc-swagger-gen.sh (2)
[style] 26-26: Use -n instead of ! -z.
[info] 27-27: Double quote to prevent globbing and word splitting.
Additional comments not posted (7)
scripts/protoc-swagger-gen.sh (6)
6-10: LGTM! Preparation steps for Swagger generation are well-structured.
11-15: LGTM! Copying proto files to a new directory ensures isolation during Swagger generation.
16-16: LGTM! Using a temporary folder for intermediate results is a good practice.
32-32: LGTM! Cleaning up after generation prevents issues with stale files.
32-32: LGTM! Effective finalization of the Swagger generation process.
Line range hint
6-32: The script is well-structured and effectively supports the enhancements to Swagger documentation.app/app.go (1)
114-114: Ensure the imported Swagger documentation is utilized within the application.Verification successful
The search results indicate that the import statement for the
statikpackage appears only once inapp/app.go, and that is the import line itself. There is no further evidence from the provided output that the imported package is being utilized elsewhere in the file. This could suggest that the import might be unnecessary unless it is implicitly used by the Go toolchain (which is common for packages that embed static files).To confirm whether this package is indeed used implicitly (which is a common pattern for packages that serve static files or documentation), I will need to check if there is any reference in the build scripts or other parts of the application where this package's content is accessed indirectly.
The search results from the scripts provide clear evidence that the
statikpackage is indeed used within the project, particularly in the build process as specified in theMakefile. The references tostatikin theMakefileand other related files indicate that it is used to embed Swagger UI assets into the Go binary. This is a common practice for serving static files directly from a Go application, which aligns with the purpose of enhancing Swagger documentation as mentioned in the PR.Additionally, the presence of a
statik.gofile in theclient/docs/statikdirectory, which is generated by thestatiktool and contains static assets, confirms that thestatikpackage is not only imported but actively used to serve embedded content.Given this information, the import statement in
app/app.gois justified and necessary for the application's functionality related to serving Swagger documentation. Therefore, the review comment questioning the utilization of the imported Swagger documentation is addressed, and the usage is verified as correct.Ensure the imported Swagger documentation is utilized within the application.
- The
statikpackage is used in the build scripts to embed Swagger UI assets into the Go binary.- The generated
statik.gofile in theclient/docs/statikdirectory confirms the active use of thestatikpackage for serving embedded content.Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the usage of the imported Swagger documentation package. # Test: Search for the usage of the `statik` package. Expect: At least one occurrence. rg --type go $'github.com/desmos-labs/desmos/v7/client/docs/statik' app/app.goLength of output: 134
Script:
#!/bin/bash # Description: Check for implicit usage of the `statik` package in build scripts or other Go files. # Search for any reference to the `statik` package in all Go files and build scripts. rg --type go --type make --type sh 'statik' .Length of output: 1571
There was a problem hiding this comment.
Actionable comments posted: 0
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- .changeset/entries/9769bdf3cddefa33b7cbb5e13147c6b1f7a0d4193acb78e6904a7c1734fa5e68.yaml (1 hunks)
Files skipped from review due to trivial changes (1)
- .changeset/entries/9769bdf3cddefa33b7cbb5e13147c6b1f7a0d4193acb78e6904a7c1734fa5e68.yaml
Description
Closes: #XXXX
This PR fixes swagger page to show proper frontend and includes cosmos-sdk queries and services to swagger file.
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...
!to 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.
I have...
!in the type prefix if API or client breaking changeSummary by CodeRabbit