refactor!: migrate to core appmodule.AppModule extension interfaces by aaronc · Pull Request #13794 · cosmos/cosmos-sdk

aaronc · 2022-11-08T15:44:18Z

Description

This migrates all modules and the module manager to use the cosmossdk.io/core/appmodule.AppModule interface. It does this in a mostly backwards compatible way. The main breaking change that is required for modules is to implement the tag methods in appmodule.AppModule:

// IsOnePerModuleType implements the depinject.OnePerModuleType interface.
func (am AppModule) IsOnePerModuleType() {}

// IsAppModule implements the appmodule.AppModule interface.
func (am AppModule) IsAppModule() {}

module.AppModule and module.NewManager have been deprecated in favor of appmodule.AppModule and module.NewManagerFromMap.

This refactoring changes the way runtime consumes modules using depinject and now modules should provide
appmodule.AppModule. runtime.AppModuleWrapper and runtime.AppModuleBasicWrapper have been deleted.

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

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)

tac0turtle

Left two comments. Wondering why we need to rename interfaces to legacy?

tac0turtle · 2022-11-08T20:18:43Z


-	// RegisterServices allows a module to register services
+// LegacyRegisterServices is the legacy method for modules to register services.
+type LegacyRegisterServices interface {


This is legacy because of the new core api?

Yes. I have the idea to push the new core API version relatively quickly after this. Or we could do the rename to legacy once the core API version is ready. Don't have a strong preference just thought this was clearer.

the import will change to use the new api, correct?

Well with extension interfaces imports are actually optional, but yes it might

aaronc · 2022-11-11T19:17:34Z

I've addressed a bunch of review comments and in particular got rid of AppModuleBasicWrapper. So now modules just need to return an instance of appmodule.AppModule in their Provide function, no wrappers, no module basics. Let me know what you think @AmauryM @julienrbrt @tac0turtle

+	for name, mod := range inputs.Modules {
+		if basicMod, ok := mod.(module.AppModuleBasic); ok {
+			app.basicManager[name] = basicMod
+			basicMod.RegisterInterfaces(inputs.InterfaceRegistry)
+			basicMod.RegisterLegacyAminoCodec(inputs.LegacyAmino)
+		}
+	}


julienrbrt

The docs lgtm. We backport that to 0.47 right?

amaury1093

LGTM

amaury1093 · 2022-11-14T14:06:53Z

 	AppConfig      *appv1alpha1.Config
 	Config         *runtimev1alpha1.Module
 	AppBuilder     *AppBuilder
-	Modules        map[string]AppModuleWrapper


Yes, I think that's a good idea. Totally fine to do in a follow-up too, as this already has approvals. It's not breaking anyways, right?

aaronc · 2022-11-14T15:12:33Z

The docs lgtm. We backport that to 0.47 right?

Yes

aaronc · 2022-11-14T15:36:05Z

Should we be indicating somehow on the extension interfaces (HasServices, HasGenesis, etc.) that these are unstable and that users should expect the core API to change these?

aaronc · 2022-11-14T15:49:53Z

Also, most of the mock tests for modules no longer work because we are using extension interfaces which the mock app module doesn't have defined. Any thoughts on what to do? I can either:

delete the tests
create a mock app module which has all the extension interfaces defined

aaronc · 2022-11-14T19:37:46Z

Also, most of the mock tests for modules no longer work because we are using extension interfaces which the mock app module doesn't have defined. Any thoughts on what to do? I can either:

delete the tests

create a mock app module which has all the extension interfaces defined

I ended up taking the second approach and created a type AppModuleWithAppExtensions that is just used in tests (not exported in the public API). This feels better than deleting tests.

codecov · 2022-11-14T19:50:28Z

Codecov Report

Merging #13794 (286bd03) into main (14c582f) will decrease coverage by 0.42%.
The diff coverage is 12.93%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #13794      +/-   ##
==========================================
- Coverage   56.87%   56.44%   -0.43%     
==========================================
  Files         646      648       +2     
  Lines       55145    56221    +1076     
==========================================
+ Hits        31364    31735     +371     
- Misses      21226    21924     +698     
- Partials     2555     2562       +7

Impacted Files	Coverage Δ
testutil/mock/types_mock_appmodule.go	`0.00% <0.00%> (ø)`
testutil/mock/types_module_module.go	`0.00% <0.00%> (ø)`
types/module/simulation.go	`0.00% <0.00%> (ø)`
x/params/module.go	`21.05% <0.00%> (-1.37%)`	⬇️
x/genutil/module.go	`18.18% <16.66%> (ø)`
x/auth/vesting/module.go	`10.25% <25.00%> (ø)`
x/authz/module/module.go	`14.66% <25.00%> (-3.29%)`	⬇️
x/upgrade/module.go	`28.78% <25.00%> (ø)`
x/feegrant/module/module.go	`13.15% <33.33%> (-2.23%)`	⬇️
types/module/module.go	`63.21% <36.84%> (-3.04%)`	⬇️
... and 38 more

+
+// BeginBlock mocks base method.
+func (m *MockAppModuleWithAllExtensions) BeginBlock(arg0 types0.Context, arg1 types1.RequestBeginBlock) {
+	m.ctrl.T.Helper()


+// BeginBlock mocks base method.
+func (m *MockAppModuleWithAllExtensions) BeginBlock(arg0 types0.Context, arg1 types1.RequestBeginBlock) {
+	m.ctrl.T.Helper()
+	m.ctrl.Call(m, "BeginBlock", arg0, arg1)


+
+// BeginBlock indicates an expected call of BeginBlock.
+func (mr *MockAppModuleWithAllExtensionsMockRecorder) BeginBlock(arg0, arg1 interface{}) *gomock.Call {
+	mr.mock.ctrl.T.Helper()


+// BeginBlock indicates an expected call of BeginBlock.
+func (mr *MockAppModuleWithAllExtensionsMockRecorder) BeginBlock(arg0, arg1 interface{}) *gomock.Call {
+	mr.mock.ctrl.T.Helper()
+	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "BeginBlock", reflect.TypeOf((*MockAppModuleWithAllExtensions)(nil).BeginBlock), arg0, arg1)


+// BeginBlock indicates an expected call of BeginBlock.
+func (mr *MockAppModuleWithAllExtensionsMockRecorder) BeginBlock(arg0, arg1 interface{}) *gomock.Call {
+	mr.mock.ctrl.T.Helper()
+	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "BeginBlock", reflect.TypeOf((*MockAppModuleWithAllExtensions)(nil).BeginBlock), arg0, arg1)


+
+// EndBlock mocks base method.
+func (m *MockAppModuleWithAllExtensions) EndBlock(arg0 types0.Context, arg1 types1.RequestEndBlock) []types1.ValidatorUpdate {
+	m.ctrl.T.Helper()


+// EndBlock mocks base method.
+func (m *MockAppModuleWithAllExtensions) EndBlock(arg0 types0.Context, arg1 types1.RequestEndBlock) []types1.ValidatorUpdate {
+	m.ctrl.T.Helper()
+	ret := m.ctrl.Call(m, "EndBlock", arg0, arg1)


+
+// EndBlock indicates an expected call of EndBlock.
+func (mr *MockAppModuleWithAllExtensionsMockRecorder) EndBlock(arg0, arg1 interface{}) *gomock.Call {
+	mr.mock.ctrl.T.Helper()


+// EndBlock indicates an expected call of EndBlock.
+func (mr *MockAppModuleWithAllExtensionsMockRecorder) EndBlock(arg0, arg1 interface{}) *gomock.Call {
+	mr.mock.ctrl.T.Helper()
+	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "EndBlock", reflect.TypeOf((*MockAppModuleWithAllExtensions)(nil).EndBlock), arg0, arg1)


+// EndBlock indicates an expected call of EndBlock.
+func (mr *MockAppModuleWithAllExtensionsMockRecorder) EndBlock(arg0, arg1 interface{}) *gomock.Call {
+	mr.mock.ctrl.T.Helper()
+	return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "EndBlock", reflect.TypeOf((*MockAppModuleWithAllExtensions)(nil).EndBlock), arg0, arg1)


…aaronc/appmodule-refactor

…13794) (cherry picked from commit ec27c53)

…13794) (#13866) (cherry picked from commit ec27c53) Co-authored-by: Aaron Craelius <aaron@regen.network>

…osmos#13794)

refactor!: migrate to core appmodule.AppModule extension interfaces

60ec34a

github-actions Bot added C:x/auth C:x/authz C:x/bank C:x/capability C:x/distribution distribution module related C:x/evidence C:x/feegrant C:x/genutil genutil module issues C:x/gov C:x/group C:x/mint C:x/params C:x/slashing C:x/staking C:x/upgrade labels Nov 8, 2022

fix build errors

1ceb653

github-advanced-security AI found potential problems Nov 8, 2022

View reviewed changes

Comment thread types/module/module.go Fixed

aaronc added 4 commits November 8, 2022 13:46

docs

251500d

test fixes

f05222a

CHANGELOG.md, UPGRADING.md

62bfd3e

docs

5344498

aaronc marked this pull request as ready for review November 8, 2022 19:26

aaronc requested a review from a team November 8, 2022 19:26

Merge branch 'main' into aaronc/appmodule-refactor

99b87dd

tac0turtle reviewed Nov 8, 2022

View reviewed changes

amaury1093 reviewed Nov 9, 2022

View reviewed changes

Comment thread UPGRADING.md Outdated

WIP

05c662e

aaronc and others added 3 commits November 11, 2022 14:04

address review comments

04450d5

remove ModuleBasicWrapper

408c659

Merge branch 'main' into aaronc/appmodule-refactor

a861170

github-advanced-security AI found potential problems Nov 11, 2022

View reviewed changes

julienrbrt approved these changes Nov 14, 2022

View reviewed changes

amaury1093 approved these changes Nov 14, 2022

View reviewed changes

Merge branch 'main' into aaronc/appmodule-refactor

8650ee9

aaronc added the backport/v0.47.x label Nov 14, 2022

aaronc enabled auto-merge (squash) November 14, 2022 15:13

fix test failures

7a99acb

fix mock tests

2138652

github-actions Bot added the Type: Build label Nov 14, 2022

Merge branch 'main' into aaronc/appmodule-refactor

b1ed6ef

github-advanced-security AI found potential problems Nov 14, 2022

View reviewed changes

aaronc added 2 commits November 14, 2022 16:03

fix tests

893d37d

Merge remote-tracking branch 'origin/aaronc/appmodule-refactor' into …

286bd03

…aaronc/appmodule-refactor

aaronc merged commit ec27c53 into main Nov 14, 2022

aaronc deleted the aaronc/appmodule-refactor branch November 14, 2022 21:23

mergify Bot pushed a commit that referenced this pull request Nov 14, 2022

refactor!: migrate to core appmodule.AppModule extension interfaces (#…

782533c

…13794) (cherry picked from commit ec27c53)

mergify Bot mentioned this pull request Nov 14, 2022

refactor!: migrate to core appmodule.AppModule extension interfaces (backport #13794) #13866

Merged

tac0turtle pushed a commit that referenced this pull request Nov 15, 2022

refactor!: migrate to core appmodule.AppModule extension interfaces (#…

3f2266a

…13794) (#13866) (cherry picked from commit ec27c53) Co-authored-by: Aaron Craelius <aaron@regen.network>

aaronc mentioned this pull request Dec 15, 2022

refactor!: remove HasGenesisBasics from AppModuleBasic interfaces #14333

Merged

19 tasks

larry0x pushed a commit to larry0x/cosmos-sdk that referenced this pull request May 22, 2023

refactor!: migrate to core appmodule.AppModule extension interfaces (c…

f6cb3f8

…osmos#13794)

0xstepit mentioned this pull request Jul 1, 2024

chore(cachemulti): add Copy method evmos/cosmos-sdk#52

Merged

Conversation

aaronc commented Nov 8, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Author Checklist

Reviewers Checklist

Uh oh!

Uh oh!

tac0turtle left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tac0turtle Nov 8, 2022

Choose a reason for hiding this comment

Uh oh!

aaronc Nov 8, 2022

Choose a reason for hiding this comment

Uh oh!

tac0turtle Nov 9, 2022

Choose a reason for hiding this comment

Uh oh!

aaronc Nov 9, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

aaronc commented Nov 11, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Check warning

julienrbrt left a comment

Choose a reason for hiding this comment

Uh oh!

amaury1093 left a comment

Choose a reason for hiding this comment

Uh oh!

amaury1093 Nov 14, 2022

Choose a reason for hiding this comment

Uh oh!

aaronc commented Nov 14, 2022

Uh oh!

aaronc commented Nov 14, 2022

Uh oh!

aaronc commented Nov 14, 2022

Uh oh!

aaronc commented Nov 14, 2022

Uh oh!

codecov Bot commented Nov 14, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Check warning

Check warning

Check warning

Check warning

Check warning

Check warning

Check warning

Check warning

Check warning

Check warning

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

aaronc commented Nov 8, 2022 •

edited

Loading

aaronc commented Nov 11, 2022 •

edited

Loading

codecov Bot commented Nov 14, 2022 •

edited

Loading