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

chore(preferences): Rename ControllerMessenger to Messenger #5251

Merged
merged 2 commits into from
Jan 31, 2025
+19 −20
Merged

chore(preferences): Rename ControllerMessenger to Messenger #5251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f648967
chore(preferences): Rename ControllerMessenger to Messenger
cryptodev-2s Jan 31, 2025
9ab2e18
Merge branch 'main' into messenger-rename-preferences
cryptodev-2s Jan 31, 2025
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
35 changes: 17 additions & 18 deletions packages/preferences-controller/src/PreferencesController.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { ControllerMessenger } from '@metamask/base-controller';
import { Messenger } from '@metamask/base-controller';
import { getDefaultKeyringState } from '@metamask/keyring-controller';
import { cloneDeep } from 'lodash';

Expand Down Expand Up @@ -48,7 +48,7 @@ describe('PreferencesController', () => {

describe('KeyringController:stateChange', () => {
it('should update identities state to reflect new keyring accounts', () => {
const messenger = getControllerMessenger();
const messenger = getMessenger();
const controller = setupPreferencesController({
options: {
state: {
Expand Down Expand Up @@ -89,7 +89,7 @@ describe('PreferencesController', () => {
});

it('should update identities state to reflect removed keyring accounts', () => {
const messenger = getControllerMessenger();
const messenger = getMessenger();
const controller = setupPreferencesController({
options: {
state: {
Expand Down Expand Up @@ -119,7 +119,7 @@ describe('PreferencesController', () => {
});

it('should update selected address to first identity if the selected address was removed', () => {
const messenger = getControllerMessenger();
const messenger = getMessenger();
const controller = setupPreferencesController({
options: {
state: {
Expand Down Expand Up @@ -152,7 +152,7 @@ describe('PreferencesController', () => {
'0x01': { address: '0x01', importTime: 2, name: 'Account 2' },
'0x02': { address: '0x02', importTime: 3, name: 'Account 3' },
};
const messenger = getControllerMessenger();
const messenger = getMessenger();
const controller = setupPreferencesController({
options: {
state: {
Expand Down Expand Up @@ -181,7 +181,7 @@ describe('PreferencesController', () => {
'0x01': { address: '0x01', importTime: 2, name: 'Account 2' },
'0x02': { address: '0x02', importTime: 3, name: 'Account 3' },
};
const messenger = getControllerMessenger();
const messenger = getMessenger();
const controller = setupPreferencesController({
options: {
state: {
Expand Down Expand Up @@ -212,7 +212,7 @@ describe('PreferencesController', () => {
'0x01': { address: '0x01', importTime: 2, name: 'Account 2' },
'0x02': { address: '0x02', importTime: 3, name: 'Account 3' },
};
const messenger = getControllerMessenger();
const messenger = getMessenger();
const controller = setupPreferencesController({
options: {
state: {
Expand Down Expand Up @@ -244,7 +244,7 @@ describe('PreferencesController', () => {
'0x01': { address: '0x01', importTime: 2, name: 'Account 2' },
'0x02': { address: '0x02', importTime: 3, name: 'Account 3' },
};
const messenger = getControllerMessenger();
const messenger = getMessenger();
const controller = setupPreferencesController({
options: {
state: {
Expand Down Expand Up @@ -478,18 +478,18 @@ describe('PreferencesController', () => {
});

/**
* Construct a controller messenger for use in PreferencesController tests.
* Construct a messenger for use in PreferencesController tests.
*
* This is a utility function that saves us from manually entering the correct
* type parameters for the ControllerMessenger each time we construct it.
* type parameters for the Messenger each time we construct it.
*
* @returns A controller messenger
* @returns A messenger
*/
function getControllerMessenger(): ControllerMessenger<
function getMessenger(): Messenger<
PreferencesControllerActions,
PreferencesControllerEvents | AllowedEvents
> {
return new ControllerMessenger<
return new Messenger<
PreferencesControllerActions,
PreferencesControllerEvents | AllowedEvents
>();
Expand All @@ -500,21 +500,20 @@ function getControllerMessenger(): ControllerMessenger<
*
* @param args - Arguments
* @param args.options - PreferencesController options.
* @param args.messenger - A controller messenger.
* @param args.messenger - A messenger.
* @returns A PreferencesController instance.
*/
function setupPreferencesController({
options = {},
messenger,
messenger = getMessenger(),
}: {
options?: Partial<ConstructorParameters<typeof PreferencesController>[0]>;
messenger?: ControllerMessenger<
messenger?: Messenger<
PreferencesControllerActions,
PreferencesControllerEvents | AllowedEvents
>;
} = {}) {
const controllerMessenger = messenger ?? getControllerMessenger();
const preferencesControllerMessenger = controllerMessenger.getRestricted<
const preferencesControllerMessenger = messenger.getRestricted<
'PreferencesController',
never,
AllowedEvents['type']
Expand Down
4 changes: 2 additions & 2 deletions packages/preferences-controller/src/PreferencesController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import {
BaseController,
type ControllerStateChangeEvent,
type ControllerGetStateAction,
type RestrictedControllerMessenger,
type RestrictedMessenger,
} from '@metamask/base-controller';
import { toChecksumHexAddress } from '@metamask/controller-utils';
import type {
Expand Down Expand Up @@ -174,7 +174,7 @@ export type PreferencesControllerEvents = PreferencesControllerStateChangeEvent;

export type AllowedEvents = KeyringControllerStateChangeEvent;

export type PreferencesControllerMessenger = RestrictedControllerMessenger<
export type PreferencesControllerMessenger = RestrictedMessenger<
typeof name,
PreferencesControllerActions,
PreferencesControllerEvents | AllowedEvents,
Expand Down
Loading