fix: clean up test helpers (#3127)

* fix: clean up test helpers

* chore: rename node-test-helpers.js to node.js

Author: bashmish

.changeset/cyan-clubs-serve.md

@@ -0,0 +1,5 @@
+---
+'@web/dev-server-core': major
+---
+
+Removed test helpers timeout, fetchText, expectIncludes, expectNotIncludes, virtualFilesPlugin.

integration/test-runner/tests/location-change/runLocationChangeTest.ts

@@ -1,10 +1,10 @@
-import { expectIncludes } from '@web/dev-server-core/test-helpers';
 import { legacyPlugin } from '@web/dev-server-legacy';
 import type { BrowserLauncher, TestRunnerCoreConfig, TestSession } from '@web/test-runner-core';
 import { runTests } from '@web/test-runner-core/test-helpers';
 import assert from 'node:assert/strict';
 import { before, describe, it } from 'node:test';
 import { resolve } from 'path';
+import { assertIncludes } from '../../../../test-helpers/node.js';
 
 export function runLocationChangeTest(
   config: Partial<TestRunnerCoreConfig> & { browsers: BrowserLauncher[] },
@@ -42,11 +42,11 @@ export function runLocationChangeTest(
         assert.equal(session.testResults, undefined);
         assert.deepEqual(session.logs, []);
         assert.equal(session.errors.length, 1);
-        expectIncludes(
+        assertIncludes(
           session.errors[0].message,
           'Tests were interrupted because the page navigated to',
         );
-        expectIncludes(
+        assertIncludes(
           session.errors[0].message,
           'This can happen when clicking a link, submitting a form or interacting with window.location.',
         );
@@ -77,12 +77,12 @@ export function runLocationChangeTest(
         assert.equal(session.testResults, undefined);
         assert.deepEqual(session.logs, []);
         assert.equal(session.errors.length, 1);
-        expectIncludes(
+        assertIncludes(
           session.errors[0].message,
           'Tests were interrupted because the page navigated to',
         );
-        expectIncludes(session.errors[0].message, '/new-page/');
-        expectIncludes(
+        assertIncludes(session.errors[0].message, '/new-page/');
+        assertIncludes(
           session.errors[0].message,
           'This can happen when clicking a link, submitting a form or interacting with window.location.',
         );

integration/test-runner/tests/test-failure/runTestFailureTest.ts

@@ -1,10 +1,10 @@
-import { expectIncludes } from '@web/dev-server-core/test-helpers';
 import { legacyPlugin } from '@web/dev-server-legacy';
 import type { BrowserLauncher, TestRunnerCoreConfig, TestSession } from '@web/test-runner-core';
 import { runTests } from '@web/test-runner-core/test-helpers';
 import assert from 'node:assert/strict';
 import { before, describe, it } from 'node:test';
 import { resolve, sep } from 'path';
+import { assertIncludes } from '../../../../test-helpers/node.js';
 
 const ERROR_NOT_IMPORTABLE = {
   message:
@@ -94,7 +94,7 @@ export function runTestFailureTest(
           ['true is true', 'true is really true'],
         );
         assert.equal(session.errors.length, 1);
-        expectIncludes(session.errors[0].message, 'error thrown in afterEach hook');
+        assertIncludes(session.errors[0].message, 'error thrown in afterEach hook');
         assert.ok(
           session.errors[0].stack!.includes(
             `test-failure${sep}browser-tests${sep}fail-after-each.test.js`,
@@ -113,7 +113,7 @@ export function runTestFailureTest(
           ['true is true', 'true is really true'],
         );
         assert.equal(session.errors.length, 1);
-        expectIncludes(session.errors[0].message, 'error thrown in after hook');
+        assertIncludes(session.errors[0].message, 'error thrown in after hook');
         assert.ok(
           session.errors[0].stack!.includes(
             `test-failure${sep}browser-tests${sep}fail-after.test.js`,
@@ -132,7 +132,7 @@ export function runTestFailureTest(
           ['true is true', 'true is really true'],
         );
         assert.equal(session.errors.length, 1);
-        expectIncludes(session.errors[0].message, 'error thrown in beforeEach hook');
+        assertIncludes(session.errors[0].message, 'error thrown in beforeEach hook');
         assert.ok(
           session.errors[0].stack!.includes(
             `test-failure${sep}browser-tests${sep}fail-before-each.test.js`,
@@ -151,7 +151,7 @@ export function runTestFailureTest(
           ['true is true', 'true is really true'],
         );
         assert.equal(session.errors.length, 1);
-        expectIncludes(session.errors[0].message, 'error thrown in before hook');
+        assertIncludes(session.errors[0].message, 'error thrown in before hook');
         assert.ok(
           session.errors[0].stack!.includes(
             `test-failure${sep}browser-tests${sep}fail-before.test.js`,
@@ -169,7 +169,7 @@ export function runTestFailureTest(
           session.testResults!.tests.map(t => t.name),
           ['custom error'],
         );
-        expectIncludes(session.testResults!.tests[0].error!.message, 'a custom error thrown');
+        assertIncludes(session.testResults!.tests[0].error!.message, 'a custom error thrown');
         assert.ok(
           session.testResults!.tests[0].error!.stack!.includes(
             `browser-tests${sep}fail-custom-error.test.js`,
@@ -189,7 +189,7 @@ export function runTestFailureTest(
         assert.equal(session.testResults!.suites.length, 0);
         assert.equal(session.testResults!.tests.length, 0);
         assert.deepEqual(session.errors, [ERROR_NOT_IMPORTABLE]);
-        expectIncludes(session.logs[0][0] as string, 'This is thrown before running tests');
+        assertIncludes(session.logs[0][0] as string, 'This is thrown before running tests');
       }
     });
 
@@ -198,9 +198,9 @@ export function runTestFailureTest(
       assert.equal(sessions.length === browserCount, true);
       for (const session of sessions) {
         assert.equal(session.testResults!.tests.length, 1);
-        expectIncludes(session.testResults!.tests[0]!.error!.message, 'My error');
-        expectIncludes(session.testResults!.tests[0]!.error!.stack!, 'throwErrorC');
-        expectIncludes(session.testResults!.tests[0]!.error!.stack!, 'fail-stack-trace-c.js');
+        assertIncludes(session.testResults!.tests[0]!.error!.message, 'My error');
+        assertIncludes(session.testResults!.tests[0]!.error!.stack!, 'throwErrorC');
+        assertIncludes(session.testResults!.tests[0]!.error!.stack!, 'fail-stack-trace-c.js');
         assert.deepEqual(session.errors, []);
         assert.deepEqual(session.logs, []);
       }

packages/browser-logs/test/serialize-deserialize.test.ts

@@ -1,8 +1,8 @@
-import { expectIncludes } from '@web/dev-server-core/test-helpers';
 import assert from 'node:assert/strict';
 import fs from 'node:fs';
 import path from 'node:path';
 import { after, before, describe, it } from 'node:test';
+import { assertIncludes } from '../../../test-helpers/node.js';
 
 import type { Browser, Page } from 'puppeteer';
 import puppeteer from 'puppeteer';
@@ -350,11 +350,11 @@ describe('serialize deserialize', { timeout: 10000 }, function () {
     });
     const deserialized = await deserialize(serialized, defaultOptions);
     assert.equal(typeof deserialized, 'string');
-    expectIncludes(deserialized, 'my error msg');
-    expectIncludes(deserialized, '2:23');
-    expectIncludes(deserialized, '3:23');
-    expectIncludes(deserialized, '4:23');
-    expectIncludes(deserialized, '5:35');
+    assertIncludes(deserialized, 'my error msg');
+    assertIncludes(deserialized, '2:23');
+    assertIncludes(deserialized, '3:23');
+    assertIncludes(deserialized, '4:23');
+    assertIncludes(deserialized, '5:35');
   });
 
   it('handles errors in objects', async () => {
@@ -366,11 +366,11 @@ describe('serialize deserialize', { timeout: 10000 }, function () {
     });
     const deserialized = await deserialize(serialized, defaultOptions);
     assert.equal(typeof deserialized.myError, 'string');
-    expectIncludes(deserialized.myError, 'my error msg');
-    expectIncludes(deserialized.myError, '2:23');
-    expectIncludes(deserialized.myError, '3:23');
-    expectIncludes(deserialized.myError, '4:23');
-    expectIncludes(deserialized.myError, '5:46');
+    assertIncludes(deserialized.myError, 'my error msg');
+    assertIncludes(deserialized.myError, '2:23');
+    assertIncludes(deserialized.myError, '3:23');
+    assertIncludes(deserialized.myError, '4:23');
+    assertIncludes(deserialized.myError, '5:46');
   });
 
   it('handles errors in arrays', async () => {
@@ -382,20 +382,20 @@ describe('serialize deserialize', { timeout: 10000 }, function () {
     });
     const deserialized = await deserialize(serialized, defaultOptions);
     assert.equal(typeof deserialized[0], 'string');
-    expectIncludes(deserialized[0], 'my error msg');
-    expectIncludes(deserialized[0], '2:23');
-    expectIncludes(deserialized[0], '3:23');
-    expectIncludes(deserialized[0], '4:23');
-    expectIncludes(deserialized[0], '5:36');
+    assertIncludes(deserialized[0], 'my error msg');
+    assertIncludes(deserialized[0], '2:23');
+    assertIncludes(deserialized[0], '3:23');
+    assertIncludes(deserialized[0], '4:23');
+    assertIncludes(deserialized[0], '5:36');
     assert.equal(typeof deserialized[1], 'string');
-    expectIncludes(deserialized[1], 'my error msg');
-    expectIncludes(deserialized[1], '2:23');
-    expectIncludes(deserialized[1], '3:23');
-    expectIncludes(deserialized[1], '5:41');
+    assertIncludes(deserialized[1], 'my error msg');
+    assertIncludes(deserialized[1], '2:23');
+    assertIncludes(deserialized[1], '3:23');
+    assertIncludes(deserialized[1], '5:41');
     assert.equal(typeof deserialized[2], 'string');
-    expectIncludes(deserialized[2], 'my error msg');
-    expectIncludes(deserialized[2], '2:23');
-    expectIncludes(deserialized[2], '5:46');
+    assertIncludes(deserialized[2], 'my error msg');
+    assertIncludes(deserialized[2], '2:23');
+    assertIncludes(deserialized[2], '5:46');
   });
 
   it('can map stack trace locations', async () => {
@@ -410,8 +410,8 @@ describe('serialize deserialize', { timeout: 10000 }, function () {
       mapStackLocation: l => ({ ...l, filePath: `${l.filePath}__MAPPED__`, line: 1, column: 2 }),
     });
     assert.equal(typeof deserialized, 'string');
-    expectIncludes(deserialized, 'my error msg');
-    expectIncludes(deserialized, `__MAPPED__:1:2`);
+    assertIncludes(deserialized, 'my error msg');
+    assertIncludes(deserialized, `__MAPPED__:1:2`);
   });
 
   it('mapped stack traces can be async', async () => {
@@ -429,8 +429,8 @@ describe('serialize deserialize', { timeout: 10000 }, function () {
       },
     });
     assert.equal(typeof deserialized, 'string');
-    expectIncludes(deserialized, 'my error msg');
-    expectIncludes(deserialized, `__MAPPED__:1:2`);
+    assertIncludes(deserialized, 'my error msg');
+    assertIncludes(deserialized, `__MAPPED__:1:2`);
   });
 
   it('can define a cwd below current directory', async () => {
@@ -445,11 +445,11 @@ describe('serialize deserialize', { timeout: 10000 }, function () {
       cwd: path.resolve(import.meta.dirname, '..'),
     });
     assert.equal(typeof deserialized, 'string');
-    expectIncludes(deserialized, 'my error msg');
-    expectIncludes(deserialized, `2:23`);
-    expectIncludes(deserialized, `3:23`);
-    expectIncludes(deserialized, `4:23`);
-    expectIncludes(deserialized, `5:35`);
+    assertIncludes(deserialized, 'my error msg');
+    assertIncludes(deserialized, `2:23`);
+    assertIncludes(deserialized, `3:23`);
+    assertIncludes(deserialized, `4:23`);
+    assertIncludes(deserialized, `5:35`);
   });
 
   it('can define a cwd above current directory', async () => {
@@ -464,11 +464,11 @@ describe('serialize deserialize', { timeout: 10000 }, function () {
       browserRootDir: path.resolve(import.meta.dirname, '..'),
     });
     assert.equal(typeof deserialized, 'string');
-    expectIncludes(deserialized, 'my error msg');
-    expectIncludes(deserialized, `2:23`);
-    expectIncludes(deserialized, `3:23`);
-    expectIncludes(deserialized, `4:23`);
-    expectIncludes(deserialized, `5:35`);
+    assertIncludes(deserialized, 'my error msg');
+    assertIncludes(deserialized, `2:23`);
+    assertIncludes(deserialized, `3:23`);
+    assertIncludes(deserialized, `4:23`);
+    assertIncludes(deserialized, `5:35`);
   });
 
   it('handles null', async () => {

packages/dev-server-core/src/test-helpers.ts

@@ -1,8 +1,6 @@
-import { green, red, yellow } from 'nanocolors';
 import portfinder from 'portfinder';
 
 import { Logger } from './logger/Logger.js';
-import { Plugin } from './plugins/Plugin.js';
 import { DevServer } from './server/DevServer.js';
 import { DevServerCoreConfig } from './server/DevServerCoreConfig.js';
 
@@ -23,17 +21,6 @@ const mockLogger: Logger = {
   },
 };
 
-export function virtualFilesPlugin(servedFiles: Record<string, string>): Plugin {
-  return {
-    name: 'test-helpers-virtual-files',
-    serve(context) {
-      if (context.path in servedFiles) {
-        return servedFiles[context.path];
-      }
-    },
-  };
-}
-
 export async function createTestServer(
   config: Partial<DevServerCoreConfig>,
   _mockLogger = mockLogger,
@@ -56,25 +43,3 @@ export async function createTestServer(
   url.port = port.toString();
   return { server, port, host: url.toString().slice(0, -1) };
 }
-
-export const timeout = (ms = 0) => new Promise(resolve => setTimeout(resolve, ms));
-
-export async function fetchText(url: string, init?: RequestInit) {
-  const response = await fetch(url, init);
-  if (response.status !== 200) {
-    throw new Error(`Failed to fetch ${url}: ${response.status} ${response.statusText}`);
-  }
-  return response.text();
-}
-
-export function expectIncludes(text: string, expected: string) {
-  if (!text.includes(expected)) {
-    throw new Error(red(`Expected "${yellow(expected)}" in string: \n\n${green(text)}`));
-  }
-}
-
-export function expectNotIncludes(text: string, expected: string) {
-  if (text.includes(expected)) {
-    throw new Error(`Did not expect "${expected}" in string: \n\n${text}`);
-  }
-}

packages/dev-server-core/test-helpers.mjs

@@ -1,20 +1,6 @@
 // this file is autogenerated with the generate-mjs-dts-entrypoints script
 import cjsEntrypoint from './dist/test-helpers.js';
 
-const {
-  virtualFilesPlugin,
-  createTestServer,
-  timeout,
-  fetchText,
-  expectIncludes,
-  expectNotIncludes,
-} = cjsEntrypoint;
+const { createTestServer } = cjsEntrypoint;
 
-export {
-  virtualFilesPlugin,
-  createTestServer,
-  timeout,
-  fetchText,
-  expectIncludes,
-  expectNotIncludes,
-};
+export { createTestServer };

packages/dev-server-core/test/helpers.ts

@@ -1,19 +1,10 @@
 import path from 'path';
 import type { DevServerCoreConfig } from '../dist/server/DevServerCoreConfig.js';
-import {
-  expectIncludes,
-  expectNotIncludes,
-  fetchText,
-  createTestServer as originalCreateTestServer,
-  timeout,
-  virtualFilesPlugin,
-} from '../dist/test-helpers.js';
+import { createTestServer as originalCreateTestServer } from '../dist/test-helpers.js';
 
 export function createTestServer(config: Partial<DevServerCoreConfig> = {}) {
   return originalCreateTestServer({
     rootDir: path.resolve(import.meta.dirname, 'fixtures', 'basic'),
     ...config,
   });
 }
-
-export { timeout, fetchText, expectIncludes, expectNotIncludes, virtualFilesPlugin };