Migrate AppStateController to BaseController v2

[mcmire]

What is this about?

Following the Wallet Framework team's OKRs for Q3 2024, we want to bring AppStateController up to date with our latest controller patterns.

Scenario

No response

Design

No response

Technical Details

No response

Threat Modeling Framework

No response

Acceptance Criteria

• A constant called controllerName exists which holds the name of the controller.
• A constant called controllerMetadata exists which holds the metadata for the state.
• The default state object is extracted to a function called getDefaultAppStateControllerState.
• AppStateController inherits from BaseController instead of EventEmitter.
  • The AppStateController constructor signature is updated to take a partial state option instead of initState.
  • The constructor no longer takes a preferencesStore option; instead, it subscribes to PreferencesController:stateChange.
  • The AppStateController constructor is updated to super to the superclass.
  • AppStateController uses this.messagingSystem to refer to the messenger.
  • this.state is used to access state instead of this.store.getState.
  • this.update is used to update state instead of this.store.updateState.
  • AppStateController uses the messenger to emit the updateBadge event instead of the EventEmitter.
• Supporting types exist.
  • The AppStateControllerState type exists and represents the current shape of the state object.
  • The AppStateControllerGetStateAction and AppStateControllerStateChangeEvent types exist.
  • A type for the AppStateController:badgeUpdated event exists.
  • The AppStateControllerActions and AppStateControllerEvents types exist.
  • The AllowedActions and AllowedEvents types exist.
  • The AppStateControllerMessenger type exists and expects KeyringController:qrKeyringStateChange, ApprovalController:addRequest, and ApprovalController:acceptRequest to be allowed.
  • AppStateControllerState exists and represents the current shape of the state object.
• The tests are updated to follow suit.
  • The tests no longer pre-create an appStateController in a beforeEach.
  • Instead of passing a mock version of the messenger, the tests passes a real messenger to the AppStateController instance and use it for verification.
  • The tests verify changes in state for real (they do not merely test that updateState gets called).

Stakeholder review needed before the work gets merged

• Engineering (needed in most cases)
• Design
• Product
• QA (automation tests are required to pass before merging PRs but not all changes are covered by automation tests - please review if QA is needed beyond automation tests)
• Security
• Legal
• Marketing
• Management (please specify)
• Other (please specify)

References

• Ensure that all controllers used across clients are using BaseControllerV2 core#1509