Skip to content

chore(account-tree-controller): remove accountOrderCallbacks config #9829

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
gantunesr wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

chore(account-tree-controller): remove accountOrderCallbacks config #9829

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/account-tree-controller/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- Bump `@metamask/accounts-controller` from `^39.0.7` to `^39.1.0` ([#9807](https://github.com/MetaMask/core/pull/9807))

### Removed

- **BREAKING:** Remove `AccountTreeControllerConfig.accountOrderCallbacks` and stop migrating pinned/hidden state from account-order callbacks

## [7.6.1]

### Changed
Expand Down
297 changes: 56 additions & 241 deletions packages/account-tree-controller/src/AccountTreeController.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,9 +289,6 @@ const MOCK_PREPOPULATED_STATE: Partial<AccountTreeControllerState> = {
* @param options.config.backupAndSync.onBackupAndSyncEvent - Event handler for backup and sync events.
* @param options.config.backupAndSync.isAccountSyncingEnabled - Flag to enable account syncing.
* @param options.config.backupAndSync.isBackupAndSyncEnabled - Flag to enable backup and sync.
* @param options.config.accountOrderCallbacks - Callbacks to migrate hidden and pinned account information from the account order controller.
* @param options.config.accountOrderCallbacks.isHiddenAccount - Callback to check if an account is hidden.
* @param options.config.accountOrderCallbacks.isPinnedAccount - Callback to check if an account is pinned.
* @returns An object containing the controller instance and the messenger.
*/
function setup({
Expand All @@ -305,10 +302,6 @@ function setup({
isBackupAndSyncEnabled: true,
onBackupAndSyncEvent: jest.fn(),
},
accountOrderCallbacks: {
isHiddenAccount: jest.fn().mockReturnValue(false),
isPinnedAccount: jest.fn().mockReturnValue(false),
},
},
}: {
state?: Partial<AccountTreeControllerState>;
Expand All @@ -323,10 +316,6 @@ function setup({
event: BackupAndSyncAnalyticsEventPayload,
) => void;
};
accountOrderCallbacks?: {
isHiddenAccount?: (accountId: AccountId) => boolean;
isPinnedAccount?: (accountId: AccountId) => boolean;
};
};
} = {}): {
controller: AccountTreeController;
Expand Down Expand Up @@ -6137,256 +6126,82 @@ describe('AccountTreeController', () => {
});
});

describe('migrating account order callbacks', () => {
describe('account group pinned and hidden metadata', () => {
const mockAccount1 = {
...MOCK_HD_ACCOUNT_1,
id: 'test-account-1' as AccountId,
address: '0x123',
};

describe('basic functionality', () => {
it('initializes without callbacks and use default metadata values', () => {
const { controller } = setup({
accounts: [mockAccount1],
config: {
backupAndSync: {
isAccountSyncingEnabled: true,
isBackupAndSyncEnabled: true,
onBackupAndSyncEvent: jest.fn(),
},
// No accountOrderCallbacks provided
},
});

controller.init();

const wallets = Object.values(controller.state.accountTree.wallets);
expect(wallets).toHaveLength(1);

const groups = Object.values(wallets[0].groups);
expect(groups).toHaveLength(1);
expect(groups[0].accounts).toContain(mockAccount1.id);
expect(groups[0].metadata.pinned).toBe(false);
expect(groups[0].metadata.hidden).toBe(false);

// Verify that metadata was persisted with default values
const groupId = groups[0].id;
expect(controller.state.accountGroupsMetadata[groupId]).toStrictEqual({
name: {
value: expect.any(String),
lastUpdatedAt: expect.any(Number),
},
pinned: {
value: false,
lastUpdatedAt: 0,
},
hidden: {
value: false,
lastUpdatedAt: 0,
},
lastSelected: 0,
});
});

it('handles only pinned callback provided', () => {
const mockCallbacks = {
isPinnedAccount: jest.fn().mockReturnValue(true),
};

const { controller } = setup({
accounts: [mockAccount1],
config: {
backupAndSync: {
isAccountSyncingEnabled: true,
isBackupAndSyncEnabled: true,
onBackupAndSyncEvent: jest.fn(),
},
accountOrderCallbacks: mockCallbacks,
},
});

controller.init();

const wallets = Object.values(controller.state.accountTree.wallets);
expect(wallets).toHaveLength(1);

const groups = Object.values(wallets[0].groups);
expect(groups).toHaveLength(1);
expect(groups[0].accounts).toContain(mockAccount1.id);
expect(groups[0].metadata.pinned).toBe(true);
expect(groups[0].metadata.hidden).toBe(false);
expect(mockCallbacks.isPinnedAccount).toHaveBeenCalledWith(
mockAccount1.id,
);

// Verify that metadata was persisted correctly
const groupId = groups[0].id;
expect(controller.state.accountGroupsMetadata[groupId]).toStrictEqual({
name: {
value: expect.any(String),
lastUpdatedAt: expect.any(Number),
},
pinned: {
value: true,
lastUpdatedAt: 0,
},
hidden: {
value: false,
lastUpdatedAt: 0,
},
lastSelected: 0,
});
it('initializes with default pinned and hidden metadata values', () => {
const { controller } = setup({
accounts: [mockAccount1],
});

it('handles only hidden callback provided', () => {
const mockCallbacks = {
isHiddenAccount: jest.fn().mockReturnValue(true),
};

const { controller } = setup({
accounts: [mockAccount1],
config: {
backupAndSync: {
isAccountSyncingEnabled: true,
isBackupAndSyncEnabled: true,
onBackupAndSyncEvent: jest.fn(),
},
accountOrderCallbacks: mockCallbacks,
},
});

controller.init();
controller.init();

const wallets = Object.values(controller.state.accountTree.wallets);
expect(wallets).toHaveLength(1);
const wallets = Object.values(controller.state.accountTree.wallets);
expect(wallets).toHaveLength(1);

const groups = Object.values(wallets[0].groups);
expect(groups).toHaveLength(1);
expect(groups[0].accounts).toContain(mockAccount1.id);
expect(groups[0].metadata.pinned).toBe(false);
expect(groups[0].metadata.hidden).toBe(true);
expect(mockCallbacks.isHiddenAccount).toHaveBeenCalledWith(
mockAccount1.id,
);
const groups = Object.values(wallets[0].groups);
expect(groups).toHaveLength(1);
expect(groups[0].accounts).toContain(mockAccount1.id);
expect(groups[0].metadata.pinned).toBe(false);
expect(groups[0].metadata.hidden).toBe(false);

// Verify that metadata was persisted correctly
const groupId = groups[0].id;
expect(controller.state.accountGroupsMetadata[groupId]).toStrictEqual({
name: {
value: expect.any(String),
lastUpdatedAt: expect.any(Number),
},
pinned: {
value: false,
lastUpdatedAt: 0,
},
hidden: {
value: true,
lastUpdatedAt: 0,
},
lastSelected: 0,
});
const groupId = groups[0].id;
expect(controller.state.accountGroupsMetadata[groupId]).toStrictEqual({
name: {
value: expect.any(String),
lastUpdatedAt: expect.any(Number),
},
pinned: {
value: false,
lastUpdatedAt: 0,
},
hidden: {
value: false,
lastUpdatedAt: 0,
},
lastSelected: 0,
});
});

it('prefers persisted metadata over callbacks', () => {
const mockIsHiddenAccount = jest.fn().mockReturnValue(true);
const mockIsPinnedAccount = jest.fn().mockReturnValue(true);

const walletId = toMultichainAccountWalletId(
mockAccount1.options.entropy.id,
);
const groupId = toMultichainAccountGroupId(
walletId,
mockAccount1.options.entropy.groupIndex,
);
it('uses persisted pinned and hidden metadata', () => {
const walletId = toMultichainAccountWalletId(
mockAccount1.options.entropy.id,
);
const groupId = toMultichainAccountGroupId(
walletId,
mockAccount1.options.entropy.groupIndex,
);

const { controller } = setup({
accounts: [mockAccount1],
keyrings: [MOCK_HD_KEYRING_1],
state: {
accountGroupsMetadata: {
[groupId]: {
pinned: {
value: false,
lastUpdatedAt: Date.now(),
},
hidden: {
value: false,
lastUpdatedAt: Date.now(),
},
const { controller } = setup({
accounts: [mockAccount1],
keyrings: [MOCK_HD_KEYRING_1],
state: {
accountGroupsMetadata: {
[groupId]: {
pinned: {
value: true,
lastUpdatedAt: Date.now(),
},
},
},
config: {
backupAndSync: {
isAccountSyncingEnabled: true,
isBackupAndSyncEnabled: true,
onBackupAndSyncEvent: jest.fn(),
},
accountOrderCallbacks: {
isHiddenAccount: mockIsHiddenAccount,
isPinnedAccount: mockIsPinnedAccount,
},
},
});

controller.init();

// Verify callbacks were NOT called because persisted metadata takes precedence
expect(mockIsHiddenAccount).not.toHaveBeenCalled();
expect(mockIsPinnedAccount).not.toHaveBeenCalled();

const wallets = Object.values(controller.state.accountTree.wallets);
const groups = Object.values(wallets[0].groups);
expect(groups[0].accounts).toContain(mockAccount1.id);
expect(groups[0].metadata.pinned).toBe(false); // Persisted value used
expect(groups[0].metadata.hidden).toBe(false); // Persisted value used
});

it('uses persisted metadata when no callbacks are provided', () => {
const walletId = toMultichainAccountWalletId(
mockAccount1.options.entropy.id,
);
const groupId = toMultichainAccountGroupId(
walletId,
mockAccount1.options.entropy.groupIndex,
);

const { controller } = setup({
accounts: [mockAccount1],
keyrings: [MOCK_HD_KEYRING_1],
state: {
accountGroupsMetadata: {
[groupId]: {
pinned: {
value: true, // Persisted as pinned
lastUpdatedAt: Date.now(),
},
hidden: {
value: true, // Persisted as hidden
lastUpdatedAt: Date.now(),
},
hidden: {
value: true,
lastUpdatedAt: Date.now(),
},
},
},
config: {
backupAndSync: {
isAccountSyncingEnabled: true,
isBackupAndSyncEnabled: true,
onBackupAndSyncEvent: jest.fn(),
},
// No accountOrderCallbacks provided
},
});
},
});

controller.init();
controller.init();

const wallets = Object.values(controller.state.accountTree.wallets);
const groups = Object.values(wallets[0].groups);
expect(groups[0].accounts).toContain(mockAccount1.id);
expect(groups[0].metadata.pinned).toBe(true);
expect(groups[0].metadata.hidden).toBe(true);
});
const wallets = Object.values(controller.state.accountTree.wallets);
const groups = Object.values(wallets[0].groups);
expect(groups[0].accounts).toContain(mockAccount1.id);
expect(groups[0].metadata.pinned).toBe(true);
expect(groups[0].metadata.hidden).toBe(true);
});
});
});
Loading
Loading