@prisma/compute 0.0.0-dev.0

package/LICENSE

@@ -0,0 +1,158 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work.
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work by
+the copyright owner or by an individual or Legal Entity authorized to submit on
+behalf of the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent to the
+Licensor or its representatives, including but not limited to communication on
+electronic mailing lists, source code control systems, and issue tracking
+systems that are managed by, or on behalf of, the Licensor for the purpose of
+discussing and improving the Work, but excluding communication that is
+conspicuously marked or otherwise designated in writing by the copyright owner
+as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable copyright license to
+reproduce, prepare Derivative Works of, publicly display, publicly perform,
+sublicense, and distribute the Work and such Derivative Works in Source or Object
+form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License,
+each Contributor hereby grants to You a perpetual, worldwide, non-exclusive,
+no-charge, royalty-free, irrevocable (except as stated in this section) patent
+license to make, have made, use, offer to sell, sell, import, and otherwise
+transfer the Work, where such license applies only to those patent claims
+licensable by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s) with the Work to
+which such Contribution(s) was submitted. If You institute patent litigation
+against any entity (including a cross-claim or counterclaim in a lawsuit)
+alleging that the Work or a Contribution incorporated within the Work
+constitutes direct or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate as of the date
+such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or
+Derivative Works thereof in any medium, with or without modifications, and in
+Source or Object form, provided that You meet the following conditions:
+
+(a) You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+
+(b) You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works that You
+distribute, all copyright, patent, trademark, and attribution notices from the
+Source form of the Work, excluding those notices that do not pertain to any part
+of the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its distribution, then
+any Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the Derivative
+Works; within the Source form or documentation, if provided along with the
+Derivative Works; or, within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents of the NOTICE
+file are for informational purposes only and do not modify the License. You may
+add Your own attribution notices within Derivative Works that You distribute,
+alongside or as an addendum to the NOTICE text from the Work, provided that such
+additional attribution notices cannot be construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any
+Contribution intentionally submitted for inclusion in the Work by You to the
+Licensor shall be under the terms and conditions of this License, without any
+additional terms or conditions. Notwithstanding the above, nothing herein shall
+supersede or modify the terms of any separate license agreement you may have
+executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names,
+trademarks, service marks, or product names of the Licensor, except as required
+for reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
+writing, Licensor provides the Work (and each Contributor provides its
+Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+either express or implied, including, without limitation, any warranties or
+conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any risks
+associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in
+tort (including negligence), contract, or otherwise, unless required by
+applicable law (such as deliberate and grossly negligent acts) or agreed to in
+writing, shall any Contributor be liable to You for damages, including any
+direct, indirect, special, incidental, or consequential damages of any character
+arising as a result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill, work stoppage,
+computer failure or malfunction, or any and all other commercial damages or
+losses), even if such Contributor has been advised of the possibility of such
+damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or
+Derivative Works thereof, You may choose to offer, and charge a fee for,
+acceptance of support, warranty, indemnity, or other liability obligations and/or
+rights consistent with this License. However, in accepting such obligations, You
+may act only on Your own behalf and on Your sole responsibility, not on behalf of
+any other Contributor, and only if You agree to indemnify, defend, and hold each
+Contributor harmless for any liability incurred by, or claims asserted against,
+such Contributor by reason of your accepting any such warranty or additional
+liability.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,50 @@
+# Prisma Compute
+
+`@prisma/compute` provides runtime utilities for applications deployed to Prisma
+Compute.
+
+## Preventing Application Sleep
+
+Applications deployed to Prisma Compute can sleep after short periods of inactivity. When an application sleeps, Prisma Compute snapshots its memory and resumes from that snapshot when the next request arrives.
+
+This works well for request-driven code, but background work outside the request lifecycle can be interrupted when the application sleeps. Examples include `setTimeout`, `setInterval`, and background `Promise` work.
+
+`@prisma/compute` provides two utilities that signal to Prisma Compute that work is still active and the application should stay awake.
+
+`waitUntil` keeps the application awake until a `Promise` settles. It returns `void`, so callers should keep using the original promise for result and error handling. Pass an `AbortSignal`, usually from `AbortSignal.timeout(ms)`, as a safety bound if the promise does not settle. `waitUntil` can be called multiple times during a single request.
+
+```ts
+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.
+
+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";
+
+async function runsInBackground() {
+  // guard is acquired here
+  using guard = new ScaleToZeroGuard({ 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";
+
+async function runsInBackground() {
+  const guard = new ScaleToZeroGuard({ signal: AbortSignal.timeout(30_000) });
+
+  try {
+    await doCriticalWork();
+  } finally {
+    guard.release();
+  }
+}
+```

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import { ScaleToZeroGuard, ScaleToZeroGuardOptions, waitUntil } from "./scale-to-zero.js";
+export { ScaleToZeroGuard, type ScaleToZeroGuardOptions, waitUntil };

