Move helper functions to simulation package (#2769)

To make the simulation package easier to work with, I've moved all the
helper functions (`request`, `onTransaction`, etc.) to the simulation
package.

There are no functional changes in this PR, it just moves code around.

packages/snaps-jest/src/environment.ts

@@ -4,11 +4,12 @@ import type {
 } from '@jest/environment';
 import type { AbstractExecutionService } from '@metamask/snaps-controllers';
 import type { SnapId } from '@metamask/snaps-sdk';
+import { installSnap } from '@metamask/snaps-simulation';
 import type {
   InstalledSnap,
   InstallSnapOptions,
+  SnapHelpers,
 } from '@metamask/snaps-simulation';
-import { installSnap } from '@metamask/snaps-simulation';
 import { assert, createModuleLogger } from '@metamask/utils';
 import type { Server } from 'http';
 import NodeEnvironment from 'jest-environment-node';
@@ -31,7 +32,7 @@ export class SnapsEnvironment extends NodeEnvironment {
 
   #server: Server | undefined;
 
-  #instance: InstalledSnap | undefined;
+  #instance: (InstalledSnap & SnapHelpers) | undefined;
 
   /**
    * Constructor.

packages/snaps-jest/src/helpers.ts

@@ -1,28 +1,10 @@
 import type { AbstractExecutionService } from '@metamask/snaps-controllers';
 import type { SnapId } from '@metamask/snaps-sdk';
-import type { InstallSnapOptions } from '@metamask/snaps-simulation';
-import {
-  JsonRpcMockOptionsStruct,
-  SignatureOptionsStruct,
-  handleRequest,
-  TransactionOptionsStruct,
-  addJsonRpcMock,
-  removeJsonRpcMock,
-  SnapResponseWithInterfaceStruct,
-} from '@metamask/snaps-simulation';
-import { HandlerType, logInfo } from '@metamask/snaps-utils';
-import { create } from '@metamask/superstruct';
-import { assertStruct, createModuleLogger } from '@metamask/utils';
+import type { InstallSnapOptions, Snap } from '@metamask/snaps-simulation';
+import { logInfo } from '@metamask/snaps-utils';
+import { createModuleLogger } from '@metamask/utils';
 
 import { rootLogger, getEnvironment } from './internals';
-import type {
-  SnapResponseWithInterface,
-  CronjobOptions,
-  JsonRpcMockOptions,
-  Snap,
-  SnapResponse,
-  TransactionOptions,
-} from './types';
 
 const log = createModuleLogger(rootLogger, 'helpers');
 
@@ -48,17 +30,6 @@ function getOptions<
   return [snapId, options];
 }
 
-/**
- * Ensure that the actual response contains `getInterface`.
- *
- * @param response - The response of the handler.
- */
-function assertIsResponseWithInterface(
-  response: SnapResponse,
-): asserts response is SnapResponseWithInterface {
-  assertStruct(response, SnapResponseWithInterfaceStruct);
-}
-
 /**
  * Load a snap into the environment. This is the main entry point for testing
  * snaps: It returns a {@link Snap} object that can be used to interact with the
@@ -200,154 +171,33 @@ export async function installSnap<
 ): Promise<Snap> {
   const resolvedOptions = getOptions(snapId, options);
   const {
-    snapId: installedSnapId,
-    store,
-    executionService,
-    runSaga,
-    controllerMessenger,
+    request,
+    onTransaction,
+    sendTransaction,
+    onSignature,
+    onCronjob,
+    runCronjob,
+    onHomePage,
+    mockJsonRpc,
+    close,
   } = await getEnvironment().installSnap(...resolvedOptions);
 
-  const onTransaction = async (
-    request: TransactionOptions,
-  ): Promise<SnapResponseWithInterface> => {
-    log('Sending transaction %o.', request);
-
-    const {
-      origin: transactionOrigin,
-      chainId,
-      ...transaction
-    } = create(request, TransactionOptionsStruct);
-
-    const response = await handleRequest({
-      snapId: installedSnapId,
-      store,
-      executionService,
-      runSaga,
-      controllerMessenger,
-      handler: HandlerType.OnTransaction,
-      request: {
-        method: '',
-        params: {
-          chainId,
-          transaction,
-          transactionOrigin,
-        },
-      },
-    });
-
-    assertIsResponseWithInterface(response);
-
-    return response;
-  };
-
-  const onCronjob = (request: CronjobOptions) => {
-    log('Running cronjob %o.', options);
-
-    return handleRequest({
-      snapId: installedSnapId,
-      store,
-      executionService,
-      controllerMessenger,
-      runSaga,
-      handler: HandlerType.OnCronjob,
-      request,
-    });
-  };
-
   return {
-    request: (request) => {
-      log('Sending request %o.', request);
-
-      return handleRequest({
-        snapId: installedSnapId,
-        store,
-        executionService,
-        controllerMessenger,
-        runSaga,
-        handler: HandlerType.OnRpcRequest,
-        request,
-      });
-    },
-
+    request,
     onTransaction,
-    sendTransaction: onTransaction,
-
-    onSignature: async (
-      request: unknown,
-    ): Promise<SnapResponseWithInterface> => {
-      log('Requesting signature %o.', request);
-
-      const { origin: signatureOrigin, ...signature } = create(
-        request,
-        SignatureOptionsStruct,
-      );
-
-      const response = await handleRequest({
-        snapId: installedSnapId,
-        store,
-        executionService,
-        controllerMessenger,
-        runSaga,
-        handler: HandlerType.OnSignature,
-        request: {
-          method: '',
-          params: {
-            signature,
-            signatureOrigin,
-          },
-        },
-      });
-
-      assertIsResponseWithInterface(response);
-
-      return response;
-    },
-
+    sendTransaction,
+    onSignature,
     onCronjob,
-    runCronjob: onCronjob,
-
-    onHomePage: async (): Promise<SnapResponseWithInterface> => {
-      log('Rendering home page.');
-
-      const response = await handleRequest({
-        snapId: installedSnapId,
-        store,
-        executionService,
-        controllerMessenger,
-        runSaga,
-        handler: HandlerType.OnHomePage,
-        request: {
-          method: '',
-        },
-      });
-
-      assertIsResponseWithInterface(response);
-
-      return response;
-    },
-
-    mockJsonRpc(mock: JsonRpcMockOptions) {
-      log('Mocking JSON-RPC request %o.', mock);
-
-      const { method, result } = create(mock, JsonRpcMockOptionsStruct);
-      store.dispatch(addJsonRpcMock({ method, result }));
-
-      return {
-        unmock() {
-          log('Unmocking JSON-RPC request %o.', mock);
-
-          store.dispatch(removeJsonRpcMock(method));
-        },
-      };
-    },
-
+    runCronjob,
+    onHomePage,
+    mockJsonRpc,
     close: async () => {
       log('Closing execution service.');
       logInfo(
         'Calling `snap.close()` is deprecated, and will be removed in a future release. Snaps are now automatically closed when the test ends.',
       );
 
-      await executionService.terminateAllSnaps();
+      await close();
     },
   };
 }

packages/snaps-jest/src/index.ts

@@ -4,7 +4,6 @@ import './global';
 export { default, default as TestEnvironment } from './environment';
 export * from './helpers';
 export * from './options';
-export * from './types';
 
 export {
   assertCustomDialogHasNoFooter,
@@ -14,3 +13,29 @@ export {
   assertIsCustomDialog,
   assertIsPromptDialog,
 } from '@metamask/snaps-simulation';
+
+export type {
+  CronjobOptions,
+  DefaultSnapInterface,
+  DefaultSnapInterfaceWithFooter,
+  DefaultSnapInterfaceWithPartialFooter,
+  DefaultSnapInterfaceWithoutFooter,
+  FileOptions,
+  RequestOptions,
+  SignatureOptions,
+  Snap,
+  SnapAlertInterface,
+  SnapConfirmationInterface,
+  SnapHandlerInterface,
+  SnapInterface,
+  SnapInterfaceActions,
+  SnapOptions,
+  SnapPromptInterface,
+  SnapResponse,
+  SnapResponseType,
+  SnapResponseWithInterface,
+  SnapResponseWithoutInterface,
+  SnapRequest,
+  SnapRequestObject,
+  TransactionOptions,
+} from '@metamask/snaps-simulation';

packages/snaps-jest/src/matchers.ts

@@ -13,6 +13,7 @@ import type {
 } from '@metamask/snaps-sdk';
 import type { JSXElement } from '@metamask/snaps-sdk/jsx';
 import { isJSXElementUnsafe } from '@metamask/snaps-sdk/jsx';
+import type { SnapResponse } from '@metamask/snaps-simulation';
 import {
   InterfaceStruct,
   SnapResponseStruct,
@@ -35,8 +36,6 @@ import {
   RECEIVED_COLOR,
 } from 'jest-matcher-utils';
 
-import type { SnapResponse } from './types';
-
 /**
  * Ensure that the actual value is a response from the `request` function.
  *

packages/snaps-jest/src/test-utils/response.ts

@@ -1,6 +1,8 @@
 import type { JSXElement } from '@metamask/snaps-sdk/jsx';
-
-import type { SnapHandlerInterface, SnapResponse } from '../types';
+import type {
+  SnapHandlerInterface,
+  SnapResponse,
+} from '@metamask/snaps-simulation';
 
 /**
  * Get a mock response.
@@ -40,6 +42,7 @@ export function getMockInterfaceResponse(
     typeInField: jest.fn(),
     selectInDropdown: jest.fn(),
     selectFromRadioGroup: jest.fn(),
+    selectFromSelector: jest.fn(),
     uploadFile: jest.fn(),
   };
 }