fix: nil pointer panic when store don't exists in historical version #20425
Conversation
don't panic so the query handler can keep backward compatibility. changelog
WalkthroughWalkthroughThe recent updates primarily address a bug fix in 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Review Details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (3)
- store/CHANGELOG.md (1 hunks)
- store/rootmulti/store.go (1 hunks)
- store/rootmulti/store_test.go (1 hunks)
Additional Context Used
LanguageTool (1)
store/CHANGELOG.md (1)
Near line 63: The preposition ‘to’ may be missing (allow someone to do something).
Context: ... a separate go.mod file which allows it be a standalone module. * [#14410](https:/...
Path-based Instructions (3)
store/CHANGELOG.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"store/rootmulti/store_test.go (2)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
Pattern
**/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"store/rootmulti/store.go (1)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
Additional comments not posted (2)
store/rootmulti/store_test.go (1)
103-115: Verify the handling of nil databases when mounting stores.Verification successful
Verify the handling of
nildatabases in the test cases.
Verify the handling of
nildatabases in the test cases with an adjusted pattern.
The test case
TestCacheMultiStoreWithVersioninstore/rootmulti/store_test.gocorrectly handles the mounting of stores withnildatabases and verifies their behavior through various assertions. The test ensures that the multi-store can cache-load valid versions, handle invalid versions, and correctly manage new module stores.
store/rootmulti/store_test.go:
TestCacheMultiStoreWithVersionfunctionScripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify that mounting stores with nil databases does not cause issues elsewhere in the codebase. # Test: Search for other occurrences of mounting stores with nil databases. Expect: No other problematic usage. rg --type go $'MountStoreWithDB\\(.*, types.StoreTypeIAVL, nil\\)'Length of output: 2096
Script:
#!/bin/bash # Description: Verify that the test cases handle `nil` databases correctly. # Test: Extract and review the test functions in `store/rootmulti/store_test.go` and `store/rootmulti/snapshot_test.go` that use `MountStoreWithDB` with `nil` databases. ast-grep --lang go --pattern $'func $_($_) { $$$ MountStoreWithDB($_, types.StoreTypeIAVL, nil) $$$ }' store/rootmulti/store_test.go store/rootmulti/snapshot_test.goLength of output: 172
Script:
#!/bin/bash # Description: Verify that the test cases handle `nil` databases correctly. # Test: Extract and review the test functions in `store/rootmulti/store_test.go` and `store/rootmulti/snapshot_test.go` that use `MountStoreWithDB` with `nil` databases. ast-grep --lang go --pattern $'func $_($_) { $$$ $_.MountStoreWithDB($_, types.StoreTypeIAVL, nil) $$$ }' store/rootmulti/store_test.go store/rootmulti/snapshot_test.goLength of output: 3664
store/rootmulti/store.go (1)
611-613: Handle non-existent stores gracefully by creating a dummy store.This change effectively prevents nil pointer panics when querying non-existent stores in historical versions by creating a dummy in-memory store. This is a robust solution for maintaining backward compatibility and ensuring system stability.
|
|
||
| ### Bug Fixes | ||
|
|
||
| * (store) [#20425](https://github.com/cosmos/cosmos-sdk/pull/20425) Fix nil pointer panic when query historical state where a new store don't exist. |
There was a problem hiding this comment.
Correct grammatical error in changelog entry.
- * (store) [#20425](https://github.com/cosmos/cosmos-sdk/pull/20425) Fix nil pointer panic when query historical state where a new store don't exist.
+ * (store) [#20425](https://github.com/cosmos/cosmos-sdk/pull/20425) Fix nil pointer panic when querying historical state where a new store does not exist.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.
| * (store) [#20425](https://github.com/cosmos/cosmos-sdk/pull/20425) Fix nil pointer panic when query historical state where a new store don't exist. | |
| * (store) [#20425](https://github.com/cosmos/cosmos-sdk/pull/20425) Fix nil pointer panic when querying historical state where a new store does not exist. |
* main: (95 commits) fix(x/accounts): check for overflows in multisig weights and votes (#20384) docs(x/account/auth): Improve error handling and comments in fee.go (#20426) docs: fix some markdown syntax (#20432) revert: bank change module to account change (#20427) fix: nil pointer panic when store don't exists in historical version (#20425) fix(store/v2): Remove should not error on miss (#20423) chore: upstream more changes from v2 (#20387) docs(x/auth/ante): fixed typo in TxWithTimeoutHeight interface name (#20418) fix: avoid default sendenabled for module accounts (#20419) docs(x/auth): fixed typo in command example for multisign transaction (#20417) build(deps): Bump bufbuild/buf-setup-action from 1.31.0 to 1.32.0 (#20413) build(deps): Bump github.com/hashicorp/go-plugin from 1.6.0 to 1.6.1 in /store (#20414) feat(x/accounts): Add schema caching feature and corresponding test case (#20055) refactor(runtime/v2): remove dependency on sdk (#20389) refactor!: turn MsgsV2 into ReflectMessages to make it less confusing (#19839) docs: Enhanced the ParsePagination method documentation (#20385) refactor(runtime,core): split router service (#20401) chore: fix spelling errors (#20400) docs: Documented error handling in OfferSnapshot method (#20380) build(deps): Bump google.golang.org/grpc from 1.63.2 to 1.64.0 (#20390) ...
don't panic so the query handler can keep backward compatibility.
changelog
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...
!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.
I have...
Summary by CodeRabbit