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(logging): Rename ControllerMessenger to Messenger #5235

Merged
merged 2 commits into from
Feb 3, 2025
Merged

chore(logging): Rename ControllerMessenger to Messenger #5235

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
b1ceab7
chore(logging): Rename ControllerMessenger to Messenger
cryptodev-2s Jan 31, 2025
94717a8
Merge branch 'main' into messenger-rename-logging
cryptodev-2s Feb 3, 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
20 changes: 9 additions & 11 deletions packages/logging-controller/src/LoggingController.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 * as uuid from 'uuid';

import type { LoggingControllerActions } from './LoggingController';
Expand All @@ -18,24 +18,22 @@ jest.mock('uuid', () => {
const name = 'LoggingController';

/**
* Constructs a unrestricted controller messenger.
* Constructs a unrestricted messenger.
*
* @returns A unrestricted controller messenger.
* @returns A unrestricted messenger.
*/
Comment on lines +21 to +23
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit:

Suggested change
* Constructs a unrestricted messenger.
*
* @returns A unrestricted controller messenger.
* @returns A unrestricted messenger.
* Constructs an unrestricted messenger.
*
* @returns An unrestricted messenger.

function getUnrestrictedMessenger() {
return new ControllerMessenger<LoggingControllerActions, never>();
return new Messenger<LoggingControllerActions, never>();
}

/**
* Constructs a restricted controller messenger.
* Constructs a restricted messenger.
*
* @param controllerMessenger - An optional unrestricted messenger
* @returns A restricted controller messenger.
* @param messenger - An optional unrestricted messenger
* @returns A restricted messenger.
*/
function getRestrictedMessenger(
controllerMessenger = getUnrestrictedMessenger(),
) {
return controllerMessenger.getRestricted({
function getRestrictedMessenger(messenger = getUnrestrictedMessenger()) {
return messenger.getRestricted({
name,
allowedActions: [],
allowedEvents: [],
Expand Down
6 changes: 3 additions & 3 deletions packages/logging-controller/src/LoggingController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import type {
ControllerGetStateAction,
ControllerStateChangeEvent,
RestrictedControllerMessenger,
RestrictedMessenger,
} from '@metamask/base-controller';
import { BaseController } from '@metamask/base-controller';
import { v1 as random } from 'uuid';
Expand Down Expand Up @@ -54,7 +54,7 @@ export type LoggingControllerStateChangeEvent = ControllerStateChangeEvent<

export type LoggingControllerEvents = LoggingControllerStateChangeEvent;

export type LoggingControllerMessenger = RestrictedControllerMessenger<
export type LoggingControllerMessenger = RestrictedMessenger<
typeof name,
LoggingControllerActions,
LoggingControllerEvents,
Expand Down Expand Up @@ -82,7 +82,7 @@ export class LoggingController extends BaseController<
* Creates a LoggingController instance.
*
* @param options - Constructor options
* @param options.messenger - An instance of the ControllerMessenger
* @param options.messenger - An instance of the Messenger
* @param options.state - Initial state to set on this controller.
*/
constructor({
Expand Down
Loading