Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: use empty map instead of nil value for setting BaseApp.snapshotManager.extensions #12031

Merged
merged 12 commits into from
Jun 2, 2022

Conversation

catShaark
Copy link
Contributor

@catShaark catShaark commented May 24, 2022

Description

BaseApp method SetSnapshot sets BaseApp.snapshotManager.extensions with a nil value, this will cause nil map error whenever BaseApp.snapshotManager.extensions is used, so I change it to an empty map instead.

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
  • added ! to 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
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • 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.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@catShaark catShaark requested a review from a team as a code owner May 24, 2022 17:24
@catShaark catShaark changed the title use empty map instead of nil for setting snapshotManager.extensions fix: use empty map instead of nil for setting BaseApp.snapshotManager.extensions May 24, 2022
@catShaark catShaark changed the title fix: use empty map instead of nil for setting BaseApp.snapshotManager.extensions fix: nil value setting BaseApp.snapshotManager.extensions May 24, 2022
@catShaark catShaark changed the title fix: nil value setting BaseApp.snapshotManager.extensions fix: use empty map instead of nil value for setting BaseApp.snapshotManager.extensions May 24, 2022
@catShaark
Copy link
Contributor Author

Should I add unit test for this ?

Copy link
Collaborator

@yihuang yihuang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@yihuang
Copy link
Collaborator

yihuang commented May 25, 2022

maybe better to change the NewManager internal to create a map if input with nil?

@yihuang
Copy link
Collaborator

yihuang commented May 25, 2022

https://github.com/CosmWasm/wasmd/blob/main/app/app.go#L744
wasmd has been using this feature, I wonder why it works for them?

@tac0turtle
Copy link
Member

Should I add unit test for this ?

yes please

@codecov
Copy link

codecov bot commented May 26, 2022

Codecov Report

Merging #12031 (1e95c65) into main (8c281ee) will decrease coverage by 0.35%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #12031      +/-   ##
==========================================
- Coverage   66.36%   66.00%   -0.36%     
==========================================
  Files         685      671      -14     
  Lines       71983    70987     -996     
==========================================
- Hits        47774    46858     -916     
+ Misses      21518    21467      -51     
+ Partials     2691     2662      -29     
Impacted Files Coverage Δ
snapshots/manager.go 47.58% <100.00%> (+0.54%) ⬆️
x/distribution/simulation/operations.go 80.21% <0.00%> (-9.90%) ⬇️
depinject/one_per_module.go
depinject/supply.go
depinject/module_key.go
depinject/struct_args.go
depinject/location.go
depinject/errors.go
depinject/inject.go
depinject/debug.go
... and 6 more

@faddat
Copy link
Contributor

faddat commented May 26, 2022

@yihuang honestly, I don't know -- I tried to implement line for line the same way as they did in the current wasmd. This PR is actually for wasmd.

Please feel free to comment / let us know if you see the issue?

CosmWasm/wasmd#863

Thanks very much @yihuang <3

@catShaark
Copy link
Contributor Author

catShaark commented May 26, 2022

https://github.com/CosmWasm/wasmd/blob/main/app/app.go#L744 wasmd has been using this feature, I wonder why it works for them?

I think it's because they don't call the SetSnapshot func to set BaseApp.snapshotManager, which makes manager == nil , and therefore this line is never run

@alexanderbez
Copy link
Contributor

Once we get the liveness test figure out and working on main, we'll merge this 👍

@yihuang
Copy link
Collaborator

yihuang commented May 27, 2022

@yihuang honestly, I don't know -- I tried to implement line for line the same way as they did in the current wasmd. This PR is actually for wasmd.

Please feel free to comment / let us know if you see the issue?

CosmWasm/wasmd#863

Thanks very much @yihuang <3

811cb8a#diff-84a22ba89cc7868bbafc59e07c35ba0bffb05115962cb885bf39eef1a1a8a66eR68

The v0.45.x backported version has a slight difference to avoid breaking the existing API, lol.

@amaury1093
Copy link
Contributor

amaury1093 commented Jun 1, 2022

Is this ready to be merged?

This branch is out-of-date with the base branch

@catShaark Can you merge / rebase main to this branch? Or allow edits from maintainers

@catShaark
Copy link
Contributor Author

@yihuang , I've updated this branch

@yihuang
Copy link
Collaborator

yihuang commented Jun 1, 2022

@yihuang , I've updated this branch

LGTM

@amaury1093 amaury1093 added the A:automerge Automatically merge PR once all prerequisites pass. label Jun 1, 2022
@mergify mergify bot merged commit 93f5108 into cosmos:main Jun 2, 2022
faddat pushed a commit to notional-labs/cosmos-sdk that referenced this pull request Jul 5, 2022
…anager.extensions (cosmos#12031)

## Description

`BaseApp` method `SetSnapshot` sets `BaseApp.snapshotManager.extensions` with a nil value, this will cause nil map error whenever `BaseApp.snapshotManager.extensions` is used, so I change it to an empty map instead.

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

- [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [x] added `!` to the type prefix if API or client breaking change
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting))
- [x] provided a link to the relevant issue or specification
- [x] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [x] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [x] updated the relevant documentation or specification
- [x] reviewed "Files changed" and left comments if necessary
- [x] 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.*

I have...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed 
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)
alexanderbez pushed a commit that referenced this pull request Jul 5, 2022
roysc pushed a commit to vulcanize/cosmos-sdk that referenced this pull request Jul 16, 2022
…anager.extensions (cosmos#12031)

## Description

`BaseApp` method `SetSnapshot` sets `BaseApp.snapshotManager.extensions` with a nil value, this will cause nil map error whenever `BaseApp.snapshotManager.extensions` is used, so I change it to an empty map instead.

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

- [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [x] added `!` to the type prefix if API or client breaking change
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting))
- [x] provided a link to the relevant issue or specification
- [x] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [x] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [x] updated the relevant documentation or specification
- [x] reviewed "Files changed" and left comments if necessary
- [x] 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.*

I have...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed 
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:automerge Automatically merge PR once all prerequisites pass.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants