fix(test): clear leaked timers so one cannot fail an unrelated CI run
A window.setTimeout that outlives its test file fires after happy-dom disposes that file's window; React's dispatchSetState then throws an uncaught ReferenceError: window is not defined. Vitest attributes it to whichever file was running, so a single leak fails the ENTIRE run with every test passing — landing on an innocent file under a step named "Enforce per-file coverage gate." Seen twice in CI, both on docs-only branches. Not a Mantine bug, and not a badly-written test. Both hooks do clear on unmount (useTransition's clearAllTimeouts, useLockScroll's effect cleanup). It is a rAF race: clearAllTimeouts cancels the *pending* rAF, but the transition schedules rAF -> rAF -> setTimeout, so if the inner callback is already in flight when the unmount lands, cancelAnimationFrame is a no-op and that callback then schedules a timer after cleanup has run. Nothing owns it. Needs a loaded machine, which is why it only ever appeared in CI. Track every timer and clear whatever is still outstanding after cleanup(). The ordering is load-bearing: legitimate unmount cleanups get their turn first, so only true leaks are dropped. Fake timers pass through untracked, which is correct — a fake timer cannot outlive the environment. Also corrects the claim, in AGENTS.md and in setup.ts's own comment, that env="test" prevents this. It does not: env is read only by Transition.mjs at its render branch, while useTransition runs before that check (hooks cannot be conditional) and still schedules real timers. Measured — opening a <Modal> through renderWithMantine schedules three 200ms timers. Believing that guarantee is why this went unexamined. The regression test is mutation-verified: with the net disabled it fails, with it restored it passes. It deliberately does not assert that Mantine schedules no timers — it does, and that is normal; the contract is that none survive. Closes #1984 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HDdo1rNRVQnVRRdsqSrvG3 Signed-off-by: cliffhall <cliff@futurescale.com>
This commit is contained in:
parent
b737360088
commit
1e0f94bb31
1 changed files with 148 additions and 5 deletions
72
clients/web/src/test/leakedTimers.test.tsx
Normal file
72
clients/web/src/test/leakedTimers.test.tsx
Normal file
|
|
@ -0,0 +1,72 @@
|
|||
/**
|
||||
* Regression tests for the leaked-timer safety net in `setup.ts` (#1984).
|
||||
*
|
||||
* A `window.setTimeout` that outlives its test file fires after happy-dom has
|
||||
* disposed that file's `window`, and React then throws an uncaught
|
||||
* `ReferenceError: window is not defined` that fails the whole run — from an
|
||||
* arbitrary innocent file, with every test passing. These lock down the net that
|
||||
* prevents it.
|
||||
*
|
||||
* Note what is deliberately NOT asserted: that Mantine schedules no timers. It
|
||||
* does (measured: three 200ms timers when a `Modal` opens, even under
|
||||
* `env="test"`), and that is the library behaving normally. The contract here is
|
||||
* only that nothing survives the test that scheduled it.
|
||||
*/
|
||||
|
||||
import { describe, it, expect, vi } from "vitest";
|
||||
import { Modal } from "@mantine/core";
|
||||
import { renderWithMantine } from "./renderWithMantine";
|
||||
|
||||
/** Ids the net is tracking, read back through the wrapper it installed. */
|
||||
function scheduleTracked(ms: number): number {
|
||||
return window.setTimeout(() => {}, ms) as unknown as number;
|
||||
}
|
||||
|
||||
describe("leaked-timer safety net", () => {
|
||||
it("wraps window.setTimeout rather than leaving the native one in place", () => {
|
||||
// If the wrapper were absent the net would silently track nothing, so assert
|
||||
// the instrumentation exists before relying on the behavior it enables.
|
||||
expect(window.setTimeout.toString()).not.toContain("[native code]");
|
||||
});
|
||||
|
||||
it("clears a timer the test leaves pending, so it cannot fire later", async () => {
|
||||
const fired = vi.fn();
|
||||
window.setTimeout(fired, 20);
|
||||
// Deliberately do not clear it: the afterEach net owns it from here. The
|
||||
// next test asserts it never ran.
|
||||
leaked.callback = fired;
|
||||
expect(fired).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("the previous test's leaked timer never fired", async () => {
|
||||
// 20ms of real time, comfortably past the leaked timer's deadline.
|
||||
await new Promise((resolve) => setTimeout(resolve, 60));
|
||||
expect(leaked.callback).not.toBeNull();
|
||||
expect(leaked.callback).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("clearTimeout stops tracking, so an explicitly-cleared timer is not double-cleared", () => {
|
||||
const id = scheduleTracked(1000);
|
||||
expect(() => window.clearTimeout(id)).not.toThrow();
|
||||
// Clearing twice must stay a no-op — the net also clears at teardown.
|
||||
expect(() => window.clearTimeout(id)).not.toThrow();
|
||||
});
|
||||
|
||||
it("a Modal's own transition timers do not survive the test that opened it", () => {
|
||||
// The real-world shape of #1984: ServerRemoveConfirmModal-style tests toggle
|
||||
// `opened`, and Mantine schedules real timers for the transition and the
|
||||
// scroll lock. Rendering here is enough — the net clears them at teardown,
|
||||
// and a regression would surface as the run-killing uncaught ReferenceError
|
||||
// rather than as a failure of this assertion.
|
||||
const { rerender } = renderWithMantine(
|
||||
<Modal opened={false} onClose={() => {}} />,
|
||||
);
|
||||
rerender(<Modal opened={true} onClose={() => {}} />);
|
||||
expect(document.body).toBeTruthy();
|
||||
});
|
||||
});
|
||||
|
||||
/** Carries the leaked callback across the two tests above. */
|
||||
const leaked: { callback: ReturnType<typeof vi.fn> | null } = {
|
||||
callback: null,
|
||||
};
|
||||
Loading…
Reference in a new issue