chore(x/feegrant): use cosmossdk.io/core/codec instead of github.com/cosmos/cosmos-sdk/codec
#23297
Conversation
…b.com/cosmos/cosmos-sdk/codec
|
Warning Rate limit exceeded@julienrbrt has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 22 minutes and 34 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (3)
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
|
caseylove
changed the title
cosmossdk.io/core/codec instead of github.com/cosmos/cosmos-sdk/codeccosmossdk.io/core/codec instead of github.com/cosmos/cosmos-sdk/codec
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
x/feegrant/module/module.go(2 hunks)x/feegrant/simulation/decoder.go(2 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
x/feegrant/module/module.go (1)
Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
x/feegrant/simulation/decoder.go (1)
Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
🪛 golangci-lint (1.62.2)
x/feegrant/module/module.go
19-19: File is not gci-ed with --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk) --custom-order
(gci)
🪛 GitHub Actions: Lint
x/feegrant/module/module.go
[error] 12-12: File is not gci-ed with --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk) --custom-order
[error] 19-19: File is not gci-ed with --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk) --custom-order
x/feegrant/simulation/decoder.go
[error] 8-8: File is not gci-ed with --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk) --custom-order
⏰ Context from checks skipped due to timeout of 90000ms (5)
- GitHub Check: repo-analysis
- GitHub Check: test-simapp-v2
- GitHub Check: test-system-v2
- GitHub Check: Analyze
- GitHub Check: Summary
| @@ -4,9 +4,8 @@ import ( | |||
| "bytes" | |||
| "fmt" | |||
|
|
|||
| "cosmossdk.io/core/codec" | |||
There was a problem hiding this comment.
Fix import ordering using gci.
The imports need to be reordered according to the project's guidelines using gci with the following configuration:
gci --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk)
| if err := cdc.Unmarshal(kvA.Value, &grantA); err != nil { | ||
| panic(err) | ||
| } | ||
| if err := cdc.Unmarshal(kvB.Value, &grantB); err != nil { | ||
| panic(err) | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider using error propagation instead of panic.
While the error handling is more explicit now, using panic in production code is generally discouraged. Consider propagating the error up the call stack instead.
-func NewDecodeStore(cdc codec.Codec) func(kvA, kvB kv.Pair) string {
+func NewDecodeStore(cdc codec.Codec) func(kvA, kvB kv.Pair) (string, error) {
- return func(kvA, kvB kv.Pair) string {
+ return func(kvA, kvB kv.Pair) (string, error) {
switch {
case bytes.Equal(kvA.Key[:1], feegrant.FeeAllowanceKeyPrefix):
var grantA, grantB feegrant.Grant
if err := cdc.Unmarshal(kvA.Value, &grantA); err != nil {
- panic(err)
+ return "", fmt.Errorf("failed to unmarshal grant A: %w", err)
}
if err := cdc.Unmarshal(kvB.Value, &grantB); err != nil {
- panic(err)
+ return "", fmt.Errorf("failed to unmarshal grant B: %w", err)
}
- return fmt.Sprintf("%v\n%v", grantA, grantB)
+ return fmt.Sprintf("%v\n%v", grantA, grantB), nil
default:
- panic(fmt.Sprintf("invalid feegrant key %X", kvA.Key))
+ return "", fmt.Errorf("invalid feegrant key %X", kvA.Key)
}
}
}📝 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.
| if err := cdc.Unmarshal(kvA.Value, &grantA); err != nil { | |
| panic(err) | |
| } | |
| if err := cdc.Unmarshal(kvB.Value, &grantB); err != nil { | |
| panic(err) | |
| } | |
| func NewDecodeStore(cdc codec.Codec) func(kvA, kvB kv.Pair) (string, error) { | |
| return func(kvA, kvB kv.Pair) (string, error) { | |
| switch { | |
| case bytes.Equal(kvA.Key[:1], feegrant.FeeAllowanceKeyPrefix): | |
| var grantA, grantB feegrant.Grant | |
| if err := cdc.Unmarshal(kvA.Value, &grantA); err != nil { | |
| return "", fmt.Errorf("failed to unmarshal grant A: %w", err) | |
| } | |
| if err := cdc.Unmarshal(kvB.Value, &grantB); err != nil { | |
| return "", fmt.Errorf("failed to unmarshal grant B: %w", err) | |
| } | |
| return fmt.Sprintf("%v\n%v", grantA, grantB), nil | |
| default: | |
| return "", fmt.Errorf("invalid feegrant key %X", kvA.Key) | |
| } | |
| } | |
| } |
x/feegrant/module/module.go
Outdated
| @@ -16,8 +16,8 @@ import ( | |||
| "cosmossdk.io/x/feegrant/client/cli" | |||
| "cosmossdk.io/x/feegrant/keeper" | |||
|
|
|||
| "cosmossdk.io/core/codec" | |||
There was a problem hiding this comment.
Fix import ordering using gci.
The imports need to be reordered according to the project's guidelines using gci with the following configuration:
gci --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk)
🧰 Tools
🪛 golangci-lint (1.62.2)
19-19: File is not gci-ed with --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk) --custom-order
(gci)
🪛 GitHub Actions: Lint
[error] 19-19: File is not gci-ed with --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk) --custom-order
| data, err := am.cdc.MarshalJSON(feegrant.DefaultGenesisState()) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| return data |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider using error propagation instead of panic.
While the error handling is more explicit now, using panic in production code is generally discouraged. Consider propagating the error up the call stack by updating the interface to return an error.
-func (am AppModule) DefaultGenesis() json.RawMessage {
+func (am AppModule) DefaultGenesis() (json.RawMessage, error) {
data, err := am.cdc.MarshalJSON(feegrant.DefaultGenesisState())
if err != nil {
- panic(err)
+ return nil, fmt.Errorf("failed to marshal default genesis state: %w", err)
}
- return data
+ return data, nil
}Committable suggestion skipped: line range outside the PR's diff.
julienrbrt
added
the
backport/v0.52.x
Description
Partially addresses: #23253
Summary by CodeRabbit
Refactor
cosmos-sdk/codectocosmossdk.io/core/codecDefaultGenesismethod andNewDecodeStorefunctionMustMarshalJSONandMustUnmarshalwith methods that allow explicit error managementChores