package/dist/index.js

@@ -0,0 +1,2 @@
+import { ScaleToZeroGuard, waitUntil } from "./scale-to-zero.js";
+export { ScaleToZeroGuard, waitUntil };

package/dist/scale-to-zero-control.js

@@ -0,0 +1,33 @@
+import fs from "node:fs";
+let controlFileState = {
+	kind: "uninitialized",
+	path: "/uk/libukp/scale_to_zero_disable"
+};
+function writeScaleToZeroSignal(signal) {
+	const state = getControlFileState();
+	if (state.kind !== "open") return false;
+	try {
+		fs.writeSync(state.fd, signal === "acquire" ? "+" : "-");
+		return true;
+	} catch {
+		return false;
+	}
+}
+function getControlFileState() {
+	if (controlFileState.kind !== "uninitialized") return controlFileState;
+	try {
+		controlFileState = {
+			kind: "open",
+			fd: fs.openSync(controlFileState.path, fs.constants.O_WRONLY),
+			path: controlFileState.path
+		};
+	} catch {
+		controlFileState = {
+			kind: "unavailable",
+			path: controlFileState.path
+		};
+	}
+	return controlFileState;
+}
+//#endregion
+export { writeScaleToZeroSignal };

package/dist/scale-to-zero.d.ts

@@ -0,0 +1,93 @@
+//#region src/scale-to-zero.d.ts
+/**
+ * Options for holding a Prisma Compute sleep guard.
+ */
+interface ScaleToZeroGuardOptions {
+  /**
+   * Signal that releases the guard when aborted.
+   *
+   * Use `AbortSignal.timeout(ms)` for a time bound, or pass a request or
+   * operation signal to tie the guard to caller-owned cancellation. Passing a
+   * signal is strongly recommended as a safety bound for dangling guards.
+   */
+  signal?: AbortSignal;
+}
+/**
+ * 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
+ * the configured abort signal releases that signal. Release is idempotent, so
+ * manual release and disposal can be combined safely.
+ *
+ * Pass `signal` whenever possible, usually from `AbortSignal.timeout(ms)`, to
+ * bound how long the guard can keep the instance awake if release is not reached.
+ *
+ * Outside the Prisma Compute runtime, where the sleep control endpoint is
+ * unavailable, the guard is a no-op.
+ *
+ * @example
+ * ```ts
+ * import { ScaleToZeroGuard } from "@prisma/compute";
+ *
+ * using guard = new ScaleToZeroGuard({ signal: AbortSignal.timeout(30_000) });
+ * await doCriticalWork();
+ * ```
+ *
+ * @example
+ * ```ts
+ * const guard = new ScaleToZeroGuard();
+ * try {
+ *   await doCriticalWork();
+ * } finally {
+ *   guard.release();
+ * }
+ * ```
+ */
+declare class ScaleToZeroGuard implements Disposable {
+  #private;
+  /**
+   * Creates a guard and immediately signals the compute runtime to stay awake.
+   *
+   * If `signal` is already aborted, no signal is written. If `signal` aborts
+   * while the guard is active, the guard releases itself. Passing a signal is
+   * recommended as a safety bound if release is not reached.
+   */
+  constructor(options?: ScaleToZeroGuardOptions);
+  /**
+   * Releases the guard's keep-awake signal.
+   *
+   * This method is idempotent. Calling it multiple times, or calling it before
+   * a `using` scope exits, writes at most one release signal.
+   */
+  release(): void;
+  /**
+   * 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
+   * the scope exits.
+   */
+  [Symbol.dispose](): void;
+}
+/**
+ * Keeps a Prisma Compute application awake until a promise settles.
+ *
+ * The guard is acquired immediately, then released from a `finally` handler on
+ * the passed promise. This function returns `void`; callers should keep using
+ * the original promise for result and error handling. If `signal` aborts first,
+ * only the guard is released; the passed promise continues independently.
+ *
+ * Pass `signal`, usually from `AbortSignal.timeout(ms)`, to bound guard lifetime
+ * even when the promise does not settle.
+ *
+ * @example
+ * ```ts
+ * import { waitUntil } from "@prisma/compute";
+ *
+ * waitUntil(sendWebhook(), { signal: AbortSignal.timeout(10_000) });
+ * ```
+ */
+declare function waitUntil(promise: PromiseLike<unknown>, options?: ScaleToZeroGuardOptions): void;
+//#endregion
+export { ScaleToZeroGuard, ScaleToZeroGuardOptions, waitUntil };

