test(accounts-controller): add test for setAccountNameAndSelectAccount

Author: ccharly

packages/accounts-controller/src/AccountsController.test.ts

@@ -1,5 +1,4 @@
 import { Messenger } from '@metamask/base-controller';
-import { InfuraNetworkType } from '@metamask/controller-utils';
 import type {
   AccountAssetListUpdatedEventPayload,
   AccountBalancesUpdatedEventPayload,
@@ -2719,6 +2718,116 @@ describe('AccountsController', () => {
     });
   });
 
+  describe('setAccountNameAndSelect', () => {
+    const newAccountName = 'New Account Name';
+    const mockState = {
+      initialState: {
+        internalAccounts: {
+          accounts: { [mockAccount.id]: mockAccount },
+          selectedAccount: mockAccount.id,
+        },
+      },
+    };
+
+    it('sets the name of an existing account', () => {
+      const { accountsController } = setupAccountsController(mockState);
+
+      accountsController.setAccountNameAndSelectAccount(
+        mockAccount.id,
+        newAccountName,
+      );
+
+      expect(
+        accountsController.getAccountExpect(mockAccount.id).metadata.name,
+      ).toBe(newAccountName);
+      expect(accountsController.state.internalAccounts.selectedAccount).toBe(
+        mockAccount.id,
+      );
+    });
+
+    it('sets the name of an existing account and select the account', () => {
+      const { accountsController } = setupAccountsController({
+        initialState: {
+          internalAccounts: {
+            accounts: {
+              [mockAccount.id]: mockAccount,
+              [mockAccount2.id]: mockAccount2,
+            },
+            selectedAccount: mockAccount.id,
+          },
+        },
+      });
+
+      accountsController.setAccountNameAndSelectAccount(
+        mockAccount2.id,
+        newAccountName,
+      );
+
+      expect(
+        accountsController.getAccountExpect(mockAccount2.id).metadata.name,
+      ).toBe(newAccountName);
+      expect(accountsController.state.internalAccounts.selectedAccount).toBe(
+        mockAccount2.id,
+      );
+    });
+
+    it('sets the nameLastUpdatedAt timestamp when setting the name of an existing account', () => {
+      const expectedTimestamp = Number(new Date('2024-01-02'));
+
+      jest.spyOn(Date, 'now').mockImplementation(() => expectedTimestamp);
+
+      const { accountsController } = setupAccountsController(mockState);
+
+      accountsController.setAccountNameAndSelectAccount(
+        mockAccount.id,
+        newAccountName,
+      );
+
+      expect(
+        accountsController.getAccountExpect(mockAccount.id).metadata
+          .nameLastUpdatedAt,
+      ).toBe(expectedTimestamp);
+    });
+
+    it('publishes the accountRenamed event', () => {
+      const { accountsController, messenger } =
+        setupAccountsController(mockState);
+
+      const messengerSpy = jest.spyOn(messenger, 'publish');
+
+      accountsController.setAccountNameAndSelectAccount(
+        mockAccount.id,
+        newAccountName,
+      );
+
+      expect(messengerSpy).toHaveBeenCalledWith(
+        'AccountsController:accountRenamed',
+        accountsController.getAccountExpect(mockAccount.id),
+      );
+    });
+
+    it('throw an error if the account name already exists', () => {
+      const { accountsController } = setupAccountsController({
+        initialState: {
+          internalAccounts: {
+            accounts: {
+              [mockAccount.id]: mockAccount,
+              [mockAccount2.id]: mockAccount2,
+            },
+            selectedAccount: mockAccount.id,
+          },
+        },
+      });
+
+      expect(() =>
+        accountsController.setAccountNameAndSelectAccount(
+          mockAccount.id,
+          mockAccount2.metadata.name,
+        ),
+      ).toThrow('Account name already exists');
+    });
+  });
+
   describe('setAccountName', () => {
     it('sets the name of an existing account', () => {
       const { accountsController } = setupAccountsController({
@@ -3033,6 +3142,10 @@ describe('AccountsController', () => {
       jest.spyOn(AccountsController.prototype, 'getAccountByAddress');
       jest.spyOn(AccountsController.prototype, 'getSelectedAccount');
       jest.spyOn(AccountsController.prototype, 'getAccount');
+      jest.spyOn(
+        AccountsController.prototype,
+        'setAccountNameAndSelectAccount',
+      );
     });
 
     describe('setSelectedAccount', () => {
@@ -3142,6 +3255,37 @@ describe('AccountsController', () => {
       });
     });
 
+    describe('setAccountNameAndSelectAccount', () => {
+      it('set the account name and select the account', async () => {
+        const messenger = buildMessenger();
+        const { accountsController } = setupAccountsController({
+          initialState: {
+            internalAccounts: {
+              accounts: {
+                [mockAccount.id]: mockAccount,
+                [mockAccount2.id]: mockAccount2,
+              },
+              selectedAccount: mockAccount.id,
+            },
+          },
+          messenger,
+        });
+
+        const newAccountName = 'New Account Name';
+        messenger.call(
+          'AccountsController:setAccountNameAndSelectAccount',
+          mockAccount2.id,
+          newAccountName,
+        );
+        expect(
+          accountsController.setAccountNameAndSelectAccount,
+        ).toHaveBeenCalledWith(mockAccount2.id, newAccountName);
+        expect(accountsController.state.internalAccounts.selectedAccount).toBe(
+          mockAccount2.id,
+        );
+      });
+    });
+
     describe('updateAccounts', () => {
       it('update accounts', async () => {
         const messenger = buildMessenger();

packages/accounts-controller/src/AccountsController.ts

@@ -469,9 +469,12 @@ export class AccountsController extends BaseController<
       // deep and possibly infinite.ts(2589)" (https://github.com/MetaMask/utils/issues/168)
       // Using a type-cast workaround this error and is slightly better than using a @ts-expect-error
       // which sometimes fail when compiling locally.
-      internalAccounts.accounts[accountId] = internalAccount;
+      internalAccounts.accounts[account.id] = internalAccount;
 
-      internalAccounts.accounts[account.id].metadata.lastSelected = Date.now();
+      internalAccounts.accounts[account.id].metadata.lastSelected =
+        this.#getLastSelectedIndex();
+      internalAccounts.accounts[account.id].metadata.nameLastUpdatedAt =
+        Date.now();
       internalAccounts.selectedAccount = account.id;
     });