Skip to content
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

Jump to bottom

upgrade address book controller to base controller v2 #4392

Merged
merged 5 commits into from
Jun 11, 2024
Merged

upgrade address book controller to base controller v2 #4392

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
945f48b
upgrade address book controller to base controller v2
kanthesha Jun 7, 2024
ceffc2d
simplify object deletion
kanthesha Jun 7, 2024
b37ffcf
remove jsdoc comment for enum type
kanthesha Jun 7, 2024
557f927
Merge branch 'main' into upgrade-address-book-controller-to-base-cont…
kanthesha Jun 8, 2024
8b9daed
Merge branch 'main' into upgrade-address-book-controller-to-base-cont…
kanthesha Jun 11, 2024
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
104 changes: 84 additions & 20 deletions packages/address-book-controller/src/AddressBookController.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,45 @@
import { ControllerMessenger } from '@metamask/base-controller';
import { toHex } from '@metamask/controller-utils';

import { AddressBookController, AddressType } from './AddressBookController';
import type {
AddressBookControllerActions,
AddressBookControllerEvents,
} from './AddressBookController';
import {
AddressBookController,
AddressType,
controllerName,
} from './AddressBookController';

/**
* Constructs a restricted controller messenger.
*
* @returns A restricted controller messenger.
*/
function getRestrictedMessenger() {
const controllerMessenger = new ControllerMessenger<
AddressBookControllerActions,
AddressBookControllerEvents
>();
return controllerMessenger.getRestricted({
name: controllerName,
allowedActions: [],
allowedEvents: [],
});
}

describe('AddressBookController', () => {
it('should set default state', () => {
const controller = new AddressBookController();
const controller = new AddressBookController({
messenger: getRestrictedMessenger(),
});
expect(controller.state).toStrictEqual({ addressBook: {} });
});

it('should add a contact entry', () => {
const controller = new AddressBookController();
const controller = new AddressBookController({
messenger: getRestrictedMessenger(),
});
controller.set('0x32Be343B94f860124dC4fEe278FDCBD38C102D88', 'foo');

expect(controller.state).toStrictEqual({
Expand All @@ -29,7 +59,9 @@ describe('AddressBookController', () => {
});

it('should add a contact entry with chainId and memo', () => {
const controller = new AddressBookController();
const controller = new AddressBookController({
messenger: getRestrictedMessenger(),
});
controller.set(
'0x32Be343B94f860124dC4fEe278FDCBD38C102D88',
'foo',
Expand All @@ -55,7 +87,9 @@ describe('AddressBookController', () => {
});

it('should add a contact entry with address type contract accounts', () => {
const controller = new AddressBookController();
const controller = new AddressBookController({
messenger: getRestrictedMessenger(),
});
controller.set(
'0x32Be343B94f860124dC4fEe278FDCBD38C102D88',
'foo',
Expand All @@ -81,7 +115,9 @@ describe('AddressBookController', () => {
});

it('should add a contact entry with address type non accounts', () => {
const controller = new AddressBookController();
const controller = new AddressBookController({
messenger: getRestrictedMessenger(),
});
controller.set(
'0x32Be343B94f860124dC4fEe278FDCBD38C102D88',
'foo',
Expand All @@ -107,7 +143,9 @@ describe('AddressBookController', () => {
});

it('should add multiple contact entries with different chainIds', () => {
const controller = new AddressBookController();
const controller = new AddressBookController({
messenger: getRestrictedMessenger(),
});
controller.set(
'0x32Be343B94f860124dC4fEe278FDCBD38C102D88',
'foo',
Expand Down Expand Up @@ -149,7 +187,9 @@ describe('AddressBookController', () => {
});

it('should update a contact entry', () => {
const controller = new AddressBookController();
const controller = new AddressBookController({
messenger: getRestrictedMessenger(),
});
controller.set('0x32Be343B94f860124dC4fEe278FDCBD38C102D88', 'foo');

controller.set('0x32Be343B94f860124dC4fEe278FDCBD38C102D88', 'bar');
Expand All @@ -171,22 +211,28 @@ describe('AddressBookController', () => {
});

it('should not add invalid contact entry', () => {
const controller = new AddressBookController();
const controller = new AddressBookController({
messenger: getRestrictedMessenger(),
});
// @ts-expect-error Intentionally invalid entry
controller.set('0x01', 'foo', AddressType.externallyOwnedAccounts);
expect(controller.state).toStrictEqual({ addressBook: {} });
});

it('should remove one contact entry', () => {
const controller = new AddressBookController();
const controller = new AddressBookController({
messenger: getRestrictedMessenger(),
});
controller.set('0x32Be343B94f860124dC4fEe278FDCBD38C102D88', 'foo');
controller.delete(toHex(1), '0x32Be343B94f860124dC4fEe278FDCBD38C102D88');

expect(controller.state).toStrictEqual({ addressBook: {} });
});

it('should remove only one contact entry', () => {
const controller = new AddressBookController();
const controller = new AddressBookController({
messenger: getRestrictedMessenger(),
});
controller.set('0x32Be343B94f860124dC4fEe278FDCBD38C102D88', 'foo');

controller.set('0xc38bf1ad06ef69f0c04e29dbeb4152b4175f0a8d', 'bar');
Expand All @@ -209,7 +255,9 @@ describe('AddressBookController', () => {
});

it('should add two contact entries with the same chainId', () => {
const controller = new AddressBookController();
const controller = new AddressBookController({
messenger: getRestrictedMessenger(),
});
controller.set('0x32Be343B94f860124dC4fEe278FDCBD38C102D88', 'foo');

controller.set('0xc38bf1ad06ef69f0c04e29dbeb4152b4175f0a8d', 'bar');
Expand Down Expand Up @@ -239,7 +287,9 @@ describe('AddressBookController', () => {
});

it('should correctly mark ens entries', () => {
const controller = new AddressBookController();
const controller = new AddressBookController({
messenger: getRestrictedMessenger(),
});
controller.set(
'0x32Be343B94f860124dC4fEe278FDCBD38C102D88',
'metamask.eth',
Expand All @@ -262,7 +312,9 @@ describe('AddressBookController', () => {
});

it('should clear all contact entries', () => {
const controller = new AddressBookController();
const controller = new AddressBookController({
messenger: getRestrictedMessenger(),
});
controller.set('0x32Be343B94f860124dC4fEe278FDCBD38C102D88', 'foo');

controller.set('0xc38bf1ad06ef69f0c04e29dbeb4152b4175f0a8d', 'bar');
Expand All @@ -271,22 +323,28 @@ describe('AddressBookController', () => {
});

it('should return true to indicate an address book entry has been added', () => {
const controller = new AddressBookController();
const controller = new AddressBookController({
messenger: getRestrictedMessenger(),
});
expect(
controller.set('0x32Be343B94f860124dC4fEe278FDCBD38C102D88', 'foo'),
).toBe(true);
});

it('should return false to indicate an address book entry has NOT been added', () => {
const controller = new AddressBookController();
const controller = new AddressBookController({
messenger: getRestrictedMessenger(),
});
expect(
// @ts-expect-error Intentionally invalid entry
controller.set('0x00', 'foo', AddressType.externallyOwnedAccounts),
).toBe(false);
});

it('should return true to indicate an address book entry has been deleted', () => {
const controller = new AddressBookController();
const controller = new AddressBookController({
messenger: getRestrictedMessenger(),
});
controller.set('0x32Be343B94f860124dC4fEe278FDCBD38C102D88', 'foo');

expect(
Expand All @@ -295,20 +353,26 @@ describe('AddressBookController', () => {
});

it('should return false to indicate an address book entry has NOT been deleted due to unsafe input', () => {
const controller = new AddressBookController();
const controller = new AddressBookController({
messenger: getRestrictedMessenger(),
});
// @ts-expect-error Suppressing error to test runtime behavior
expect(controller.delete('__proto__', '0x01')).toBe(false);
expect(controller.delete(toHex(1), 'constructor')).toBe(false);
});

it('should return false to indicate an address book entry has NOT been deleted', () => {
const controller = new AddressBookController();
const controller = new AddressBookController({
messenger: getRestrictedMessenger(),
});
controller.set('0x32Be343B94f860124dC4fEe278FDCBD38C102D88', '0x00');
expect(controller.delete(toHex(1), '0x01')).toBe(false);
});

it('should normalize addresses so adding and removing entries work across casings', () => {
const controller = new AddressBookController();
const controller = new AddressBookController({
messenger: getRestrictedMessenger(),
});
controller.set('0x32Be343B94f860124dC4fEe278FDCBD38C102D88', 'foo');

controller.set('0xc38bf1ad06ef69f0c04e29dbeb4152b4175f0a8d', 'bar');
Expand Down
Loading
Loading