feat!: Expose Accounts-owned controller/service methods through messenger

eslint-suppressions.json

@@ -1415,7 +1415,7 @@
   },
   "packages/profile-sync-controller/src/controllers/user-storage/UserStorageController.ts": {
     "@typescript-eslint/explicit-function-return-type": {
-      "count": 13
+      "count": 12
     },
     "id-length": {
       "count": 1

packages/account-tree-controller/CHANGELOG.md

@@ -9,6 +9,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- Refactor the controller's messenger action registration ([#7976](https://github.com/MetaMask/core/pull/7976/))
+  - The controller's methods are now exposed to the messenger through `registerMethodActionHandlers` and `MESSENGER_EXPOSED_METHODS`.
+  - The action types are now generated using `generate-method-action-types`.
+  - Exposes the missing public methods in the messenger.
+- Update `UserStorageController` and `AuthenticationController` actions to their new names ([#7976](https://github.com/MetaMask/core/pull/7976))
 - Bump `@metamask/accounts-controller` from `^36.0.0` to `^36.0.1` ([#7996](https://github.com/MetaMask/core/pull/7996))
 
 ## [4.1.1]

packages/account-tree-controller/package.json

@@ -40,6 +40,7 @@
     "build:docs": "typedoc",
     "changelog:update": "../../scripts/update-changelog.sh @metamask/account-tree-controller",
     "changelog:validate": "../../scripts/validate-changelog.sh @metamask/account-tree-controller",
+    "generate-method-action-types": "tsx ../../scripts/generate-method-action-types.ts",
     "publish:preview": "yarn npm publish --tag preview",
     "since-latest-release": "../../scripts/since-latest-release.sh",
     "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter",
@@ -72,6 +73,7 @@
     "deepmerge": "^4.2.2",
     "jest": "^29.7.0",
     "ts-jest": "^29.2.5",
+    "tsx": "^4.20.5",
     "typedoc": "^0.25.13",
     "typedoc-plugin-missing-exports": "^2.0.0",
     "typescript": "~5.3.3",

packages/account-tree-controller/src/AccountTreeController-method-action-types.ts

@@ -0,0 +1,196 @@
+/**
+ * This file is auto generated by `scripts/generate-method-action-types.ts`.
+ * Do not edit manually.
+ */
+
+import type { AccountTreeController } from './AccountTreeController';
+
+/**
+ * Gets the account wallet object from its ID.
+ *
+ * @param walletId - Account wallet ID.
+ * @returns The account wallet object if found, undefined otherwise.
+ */
+export type AccountTreeControllerGetAccountWalletObjectAction = {
+  type: `AccountTreeController:getAccountWalletObject`;
+  handler: AccountTreeController['getAccountWalletObject'];
+};
+
+/**
+ * Gets all account wallet objects.
+ *
+ * @returns All account wallet objects.
+ */
+export type AccountTreeControllerGetAccountWalletObjectsAction = {
+  type: `AccountTreeController:getAccountWalletObjects`;
+  handler: AccountTreeController['getAccountWalletObjects'];
+};
+
+/**
+ * Gets all underlying accounts from the currently selected account
+ * group.
+ *
+ * It also support account selector, which allows to filter specific
+ * accounts given some criterias (account type, address, scopes, etc...).
+ *
+ * @param selector - Optional account selector.
+ * @returns Underlying accounts for the currently selected account (filtered
+ * by the selector if provided).
+ */
+export type AccountTreeControllerGetAccountsFromSelectedAccountGroupAction = {
+  type: `AccountTreeController:getAccountsFromSelectedAccountGroup`;
+  handler: AccountTreeController['getAccountsFromSelectedAccountGroup'];
+};
+
+/**
+ * Gets the account group object from its ID.
+ *
+ * @param groupId - Account group ID.
+ * @returns The account group object if found, undefined otherwise.
+ */
+export type AccountTreeControllerGetAccountGroupObjectAction = {
+  type: `AccountTreeController:getAccountGroupObject`;
+  handler: AccountTreeController['getAccountGroupObject'];
+};
+
+/**
+ * Gets the account's context which contains its wallet ID, group ID, and sort order.
+ *
+ * @param accountId - Account ID.
+ * @returns The account context if found, undefined otherwise.
+ */
+export type AccountTreeControllerGetAccountContextAction = {
+  type: `AccountTreeController:getAccountContext`;
+  handler: AccountTreeController['getAccountContext'];
+};
+
+/**
+ * Gets the currently selected account group ID.
+ *
+ * @returns The selected account group ID or empty string if none selected.
+ */
+export type AccountTreeControllerGetSelectedAccountGroupAction = {
+  type: `AccountTreeController:getSelectedAccountGroup`;
+  handler: AccountTreeController['getSelectedAccountGroup'];
+};
+
+/**
+ * Sets the selected account group and updates the AccountsController selectedAccount accordingly.
+ *
+ * @param groupId - The account group ID to select.
+ */
+export type AccountTreeControllerSetSelectedAccountGroupAction = {
+  type: `AccountTreeController:setSelectedAccountGroup`;
+  handler: AccountTreeController['setSelectedAccountGroup'];
+};
+
+/**
+ * Sets a custom name for an account group.
+ *
+ * @param groupId - The account group ID.
+ * @param name - The custom name to set.
+ * @param autoHandleConflict - If true, automatically resolves name conflicts by adding a suffix. If false, throws on conflicts.
+ * @throws If the account group ID is not found in the current tree.
+ * @throws If the account group name already exists and autoHandleConflict is false.
+ */
+export type AccountTreeControllerSetAccountGroupNameAction = {
+  type: `AccountTreeController:setAccountGroupName`;
+  handler: AccountTreeController['setAccountGroupName'];
+};
+
+/**
+ * Sets a custom name for an account wallet.
+ *
+ * @param walletId - The account wallet ID.
+ * @param name - The custom name to set.
+ * @throws If the account wallet ID is not found in the current tree.
+ */
+export type AccountTreeControllerSetAccountWalletNameAction = {
+  type: `AccountTreeController:setAccountWalletName`;
+  handler: AccountTreeController['setAccountWalletName'];
+};
+
+/**
+ * Toggles the pinned state of an account group.
+ *
+ * @param groupId - The account group ID.
+ * @param pinned - Whether the group should be pinned.
+ * @throws If the account group ID is not found in the current tree.
+ */
+export type AccountTreeControllerSetAccountGroupPinnedAction = {
+  type: `AccountTreeController:setAccountGroupPinned`;
+  handler: AccountTreeController['setAccountGroupPinned'];
+};
+
+/**
+ * Toggles the hidden state of an account group.
+ *
+ * @param groupId - The account group ID.
+ * @param hidden - Whether the group should be hidden.
+ * @throws If the account group ID is not found in the current tree.
+ */
+export type AccountTreeControllerSetAccountGroupHiddenAction = {
+  type: `AccountTreeController:setAccountGroupHidden`;
+  handler: AccountTreeController['setAccountGroupHidden'];
+};
+
+/**
+ * Clears the controller state and resets to default values.
+ * Also clears the backup and sync service state.
+ */
+export type AccountTreeControllerClearStateAction = {
+  type: `AccountTreeController:clearState`;
+  handler: AccountTreeController['clearState'];
+};
+
+/**
+ * Bi-directionally syncs the account tree with user storage.
+ * This will perform a full sync, including both pulling updates
+ * from user storage and pushing local changes to user storage.
+ * This also performs legacy account syncing if needed.
+ *
+ * IMPORTANT:
+ * If a full sync is already in progress, it will return the ongoing promise.
+ *
+ * @returns A promise that resolves when the sync is complete.
+ */
+export type AccountTreeControllerSyncWithUserStorageAction = {
+  type: `AccountTreeController:syncWithUserStorage`;
+  handler: AccountTreeController['syncWithUserStorage'];
+};
+
+/**
+ * Bi-directionally syncs the account tree with user storage.
+ * This will ensure at least one full sync is ran, including both pulling updates
+ * from user storage and pushing local changes to user storage.
+ * This also performs legacy account syncing if needed.
+ *
+ * IMPORTANT:
+ * If the first ever full sync is already in progress, it will return the ongoing promise.
+ * If the first ever full sync was previously completed, it will NOT start a new sync, and will resolve immediately.
+ *
+ * @returns A promise that resolves when the first ever full sync is complete.
+ */
+export type AccountTreeControllerSyncWithUserStorageAtLeastOnceAction = {
+  type: `AccountTreeController:syncWithUserStorageAtLeastOnce`;
+  handler: AccountTreeController['syncWithUserStorageAtLeastOnce'];
+};
+
+/**
+ * Union of all AccountTreeController action types.
+ */
+export type AccountTreeControllerMethodActions =
+  | AccountTreeControllerGetAccountWalletObjectAction
+  | AccountTreeControllerGetAccountWalletObjectsAction
+  | AccountTreeControllerGetAccountsFromSelectedAccountGroupAction
+  | AccountTreeControllerGetAccountGroupObjectAction
+  | AccountTreeControllerGetAccountContextAction
+  | AccountTreeControllerGetSelectedAccountGroupAction
+  | AccountTreeControllerSetSelectedAccountGroupAction
+  | AccountTreeControllerSetAccountGroupNameAction
+  | AccountTreeControllerSetAccountWalletNameAction
+  | AccountTreeControllerSetAccountGroupPinnedAction
+  | AccountTreeControllerSetAccountGroupHiddenAction
+  | AccountTreeControllerClearStateAction
+  | AccountTreeControllerSyncWithUserStorageAction
+  | AccountTreeControllerSyncWithUserStorageAtLeastOnceAction;

packages/account-tree-controller/src/AccountTreeController.test.ts

@@ -4575,21 +4575,18 @@ describe('AccountTreeController', () => {
       });
 
       // Test suffix resolution directly using the public method
-      const wallet = controller.state.accountTree.wallets[walletId];
-      const resolvedName = controller.resolveNameConflict(
-        wallet,
-        groupId,
-        'Suffix Test',
-      );
-      expect(resolvedName).toBe('Suffix Test (3)');
+      controller.setAccountGroupName(groupId, 'Suffix Test', true);
 
-      // Test with no conflicts: should return "Unique Name (2)"
-      const uniqueName = controller.resolveNameConflict(
-        wallet,
-        groupId,
-        'Unique Name',
-      );
-      expect(uniqueName).toBe('Unique Name (2)');
+      const collidingGroupObject = controller.getAccountGroupObject(groupId);
+
+      expect(collidingGroupObject?.metadata.name).toBe('Suffix Test (3)');
+
+      // Test with no conflicts: should return "Unique Name"
+      controller.setAccountGroupName(groupId, 'Unique Name', true);
+
+      const uniqueGroupObject = controller.getAccountGroupObject(groupId);
+
+      expect(uniqueGroupObject?.metadata.name).toBe('Unique Name');
     });
 
     it('throws error when group ID not found in tree', () => {

packages/account-tree-controller/src/AccountTreeController.ts

@@ -44,6 +44,23 @@ import type { AccountWalletObject, AccountWalletObjectOf } from './wallet';
 
 export const controllerName = 'AccountTreeController';
 
+const MESSENGER_EXPOSED_METHODS = [
+  'getSelectedAccountGroup',
+  'setSelectedAccountGroup',
+  'getAccountsFromSelectedAccountGroup',
+  'getAccountContext',
+  'setAccountWalletName',
+  'setAccountGroupName',
+  'setAccountGroupPinned',
+  'setAccountGroupHidden',
+  'getAccountWalletObject',
+  'getAccountWalletObjects',
+  'getAccountGroupObject',
+  'clearState',
+  'syncWithUserStorage',
+  'syncWithUserStorageAtLeastOnce',
+] as const;
+
 const accountTreeControllerMetadata: StateMetadata<AccountTreeControllerState> =
   {
     accountTree: {
@@ -246,7 +263,10 @@ export class AccountTreeController extends BaseController<
       },
     );
 
-    this.#registerMessageHandlers();
+    this.messenger.registerMethodActionHandlers(
+      this,
+      MESSENGER_EXPOSED_METHODS,
+    );
   }
 
   /**
@@ -507,7 +527,7 @@ export class AccountTreeController extends BaseController<
       proposedName.length &&
       !isAccountGroupNameUniqueFromWallet(wallet, group.id, proposedName)
     ) {
-      proposedName = this.resolveNameConflict(wallet, group.id, proposedName);
+      proposedName = this.#resolveNameConflict(wallet, group.id, proposedName);
     }
 
     return proposedName;
@@ -1324,7 +1344,7 @@ export class AccountTreeController extends BaseController<
    * @param name - The desired name that has a conflict.
    * @returns A unique name with suffix added if necessary.
    */
-  resolveNameConflict(
+  #resolveNameConflict(
     wallet: AccountWalletObject,
     groupId: AccountGroupId,
     name: string,
@@ -1371,7 +1391,7 @@ export class AccountTreeController extends BaseController<
       autoHandleConflict &&
       !isAccountGroupNameUniqueFromWallet(wallet, groupId, name)
     ) {
-      finalName = this.resolveNameConflict(wallet, groupId, name);
+      finalName = this.#resolveNameConflict(wallet, groupId, name);
     } else {
       // Validate that the name is unique
       this.#assertAccountGroupNameIsUnique(groupId, finalName);
@@ -1538,51 +1558,6 @@ export class AccountTreeController extends BaseController<
     this.#initialized = false;
   }
 
-  /**
-   * Registers message handlers for the AccountTreeController.
-   */
-  #registerMessageHandlers(): void {
-    this.messenger.registerActionHandler(
-      `${controllerName}:getSelectedAccountGroup`,
-      this.getSelectedAccountGroup.bind(this),
-    );
-
-    this.messenger.registerActionHandler(
-      `${controllerName}:setSelectedAccountGroup`,
-      this.setSelectedAccountGroup.bind(this),
-    );
-
-    this.messenger.registerActionHandler(
-      `${controllerName}:getAccountsFromSelectedAccountGroup`,
-      this.getAccountsFromSelectedAccountGroup.bind(this),
-    );
-
-    this.messenger.registerActionHandler(
-      `${controllerName}:getAccountContext`,
-      this.getAccountContext.bind(this),
-    );
-
-    this.messenger.registerActionHandler(
-      `${controllerName}:setAccountWalletName`,
-      this.setAccountWalletName.bind(this),
-    );
-
-    this.messenger.registerActionHandler(
-      `${controllerName}:setAccountGroupName`,
-      this.setAccountGroupName.bind(this),
-    );
-
-    this.messenger.registerActionHandler(
-      `${controllerName}:setAccountGroupPinned`,
-      this.setAccountGroupPinned.bind(this),
-    );
-
-    this.messenger.registerActionHandler(
-      `${controllerName}:setAccountGroupHidden`,
-      this.setAccountGroupHidden.bind(this),
-    );
-  }
-
   /**
    * Bi-directionally syncs the account tree with user storage.
    * This will perform a full sync, including both pulling updates