7f0e886851
The suite allocated temp dirs at 68 sites across 21 files and removed none,
accumulating ~6700 directories and 189MB per machine-day, some holding age
keys. All 68 now go through a single `tmp()` helper allocating inside a
per-run root that vitest's globalSetup teardown removes wholesale, and a
class-guard test fails if `mkdtempSync` appears under test/ outside the
helpers.
The per-worker `process.once("exit")` reaper that suggests itself here does
not work under vitest and fails silently: the pool recycles workers by
killing them, so exit handlers registered in a test file never run. Measured
— a probe test writing from an exit hook produced no file, and a full run
with per-worker hooks still left 750 directories. globalSetup's teardown runs
in the main process, after every worker, and vitest awaits it.
Separately, and contrary to #117's framing that "cast itself does not leak":
resolveCheckout() mkdtemps an `infra-checkout-` dir, clones the infra repo
into it, and never removes it, so every `cast apply`/`diff`/`capture` without
--path leaked a full clone. The box that reported #117 was holding 602 such
directories, 73MB of real .git trees, from the same day. The leak fires on
the failure path too, since the dir is created before the clone runs.
Ephemeral checkouts are now reaped on process exit — the lifetime that fits,
since callers read the tree after resolveCheckout returns; a --path checkout
is the operator's own tree and is never registered.
Empirical: /tmp/cast-* + /tmp/infra-* count is 0 before and 0 after a full
`npm test`, against 750 with the exit-hook design. 626 tests green.
Refs #117
39 lines
1.7 KiB
TypeScript
39 lines
1.7 KiB
TypeScript
import { mkdtempSync, rmSync } from "node:fs";
|
|
import { tmpdir } from "node:os";
|
|
import { join } from "node:path";
|
|
|
|
// The env var that tells `tmp()` (test/helpers/tmp.ts) where to allocate.
|
|
export const RUN_ROOT_ENV = "CAST_TEST_TMP_ROOT";
|
|
|
|
// One directory per `vitest run`, holding every temp dir the suite allocates.
|
|
//
|
|
// This is what actually reaps the suite's temp dirs (#117). The obvious design —
|
|
// each worker cleaning up after itself in a `process.once("exit")` hook — does
|
|
// NOT work under vitest, and it fails silently, which is worse: vitest recycles
|
|
// its pool workers by killing them, so `exit` handlers registered inside a test
|
|
// file never run. Measured, not assumed: a probe test that wrote a file from an
|
|
// `exit` hook produced no file, and a full suite run with per-worker exit hooks
|
|
// still left 750 directories behind.
|
|
//
|
|
// globalSetup's teardown runs in vitest's MAIN process, after every worker has
|
|
// finished, and vitest awaits it. That makes it the only hook in the run with
|
|
// both of the properties this needs: it is guaranteed to execute, and it sees
|
|
// the whole run rather than one worker's slice of it.
|
|
//
|
|
// Collapsing the whole run into a single root is what makes that teardown one
|
|
// `rmSync` instead of a list to keep in sync across processes — the workers do
|
|
// not have to report anything back, because the parent already knows the one
|
|
// path that contains everything.
|
|
export function setup(): () => void {
|
|
const root = mkdtempSync(join(tmpdir(), "cast-testrun-"));
|
|
process.env[RUN_ROOT_ENV] = root;
|
|
|
|
return function teardown(): void {
|
|
// Best-effort: a failure to clean up must not turn a green run red.
|
|
try {
|
|
rmSync(root, { recursive: true, force: true });
|
|
} catch {
|
|
// ignore
|
|
}
|
|
};
|
|
}
|