Skip to content

Never stop coding. Free MIT AI gateway: one endpoint, 375 providers (150+ free), 1,400+ models Kimi, Claude, GPT, Gemini, GLM, DeepSeek, MiniMax. Works with Claude Code, Codex, Cursor, OpenCode, Cline & Copilot. Quota-aware auto-fallback, RTK+Caveman compression saves 15-95% tokens, MCP/A2A, Desktop/PWA. Built by 900+ contributors

2.9 KB
Raw Blame
// Shared teardown for tests that own their own temporary DATA_DIR.
//
// Why this exists (#13290): a test that opens the SQLite DB and then removes its
// temp DATA_DIR in `test.after()` fails on Windows with EPERM, because Windows
// refuses to remove a directory while any handle on it is still open. The tell is
// `storage.sqlite-shm` / `-wal` left behind next to the database file.
//
// `maxRetries` cannot help: nothing ever closes the connection, so every retry
// hits the same open handle. The `process.on("exit")` fallback in isolateDataDir.ts
// does not cover these tests either — it only runs when the test does NOT set
// DATA_DIR itself, which is exactly the case that fails here.
//
// The cleanup is deliberately best-effort. A leftover temp directory is a disk
// nuisance the OS eventually reaps; a throwing teardown is a red test that hides
// a green assertion. Failing to remove the directory must never fail the test.
import fs from "node:fs";
import os from "node:os";
import path from "node:path";

/**
 * Close the SQLite singleton if the DB module was ever loaded.
 *
 * Imported lazily and defensively: most callers never touch the database, and a
 * static import would drag the whole DB layer into every test that only needs a
 * scratch directory. If the module was never loaded, there is nothing to close.
 */
async function closeDbIfOpen(): Promise<void> {
  try {
    const core = await import("../../src/lib/db/core.ts");
    core.resetDbInstance?.();
  } catch {
    // The DB module is absent, failed to load, or was never initialised.
    // Nothing to close — cleanup continues.
  }
}

/** Remove a directory, swallowing any failure. Never throws. */
function removeQuietly(dir: string): void {
  try {
    fs.rmSync(dir, { recursive: true, force: true, maxRetries: 5, retryDelay: 100 });
  } catch {
    // Best-effort: see the file header. A leftover temp dir must not fail a test.
  }
}

/**
 * Create a temporary DATA_DIR and point `process.env.DATA_DIR` at it.
 *
 * Returns the directory path plus a `cleanup()` that closes the database before
 * removing it. Pass `cleanup` straight to `test.after()`:
 *
 * ```ts
 * const { dir: TEST_DATA_DIR, cleanup } = createTempDataDir("my-suite-");
 * test.after(cleanup);
 * ```
 */
export function createTempDataDir(prefix = "omniroute-test-"): {
  dir: string;
  cleanup: () => Promise<void>;
} {
  const dir = fs.mkdtempSync(path.join(os.tmpdir(), prefix));
  process.env.DATA_DIR = dir;

  return {
    dir,
    cleanup: async () => {
      await closeDbIfOpen();
      removeQuietly(dir);
    },
  };
}

/**
 * Teardown for a temp DATA_DIR that was created by hand.
 *
 * For existing tests that already have their own `mkdtempSync` call and only need
 * the close-then-remove ordering fixed:
 *
 * ```ts
 * test.after(() => cleanupTempDataDir(TEST_DATA_DIR));
 * ```
 */
export async function cleanupTempDataDir(dir: string): Promise<void> {
  await closeDbIfOpen();
  removeQuietly(dir);
}