package/dist/scale-to-zero.js

@@ -0,0 +1,116 @@
+import { writeScaleToZeroSignal } from "./scale-to-zero-control.js";
+//#region src/scale-to-zero.ts
+/**
+* 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
+* the configured abort signal releases that signal. Release is idempotent, so
+* manual release and disposal can be combined safely.
+*
+* Pass `signal` whenever possible, usually from `AbortSignal.timeout(ms)`, to
+* bound how long the guard can keep the instance awake if release is not reached.
+*
+* Outside the Prisma Compute runtime, where the sleep control endpoint is
+* unavailable, the guard is a no-op.
+*
+* @example
+* ```ts
+* import { ScaleToZeroGuard } from "@prisma/compute";
+*
+* using guard = new ScaleToZeroGuard({ signal: AbortSignal.timeout(30_000) });
+* await doCriticalWork();
+* ```
+*
+* @example
+* ```ts
+* const guard = new ScaleToZeroGuard();
+* try {
+*   await doCriticalWork();
+* } finally {
+*   guard.release();
+* }
+* ```
+*/
+var ScaleToZeroGuard = class {
+	#active;
+	#abortSignal;
+	#abortListener;
+	/**
+	* Creates a guard and immediately signals the compute runtime to stay awake.
+	*
+	* If `signal` is already aborted, no signal is written. If `signal` aborts
+	* while the guard is active, the guard releases itself. Passing a signal is
+	* recommended as a safety bound if release is not reached.
+	*/
+	constructor(options = {}) {
+		if (options.signal?.aborted) {
+			this.#active = false;
+			return;
+		}
+		this.#active = writeScaleToZeroSignal("acquire");
+		if (this.#active && options.signal !== void 0) {
+			this.#abortSignal = options.signal;
+			this.#abortListener = () => {
+				this.release();
+			};
+			options.signal.addEventListener("abort", this.#abortListener, { once: true });
+		}
+	}
+	/**
+	* Releases the guard's keep-awake signal.
+	*
+	* This method is idempotent. Calling it multiple times, or calling it before
+	* a `using` scope exits, writes at most one release signal.
+	*/
+	release() {
+		if (!this.#active) return;
+		this.#active = false;
+		this.#removeAbortListener();
+		writeScaleToZeroSignal("release");
+	}
+	/**
+	* 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
+	* the scope exits.
+	*/
+	[Symbol.dispose]() {
+		this.release();
+	}
+	#removeAbortListener() {
+		if (this.#abortSignal === void 0 || this.#abortListener === void 0) return;
+		this.#abortSignal.removeEventListener("abort", this.#abortListener);
+		this.#abortSignal = void 0;
+		this.#abortListener = void 0;
+	}
+};
+/**
+* Keeps a Prisma Compute application awake until a promise settles.
+*
+* The guard is acquired immediately, then released from a `finally` handler on
+* the passed promise. This function returns `void`; callers should keep using
+* the original promise for result and error handling. If `signal` aborts first,
+* only the guard is released; the passed promise continues independently.
+*
+* Pass `signal`, usually from `AbortSignal.timeout(ms)`, to bound guard lifetime
+* even when the promise does not settle.
+*
+* @example
+* ```ts
+* import { waitUntil } from "@prisma/compute";
+*
+* waitUntil(sendWebhook(), { signal: AbortSignal.timeout(10_000) });
+* ```
+*/
+function waitUntil(promise, options) {
+	const guard = new ScaleToZeroGuard(options);
+	Promise.resolve(promise).finally(() => {
+		try {
+			guard.release();
+		} catch {}
+	});
+}
+//#endregion
+export { ScaleToZeroGuard, waitUntil };

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@prisma/compute",
+  "version": "0.0.0-dev.0",
+  "description": "Utilities for applications running on the Prisma compute runtime.",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "keywords": [
+    "prisma",
+    "compute",
+    "runtime"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/prisma/prisma-cli.git",
+    "directory": "packages/compute"
+  },
+  "homepage": "https://github.com/prisma/prisma-cli#readme",
+  "bugs": {
+    "url": "https://github.com/prisma/prisma-cli/issues"
+  },
+  "license": "Apache-2.0",
+  "scripts": {
+    "build": "tsdown",
+    "prepack": "pnpm run build",
+    "test": "vitest run"
+  },
+  "devDependencies": {
+    "@types/node": "^22.19.19",
+    "tsdown": "^0.21.10",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.8"
+  }
+}