miravo 0.6.0 → 0.6.1

package/src/lib/shutdown.test.ts

@@ -1,562 +0,0 @@
-import { afterEach, describe, expect, test } from "bun:test";
-import type { Engine, EngineMetricsSnapshot } from "@miravo/core";
-import { muteAllLoggers } from "../commands/cli-test-setup.ts";
-import {
-  configLog,
-  configureLogger,
-  controlLog,
-  engineLog,
-  faultLog,
-  lifecycleLog,
-  lockLogger,
-  logger,
-  mqttLog,
-  opcuaLog,
-  unlockLogger,
-} from "../logger.ts";
-import { createShutdownController } from "./shutdown.ts";
-
-const noopReporter = { log() {} };
-
-function configureSummaryLogger(
-  options: { plain?: boolean; logFormat?: "pretty" | "json" } = {},
-): void {
-  const previousNoColor = Bun.env["NO_COLOR"];
-  if (!(options.plain ?? false)) {
-    delete Bun.env["NO_COLOR"];
-  }
-  unlockLogger();
-  try {
-    configureLogger({
-      plain: options.plain ?? false,
-      logFormat: options.logFormat ?? "pretty",
-    });
-  } finally {
-    if (previousNoColor === undefined) {
-      delete Bun.env["NO_COLOR"];
-    } else {
-      Bun.env["NO_COLOR"] = previousNoColor;
-    }
-  }
-  for (const l of [
-    logger,
-    engineLog,
-    mqttLog,
-    opcuaLog,
-    configLog,
-    lifecycleLog,
-    faultLog,
-    controlLog,
-  ]) {
-    l.level = -999;
-    l.setReporters([noopReporter]);
-  }
-  lockLogger();
-}
-
-function setStdoutIsTTY(value: boolean): () => void {
-  const descriptor = Object.getOwnPropertyDescriptor(process.stdout, "isTTY");
-  Object.defineProperty(process.stdout, "isTTY", {
-    configurable: true,
-    value,
-  });
-
-  return () => {
-    if (descriptor) {
-      Object.defineProperty(process.stdout, "isTTY", descriptor);
-      return;
-    }
-    delete (process.stdout as { isTTY?: boolean }).isTTY;
-  };
-}
-
-function createMockEngine(): Engine & { stopCalled: boolean; stopReason: string | undefined } {
-  const metrics: EngineMetricsSnapshot = {
-    simulationName: "test-sim",
-    core: {
-      state: "running",
-      tickCount: 100,
-      simulationTimeSeconds: 100,
-      instanceCount: 5,
-      memberValueCount: 25,
-      quarantinedInstanceCount: 0,
-      engineErrorsCount: 0,
-      tickOverrunsCount: 0,
-      circuitBreakerTripsCount: 0,
-      uptimeMs: 60_000,
-      actualTicksPerSecond: 1.0,
-    },
-    fleet: {
-      modelBreakdown: [{ model: "pump", count: 5 }],
-      lifecycleBreakdown: { normal: 5 },
-      activeFaultCount: 0,
-      faultBreakdown: [],
-    },
-    adapters: [],
-  };
-
-  const mock = {
-    stopCalled: false,
-    stopReason: undefined as string | undefined,
-    getMetrics: () => metrics,
-    stop: async (reason?: string) => {
-      mock.stopCalled = true;
-      mock.stopReason = reason;
-    },
-  } as unknown as Engine & { stopCalled: boolean; stopReason: string | undefined };
-
-  return mock;
-}
-
-describe("createShutdownController", () => {
-  const teardowns: Array<() => void> = [];
-
-  afterEach(() => {
-    while (teardowns.length > 0) {
-      teardowns.pop()?.();
-    }
-    muteAllLoggers();
-  });
-
-  test("first SIGINT calls engine.stop and exit(0)", async () => {
-    const engine = createMockEngine();
-    let exitCode: number | undefined;
-
-    const controller = createShutdownController({
-      seed: 42,
-      seedExplicit: true,
-      exit: (code) => {
-        exitCode = code;
-      },
-    });
-    teardowns.push(controller.teardown);
-    controller.setEngine(engine);
-
-    process.emit("SIGINT");
-    await controller.waitForShutdownRequest();
-    await controller.runShutdown();
-
-    expect(engine.stopCalled).toBe(true);
-    expect(engine.stopReason).toBe("user interrupt");
-    expect(exitCode).toBe(0);
-  });
-
-  test("SIGTERM during graceful shutdown does not force-exit (parent runner cleanup)", async () => {
-    const engine = createMockEngine();
-    let exitCode: number | undefined;
-    let engineStopped = false;
-
-    (engine as unknown as Record<string, unknown>)["stop"] = () =>
-      new Promise<void>((resolve) =>
-        setTimeout(() => {
-          engineStopped = true;
-          resolve();
-        }, 50),
-      );
-
-    const controller = createShutdownController({
-      seed: 42,
-      seedExplicit: true,
-      exit: (code) => {
-        exitCode = code;
-      },
-    });
-    teardowns.push(controller.teardown);
-    controller.setEngine(engine);
-
-    process.emit("SIGINT");
-    await controller.waitForShutdownRequest();
-    const shutdownPromise = controller.runShutdown();
-    await new Promise((resolve) => setTimeout(resolve, 10));
-    // Simulate bun run / bunx forwarding SIGTERM to the child as the parent exits
-    process.emit("SIGTERM");
-    await controller.completion;
-    await shutdownPromise;
-
-    // Graceful shutdown must complete: engine stopped, exit(0), not force-stopped
-    expect(engineStopped).toBe(true);
-    expect(exitCode).toBe(0);
-  });
-
-  test("second signal during shutdown calls exit(1)", async () => {
-    const engine = createMockEngine();
-    const exitCodes: number[] = [];
-
-    (engine as unknown as Record<string, unknown>)["stop"] = () =>
-      new Promise((resolve) => setTimeout(resolve, 200));
-
-    const controller = createShutdownController({
-      seed: 42,
-      seedExplicit: true,
-      sigintCoalesceWindowMs: 20,
-      exit: (code) => {
-        exitCodes.push(code);
-      },
-    });
-    teardowns.push(controller.teardown);
-    controller.setEngine(engine);
-
-    process.emit("SIGINT");
-    await controller.waitForShutdownRequest();
-    const shutdownPromise = controller.runShutdown();
-    await new Promise((resolve) => setTimeout(resolve, 40));
-    process.emit("SIGINT");
-    await controller.completion;
-    await shutdownPromise;
-
-    expect(exitCodes).toEqual([1]);
-  });
-
-  test("duplicate SIGINT from bun run does not force-exit on a single Ctrl+C", async () => {
-    const engine = createMockEngine();
-    let exitCode: number | undefined;
-    let engineStopped = false;
-
-    (engine as unknown as Record<string, unknown>)["stop"] = () =>
-      new Promise<void>((resolve) =>
-        setTimeout(() => {
-          engineStopped = true;
-          resolve();
-        }, 50),
-      );
-
-    const controller = createShutdownController({
-      seed: 42,
-      seedExplicit: true,
-      sigintCoalesceWindowMs: 20,
-      exit: (code) => {
-        exitCode = code;
-      },
-    });
-    teardowns.push(controller.teardown);
-    controller.setEngine(engine);
-
-    process.emit("SIGINT");
-    await controller.waitForShutdownRequest();
-    const shutdownPromise = controller.runShutdown();
-    // Regression: `bun run <script>` forwards a second SIGINT to its child
-    // immediately after the terminal already delivered SIGINT to the group.
-    process.emit("SIGINT");
-    await controller.completion;
-    await shutdownPromise;
-
-    expect(engineStopped).toBe(true);
-    expect(exitCode).toBe(0);
-  });
-
-  test("runShutdown() without prior requestShutdown() throws synchronously", () => {
-    const controller = createShutdownController({
-      seed: 1,
-      seedExplicit: true,
-      exit: () => {},
-    });
-    teardowns.push(controller.teardown);
-
-    expect(() => controller.runShutdown()).toThrow(
-      "Shutdown was not requested before runShutdown()",
-    );
-  });
-
-  test("duplicate requestShutdown before runShutdown is deduplicated (no force-exit)", async () => {
-    const engine = createMockEngine();
-    const exitCodes: number[] = [];
-
-    const controller = createShutdownController({
-      seed: 1,
-      seedExplicit: true,
-      exit: (code) => {
-        exitCodes.push(code);
-      },
-    });
-    teardowns.push(controller.teardown);
-    controller.setEngine(engine);
-
-    // First request via signal, second via direct API (simulating admin /shutdown race with SIGINT)
-    process.emit("SIGINT");
-    await controller.waitForShutdownRequest();
-    controller.requestShutdown("admin api"); // second call before runShutdown starts
-    await controller.runShutdown();
-
-    expect(exitCodes).toEqual([0]);
-    expect(engine.stopCalled).toBe(true);
-  });
-
-  test("shutdown request is inert until the owner runs shutdown", async () => {
-    const engine = createMockEngine();
-    let stopCallCount = 0;
-
-    (engine as unknown as Record<string, unknown>)["stop"] = async () => {
-      stopCallCount++;
-    };
-
-    const controller = createShutdownController({
-      seed: 1,
-      seedExplicit: true,
-      exit: () => {},
-    });
-    teardowns.push(controller.teardown);
-    controller.setEngine(engine);
-
-    process.emit("SIGINT");
-    await controller.waitForShutdownRequest();
-
-    expect(stopCallCount).toBe(0);
-
-    await controller.runShutdown();
-
-    expect(stopCallCount).toBe(1);
-  });
-
-  test("task that hangs past timeout: warns and shutdown continues", async () => {
-    const engine = createMockEngine();
-    const steps: string[] = [];
-    let exitCode: number | undefined;
-
-    const controller = createShutdownController({
-      seed: 1,
-      seedExplicit: true,
-      taskTimeoutMs: 30,
-      exit: (code) => {
-        exitCode = code;
-      },
-    });
-    teardowns.push(controller.teardown);
-    controller.setEngine(engine);
-
-    controller.addTask("cleanup", "hanging task", () => new Promise<void>(() => {}));
-    controller.addTask("finalize", "post-timeout step", () => {
-      steps.push("finalize ran");
-    });
-
-    process.emit("SIGINT");
-    await controller.waitForShutdownRequest();
-    await controller.runShutdown();
-
-    expect(steps).toEqual(["finalize ran"]);
-    expect(exitCode).toBe(0);
-  });
-
-  test("task that rejects after timeout does not cause unhandled rejection", async () => {
-    const engine = createMockEngine();
-    const unhandledReasons: unknown[] = [];
-    const onUnhandled = (reason: unknown) => {
-      unhandledReasons.push(reason);
-    };
-    process.on("unhandledRejection", onUnhandled);
-
-    try {
-      const controller = createShutdownController({
-        seed: 1,
-        seedExplicit: true,
-        taskTimeoutMs: 30,
-        exit: () => {},
-      });
-      teardowns.push(controller.teardown);
-      controller.setEngine(engine);
-
-      let rejectLate!: (err: Error) => void;
-      controller.addTask(
-        "cleanup",
-        "slow-then-reject",
-        () =>
-          new Promise<void>((_, reject) => {
-            rejectLate = reject;
-          }),
-      );
-
-      process.emit("SIGINT");
-      await controller.waitForShutdownRequest();
-      await controller.runShutdown(); // task times out after 30ms
-
-      rejectLate(new Error("late rejection after timeout"));
-      await new Promise((resolve) => setTimeout(resolve, 50));
-    } finally {
-      process.removeListener("unhandledRejection", onUnhandled);
-    }
-
-    expect(unhandledReasons).toHaveLength(0);
-  });
-
-  test("teardown removes signal handlers", async () => {
-    const engine = createMockEngine();
-
-    const controller = createShutdownController({
-      seed: 1,
-      seedExplicit: true,
-      exit: () => {},
-    });
-    controller.setEngine(engine);
-    controller.teardown();
-
-    process.emit("SIGINT");
-    await new Promise((resolve) => setTimeout(resolve, 50));
-
-    expect(engine.stopCalled).toBe(false);
-  });
-
-  test("runs cleanup before summary and exit", async () => {
-    const engine = createMockEngine();
-    const steps: string[] = [];
-    configureSummaryLogger({ plain: false, logFormat: "pretty" });
-
-    const controller = createShutdownController({
-      seed: 42,
-      seedExplicit: true,
-      writeFinalOutput: async () => {
-        steps.push("summary");
-      },
-      exit: () => {
-        steps.push("exit");
-      },
-    });
-    teardowns.push(controller.teardown);
-    controller.setEngine(engine);
-    controller.addTask("cleanup", "cleanup", async () => {
-      await new Promise((resolve) => setTimeout(resolve, 25));
-      steps.push("cleanup");
-    });
-    controller.addTask("finalize", "finalize", () => {
-      steps.push("finalize");
-    });
-
-    process.emit("SIGINT");
-    await controller.waitForShutdownRequest();
-    await controller.runShutdown();
-
-    expect(steps).toEqual(["cleanup", "summary", "finalize", "exit"]);
-  });
-
-  test("cleanup failure does not suppress the shutdown summary", async () => {
-    const engine = createMockEngine();
-    let exitCode: number | undefined;
-    const renders: string[] = [];
-
-    configureSummaryLogger({ plain: false, logFormat: "pretty" });
-
-    const controller = createShutdownController({
-      seed: 42,
-      seedExplicit: true,
-      writeFinalOutput: async (text) => {
-        renders.push(text);
-      },
-      exit: (code) => {
-        exitCode = code;
-      },
-    });
-    teardowns.push(controller.teardown);
-    controller.setEngine(engine);
-    controller.addTask("cleanup", "cleanup", () => {
-      throw new Error("cleanup failed");
-    });
-
-    process.emit("SIGINT");
-    await controller.waitForShutdownRequest();
-    await controller.runShutdown();
-
-    expect(exitCode).toBe(0);
-    expect(renders).toHaveLength(1);
-    expect(renders[0]?.includes("Shutdown Summary")).toBe(true);
-  });
-
-  test("renders the rounded shutdown box in pretty mode even when stdout is not a TTY", async () => {
-    const engine = createMockEngine();
-    let exitCode: number | undefined;
-    const renders: string[] = [];
-    const restoreTTY = setStdoutIsTTY(false);
-    configureSummaryLogger({ plain: false, logFormat: "pretty" });
-
-    try {
-      const controller = createShutdownController({
-        seed: 42,
-        seedExplicit: true,
-        writeFinalOutput: async (text) => {
-          renders.push(text);
-        },
-        exit: (code) => {
-          exitCode = code;
-        },
-      });
-      teardowns.push(controller.teardown);
-      controller.setEngine(engine);
-
-      process.emit("SIGINT");
-      await controller.waitForShutdownRequest();
-      await controller.runShutdown();
-    } finally {
-      restoreTTY();
-    }
-
-    expect(exitCode).toBe(0);
-    expect(renders).toHaveLength(1);
-    expect(renders[0]?.includes("Shutdown Summary")).toBe(true);
-    expect(renders[0]?.includes("╭")).toBe(true);
-    expect(renders[0]?.includes("╰")).toBe(true);
-  });
-
-  test("keeps shutdown output plain when --plain is enabled", async () => {
-    const engine = createMockEngine();
-    const renders: string[] = [];
-    configureSummaryLogger({ plain: true, logFormat: "pretty" });
-
-    const controller = createShutdownController({
-      seed: 42,
-      seedExplicit: true,
-      writeFinalOutput: async (text) => {
-        renders.push(text);
-      },
-      exit: () => {},
-    });
-    teardowns.push(controller.teardown);
-    controller.setEngine(engine);
-
-    process.emit("SIGINT");
-    await controller.waitForShutdownRequest();
-    await controller.runShutdown();
-
-    expect(renders).toHaveLength(1);
-    expect(renders[0]?.startsWith("Shutdown Summary\n")).toBe(true);
-    expect(renders[0]?.includes("╭")).toBe(false);
-  });
-
-  test("prints top 5 error contexts in shutdown summary", async () => {
-    const engine = createMockEngine();
-    let exitCode: number | undefined;
-    const renders: string[] = [];
-    configureSummaryLogger({ plain: true, logFormat: "pretty" });
-
-    const controller = createShutdownController({
-      seed: 42,
-      seedExplicit: true,
-      errorContextCounts: new Map([
-        ["mqtt:publish", 9],
-        ["tick-overrun", 7],
-        ["mqtt:backpressure", 5],
-        ["mqtt:reconnect", 3],
-        ['circuit-breaker instance="pump-001"', 2],
-        ["mqtt:client", 1],
-      ]),
-      writeFinalOutput: async (text) => {
-        renders.push(text);
-      },
-      exit: (code) => {
-        exitCode = code;
-      },
-    });
-    teardowns.push(controller.teardown);
-    controller.setEngine(engine);
-
-    process.emit("SIGINT");
-    await controller.waitForShutdownRequest();
-    await controller.runShutdown();
-
-    const output = renders[0] ?? "";
-    expect(exitCode).toBe(0);
-    expect(output.includes("Top errors")).toBe(true);
-    expect(output.includes("mqtt:publish")).toBe(true);
-    expect(output.includes("tick-overrun")).toBe(true);
-    expect(output.includes("mqtt:backpressure")).toBe(true);
-    expect(output.includes("mqtt:reconnect")).toBe(true);
-    expect(output.includes('circuit-breaker instance="pump-001"')).toBe(true);
-    expect(output.includes("mqtt:client")).toBe(false);
-  });
-});