refactor: migrate to node:test and setup jsdom environment (#5667)

* feat(tests): add node test setup and update test utilities

- Introduced a new script for node test setup (`scripts/node-test-setup.mjs`) to configure snapshot serializers and resolve snapshot paths for webpack tests.
- Added new npm script `test:node` in `package.json` for running node tests with specific configurations.
- Updated Jest snapshots in `proxy-option.test.js.snap.webpack5` to reflect changes in test descriptions.
- Refactored tests in `open-option.test.js` and `proxy-option.test.js` to utilize `jest-mock` for mocking and spying, replacing previous Jest mocking methods.
- Changed `beforeAll` and `afterAll` hooks to `before` and `after` for better test isolation and readability.

* refactor(tests): update snapshot test descriptions and improve test structure

- Changed snapshot test descriptions to include a more structured format.
- Updated snapshot assertions to use `t.assert.snapshot` for consistency.
- Refactored test setup and teardown methods to use `before` and `after` from `node:test`.
- Adjusted the test cases in `normalize-options.test.js` and `validate-options.test.js` for improved clarity and maintainability.

* refactor(tests): update CLI option tests to use node:test and expect

- Refactored multiple test files to utilize the `node:test` module for structuring tests.
- Replaced direct assertions with `t.assert.snapshot` for snapshot testing.
- Ensured consistency across tests by adding async context to test functions.
- Updated imports to include necessary testing utilities from `node:test` and `expect`.

* refactor(tests): update web socket tests to use node:test and expect assertions

- Replaced traditional test structure with node:test for better test organization.
- Updated snapshot assertions to use the new test framework's syntax.
- Ensured all test cases in web-socket-communication.test.js, web-socket-server-url.test.js, and web-socket-server.test.js are consistent with the new structure.

* refactor(tests): migrate tests to use node:test and improve snapshot organization

- Updated test files to utilize the `node:test` module for better compatibility and performance.
- Replaced `jest.fn()` with `jest-mock` functions for mocking in various test cases.
- Enhanced snapshot descriptions for clarity and consistency across tests.
- Introduced a new `jsdom-setup.js` helper to streamline JSDOM configuration for tests.
- Adjusted test cases to use `t.assert.snapshot()` for snapshot assertions.
- Cleaned up mock implementations and reset logic in tests for improved reliability.

* refactor: migrate tests from Jest to Node's test module

- Updated package.json to remove Jest dependencies and adjust test scripts for Node's test module.
- Deleted globalSetupTest.js and setupTest.js as they are no longer needed.
- Refactored ReactErrorBoundary.test.js to utilize real jsdom window/document.
- Updated WebsocketClient.test.js to use async/await and improved test structure.
- Skipped index.test.js due to dependency on Jest's mocking capabilities.
- Refactored socket-helper.test.js to create a mock WebSocketClient class.
- Updated log.test.js to simplify logger tests and remove unnecessary mocks.
- Enhanced jsdom-setup.js to replace jsdom's WebSocket with Node's ws library for better testing of WebSocket connections.

* fixup!

* fixup!

* fixup!

* fixup!

* fixup!

* fixup!

* fixup!

* fixup!

* fixup!

* fixup!

* fixup!

* chore: update test runner

* fixup!

* chore: update snapshots and fix module path in API tests

* fixup!

* fixup!

* chore: update snapshots for watchFiles option tests

* refactor: remove unused Logger interface and simplify socket function parameters

* fix: update snapshot serialization for Windows compatibility and adjust test helper import

* fix: codecov upload

* fix: ensure directories are created for test reporter destination

* refactor: simplify client resolution and clean up socket tests

* refactor: clean up comments and improve clarity in test files

* fixup!

Author: bjohansebas

.github/workflows/nodejs.yml

@@ -106,7 +106,7 @@ jobs:
           cp -R tmp-client client
 
       - name: Run tests for webpack version ${{ matrix.webpack-version }}
-        run: npm run test:coverage -- --ci --shard=${{ matrix.shard }}
+        run: npm run test:coverage -- --test-shard=${{ matrix.shard }}
 
       - name: Submit coverage data to codecov
         uses: codecov/codecov-action@v5

eslint.config.mjs

@@ -21,5 +21,23 @@ export default defineConfig([
   {
     files: ["test/**/*"],
     extends: [configs["universal-recommended"]],
+    rules: {
+      // Tests use experimental node:test APIs intentionally
+      // (mock.module, mock.timers, snapshot.*). The package's engines field
+      // is wider than where these are stable, so silence the linter here.
+      "n/no-unsupported-features/node-builtins": "off",
+      // Test callbacks (it/test/subtest arrow functions) don't need JSDoc.
+      "jsdoc/require-jsdoc": "off",
+      // Tests legitimately log diagnostics (retry attempts, etc.).
+      "no-console": "off",
+      // node:test callbacks receive `t` (TestContext) as a parameter.
+      "id-length": "off",
+    },
+  },
+  {
+    files: ["scripts/node-test-setup.mjs", "scripts/run-tests.mjs"],
+    rules: {
+      "n/no-unsupported-features/node-builtins": "off",
+    },
   },
 ]);

jest.config.js

@@ -3392,6 +3392,17 @@ class Server {
           }
 
           this.sockets = [];
+
+          // Force-close any remaining connections that aren't in `this.sockets`
+          // (HTTP keep-alive idle connections from upstream clients,
+          // long-poll requests, sockets that were upgraded out of `connection`
+          // tracking, etc). Without this, `server.close()`'s callback can hang
+          // indefinitely waiting for connections that never close on their own
+          // — a problem that surfaces in test suites that rapidly start/stop
+          // servers on the same port (next start hits EADDRINUSE).
+          // `closeAllConnections` is available since Node.js 18.2.
+          /** @type {S & { closeAllConnections?: () => void }} */
+          (this.server).closeAllConnections?.();
         })
       );