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

Add implementations for OnChanUpgradeOpen and OnChanUpgradeRestore for controller. #5467

Merged

Conversation

DimitrisJim
Copy link
Contributor

@DimitrisJim DimitrisJim commented Dec 19, 2023

Description

note: all panic in callbacks should be unreachable.

closes: #5457

Commit Message / Changelog Entry

fix: add implementations that forward call to callback if app is set

see the guidelines for commit messages. (view raw markdown for examples)


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against the correct branch (see CONTRIBUTING.md).
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards and Go style guide.
  • Wrote unit and integration tests.
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/).
  • Added relevant godoc comments.
  • Provide a commit message to be used for the changelog entry in the PR description for review.
  • Re-reviewed Files changed in the Github PR explorer.
  • Review Codecov Report in the comment section below once CI passes.

@DimitrisJim DimitrisJim added channel-upgradability Channel upgradability feature audit Feedback from implementation audit labels Dec 19, 2023
Copy link
Member

@damiannolan damiannolan left a comment

Choose a reason for hiding this comment

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

Awesome, thank you @DimitrisJim! 🚀

Comment on lines 970 to 973
testCases := []struct {
name string
malleate func()
expError error
Copy link
Member

Choose a reason for hiding this comment

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

Suppose there will never an expError because the func can only panic in one case.

It should be possible to set some mock app or middleware as the app which doesn't implement the interface. Maybe could reuse something from #5406 with expPanics, where instead of using nil we use a mock that doesn't implement the interface:

if expPanics {
    cbs = controller.NewIBCMiddleware(ibcmock.NewBlockUpgradeMiddleware(), suite.chainA.GetSimApp().ICAControllerKeeper)
}

Happy to do it in a follow up if we go with the mock upgrade middleware

Copy link
Contributor Author

@DimitrisJim DimitrisJim Dec 20, 2023

Choose a reason for hiding this comment

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

Happy to do it in a follow up if we go with the mock upgrade middleware

Sounds perfect to me, I'll open a quick issue for it. (I'll clean up expError for now)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor

@chatton chatton left a comment

Choose a reason for hiding this comment

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

LGTM thanks @DimitrisJim

@DimitrisJim DimitrisJim merged commit 21a2cbf into 04-channel-upgrades Dec 20, 2023
55 of 56 checks passed
@DimitrisJim DimitrisJim deleted the jim/5457-impl-missing-callbacks-for-controller branch December 20, 2023 12:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
audit Feedback from implementation audit channel-upgradability Channel upgradability feature priority PRs that need prompt reviews
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants