@metamask/snaps-jest 4.0.0 → 5.0.0

package/CHANGELOG.md

@@ -6,6 +6,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [5.0.0]
+### Added
+- **BREAKING:** Implement testing framework using Node.js executor ([#1982](https://github.com/MetaMask/snaps/pull/1982), [#2118](https://github.com/MetaMask/snaps/pull/2118))
+  - The network mocking functionality was removed, but may be reintroduced in a future version.
+  - `mockJsonRpc` no longer returns a `Promise`.
+  - `runCronjob` was renamed to `onCronjob`, and `sendTransaction` was renamed to `onTransaction`.
+    - For backwards compatibility, the old methods are still available, but will be removed in a future version.
+- Add `onHomePage` support ([#2104](https://github.com/MetaMask/snaps/pull/2104))
+- Add `onSignature` support ([#2114](https://github.com/MetaMask/snaps/pull/2114))
+- Add `snap_getClientStatus` support ([#2159](https://github.com/MetaMask/snaps/pull/2159))
+
+### Changed
+- Bump several MetaMask dependencies ([#2101](https://github.com/MetaMask/snaps/pull/2101), [#2100](https://github.com/MetaMask/snaps/pull/2100), [#2129](https://github.com/MetaMask/snaps/pull/2129), [#2140](https://github.com/MetaMask/snaps/pull/2140), [#2141](https://github.com/MetaMask/snaps/pull/2141), [#2142](https://github.com/MetaMask/snaps/pull/2142))
+
+## [4.0.1]
+### Fixed
+- Fix coercing of address values in `sendTransaction` function ([#1970](https://github.com/MetaMask/snaps/pull/1970))
+
 ## [4.0.0]
 ### Changed
 - Use `@metamask/snaps-sdk` package ([#1930](https://github.com/MetaMask/snaps/pull/1930),
@@ -77,7 +95,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - The version of the package no longer needs to match the version of all other
     MetaMask Snaps packages.
 
-[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-jest@4.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-jest@5.0.0...HEAD
+[5.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-jest@4.0.1...@metamask/snaps-jest@5.0.0
+[4.0.1]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-jest@4.0.0...@metamask/snaps-jest@4.0.1
 [4.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-jest@3.1.0...@metamask/snaps-jest@4.0.0
 [3.1.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-jest@3.0.0...@metamask/snaps-jest@3.1.0
 [3.0.0]: https://github.com/MetaMask/snaps/compare/@metamask/snaps-jest@2.0.0...@metamask/snaps-jest@3.0.0

package/README.md

@@ -1,8 +1,7 @@
 # `@metamask/snaps-jest`
 
 A [Jest](https://jestjs.io/) preset for end-to-end testing MetaMask Snaps,
-including a Jest environment, and a set of Jest matchers. This package is
-currently experimental, and the API may change in the future.
+including a Jest environment, and a set of Jest matchers.
 
 - [Installation](#installation)
 - [Usage](#usage)
@@ -10,11 +9,12 @@ currently experimental, and the API may change in the future.
 - [API](#api)
   - [Install a snap](#install-a-snap)
   - [`snap.request`](#snaprequest)
-  - [`snap.sendTransaction`](#snapsendtransaction)
-  - [`snap.runCronjob`](#snapruncronjob)
+  - [`snap.onTransaction`](#snapontransaction)
+  - [`snap.onSignature`](#snaponsignature)
+  - [`snap.onCronjob`](#snaponcronjob)
+  - [`snap.onHomePage`](#snaponhomepage)
   - [Jest matchers](#jest-matchers)
   - [Interacting with user interfaces](#interacting-with-user-interfaces)
-  - [Network mocking](#network-mocking-snapmock)
 - [Options](#options)
 
 ## Installation
@@ -66,8 +66,8 @@ module.exports = {
 ### Install a snap
 
 `@metamask/snaps-jest` exposes a `installSnap` function that can be used to
-install a snap in the browser. It's recommended to use this function in each
-test, to ensure that each test starts with a clean slate.
+install a snap in the execution environment. It's recommended to use this
+function in each test, to ensure that each test starts with a clean slate.
 
 By default, if the built-in server is enabled, it will install the snap from
 the built-in server. Otherwise, you must specify a snap ID to install.
@@ -174,9 +174,9 @@ describe('MySnap', () => {
 });
 ```
 
-### `snap.sendTransaction`
+### `snap.onTransaction`
 
-The `sendTransaction` function can be used to send a transaction to the snap. It
+The `onTransaction` function can be used to send a transaction to the snap. It
 takes a single argument, which is an object with the following properties:
 
 - `origin`: The origin of the transaction.
@@ -204,8 +204,8 @@ import { panel, text } from '@metamask/snaps-sdk';
 
 describe('MySnap', () => {
   it('should do something', async () => {
-    const { sendTransaction } = await installSnap(/* optional snap ID */);
-    const response = await sendTransaction({
+    const { onTransaction } = await installSnap(/* optional snap ID */);
+    const response = await onTransaction({
       value: '0x0',
       data: '0x',
       gasLimit: '0x5208',
@@ -219,9 +219,43 @@ describe('MySnap', () => {
 });
 ```
 
-### `snap.runCronjob`
+### `snap.onSignature`
 
-The `runCronjob` function can be used to run a cronjob in the snap. It takes
+The `onSignature` function can be used to send a signature request to the snap. It
+takes a single argument, which is an object with the following properties:
+
+- `origin`: The origin of the signature request.
+- `from`: The address of the signer.
+- `data`: The data of the signature.
+- `signatureMethod`: The signature method being used in the request.
+
+All properties are optional, and have sensible defaults. The addresses are
+randomly generated by default. Most values can be specified as a hex string, or
+a decimal number.
+
+It returns an object with the user interface that was shown by the snap, in the
+[onSignature](https://docs.metamask.io/snaps/reference/exports/#onsignature)
+function.
+
+```js
+import { installSnap } from '@metamask/snaps-jest';
+import { panel, text } from '@metamask/snaps-sdk';
+
+describe('MySnap', () => {
+  it('should do something', async () => {
+    const { onSignature } = await installSnap(/* optional snap ID */);
+    const response = await onSignature();
+
+    expect(response).toRender(
+      panel([text('You are using the personal_sign method')]),
+    );
+  });
+});
+```
+
+### `snap.onCronjob`
+
+The `onCronjob` function can be used to run a cronjob in the snap. It takes
 a single argument, which is similar to a JSON-RPC request object. It returns
 a promise that resolves to the response from the
 [onCronjob](https://docs.metamask.io/snaps/reference/exports/#oncronjob)
@@ -236,8 +270,8 @@ import { installSnap } from '@metamask/snaps-jest';
 
 describe('MySnap', () => {
   it('should do something', async () => {
-    const { runCronjob } = await installSnap(/* optional snap ID */);
-    const response = await runCronjob({
+    const { onCronjob } = await installSnap(/* optional snap ID */);
+    const response = await onCronjob({
       method: 'foo',
       params: [],
     });
@@ -254,8 +288,8 @@ import { installSnap } from '@metamask/snaps-jest';
 
 describe('MySnap', () => {
   it('should do something', async () => {
-    const { runCronjob } = await installSnap(/* optional snap ID */);
-    const response = await runCronjob({
+    const { onCronjob } = await installSnap(/* optional snap ID */);
+    const response = await onCronjob({
       method: 'foo',
       params: [],
     });
@@ -266,21 +300,25 @@ describe('MySnap', () => {
 });
 ```
 
-### `snap.close`
+### `snap.onHomePage`
 
-The `close` function can be used to close the page that the test is running in.
-This is mainly useful for cleaning up after a test, and is not required. It can
-potentially speed up your tests, since it prevents too many pages from being
-open at the same time.
+The `onHomePage` function can be used to request the home page of the snap. It
+takes no arguments, and returns a promise that resolves to the response from the
+[onHomePage](https://docs.metamask.io/snaps/reference/entry-points/#onhomepage)
+function.
 
 ```js
 import { installSnap } from '@metamask/snaps-jest';
 
 describe('MySnap', () => {
   it('should do something', async () => {
-    const { close } = await installSnap(/* optional snap ID */);
-    // ...
-    await close();
+    const { onHomePage } = await installSnap(/* optional snap ID */);
+    const response = await onHomePage({
+      method: 'foo',
+      params: [],
+    });
+
+    expect(response).toRender(/* ... */);
   });
 });
 ```
@@ -300,8 +338,9 @@ assert that a response from a snap matches an expected value:
 - `toRender(expectedInterface)`: Check if a snap rendered an interface. This is
   useful for testing the UI of a snap, either for a
   [`snap_dialog`](https://docs.metamask.io/snaps/reference/rpc-api/#snap_dialog),
-  or a UI rendered by
-  [the transaction insights API](https://docs.metamask.io/snaps/reference/exports/#ontransaction).
+  UI rendered by
+  [the transaction insights API](https://docs.metamask.io/snaps/reference/exports/#ontransaction) or
+  [the signature insights API](https://docs.metamask.io/snaps/reference/exports/#onsignature).
 
 ### Interacting with user interfaces
 
@@ -345,59 +384,6 @@ describe('MySnap', () => {
 });
 ```
 
-### Network mocking (`snap.mock`)
-
-`@metamask/snaps-jest` includes basic network mocking functionality. This can
-be used to mock the response of any network request made by the snap through
-the `endowment:network-access` functionality.
-
-The mock function takes a single argument, which is an object with the
-following properties:
-
-- `url` (`string | RegExp`): The URL of the request. This can be a string, or a
-  regular expression.
-- `partial` (`boolean`): If enabled, the request will be mocked if the URL
-  starts with the given URL. This option is ignored if a RegExp is provided to
-  the `url` option. Defaults to `false`.
-- `response` (`object`): An object with the response.
-  - `status` (`number`): The status code of the response. Defaults to `200`.
-  - `body` (`string`): The body of the response. Defaults to an empty string.
-  - `headers` (`object`): An object with the headers of the response. By
-    default, this will use headers that enable CORS.
-  - `contentType` (`string`): The content type of the response. Defaults to
-    `text/plain`.
-
-Except for the `url` option, all options are optional.
-
-#### Unmocking (`mock.unmock`)
-
-The mock function returns an object with an `unmock` function that can be
-used to remove the mock. Mocking happens on a per-snap-install basis. If the
-mock is not removed, it will remain active for the rest of the snap
-installation, so it does not affect other tests with a fresh snap installation.
-
-#### Example
-
-```js
-import { installSnap } from '@metamask/snaps-jest';
-
-describe('MySnap', () => {
-  it('should do something', async () => {
-    const { mock, request } = await installSnap(/* optional snap ID */);
-
-    const { unmock } = mock({
-      url: 'https://example.com',
-      status: 200,
-      body: 'Hello, world!',
-    });
-
-    // ...
-
-    unmock();
-  });
-});
-```
-
 ## Options
 
 You can pass options to the test environment by adding a
@@ -414,44 +400,6 @@ module.exports = {
 
 All options are optional, and have sensible defaults.
 
-### `keepAlive`
-
-- Type: `boolean`
-- Default: `false`
-
-Whether to keep the Jest environment running after the tests have finished. This
-is useful for debugging, but should not be used in CI environments: When this is
-enabled, the `jest` process will not exit on its own, and will need to be
-manually killed (e.g., with <kbd>Ctrl</kbd> + <kbd>C</kbd>).
-
-#### Example
-
-```js
-module.exports = {
-  preset: '@metamask/snaps-jest',
-  testEnvironmentOptions: {
-    keepAlive: true,
-  },
-};
-```
-
-### `browser`
-
-- Type: `object`
-
-Options for the browser that is used to run the tests.
-
-#### `browser.headless`
-
-- Type: `boolean`
-- Default: `true`
-
-Whether to run the browser in headless mode. By default, it will be enabled. If
-you want to see the browser window while the tests are running, you can disable
-this option. Note that this will require you to have a graphical environment
-available, so it is not recommended for CI environments, but can be useful for
-debugging in conjunction with the `keepAlive` option.
-
 ### `server`
 
 - Type: `object`
@@ -524,64 +472,3 @@ module.exports = {
   },
 };
 ```
-
-##### Example
-
-```js
-module.exports = {
-  preset: '@metamask/snaps-jest',
-  testEnvironmentOptions: {
-    browser: {
-      headless: false,
-    },
-  },
-};
-```
-
-### `executionEnvironmentUrl`
-
-- Type: `string`
-
-The URL of the execution environment to use for testing. This is the URL that
-will be loaded by the Snaps Simulator in the tests. By default, it will use the
-URL of the built-in HTTP server that is included with this package.
-
-> **Note**: This option is intended for advanced use cases. In most cases, you
-> should not need to change this option.
-
-See also: [`@metamask/snaps-execution-environments`](../snaps-execution-environments/README.md).
-
-#### Example
-
-```js
-module.exports = {
-  preset: '@metamask/snaps-jest',
-  testEnvironmentOptions: {
-    executionEnvironmentUrl: 'http://localhost:8080',
-  },
-};
-```
-
-### `simulatorUrl`
-
-- Type: `string`
-
-The URL of the simulator to use for testing. This is the URL that will be
-loaded in the browser when running tests. By default, it will use the URL of
-the built-in HTTP server that is included with this package.
-
-> **Note**: This option is intended for advanced use cases. In most cases, you
-> should not need to change this option.
-
-See also: [`@metamask/snaps-simulator`](../snaps-simulator/README.md).
-
-#### Example
-
-```js
-module.exports = {
-  preset: '@metamask/snaps-jest',
-  testEnvironmentOptions: {
-    simulatorUrl: 'http://localhost:8081',
-  },
-};
-```

package/dist/cjs/environment.js

@@ -18,7 +18,6 @@ _export(exports, {
 });
 const _utils = require("@metamask/utils");
 const _jestenvironmentnode = /*#__PURE__*/ _interop_require_default(require("jest-environment-node"));
-const _webdriverio = require("webdriverio");
 const _internals = require("./internals");
 const _options = require("./options");
 function _check_private_redeclaration(obj, privateCollection) {
@@ -61,26 +60,13 @@ function _class_private_field_set(receiver, privateMap, value) {
     _class_apply_descriptor_set(receiver, descriptor, value);
     return value;
 }
-function _define_property(obj, key, value) {
-    if (key in obj) {
-        Object.defineProperty(obj, key, {
-            value: value,
-            enumerable: true,
-            configurable: true,
-            writable: true
-        });
-    } else {
-        obj[key] = value;
-    }
-    return obj;
-}
 function _interop_require_default(obj) {
     return obj && obj.__esModule ? obj : {
         default: obj
     };
 }
 /* eslint-enable */ const log = (0, _utils.createModuleLogger)(_internals.rootLogger, 'environment');
-var _options1 = /*#__PURE__*/ new WeakMap(), _server = /*#__PURE__*/ new WeakMap();
+var _options1 = /*#__PURE__*/ new WeakMap(), _server = /*#__PURE__*/ new WeakMap(), _instance = /*#__PURE__*/ new WeakMap();
 class SnapsEnvironment extends _jestenvironmentnode.default {
     /**
    * Set up the environment. This starts the built-in HTTP server, and creates a
@@ -91,48 +77,33 @@ class SnapsEnvironment extends _jestenvironmentnode.default {
             log('Starting server.');
             _class_private_field_set(this, _server, await (0, _internals.startServer)(_class_private_field_get(this, _options1).server));
         }
-        const args = [];
-        if (_class_private_field_get(this, _options1).browser.headless) {
-            args.push('--headless', '--disable-gpu');
-        }
-        log('Starting browser.');
-        this.browser = await (0, _webdriverio.remote)({
-            logLevel: 'error',
-            capabilities: {
-                browserName: 'chrome',
-                // eslint-disable-next-line @typescript-eslint/naming-convention
-                'goog:chromeOptions': {
-                    args
-                }
-            }
-        });
-        this.global.browser = this.browser;
         this.global.snapsEnvironment = this;
     }
     /**
    * Tear down the environment. This closes the browser, and stops the built-in
    * HTTP server.
    */ async teardown() {
-        if (_class_private_field_get(this, _options1).keepAlive) {
-            log('Not tearing down environment because keepAlive is enabled.');
-            return;
-        }
-        log('Closing browser, and stopping server.');
-        await this.browser?.deleteSession();
+        await _class_private_field_get(this, _instance)?.executionService.terminateAllSnaps();
         _class_private_field_get(this, _server)?.close();
         await super.teardown();
     }
     /**
-   * Get the URL to the simulator, including the environment URL.
+   * Install a Snap in the environment. This will terminate any previously
+   * installed Snaps, and run the Snap code in a new execution service.
    *
-   * @returns The simulator URL.
-   * @throws If the server is not running.
-   */ get url() {
-        (0, _utils.assert)(_class_private_field_get(this, _server), 'Server is not running.');
-        const { port } = _class_private_field_get(this, _server).address();
-        const simulatorUrl = _class_private_field_get(this, _options1).simulatorUrl ?? `http://localhost:${port}/simulator/`;
-        const executionEnvironmentUrl = _class_private_field_get(this, _options1).executionEnvironmentUrl ?? `http://localhost:${port}/environment/`;
-        return `${simulatorUrl}?environment=${encodeURIComponent(executionEnvironmentUrl)}`;
+   * @param snapId - The ID of the Snap to install.
+   * @param options - The options to use when installing the Snap.
+   * @param options.executionService - The execution service to use.
+   * @param options.executionServiceOptions - The options to use when creating the
+   * execution service, if any. This should only include options specific to the
+   * provided execution service.
+   * @param options.options - The simulation options.
+   * @template Service - The type of the execution service.
+   * @returns The installed Snap.
+   */ async installSnap(snapId = this.snapId, options = {}) {
+        await _class_private_field_get(this, _instance)?.executionService.terminateAllSnaps();
+        _class_private_field_set(this, _instance, await (0, _internals.handleInstallSnap)(snapId, options));
+        return _class_private_field_get(this, _instance);
     }
     /**
    * Get the snap ID for the current environment, which is used if no snap ID is
@@ -147,48 +118,12 @@ class SnapsEnvironment extends _jestenvironmentnode.default {
         return `local:http://localhost:${port}`;
     }
     /**
-   * Create a new page, and attach logging handlers.
-   *
-   * @param url - The page URL. Defaults to the specified Snaps Simulator URL,
-   * or the default simulator URL if none is specified.
-   * @param timeout - The page timeout, in milliseconds.
-   * @returns The new page.
-   */ async createPage(url = this.url, timeout = 10000) {
-        const puppeteer = await this.browser.getPuppeteer();
-        const page = await puppeteer.newPage();
-        page.setDefaultTimeout(timeout);
-        page.setDefaultNavigationTimeout(timeout);
-        // Give the page permission to show notifications. This is required for
-        // testing `snap_notify`.
-        await page.browserContext().overridePermissions(url, [
-            'notifications'
-        ]);
-        // `networkidle0` is used to ensure that the page is fully loaded. This
-        // makes it wait for no requests to be made, which guarantees that the page
-        // is ready.
-        await page.goto(url, {
-            waitUntil: 'networkidle0'
-        });
-        const browserLog = (0, _utils.createModuleLogger)(_internals.rootLogger, 'browser');
-        page// This is fired when the page calls `console.log` or similar.
-        .on('console', (message)=>{
-            browserLog(`[${message.type()}] ${message.text()}`);
-        })// This is fired when the page throws an error.
-        .on('pageerror', ({ message })=>{
-            browserLog(`[page error] ${message}`);
-        });
-        return page;
-    }
-    /**
    * Constructor.
    *
    * @param options - The environment options.
    * @param context - The environment context.
    */ constructor(options, context){
         super(options, context);
-        // `browser` is always set in the environment setup function. To avoid needing
-        // to check for `undefined` everywhere, we use a type assertion here.
-        _define_property(this, "browser", void 0);
         _class_private_field_init(this, _options1, {
             writable: true,
             value: void 0
@@ -197,6 +132,10 @@ class SnapsEnvironment extends _jestenvironmentnode.default {
             writable: true,
             value: void 0
         });
+        _class_private_field_init(this, _instance, {
+            writable: true,
+            value: void 0
+        });
         _class_private_field_set(this, _options1, (0, _options.getOptions)(options.projectConfig.testEnvironmentOptions));
     }
 }

package/dist/cjs/environment.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/environment.ts"],"sourcesContent":["import type {\n  EnvironmentContext,\n  JestEnvironmentConfig,\n} from '@jest/environment';\nimport { assert, createModuleLogger } from '@metamask/utils';\nimport type { Server } from 'http';\nimport NodeEnvironment from 'jest-environment-node';\nimport type { AddressInfo } from 'net';\nimport type { Browser } from 'puppeteer';\nimport { remote } from 'webdriverio';\n\nimport { rootLogger, startServer } from './internals';\nimport type { SnapsEnvironmentOptions } from './options';\nimport { getOptions } from './options';\n\n/* eslint-disable */\ndeclare global {\n  const browser: WebdriverIO.Browser;\n  const snapsEnvironment: SnapsEnvironment;\n}\n/* eslint-enable */\n\nconst log = createModuleLogger(rootLogger, 'environment');\n\nexport class SnapsEnvironment extends NodeEnvironment {\n  // `browser` is always set in the environment setup function. To avoid needing\n  // to check for `undefined` everywhere, we use a type assertion here.\n  browser!: WebdriverIO.Browser;\n\n  #options: SnapsEnvironmentOptions;\n\n  #server: Server | undefined;\n\n  /**\n   * Constructor.\n   *\n   * @param options - The environment options.\n   * @param context - The environment context.\n   */\n  constructor(options: JestEnvironmentConfig, context: EnvironmentContext) {\n    super(options, context);\n    this.#options = getOptions(options.projectConfig.testEnvironmentOptions);\n  }\n\n  /**\n   * Set up the environment. This starts the built-in HTTP server, and creates a\n   * new browser instance.\n   */\n  async setup() {\n    await super.setup();\n\n    if (this.#options.server.enabled) {\n      log('Starting server.');\n      this.#server = await startServer(this.#options.server);\n    }\n\n    const args = [];\n    if (this.#options.browser.headless) {\n      args.push('--headless', '--disable-gpu');\n    }\n\n    log('Starting browser.');\n    this.browser = await remote({\n      logLevel: 'error',\n      capabilities: {\n        browserName: 'chrome',\n        // eslint-disable-next-line @typescript-eslint/naming-convention\n        'goog:chromeOptions': {\n          args,\n        },\n      },\n    });\n\n    this.global.browser = this.browser;\n    this.global.snapsEnvironment = this;\n  }\n\n  /**\n   * Tear down the environment. This closes the browser, and stops the built-in\n   * HTTP server.\n   */\n  async teardown() {\n    if (this.#options.keepAlive) {\n      log('Not tearing down environment because keepAlive is enabled.');\n      return;\n    }\n\n    log('Closing browser, and stopping server.');\n    await this.browser?.deleteSession();\n    this.#server?.close();\n\n    await super.teardown();\n  }\n\n  /**\n   * Get the URL to the simulator, including the environment URL.\n   *\n   * @returns The simulator URL.\n   * @throws If the server is not running.\n   */\n  get url() {\n    assert(this.#server, 'Server is not running.');\n\n    const { port } = this.#server.address() as AddressInfo;\n    const simulatorUrl =\n      this.#options.simulatorUrl ?? `http://localhost:${port}/simulator/`;\n\n    const executionEnvironmentUrl =\n      this.#options.executionEnvironmentUrl ??\n      `http://localhost:${port}/environment/`;\n\n    return `${simulatorUrl}?environment=${encodeURIComponent(\n      executionEnvironmentUrl,\n    )}`;\n  }\n\n  /**\n   * Get the snap ID for the current environment, which is used if no snap ID is\n   * passed to {@link installSnap}. This assumes that the built-in server is\n   * running.\n   *\n   * @returns The snap ID.\n   * @throws If the server is not running.\n   */\n  get snapId() {\n    assert(\n      this.#server,\n      'You must specify a snap ID, because the built-in server is not running.',\n    );\n\n    const { port } = this.#server.address() as AddressInfo;\n    return `local:http://localhost:${port}`;\n  }\n\n  /**\n   * Create a new page, and attach logging handlers.\n   *\n   * @param url - The page URL. Defaults to the specified Snaps Simulator URL,\n   * or the default simulator URL if none is specified.\n   * @param timeout - The page timeout, in milliseconds.\n   * @returns The new page.\n   */\n  async createPage(url: string = this.url, timeout = 10000) {\n    const puppeteer = (await this.browser.getPuppeteer()) as unknown as Browser;\n    const page = await puppeteer.newPage();\n\n    page.setDefaultTimeout(timeout);\n    page.setDefaultNavigationTimeout(timeout);\n\n    // Give the page permission to show notifications. This is required for\n    // testing `snap_notify`.\n    await page.browserContext().overridePermissions(url, ['notifications']);\n\n    // `networkidle0` is used to ensure that the page is fully loaded. This\n    // makes it wait for no requests to be made, which guarantees that the page\n    // is ready.\n    await page.goto(url, { waitUntil: 'networkidle0' });\n\n    const browserLog = createModuleLogger(rootLogger, 'browser');\n\n    page\n      // This is fired when the page calls `console.log` or similar.\n      .on('console', (message) => {\n        browserLog(`[${message.type()}] ${message.text()}`);\n      })\n\n      // This is fired when the page throws an error.\n      .on('pageerror', ({ message }) => {\n        browserLog(`[page error] ${message}`);\n      });\n\n    return page;\n  }\n}\n\nexport default SnapsEnvironment;\n"],"names":["SnapsEnvironment","log","createModuleLogger","rootLogger","NodeEnvironment","setup","options","server","enabled","startServer","args","browser","headless","push","remote","logLevel","capabilities","browserName","global","snapsEnvironment","teardown","keepAlive","deleteSession","close","url","assert","port","address","simulatorUrl","executionEnvironmentUrl","encodeURIComponent","snapId","createPage","timeout","puppeteer","getPuppeteer","page","newPage","setDefaultTimeout","setDefaultNavigationTimeout","browserContext","overridePermissions","goto","waitUntil","browserLog","on","message","type","text","constructor","context","getOptions","projectConfig","testEnvironmentOptions"],"mappings":";;;;;;;;;;;IAwBaA,gBAAgB;eAAhBA;;IAuJb,OAAgC;eAAhC;;;uBA3K2C;4EAEf;6BAGL;2BAEiB;yBAEb;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAO3B,iBAAiB,GAEjB,MAAMC,MAAMC,IAAAA,yBAAkB,EAACC,qBAAU,EAAE;IAOzC,yCAEA;AAPK,MAAMH,yBAAyBI,4BAAe;IAoBnD;;;GAGC,GACD,MAAMC,QAAQ;QACZ,MAAM,KAAK,CAACA;QAEZ,IAAI,yBAAA,IAAI,EAAEC,WAAQC,MAAM,CAACC,OAAO,EAAE;YAChCP,IAAI;2CACEM,SAAS,MAAME,IAAAA,sBAAW,EAAC,yBAAA,IAAI,EAAEH,WAAQC,MAAM;QACvD;QAEA,MAAMG,OAAO,EAAE;QACf,IAAI,yBAAA,IAAI,EAAEJ,WAAQK,OAAO,CAACC,QAAQ,EAAE;YAClCF,KAAKG,IAAI,CAAC,cAAc;QAC1B;QAEAZ,IAAI;QACJ,IAAI,CAACU,OAAO,GAAG,MAAMG,IAAAA,mBAAM,EAAC;YAC1BC,UAAU;YACVC,cAAc;gBACZC,aAAa;gBACb,gEAAgE;gBAChE,sBAAsB;oBACpBP;gBACF;YACF;QACF;QAEA,IAAI,CAACQ,MAAM,CAACP,OAAO,GAAG,IAAI,CAACA,OAAO;QAClC,IAAI,CAACO,MAAM,CAACC,gBAAgB,GAAG,IAAI;IACrC;IAEA;;;GAGC,GACD,MAAMC,WAAW;QACf,IAAI,yBAAA,IAAI,EAAEd,WAAQe,SAAS,EAAE;YAC3BpB,IAAI;YACJ;QACF;QAEAA,IAAI;QACJ,MAAM,IAAI,CAACU,OAAO,EAAEW;iCACpB,IAAI,EAAEf,UAAQgB;QAEd,MAAM,KAAK,CAACH;IACd;IAEA;;;;;GAKC,GACD,IAAII,MAAM;QACRC,IAAAA,aAAM,2BAAC,IAAI,EAAElB,UAAQ;QAErB,MAAM,EAAEmB,IAAI,EAAE,GAAG,yBAAA,IAAI,EAAEnB,SAAOoB,OAAO;QACrC,MAAMC,eACJ,yBAAA,IAAI,EAAEtB,WAAQsB,YAAY,IAAI,CAAC,iBAAiB,EAAEF,KAAK,WAAW,CAAC;QAErE,MAAMG,0BACJ,yBAAA,IAAI,EAAEvB,WAAQuB,uBAAuB,IACrC,CAAC,iBAAiB,EAAEH,KAAK,aAAa,CAAC;QAEzC,OAAO,CAAC,EAAEE,aAAa,aAAa,EAAEE,mBACpCD,yBACA,CAAC;IACL;IAEA;;;;;;;GAOC,GACD,IAAIE,SAAS;QACXN,IAAAA,aAAM,2BACJ,IAAI,EAAElB,UACN;QAGF,MAAM,EAAEmB,IAAI,EAAE,GAAG,yBAAA,IAAI,EAAEnB,SAAOoB,OAAO;QACrC,OAAO,CAAC,uBAAuB,EAAED,KAAK,CAAC;IACzC;IAEA;;;;;;;GAOC,GACD,MAAMM,WAAWR,MAAc,IAAI,CAACA,GAAG,EAAES,UAAU,KAAK,EAAE;QACxD,MAAMC,YAAa,MAAM,IAAI,CAACvB,OAAO,CAACwB,YAAY;QAClD,MAAMC,OAAO,MAAMF,UAAUG,OAAO;QAEpCD,KAAKE,iBAAiB,CAACL;QACvBG,KAAKG,2BAA2B,CAACN;QAEjC,uEAAuE;QACvE,yBAAyB;QACzB,MAAMG,KAAKI,cAAc,GAAGC,mBAAmB,CAACjB,KAAK;YAAC;SAAgB;QAEtE,uEAAuE;QACvE,2EAA2E;QAC3E,YAAY;QACZ,MAAMY,KAAKM,IAAI,CAAClB,KAAK;YAAEmB,WAAW;QAAe;QAEjD,MAAMC,aAAa1C,IAAAA,yBAAkB,EAACC,qBAAU,EAAE;QAElDiC,IACE,8DAA8D;SAC7DS,EAAE,CAAC,WAAW,CAACC;YACdF,WAAW,CAAC,CAAC,EAAEE,QAAQC,IAAI,GAAG,EAAE,EAAED,QAAQE,IAAI,GAAG,CAAC;QACpD,EAEA,+CAA+C;SAC9CH,EAAE,CAAC,aAAa,CAAC,EAAEC,OAAO,EAAE;YAC3BF,WAAW,CAAC,aAAa,EAAEE,QAAQ,CAAC;QACtC;QAEF,OAAOV;IACT;IA3IA;;;;;GAKC,GACDa,YAAY3C,OAA8B,EAAE4C,OAA2B,CAAE;QACvE,KAAK,CAAC5C,SAAS4C;QAfjB,8EAA8E;QAC9E,qEAAqE;QACrEvC,uBAAAA,WAAAA,KAAAA;QAEA,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;uCAUQL,WAAU6C,IAAAA,mBAAU,EAAC7C,QAAQ8C,aAAa,CAACC,sBAAsB;IACzE;AAmIF;MAEA,WAAerD"}
+{"version":3,"sources":["../../src/environment.ts"],"sourcesContent":["import type {\n  EnvironmentContext,\n  JestEnvironmentConfig,\n} from '@jest/environment';\nimport type { AbstractExecutionService } from '@metamask/snaps-controllers';\nimport type { SnapId } from '@metamask/snaps-sdk';\nimport { assert, createModuleLogger } from '@metamask/utils';\nimport type { Server } from 'http';\nimport NodeEnvironment from 'jest-environment-node';\nimport type { AddressInfo } from 'net';\n\nimport type { InstalledSnap, InstallSnapOptions } from './internals';\nimport { handleInstallSnap, rootLogger, startServer } from './internals';\nimport type { SnapsEnvironmentOptions } from './options';\nimport { getOptions } from './options';\n\n/* eslint-disable */\ndeclare global {\n  const snapsEnvironment: SnapsEnvironment;\n}\n/* eslint-enable */\n\nconst log = createModuleLogger(rootLogger, 'environment');\n\nexport class SnapsEnvironment extends NodeEnvironment {\n  #options: SnapsEnvironmentOptions;\n\n  #server: Server | undefined;\n\n  #instance: InstalledSnap | undefined;\n\n  /**\n   * Constructor.\n   *\n   * @param options - The environment options.\n   * @param context - The environment context.\n   */\n  constructor(options: JestEnvironmentConfig, context: EnvironmentContext) {\n    super(options, context);\n    this.#options = getOptions(options.projectConfig.testEnvironmentOptions);\n  }\n\n  /**\n   * Set up the environment. This starts the built-in HTTP server, and creates a\n   * new browser instance.\n   */\n  async setup() {\n    await super.setup();\n\n    if (this.#options.server.enabled) {\n      log('Starting server.');\n      this.#server = await startServer(this.#options.server);\n    }\n\n    this.global.snapsEnvironment = this;\n  }\n\n  /**\n   * Tear down the environment. This closes the browser, and stops the built-in\n   * HTTP server.\n   */\n  async teardown() {\n    await this.#instance?.executionService.terminateAllSnaps();\n    this.#server?.close();\n    await super.teardown();\n  }\n\n  /**\n   * Install a Snap in the environment. This will terminate any previously\n   * installed Snaps, and run the Snap code in a new execution service.\n   *\n   * @param snapId - The ID of the Snap to install.\n   * @param options - The options to use when installing the Snap.\n   * @param options.executionService - The execution service to use.\n   * @param options.executionServiceOptions - The options to use when creating the\n   * execution service, if any. This should only include options specific to the\n   * provided execution service.\n   * @param options.options - The simulation options.\n   * @template Service - The type of the execution service.\n   * @returns The installed Snap.\n   */\n  async installSnap<\n    Service extends new (...args: any[]) => InstanceType<\n      typeof AbstractExecutionService\n    >,\n  >(\n    snapId: string = this.snapId,\n    options: Partial<InstallSnapOptions<Service>> = {},\n  ) {\n    await this.#instance?.executionService.terminateAllSnaps();\n    this.#instance = await handleInstallSnap(snapId as SnapId, options);\n    return this.#instance;\n  }\n\n  /**\n   * Get the snap ID for the current environment, which is used if no snap ID is\n   * passed to {@link installSnap}. This assumes that the built-in server is\n   * running.\n   *\n   * @returns The snap ID.\n   * @throws If the server is not running.\n   */\n  get snapId() {\n    assert(\n      this.#server,\n      'You must specify a snap ID, because the built-in server is not running.',\n    );\n\n    const { port } = this.#server.address() as AddressInfo;\n    return `local:http://localhost:${port}`;\n  }\n}\n\nexport default SnapsEnvironment;\n"],"names":["SnapsEnvironment","log","createModuleLogger","rootLogger","NodeEnvironment","setup","options","server","enabled","startServer","global","snapsEnvironment","teardown","instance","executionService","terminateAllSnaps","close","installSnap","snapId","handleInstallSnap","assert","port","address","constructor","context","getOptions","projectConfig","testEnvironmentOptions"],"mappings":";;;;;;;;;;;IAwBaA,gBAAgB;eAAhBA;;IAyFb,OAAgC;eAAhC;;;uBA3G2C;4EAEf;2BAI+B;yBAEhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAM3B,iBAAiB,GAEjB,MAAMC,MAAMC,IAAAA,yBAAkB,EAACC,qBAAU,EAAE;IAGzC,yCAEA,uCAEA;AALK,MAAMH,yBAAyBI,4BAAe;IAkBnD;;;GAGC,GACD,MAAMC,QAAQ;QACZ,MAAM,KAAK,CAACA;QAEZ,IAAI,yBAAA,IAAI,EAAEC,WAAQC,MAAM,CAACC,OAAO,EAAE;YAChCP,IAAI;2CACEM,SAAS,MAAME,IAAAA,sBAAW,EAAC,yBAAA,IAAI,EAAEH,WAAQC,MAAM;QACvD;QAEA,IAAI,CAACG,MAAM,CAACC,gBAAgB,GAAG,IAAI;IACrC;IAEA;;;GAGC,GACD,MAAMC,WAAW;QACf,+BAAM,IAAI,EAAEC,YAAUC,iBAAiBC;iCACvC,IAAI,EAAER,UAAQS;QACd,MAAM,KAAK,CAACJ;IACd;IAEA;;;;;;;;;;;;;GAaC,GACD,MAAMK,YAKJC,SAAiB,IAAI,CAACA,MAAM,EAC5BZ,UAAgD,CAAC,CAAC,EAClD;QACA,+BAAM,IAAI,EAAEO,YAAUC,iBAAiBC;uCACjCF,WAAW,MAAMM,IAAAA,4BAAiB,EAACD,QAAkBZ;QAC3D,gCAAO,IAAI,EAAEO;IACf;IAEA;;;;;;;GAOC,GACD,IAAIK,SAAS;QACXE,IAAAA,aAAM,2BACJ,IAAI,EAAEb,UACN;QAGF,MAAM,EAAEc,IAAI,EAAE,GAAG,yBAAA,IAAI,EAAEd,SAAOe,OAAO;QACrC,OAAO,CAAC,uBAAuB,EAAED,KAAK,CAAC;IACzC;IA/EA;;;;;GAKC,GACDE,YAAYjB,OAA8B,EAAEkB,OAA2B,CAAE;QACvE,KAAK,CAAClB,SAASkB;QAbjB,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;QAEA,gCAAA;;mBAAA,KAAA;;uCAUQlB,WAAUmB,IAAAA,mBAAU,EAACnB,QAAQoB,aAAa,CAACC,sBAAsB;IACzE;AAuEF;MAEA,WAAe3B"}