[base-controller] Controller constructors accept messengers with incomplete allowlists

[MajorLift]

Problem

BaseControllerV2 and its subclass controllers currently accept messengers as constructor options even if they are defined with incomplete or empty action/event allowlists.

Type errors are raised when the omitted actions/events are invoked. Runtime errors are also thrown when the call, subscribe, unsubscribe methods are invoked (or any method that uses the #isAllowedAction, #isAllowedEvent methods). However, these errors are produced by the messenger, not the controller.

Controller constructors do correctly raise type errors for messengers that allow actions or events that are not included in the controller's allowlists.

Repro

/**
 * Controller accepts messenger with "empty" allowlists
 */

const emptyAllowlistControllerMessenger =
 new ControllerMessenger<never, never>() // ControllerMessenger can be defined with any superset of the RestrictedControllerMessenger's empty allowlists
const emptyAllowlistMessenger = emptyAllowlistControllerMessenger.getRestricted({
 name: '',
 allowedActions: [],
 allowedEvents: [],
 })

const preferencesController = new PreferencesController({
 messenger: emptyAllowlistMessenger, // No type or runtime error!
})

/**
 * Controller accepts messenger with "incomplete" allowlists
 */

type TokenRatesControllerAllowedActions =
 | PreferencesControllerGetStateAction
 | NetworkControllerGetStateAction
 | NetworkControllerGetNetworkClientByIdAction
 | TokensControllerGetStateAction
type TokenRatesControllerAllowedEvents =
 | TokensControllerStateChangeEvent
 | PreferencesControllerStateChangeEvent
 | NetworkControllerStateChangeEvent

const incompleteAllowlistControllerMessenger = new ControllerMessenger<
 Exclude<TokenRatesControllerAllowedActions, NetworkControllerGetNetworkClientByIdAction>,
 Exclude<TokenRatesControllerAllowedEvents, NetworkControllerGetStateAction>
>() // ControllerMessenger can be defined with any superset of the RestrictedControllerMessenger's incomplete allowlists
const incompleteAllowlistMessenger = incompleteAllowlistControllerMessenger.getRestricted({
 name: 'TokenRatesController',
 allowedActions: [
 // 'NetworkController:getNetworkClientById',
 'NetworkController:getState',
 'PreferencesController:getState',
 'TokensController:getState',
 ],
 allowedEvents: [
 // 'NetworkController:stateChange',
 'PreferencesController:stateChange',
 'TokensController:stateChange',
 ],
 })

const incompleteTokenRatesController = new TokenRatesController({
 messenger: incompleteAllowlistMessenger, // No type or runtime error!
 tokenPricesService: buildMockTokenPricesService(),
})

Playground link

Acceptance Criteria

Controllers inheriting from BaseControllerV2 must raise a type and/or runtime error if they are initialized with a messenger that does not explicitly allow ALL of the actions or events in the controller's allowlists.

References

• Related: [composable-controller] Implement type validation of constructor options #4213 Requirements no. 2