Update CLI tests

Mrtenz · Mrtenz · commit f2994dea50e3 · 2025-04-09T11:12:56.000+02:00
diff --git a/packages/snaps-cli/package.json b/packages/snaps-cli/package.json
@@ -101,7 +101,6 @@
     "querystring-es3": "^0.2.1",
     "readable-stream": "^3.6.2",
     "semver": "^7.5.4",
-    "serve-handler": "^6.1.5",
     "stream-browserify": "^3.0.0",
     "stream-http": "^3.2.0",
     "string_decoder": "^1.3.0",
@@ -127,7 +126,6 @@
     "@types/express": "^5.0.1",
     "@types/jest": "^27.5.1",
     "@types/node": "18.14.2",
-    "@types/serve-handler": "^6.1.0",
     "@types/yargs": "^17.0.24",
     "cross-fetch": "^3.1.5",
     "deepmerge": "^4.2.2",
diff --git a/packages/snaps-cli/src/commands/sandbox/index.test.ts b/packages/snaps-cli/src/commands/sandbox/index.test.ts
@@ -0,0 +1,19 @@
+import command from '.';
+import { sandboxHandler } from './sandbox';
+import { getMockConfig } from '../../test-utils';
+import type { YargsArgs } from '../../types/yargs';
+
+jest.mock('./sandbox');
+
+const getMockArgv = () => {
+  return {
+    context: { config: getMockConfig('webpack') },
+  } as unknown as YargsArgs;
+};
+
+describe('sandbox command', () => {
+  it('calls the `sandboxHandler` function', async () => {
+    await command.handler(getMockArgv());
+    expect(sandboxHandler).toHaveBeenCalled();
+  });
+});
diff --git a/packages/snaps-cli/src/commands/sandbox/sandbox.test.ts b/packages/snaps-cli/src/commands/sandbox/sandbox.test.ts
@@ -0,0 +1,61 @@
+import { getMockConfig } from '@metamask/snaps-cli/test-utils';
+import { DEFAULT_SNAP_BUNDLE } from '@metamask/snaps-utils/test-utils';
+import fs from 'fs';
+
+import { sandboxHandler } from './sandbox';
+import { build } from '../build';
+
+jest.mock('fs');
+jest.mock('./server', () => ({
+  startSandbox: jest.fn().mockResolvedValue({ port: 8080 }),
+}));
+jest.mock('../build/implementation');
+jest.mock('../eval');
+
+describe('sandboxHandler', () => {
+  it('builds the Snap if the build option is `true`', async () => {
+    await fs.promises.writeFile('/input.js', DEFAULT_SNAP_BUNDLE);
+
+    jest.spyOn(console, 'log').mockImplementation();
+    const config = getMockConfig('webpack', {
+      input: '/input.js',
+      output: {
+        path: '/foo',
+        filename: 'output.js',
+      },
+    });
+
+    await sandboxHandler(config, {});
+
+    expect(process.exitCode).not.toBe(1);
+    expect(build).toHaveBeenCalledWith(config, {
+      analyze: false,
+      evaluate: false,
+      spinner: expect.any(Object),
+    });
+
+    expect(console.log).toHaveBeenCalledWith(
+      expect.stringContaining('Sandbox running at http://localhost:8080.'),
+    );
+  });
+
+  it('does not build the Snap if the build option is `false`', async () => {
+    jest.spyOn(console, 'log').mockImplementation();
+    const config = getMockConfig('webpack', {
+      input: '/input.js',
+      output: {
+        path: '/foo',
+        filename: 'output.js',
+      },
+    });
+
+    await sandboxHandler(config, { build: false });
+
+    expect(process.exitCode).not.toBe(1);
+    expect(build).not.toHaveBeenCalled();
+
+    expect(console.log).toHaveBeenCalledWith(
+      expect.stringContaining('Sandbox running at http://localhost:8080.'),
+    );
+  });
+});
diff --git a/packages/snaps-cli/src/commands/sandbox/server.test.ts b/packages/snaps-cli/src/commands/sandbox/server.test.ts
@@ -0,0 +1,42 @@
+import { getMockConfig } from '@metamask/snaps-cli/test-utils';
+import fs from 'fs';
+import { dirname } from 'path';
+
+import { startSandbox } from './server';
+
+jest.mock('fs');
+
+describe('startSandbox', () => {
+  beforeAll(async () => {
+    const sandboxPath = require.resolve(
+      '@metamask/snaps-sandbox/dist/index.html',
+    );
+
+    await fs.promises.mkdir(dirname(sandboxPath), { recursive: true });
+    await fs.promises.writeFile(
+      sandboxPath,
+      '<html><body>Snaps Sandbox</body></html>',
+    );
+  });
+
+  it('starts the sandbox server', async () => {
+    const config = getMockConfig('webpack', {
+      server: {
+        port: 8080,
+      },
+    });
+
+    const { port, close } = await startSandbox(config);
+
+    expect(port).toBe(8080);
+    expect(close).toBeInstanceOf(Function);
+
+    const response = await fetch('http://localhost:8080');
+    expect(response.status).toBe(200);
+
+    const text = await response.text();
+    expect(text).toBe('<html><body>Snaps Sandbox</body></html>');
+
+    await close();
+  });
+});
diff --git a/packages/snaps-cli/src/webpack/server.test.ts b/packages/snaps-cli/src/webpack/server.test.ts
@@ -1,8 +1,7 @@
 import { getSnapManifest } from '@metamask/snaps-utils/test-utils';
 import fetch from 'cross-fetch';
 import { promises as fs } from 'fs';
