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

refactor(x/upgrade)!: use KVStoreService and context.Context #16227

Merged
merged 39 commits into from
Jun 5, 2023

Conversation

facundomedica
Copy link
Member

@facundomedica facundomedica commented May 19, 2023

Description

TO-DO:

  • switch to context.Context in type MigrationHandler func(sdk.Context) error. It touches pretty much all modules, so it's going to be a big PR (doing it in a follow up pr)

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)

@facundomedica facundomedica marked this pull request as ready for review May 19, 2023 15:40
@facundomedica facundomedica requested a review from a team as a code owner May 19, 2023 15:40
@facundomedica facundomedica marked this pull request as draft May 19, 2023 15:48
@facundomedica facundomedica marked this pull request as ready for review May 20, 2023 07:09
x/upgrade/abci.go Outdated Show resolved Hide resolved
x/upgrade/abci.go Show resolved Hide resolved
x/upgrade/abci.go Outdated Show resolved Hide resolved
x/upgrade/keeper/keeper.go Show resolved Hide resolved
x/upgrade/keeper/keeper.go Show resolved Hide resolved
x/upgrade/keeper/keeper.go Outdated Show resolved Hide resolved
x/upgrade/keeper/keeper.go Outdated Show resolved Hide resolved
x/upgrade/keeper/keeper.go Outdated Show resolved Hide resolved
Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

left a question but overall looks good

Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

lgtm! one nit.

x/upgrade/keeper/keeper_test.go Outdated Show resolved Hide resolved
return nil, err
}
defer it.Close()
Copy link
Member

Choose a reason for hiding this comment

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

if it errors above is this still run?

Copy link
Contributor

Choose a reason for hiding this comment

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

No, it returns the error immediately, skipping the defer statement.

Copy link
Member Author

Choose a reason for hiding this comment

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

Static check complains about it with should check returned error before deferring it.Close() (SA5001). I suppose it makes sense because if it's returning an error then the iterator never got opened

Copy link
Contributor

@likhita-809 likhita-809 May 29, 2023

Choose a reason for hiding this comment

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

that makes sense.
Its completely optional, but in this case maybe we need to handle err returned from it.Close() since there is a possibility of errors coming up while closing like resource availability, connection errors etc.
Maybe something like this:

defer func() {
    if err := it.Close(); err != nil {
        // handle the err/log
    }
}()

Copy link
Member Author

Choose a reason for hiding this comment

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

We've been ignoring these errors all over the SDK, would like to fix them in a follow up PR instead of adding that to this one

prefix := []byte{types.VersionMapByte}
it, err := store.Iterator(prefix, storetypes.PrefixEndBytes(prefix))
if err != nil {
return nil, err
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we need to close the iterator before returning the error

Suggested change
return nil, err
_ = it.Close()
return nil, err

prefix := []byte{types.VersionMapByte}
it, err := store.Iterator(prefix, storetypes.PrefixEndBytes(prefix))
if err != nil {
return nil, err
Copy link
Contributor

Choose a reason for hiding this comment

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

ditto

return nil, err
}
defer it.Close()
Copy link
Contributor

Choose a reason for hiding this comment

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

No, it returns the error immediately, skipping the defer statement.

prefix := []byte{types.VersionMapByte}
it, err := store.Iterator(prefix, storetypes.PrefixEndBytes(prefix))
if err != nil {
return 0, err
Copy link
Contributor

Choose a reason for hiding this comment

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

ditto

x/upgrade/keeper/keeper.go Show resolved Hide resolved
prefix := []byte{types.DoneByte}
it, err := store.Iterator(prefix, storetypes.PrefixEndBytes(prefix))
if err != nil {
return 0, err
Copy link
Contributor

Choose a reason for hiding this comment

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

ditto

@facundomedica facundomedica added this pull request to the merge queue Jun 5, 2023
Merged via the queue into main with commit bbab968 Jun 5, 2023
@facundomedica facundomedica deleted the facu/upgrade-kvstoresvc branch June 5, 2023 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants