feat(compute): rename keep awake guard

Author: rtbenfield

packages/compute/README.md

@@ -19,27 +19,27 @@ import { waitUntil } from "@prisma/compute";
 waitUntil(doCriticalWork(), { signal: AbortSignal.timeout(30_000) });
 ```
 
-`ScaleToZeroGuard` is a disposable object that keeps the application awake until the guard is released. Use it for a scoped function or block of background work. `ScaleToZeroGuard` can be created multiple times during a single request and is safe to nest. Pass an `AbortSignal`, usually from `AbortSignal.timeout(ms)`, as a safety bound if release is not reached. The signal releases the guard only; it does not cancel the guarded work.
+`KeepAwakeGuard` is a disposable object that keeps the application awake until the guard is released. Use it for a scoped function or block of background work. `KeepAwakeGuard` can be created multiple times during a single request and is safe to nest. Pass an `AbortSignal`, usually from `AbortSignal.timeout(ms)`, as a safety bound if release is not reached. The signal releases the guard only; it does not cancel the guarded work.
 
 Read more about disposables and the `using` keyword in the [MDN resource management guide](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Resource_management).
 
 ```ts
-import { ScaleToZeroGuard } from "@prisma/compute";
+import { KeepAwakeGuard } from "@prisma/compute";
 
 async function runsInBackground() {
   // guard is acquired here
-  using guard = new ScaleToZeroGuard({ signal: AbortSignal.timeout(30_000) });
+  using guard = new KeepAwakeGuard({ signal: AbortSignal.timeout(30_000) });
   await doCriticalWork();
 } // guard is released here
 ```
 
 If `using` is not available, call `.release()` manually. Always release the guard in a `finally` block so it is released even if the guarded code throws.
 
 ```ts
-import { ScaleToZeroGuard } from "@prisma/compute";
+import { KeepAwakeGuard } from "@prisma/compute";
 
 async function runsInBackground() {
-  const guard = new ScaleToZeroGuard({ signal: AbortSignal.timeout(30_000) });
+  const guard = new KeepAwakeGuard({ signal: AbortSignal.timeout(30_000) });
 
   try {
     await doCriticalWork();

packages/compute/src/index.ts

@@ -1,6 +1,6 @@
 // biome-ignore lint/performance/noBarrelFile: Package entrypoint intentionally re-exports the public API.
 export {
-  ScaleToZeroGuard,
-  type ScaleToZeroGuardOptions,
+  KeepAwakeGuard,
+  type KeepAwakeGuardOptions,
   waitUntil,
-} from "./scale-to-zero";
+} from "./keep-awake-guard";

packages/compute/src/scale-to-zero.ts packages/compute/src/keep-awake-guard.tspackages/compute/src/scale-to-zero.ts renamed to packages/compute/src/keep-awake-guard.ts

@@ -3,7 +3,7 @@ import { writeScaleToZeroSignal } from "./scale-to-zero-control";
 /**
  * Options for holding a Prisma Compute sleep guard.
  */
-export interface ScaleToZeroGuardOptions {
+export interface KeepAwakeGuardOptions {
   /**
    * Signal that releases the keep-awake guard when aborted.
    *
@@ -19,7 +19,7 @@ export interface ScaleToZeroGuardOptions {
  * Keeps a Prisma Compute application awake for scoped async work.
  *
  * Creating a guard signals the compute runtime to stay awake. Calling
- * {@link ScaleToZeroGuard.release}, leaving a `using` scope, or reaching
+ * {@link KeepAwakeGuard.release}, leaving a `using` scope, or reaching
  * the configured abort signal releases that signal. Release is idempotent, so
  * manual release and disposal can be combined safely.
  *
@@ -32,23 +32,23 @@ export interface ScaleToZeroGuardOptions {
  *
  * @example
  * ```ts
- * import { ScaleToZeroGuard } from "@prisma/compute";
+ * import { KeepAwakeGuard } from "@prisma/compute";
  *
- * using guard = new ScaleToZeroGuard({ signal: AbortSignal.timeout(30_000) });
+ * using guard = new KeepAwakeGuard({ signal: AbortSignal.timeout(30_000) });
  * await doCriticalWork();
  * ```
  *
  * @example
  * ```ts
- * const guard = new ScaleToZeroGuard();
+ * const guard = new KeepAwakeGuard();
  * try {
  *   await doCriticalWork();
  * } finally {
  *   guard.release();
  * }
  * ```
  */
-export class ScaleToZeroGuard implements Disposable {
+export class KeepAwakeGuard implements Disposable {
   #active: boolean;
   #abortSignal: AbortSignal | undefined;
   #abortListener: (() => void) | undefined;
@@ -61,7 +61,7 @@ export class ScaleToZeroGuard implements Disposable {
    * guarded work. Passing a signal is recommended as a safety bound if release
    * is not reached.
    */
-  constructor(options: ScaleToZeroGuardOptions = {}) {
+  constructor(options: KeepAwakeGuardOptions = {}) {
     if (options.signal?.aborted) {
       this.#active = false;
       return;
@@ -100,7 +100,7 @@ export class ScaleToZeroGuard implements Disposable {
    * Releases the guard when used with TypeScript's `using` syntax.
    *
    * Most callers should prefer `using` for scoped work and call
-   * {@link ScaleToZeroGuard.release} only when release needs to happen before
+   * {@link KeepAwakeGuard.release} only when release needs to happen before
    * the scope exits.
    */
   [Symbol.dispose](): void {
@@ -140,10 +140,10 @@ export class ScaleToZeroGuard implements Disposable {
  */
 export function waitUntil(
   promise: PromiseLike<unknown>,
-  options?: ScaleToZeroGuardOptions,
+  options?: KeepAwakeGuardOptions,
 ): void {
   // biome-ignore lint/nursery/useDisposables: waitUntil transfers guard cleanup to the promise finally handler.
-  const guard = new ScaleToZeroGuard(options);
+  const guard = new KeepAwakeGuard(options);
 
   // Do not attach a catch here; callers rely on the underlying promise keeping
   // its normal unhandled-rejection behavior.

…ages/compute/tests/scale-to-zero.test.ts …s/compute/tests/keep-awake-guard.test.tspackages/compute/tests/scale-to-zero.test.ts renamed to packages/compute/tests/keep-awake-guard.test.ts packages/compute/tests/scale-to-zero.test.ts renamed to packages/compute/tests/keep-awake-guard.test.ts

@@ -4,7 +4,7 @@ import path from "node:path";
 
 import { afterEach, describe, expect, it, vi } from "vitest";
 
-import { ScaleToZeroGuard, waitUntil } from "../src/index";
+import { KeepAwakeGuard, waitUntil } from "../src/index";
 import { configureScaleToZeroControlFileForTests } from "../src/scale-to-zero-control";
 
 async function createControlFile(): Promise<{ dir: string; file: string }> {
@@ -20,7 +20,7 @@ async function readSignals(file: string): Promise<string> {
   return await fs.readFile(file, "utf8");
 }
 
-describe("scale-to-zero guard", () => {
+describe("keep-awake guard", () => {
   afterEach(async () => {
     vi.useRealTimers();
     configureScaleToZeroControlFileForTests(undefined);
@@ -29,7 +29,7 @@ describe("scale-to-zero guard", () => {
   it("writes acquire and release signals for a disposable guard", async () => {
     const { file } = await createControlFile();
 
-    using guard = new ScaleToZeroGuard();
+    using guard = new KeepAwakeGuard();
 
     expect(await readSignals(file)).toBe("+");
     guard.release();
@@ -38,7 +38,7 @@ describe("scale-to-zero guard", () => {
 
   it("releases only once when release is called multiple times", async () => {
     const { file } = await createControlFile();
-    using guard = new ScaleToZeroGuard();
+    using guard = new KeepAwakeGuard();
 
     guard.release();
     guard.release();
@@ -51,7 +51,7 @@ describe("scale-to-zero guard", () => {
     const { file } = await createControlFile();
     const controller = new AbortController();
 
-    using guard = new ScaleToZeroGuard({ signal: controller.signal });
+    using guard = new KeepAwakeGuard({ signal: controller.signal });
     expect(await readSignals(file)).toBe("+");
 
     controller.abort();
@@ -66,7 +66,7 @@ describe("scale-to-zero guard", () => {
     const controller = new AbortController();
     controller.abort();
 
-    using guard = new ScaleToZeroGuard({ signal: controller.signal });
+    using guard = new KeepAwakeGuard({ signal: controller.signal });
     guard.release();
 
     expect(await readSignals(file)).toBe("");
@@ -119,7 +119,7 @@ describe("scale-to-zero guard", () => {
   it("removes the abort listener after manual release", async () => {
     const { file } = await createControlFile();
     const controller = new AbortController();
-    using guard = new ScaleToZeroGuard({ signal: controller.signal });
+    using guard = new KeepAwakeGuard({ signal: controller.signal });
 
     guard.release();
     controller.abort();