-import http, { IncomingMessage, Server, ServerResponse } from 'http';
-import serveMiddleware from 'serve-handler';
+import { Server } from 'http';
 
 import { getAllowedPaths, getServer } from './server';
 import { getMockConfig } from '../test-utils';
@@ -201,32 +200,6 @@ describe('getServer', () => {
     await close();
   });
 
-  it('calls the serve middleware for allowed files', async () => {
-    const config = getMockConfig('webpack', {
-      input: 'src/index.js',
-      server: {
-        root: '/foo',
-        port: 0,
-      },
-    });
-
-    const server = getServer(config);
-    const { port, close } = await server.listen();
-
-    const response = await fetch(`http://localhost:${port}/snap.manifest.json`);
-
-    expect(response.status).toBe(200);
-    expect(await response.text()).toBe('');
-
-    expect(serveMiddleware).toHaveBeenCalledWith(
-      expect.any(IncomingMessage),
-      expect.any(ServerResponse),
-      expect.objectContaining({ public: expect.stringContaining('foo') }),
-    );
-
-    await close();
-  });
-
   it('ignores query strings', async () => {
     const config = getMockConfig('webpack', {
       input: 'src/index.js',
@@ -244,13 +217,7 @@ describe('getServer', () => {
     );
 
     expect(response.status).toBe(200);
-    expect(await response.text()).toBe('');
-
-    expect(serveMiddleware).toHaveBeenCalledWith(
-      expect.any(IncomingMessage),
-      expect.any(ServerResponse),
-      expect.objectContaining({ public: expect.stringContaining('foo') }),
-    );
+    expect(await response.text()).toBe(JSON.stringify(getSnapManifest()));
 
     await close();
   });
@@ -267,11 +234,10 @@ describe('getServer', () => {
     const server = getServer(config);
     const { port, close } = await server.listen();
 
-    const response = await fetch(`http://localhost:${port}/`);
+    const response = await fetch(`http://localhost:${port}/.env`);
 
     expect(response.status).toBe(404);
     expect(await response.text()).toBe('');
-    expect(serveMiddleware).not.toHaveBeenCalled();
 
     await close();
   });
@@ -281,21 +247,19 @@ describe('getServer', () => {
       input: 'src/index.js',
       server: {
         root: '/foo',
-        port: 0,
+        port: 13490,
       },
     });
 
-    const createServer = jest.spyOn(http, 'createServer');
-    const server = getServer(config);
-    const httpServer: Server = createServer.mock.results[0].value;
-
-    jest.spyOn(httpServer, 'listen').mockImplementationOnce(() => {
-      throw new Error('Address already in use.');
-    });
+    const firstServer = getServer(config);
+    const { close } = await firstServer.listen();
 
-    await expect(server.listen()).rejects.toThrow('Address already in use.');
+    const secondServer = getServer(config);
+    await expect(secondServer.listen()).rejects.toThrow(
+      'listen EADDRINUSE: address already in use :::13490',
+    );
 
-    httpServer.close();
+    await close();
   });
 
   it('throws if the server fails to close', async () => {
@@ -307,18 +271,15 @@ describe('getServer', () => {
       },
     });
 
-    const createServer = jest.spyOn(http, 'createServer');
     const server = getServer(config);
-    const httpServer: Server = createServer.mock.results[0].value;
 
+    const { server: httpServer, close } = await server.listen();
     // @ts-expect-error - Invalid mock.
     jest.spyOn(httpServer, 'close').mockImplementationOnce((callback) => {
       return callback?.(new Error('Failed to close server.'));
     });
 
-    const { close } = await server.listen();
     await expect(close()).rejects.toThrow('Failed to close server.');
-
     httpServer.close();
   });
 });
