fix: Panic if SetOrder* functions forgot modules (backport cosmos#10711…

…) (cosmos#10762)

* fix: Panic if SetOrder* functions forgot modules (cosmos#10711)

<!--
The default pull request template is for types feat, fix, or refactor.
For other templates, add one of the following parameters to the url:
- template=docs.md
- template=other.md
-->

## Description

fixes: cosmos#10708

Panic at startup if chain devs forgot to add some modules in SetOrder* functions.

<!-- Add a description of the changes that this PR introduces and the files that
are the most critical to review. -->

---

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

(cherry picked from commit d3a8e1e)

# Conflicts:
#	CHANGELOG.md
#	simapp/app.go

* fix conflicss

* Fix build

Co-authored-by: Amaury <[email protected]>

CHANGELOG.md

@@ -55,6 +55,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
   to reduce the RAM usage, CPU time usage, and garbage collection pressure from clearing maps,
   instead of allocating new maps.
 * (store) [\#10741](https://github.com/cosmos/cosmos-sdk/pull/10741) Significantly speedup iterator creation after delete heavy workloads. Significantly improves IBC migration times.
+* (module) [\#10711](https://github.com/cosmos/cosmos-sdk/pull/10711) Panic at startup if the app developer forgot to add modules in the `SetOrder{BeginBlocker, EndBlocker, InitGenesis, ExportGenesis}` functions. This means that all modules, even those who have empty implementations for those methods, need to be added to `SetOrder*`.
 * (types) [\#10076](https://github.com/cosmos/cosmos-sdk/pull/10076) Significantly speedup and lower allocations for `Coins.String()`.
 
 ### Bug Fixes

simapp/app.go

@@ -52,17 +52,16 @@ import (
 	txmodule "github.com/cosmos/cosmos-sdk/x/auth/tx/config"
 	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
 	"github.com/cosmos/cosmos-sdk/x/auth/vesting"
-	vesttypes "github.com/cosmos/cosmos-sdk/x/auth/vesting/types"
+	vestingtypes "github.com/cosmos/cosmos-sdk/x/auth/vesting/types"
+	"github.com/cosmos/cosmos-sdk/x/authz"
+	authzkeeper "github.com/cosmos/cosmos-sdk/x/authz/keeper"
+	authzmodule "github.com/cosmos/cosmos-sdk/x/authz/module"
 	"github.com/cosmos/cosmos-sdk/x/bank"
 	bankkeeper "github.com/cosmos/cosmos-sdk/x/bank/keeper"
 	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
 	"github.com/cosmos/cosmos-sdk/x/capability"
 	capabilitykeeper "github.com/cosmos/cosmos-sdk/x/capability/keeper"
 	capabilitytypes "github.com/cosmos/cosmos-sdk/x/capability/types"
-
-	"github.com/cosmos/cosmos-sdk/x/authz"
-	authzkeeper "github.com/cosmos/cosmos-sdk/x/authz/keeper"
-	authzmodule "github.com/cosmos/cosmos-sdk/x/authz/module"
 	"github.com/cosmos/cosmos-sdk/x/crisis"
 	crisiskeeper "github.com/cosmos/cosmos-sdk/x/crisis/keeper"
 	crisistypes "github.com/cosmos/cosmos-sdk/x/crisis/types"
@@ -466,6 +465,17 @@ func NewSimApp(
 	app.mm.SetOrderBeginBlockers(
 		upgradetypes.ModuleName, capabilitytypes.ModuleName, minttypes.ModuleName, distrtypes.ModuleName, slashingtypes.ModuleName,
 		evidencetypes.ModuleName, stakingtypes.ModuleName,
+		authtypes.ModuleName, banktypes.ModuleName, govtypes.ModuleName, crisistypes.ModuleName, genutiltypes.ModuleName,
+		authz.ModuleName, feegrant.ModuleName,
+		paramstypes.ModuleName, vestingtypes.ModuleName,
+	)
+	app.mm.SetOrderEndBlockers(
+		crisistypes.ModuleName, govtypes.ModuleName, stakingtypes.ModuleName,
+		capabilitytypes.ModuleName, authtypes.ModuleName, banktypes.ModuleName, distrtypes.ModuleName,
+		slashingtypes.ModuleName, minttypes.ModuleName,
+		genutiltypes.ModuleName, evidencetypes.ModuleName, authz.ModuleName,
+		feegrant.ModuleName,
+		paramstypes.ModuleName, upgradetypes.ModuleName, vestingtypes.ModuleName,
 	)
 
 	// NOTE: The genutils module must occur after staking so that pools are
@@ -485,19 +495,8 @@ func NewSimApp(
 		evidencetypes.ModuleName,
 		authz.ModuleName,
 		feegrant.ModuleName,
-		nft.ModuleName,
-		group.ModuleName,
-		upgradetypes.ModuleName,
-		vestingtypes.ModuleName,
-		circuittypes.ModuleName,
-		pooltypes.ModuleName,
-		epochstypes.ModuleName,
-	}
-	app.ModuleManager.SetOrderInitGenesis(genesisModuleOrder...)
-	app.ModuleManager.SetOrderExportGenesis(genesisModuleOrder...)
-
-	// Uncomment if you want to set a custom migration order here.
-	// app.ModuleManager.SetOrderMigrations(custom order)
+		paramstypes.ModuleName, upgradetypes.ModuleName, vestingtypes.ModuleName,
+	)
 
 	app.configurator = module.NewConfigurator(app.appCodec, app.MsgServiceRouter(), app.GRPCQueryRouter())
 	err = app.ModuleManager.RegisterServices(app.configurator)

types/module/module.go

@@ -22,6 +22,7 @@ package module
 import (
 	"context"
 	"encoding/json"
+	"fmt"
 	"sort"
 
 	abci "github.com/cometbft/cometbft/api/cometbft/abci/v1"
@@ -332,56 +333,28 @@ func (m *Manager) DefaultGenesis() map[string]json.RawMessage {
 	return genesisData
 }
 
-// ValidateGenesis performs genesis state validation for all modules
-func (m *Manager) ValidateGenesis(genesisData map[string]json.RawMessage) error {
-	for name, b := range m.Modules {
-		if mod, ok := b.(HasGenesisBasics); ok {
-			if err := mod.ValidateGenesis(genesisData[name]); err != nil {
-				return err
-			}
-		} else if mod, ok := b.(appmodule.HasGenesis); ok {
-			if err := mod.ValidateGenesis(genesisData[name]); err != nil {
-				return err
-			}
-		}
-	}
-
-	return nil
+// SetOrderInitGenesis sets the order of init genesis calls
+func (m *Manager) SetOrderInitGenesis(moduleNames ...string) {
+	m.checkForgottenModules("SetOrderInitGenesis", moduleNames)
+	m.OrderInitGenesis = moduleNames
 }
 
-// RegisterGRPCGatewayRoutes registers all module rest routes
-func (m *Manager) RegisterGRPCGatewayRoutes(clientCtx client.Context, rtr *runtime.ServeMux) {
-	for _, b := range m.Modules {
-		if mod, ok := b.(HasGRPCGateway); ok {
-			mod.RegisterGRPCGatewayRoutes(clientCtx, rtr)
-		}
-	}
+// SetOrderExportGenesis sets the order of export genesis calls
+func (m *Manager) SetOrderExportGenesis(moduleNames ...string) {
+	m.checkForgottenModules("SetOrderExportGenesis", moduleNames)
+	m.OrderExportGenesis = moduleNames
 }
 
-// AddTxCommands adds all tx commands to the rootTxCmd.
-func (m *Manager) AddTxCommands(rootTxCmd *cobra.Command) {
-	for _, b := range m.Modules {
-		if mod, ok := b.(interface {
-			GetTxCmd() *cobra.Command
-		}); ok {
-			if cmd := mod.GetTxCmd(); cmd != nil {
-				rootTxCmd.AddCommand(cmd)
-			}
-		}
-	}
+// SetOrderBeginBlockers sets the order of set begin-blocker calls
+func (m *Manager) SetOrderBeginBlockers(moduleNames ...string) {
+	m.checkForgottenModules("SetOrderBeginBlockers", moduleNames)
+	m.OrderBeginBlockers = moduleNames
 }
 
-// AddQueryCommands adds all query commands to the rootQueryCmd.
-func (m *Manager) AddQueryCommands(rootQueryCmd *cobra.Command) {
-	for _, b := range m.Modules {
-		if mod, ok := b.(interface {
-			GetQueryCmd() *cobra.Command
-		}); ok {
-			if cmd := mod.GetQueryCmd(); cmd != nil {
-				rootQueryCmd.AddCommand(cmd)
-			}
-		}
-	}
+// SetOrderEndBlockers sets the order of set end-blocker calls
+func (m *Manager) SetOrderEndBlockers(moduleNames ...string) {
+	m.checkForgottenModules("SetOrderEndBlockers", moduleNames)
+	m.OrderEndBlockers = moduleNames
 }
 
 // RegisterInvariants registers all module invariants
@@ -569,30 +542,21 @@ func (m *Manager) ExportGenesisForModules(ctx sdk.Context, modulesToExport []str
 	return genesisData, nil
 }
 
-// checkModulesExists verifies that all modules in the list exist in the app
-func (m *Manager) checkModulesExists(moduleName []string) error {
-	for _, name := range moduleName {
-		if _, ok := m.Modules[name]; !ok {
-			return fmt.Errorf("module %s does not exist", name)
-		}
+// checkForgottenModules checks that we didn't forget any modules in the
+// SetOrder* functions.
+func (m *Manager) checkForgottenModules(setOrderFnName string, moduleNames []string) {
+	setOrderMap := map[string]struct{}{}
+	for _, m := range moduleNames {
+		setOrderMap[m] = struct{}{}
 	}
 
-	return nil
+	if len(setOrderMap) != len(m.Modules) {
+		panic(fmt.Sprintf("got %d modules in the module manager, but %d modules in %s", len(m.Modules), len(setOrderMap), setOrderFnName))
+	}
 }
 
-// assertNoForgottenModules checks that we didn't forget any modules in the SetOrder* functions.
-// `pass` is a closure which allows one to omit modules from `moduleNames`.
-// If you provide non-nil `pass` and it returns true, the module would not be subject of the assertion.
-func (m *Manager) assertNoForgottenModules(setOrderFnName string, moduleNames []string, pass func(moduleName string) bool) {
-	ms := make(map[string]bool)
-	for _, m := range moduleNames {
-		ms[m] = true
-	}
-	var missing []string
-	for m := range m.Modules {
-		if pass != nil && pass(m) {
-			continue
-		}
+// MigrationHandler is the migration function that each module registers.
+type MigrationHandler func(sdk.Context) error
 
 		if !ms[m] {
 			missing = append(missing, m)