Move composable-controller utility types to base-controller

packages/base-controller/jest.config.js

@@ -17,7 +17,7 @@ module.exports = merge(baseConfig, {
   // An object that configures minimum threshold enforcement for coverage results
   coverageThreshold: {
     global: {
-      branches: 96.29,
+      branches: 100,
       functions: 100,
       lines: 100,
       statements: 100,

packages/base-controller/package.json

@@ -45,6 +45,7 @@
   },
   "devDependencies": {
     "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/json-rpc-engine": "^9.0.2",
     "@types/jest": "^27.4.1",
     "@types/sinon": "^9.0.10",
     "deepmerge": "^4.2.2",

packages/base-controller/src/BaseControllerV1.test.ts

@@ -1,18 +1,61 @@
+import { JsonRpcEngine } from '@metamask/json-rpc-engine';
 import * as sinon from 'sinon';
 
 import type { BaseConfig, BaseState } from './BaseControllerV1';
-import { BaseControllerV1 as BaseController } from './BaseControllerV1';
+import {
+  BaseControllerV1 as BaseController,
+  isBaseControllerV1,
+} from './BaseControllerV1';
+import type {
+  CountControllerAction,
+  CountControllerEvent,
+} from './BaseControllerV2.test';
+import {
+  CountController,
+  countControllerName,
+  countControllerStateMetadata,
+  getCountMessenger,
+} from './BaseControllerV2.test';
+import { ControllerMessenger } from './ControllerMessenger';
 
 const STATE = { name: 'foo' };
 const CONFIG = { disabled: true };
 
-class TestController extends BaseController<BaseConfig, BaseState> {
+// eslint-disable-next-line jest/no-export
+export class TestController extends BaseController<BaseConfig, BaseState> {
   constructor(config?: BaseConfig, state?: BaseState) {
     super(config, state);
     this.initialize();
   }
 }
 
+describe('isBaseControllerV1', () => {
+  it('should return false if passed a V1 controller', () => {
+    const controller = new TestController();
+    expect(isBaseControllerV1(controller)).toBe(true);
+  });
+
+  it('should return false if passed a V2 controller', () => {
+    const controllerMessenger = new ControllerMessenger<
+      CountControllerAction,
+      CountControllerEvent
+    >();
+    const controller = new CountController({
+      messenger: getCountMessenger(controllerMessenger),
+      name: countControllerName,
+      state: { count: 0 },
+      metadata: countControllerStateMetadata,
+    });
+    expect(isBaseControllerV1(controller)).toBe(false);
+  });
+
+  it('should return false if passed a non-controller', () => {
+    const notController = new JsonRpcEngine();
+    // @ts-expect-error Intentionally passing invalid input to test runtime behavior
+    expect(isBaseControllerV1(notController)).toBe(false);
+  });
+});
+
 describe('BaseController', () => {
   afterEach(() => {
     sinon.restore();

packages/base-controller/src/BaseControllerV1.ts

@@ -1,3 +1,34 @@
+import type { PublicInterface } from '@metamask/utils';
+
+import type { ControllerInstance } from './BaseControllerV2';
+
+/**
+ * Determines if the given controller is an instance of `BaseControllerV1`
+ *
+ * @param controller - Controller instance to check
+ * @returns True if the controller is an instance of `BaseControllerV1`
+ */
+export function isBaseControllerV1(
+  controller: ControllerInstance,
+): controller is BaseControllerV1Instance {
+  return (
+    'name' in controller &&
+    typeof controller.name === 'string' &&
+    'config' in controller &&
+    typeof controller.config === 'object' &&
+    'defaultConfig' in controller &&
+    typeof controller.defaultConfig === 'object' &&
+    'state' in controller &&
+    typeof controller.state === 'object' &&
+    'defaultState' in controller &&
+    typeof controller.defaultState === 'object' &&
+    'disabled' in controller &&
+    typeof controller.disabled === 'boolean' &&
+    'subscribe' in controller &&
+    typeof controller.subscribe === 'function'
+  );
+}
+
 /**
  * State change callbacks
  */
@@ -31,6 +62,26 @@ export interface BaseState {
   name?: string;
 }
 
+/**
+ * The narrowest supertype for `BaseControllerV1` config objects.
+ * This type can be assigned to any `BaseControllerV1` config object.
+ */
+export type ConfigConstraint = BaseConfig & object;
+
+/**
+ * The narrowest supertype for `BaseControllerV1` state objects.
+ * This type can be assigned to any `BaseControllerV1` state object.
+ */
+export type StateConstraint = BaseState & object;
+
+/**
+ * The widest subtype of all controller instances that extend from `BaseControllerV1`.
+ * Any `BaseControllerV1` instance can be assigned to this type.
+ */
+export type BaseControllerV1Instance = PublicInterface<
+  BaseControllerV1<ConfigConstraint, StateConstraint>
+>;
+
 /**
  * @deprecated This class has been renamed to BaseControllerV1 and is no longer recommended for use for controllers. Please use BaseController (formerly BaseControllerV2) instead.
  *

packages/base-controller/src/BaseControllerV2.test.ts

@@ -1,6 +1,9 @@
+/* eslint-disable jest/no-export */
 import type { Draft, Patch } from 'immer';
 import * as sinon from 'sinon';
 
+import { JsonRpcEngine } from '../../json-rpc-engine/src';
+import { TestController } from './BaseControllerV1.test';
 import type {
   ControllerGetStateAction,
   ControllerStateChangeEvent,
@@ -9,27 +12,28 @@ import {
   BaseController,
   getAnonymizedState,
   getPersistentState,
+  isBaseController,
 } from './BaseControllerV2';
 import { ControllerMessenger } from './ControllerMessenger';
 import type { RestrictedControllerMessenger } from './RestrictedControllerMessenger';
 
-const countControllerName = 'CountController';
+export const countControllerName = 'CountController';
 
 type CountControllerState = {
   count: number;
 };
 
-type CountControllerAction = ControllerGetStateAction<
+export type CountControllerAction = ControllerGetStateAction<
   typeof countControllerName,
   CountControllerState
 >;
 
-type CountControllerEvent = ControllerStateChangeEvent<
+export type CountControllerEvent = ControllerStateChangeEvent<
   typeof countControllerName,
   CountControllerState
 >;
 
-const countControllerStateMetadata = {
+export const countControllerStateMetadata = {
   count: {
     persist: true,
     anonymous: true,
@@ -50,7 +54,7 @@ type CountMessenger = RestrictedControllerMessenger<
  * @param controllerMessenger - The controller messenger.
  * @returns A restricted controller messenger for the Count controller.
  */
-function getCountMessenger(
+export function getCountMessenger(
   controllerMessenger?: ControllerMessenger<
     CountControllerAction,
     CountControllerEvent
@@ -69,7 +73,7 @@ function getCountMessenger(
   });
 }
 
-class CountController extends BaseController<
+export class CountController extends BaseController<
   typeof countControllerName,
   CountControllerState,
   CountMessenger
@@ -177,6 +181,33 @@ class MessagesController extends BaseController<
   }
 }
 
+describe('isBaseController', () => {
+  it('should return true if passed a V2 controller', () => {
+    const controllerMessenger = new ControllerMessenger<
+      CountControllerAction,
+      CountControllerEvent
+    >();
+    const controller = new CountController({
+      messenger: getCountMessenger(controllerMessenger),
+      name: countControllerName,
+      state: { count: 0 },
+      metadata: countControllerStateMetadata,
+    });
+    expect(isBaseController(controller)).toBe(true);
+  });
+
+  it('should return false if passed a V1 controller', () => {
+    const controller = new TestController();
+    expect(isBaseController(controller)).toBe(false);
+  });
+
+  it('should return false if passed a non-controller', () => {
+    const notController = new JsonRpcEngine();
+    // @ts-expect-error Intentionally passing invalid input to test runtime behavior
+    expect(isBaseController(notController)).toBe(false);
+  });
+});
+
 describe('BaseController', () => {
   afterEach(() => {
     sinon.restore();

packages/base-controller/src/BaseControllerV2.ts

@@ -1,19 +1,53 @@
-import type { Json } from '@metamask/utils';
+import type { Json, PublicInterface } from '@metamask/utils';
 import { enablePatches, produceWithPatches, applyPatches, freeze } from 'immer';
 import type { Draft, Patch } from 'immer';
 
+import type {
+  BaseControllerV1Instance,
+  StateConstraint as StateConstraintV1,
+} from './BaseControllerV1';
 import type { ActionConstraint, EventConstraint } from './ControllerMessenger';
-import type { RestrictedControllerMessenger } from './RestrictedControllerMessenger';
+import type {
+  RestrictedControllerMessenger,
+  RestrictedControllerMessengerConstraint,
+} from './RestrictedControllerMessenger';
 
 enablePatches();
 
+/**
+ * Determines if the given controller is an instance of `BaseController`
+ *
+ * @param controller - Controller instance to check
+ * @returns True if the controller is an instance of `BaseController`
+ */
+export function isBaseController(
+  controller: ControllerInstance,
+): controller is BaseControllerInstance {
+  return (
+    'name' in controller &&
+    typeof controller.name === 'string' &&
+    'state' in controller &&
+    typeof controller.state === 'object' &&
+    'metadata' in controller &&
+    typeof controller.metadata === 'object'
+  );
+}
+
 /**
  * A type that constrains the state of all controllers.
  *
  * In other words, the narrowest supertype encompassing all controller state.
  */
 export type StateConstraint = Record<string, Json>;
 
+/**
+ * A universal supertype for the controller state object, encompassing both `BaseControllerV1` and `BaseControllerV2` state.
+ */
+// TODO: Remove once BaseControllerV2 migrations are completed for all controllers.
+export type LegacyControllerStateConstraint =
+  | StateConstraintV1
+  | StateConstraint;
+
 /**
  * A state change listener.
  *
@@ -72,6 +106,55 @@ export type StatePropertyMetadata<T extends Json> = {
   anonymous: boolean | StateDeriver<T>;
 };
 
+/**
+ * A universal supertype of `StateDeriver` types.
+ * This type can be assigned to any `StateDeriver` type.
+ */
+export type StateDeriverConstraint = (value: never) => Json;
+
+/**
+ * A universal supertype of `StatePropertyMetadata` types.
+ * This type can be assigned to any `StatePropertyMetadata` type.
+ */
+export type StatePropertyMetadataConstraint = {
+  [P in 'anonymous' | 'persist']: boolean | StateDeriverConstraint;
+};
+
+/**
+ * A universal supertype of `StateMetadata` types.
+ * This type can be assigned to any `StateMetadata` type.
+ */
+export type StateMetadataConstraint = Record<
+  string,
+  StatePropertyMetadataConstraint
+>;
+
+/**
+ * The widest subtype of all controller instances that inherit from `BaseController` (formerly `BaseControllerV2`).
+ * Any `BaseController` subclass instance can be assigned to this type.
+ */
+export type BaseControllerInstance = Omit<
+  PublicInterface<
+    BaseController<
+      string,
+      StateConstraint,
+      RestrictedControllerMessengerConstraint
+    >
+  >,
+  'metadata'
+> & {
+  metadata: StateMetadataConstraint;
+};
+
+/**
+ * A widest subtype of all controller instances that inherit from `BaseController` (formerly `BaseControllerV2`) or `BaseControllerV1`.
+ * Any `BaseController` or `BaseControllerV1` subclass instance can be assigned to this type.
+ */
+// TODO: Remove once BaseControllerV2 migrations are completed for all controllers.
+export type ControllerInstance =
+  | BaseControllerV1Instance
+  | BaseControllerInstance;
+
 export type ControllerGetStateAction<
   ControllerName extends string,
   ControllerState extends StateConstraint,

packages/base-controller/src/RestrictedControllerMessenger.ts

@@ -13,6 +13,23 @@ import type {
   SelectorFunction,
 } from './ControllerMessenger';
 
+/**
+ * A universal supertype of all `RestrictedControllerMessenger` instances.
+ * This type can be assigned to any `RestrictedControllerMessenger` type.
+ *
+ * @template ControllerName - Name of the controller. Optionally can be used to
+ * narrow this type to a constraint for the messenger of a specific controller.
+ */
+export type RestrictedControllerMessengerConstraint<
+  ControllerName extends string = string,
+> = RestrictedControllerMessenger<
+  ControllerName,
+  ActionConstraint,
+  EventConstraint,
+  string,
+  string
+>;
+
 /**
  * A restricted controller messenger.
  *