diff --git a/packages/snaps-cli/src/webpack/server.ts b/packages/snaps-cli/src/webpack/server.ts
@@ -166,26 +166,27 @@ export function getServer(
       server: Server;
       close: () => Promise<void>;
     }>((resolve, reject) => {
-      try {
-        const server = app.listen(port, () => {
-          const close = async () => {
-            await new Promise<void>((resolveClose, rejectClose) => {
-              server.close((closeError) => {
-                if (closeError) {
-                  return rejectClose(closeError);
-                }
-
-                return resolveClose();
-              });
+      // eslint-disable-next-line consistent-return
+      const server = app.listen(port, (error) => {
+        if (error) {
+          return reject(error);
+        }
+
+        const close = async () => {
+          await new Promise<void>((resolveClose, rejectClose) => {
+            server.close((closeError) => {
+              if (closeError) {
+                return rejectClose(closeError);
+              }
+
+              return resolveClose();
             });
-          };
-
-          const address = server.address() as AddressInfo;
-          resolve({ port: address.port, server, close });
-        });
-      } catch (listenError) {
-        reject(listenError);
-      }
+          });
+        };
+
+        const address = server.address() as AddressInfo;
+        resolve({ port: address.port, server, close });
+      });
     });
   };
 
diff --git a/yarn.lock b/yarn.lock
@@ -5563,7 +5563,6 @@ __metadata:
     "@types/express": "npm:^5.0.1"
     "@types/jest": "npm:^27.5.1"
     "@types/node": "npm:18.14.2"
-    "@types/serve-handler": "npm:^6.1.0"
     "@types/yargs": "npm:^17.0.24"
     assert: "npm:^2.0.0"
     babelify: "npm:^10.0.0"
@@ -5597,7 +5596,6 @@ __metadata:
     querystring-es3: "npm:^0.2.1"
     readable-stream: "npm:^3.6.2"
     semver: "npm:^7.5.4"
-    serve-handler: "npm:^6.1.5"
     stream-browserify: "npm:^3.0.0"
     stream-http: "npm:^3.2.0"
     string_decoder: "npm:^1.3.0"
@@ -8077,15 +8075,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@types/serve-handler@npm:^6.1.0":
-  version: 6.1.1
-  resolution: "@types/serve-handler@npm:6.1.1"
-  dependencies:
-    "@types/node": "npm:*"
-  checksum: 10/f0931dea038b6cec92e51a693c447d27d491486486167a438349fb5a9776d7a3b5a2118ef1c94544e6ba85b2fc79401c0bdd99731b52331f8a538cd05b0a5dff
-  languageName: node
-  linkType: hard
-
 "@types/serve-index@npm:^1.9.1":
   version: 1.9.1
   resolution: "@types/serve-index@npm:1.9.1"
