Files
TREK/client/tests/environment/jsdom-native-abort.ts
T

50 lines
2.2 KiB
TypeScript

/**
* Custom Vitest environment that extends jsdom but preserves the native
* Node.js AbortController and AbortSignal.
*
* Problem 1: jsdom replaces globalThis.AbortController and AbortSignal with its
* own implementations. Node.js's undici-based fetch validates signals via
* `signal instanceof AbortSignal` against its own native class reference.
* jsdom's AbortSignal instances fail this check, causing fetch to throw:
* TypeError: RequestInit: Expected signal ("AbortSignal {}") to be an
* instance of AbortSignal.
* Fix: after jsdom installs its globals, restore the native AbortController
* and AbortSignal so fetch works correctly in tests.
*
* Problem 2 (Node 22+ experimental Web Storage): Node now exposes its own
* `localStorage`/`sessionStorage` globals, inert unless `--localstorage-file`
* is passed. Vitest's global-populate skips any key already present on the
* global that isn't in its own allow-list, and Storage isn't in it — so
* jsdom's working Storage never overwrites Node's inert one and every test
* throws on `localStorage.clear()`. Fix: delete Node's shadow globals before
* jsdom setup runs, so vitest copies jsdom's Storage across.
*/
import { builtinEnvironments } from 'vitest/environments';
const jsdomEnv = builtinEnvironments.jsdom;
export default {
name: 'jsdom-native-abort',
transformMode: 'web' as const,
async setup(global: typeof globalThis, options: Record<string, unknown>) {
// Capture native AbortController/AbortSignal BEFORE jsdom patches them
const NativeAbortController = global.AbortController;
const NativeAbortSignal = global.AbortSignal;
// Clear Node's inert Web Storage globals so jsdom's win, not this shadow.
delete (global as { localStorage?: unknown }).localStorage;
delete (global as { sessionStorage?: unknown }).sessionStorage;
// Run standard jsdom setup (installs jsdom globals, including its own AbortController)
const env = await jsdomEnv.setup(global, options as Parameters<typeof jsdomEnv.setup>[1]);
// Restore native AbortController so Node.js fetch (undici) accepts the signals
global.AbortController = NativeAbortController;
global.AbortSignal = NativeAbortSignal;
return env;
},
};