@openstatus/health-prisma 0.1.4-dev.0

package/README.md

@@ -0,0 +1,85 @@
+# @openstatus/health-prisma
+
+[Prisma](https://www.prisma.io/) probe for
+[`@openstatus/health`](https://jsr.io/@openstatus/health). Runs `select 1`
+through `$queryRawUnsafe()` on every SQL connector — or the `ping` command
+through `$runCommandRaw()` when `connector` is `"mongodb"` — and fails the
+check when the round trip does.
+
+```sh
+deno add jsr:@openstatus/health jsr:@openstatus/health-prisma
+npm install @openstatus/health @openstatus/health-prisma
+```
+
+```ts
+import { PrismaClient } from "@prisma/client";
+import { createHealthHandler } from "@openstatus/health";
+import { prismaProbe } from "@openstatus/health-prisma";
+
+const prisma = new PrismaClient();
+
+Deno.serve(
+  createHealthHandler({ probes: [prismaProbe({ client: prisma })] }),
+);
+```
+
+`connector` selects the call; it defaults to `"sql"`:
+
+| `connector` | Connectors | Call |
+| ----------- | ---------- | ---- |
+| `"sql"` | PostgreSQL, MySQL, SQLite, SQL Server, CockroachDB | `client.$queryRawUnsafe("select 1")` |
+| `"mongodb"` | MongoDB | `client.$runCommandRaw({ ping: 1 })` |
+
+The choice is explicit rather than detected because Prisma's runtime defines
+both methods on every generated client and only its type declarations hide
+the one your connector does not support, so a MongoDB client would otherwise
+be sent SQL.
+
+`$queryRawUnsafe` is used with a constant string only — nothing from the
+request reaches it — and is the raw entry point that takes a plain string
+rather than a tagged template. Prisma opens its connection pool lazily on the
+first query, so the first probe after start-up also pays for the connect.
+Prisma's raw APIs take no `AbortSignal`, so a query that outlives
+`timeoutMs` is reported as `timeout` but keeps its pooled connection busy
+until the database answers; set a server-side statement timeout on the
+database user if that matters.
+
+```ts
+prismaProbe({
+  client: prisma,
+  connector: "mongodb",
+  // optional overrides from the Probe contract
+  name: "primary",
+  critical: false,
+  timeoutMs: 2000,
+  skip: () => env.DATABASE_URL == null,
+});
+```
+
+Critical by default: a database that does not answer usually means requests
+cannot be served, so the report turns `unhealthy` and the instance is taken
+out of rotation. Set `critical: false` for a replica or reporting database.
+
+The client is typed structurally as `{ $queryRawUnsafe(query) }` or
+`{ $runCommandRaw(command) }`, so `@prisma/client` is an optional peer
+dependency for its types only and the probe adds no runtime import of it.
+The factory throws `ProbeConfigError` at construction when the client lacks
+the method for the chosen `connector`.
+
+## About openstatus
+
+[openstatus](https://www.openstatus.dev/) is the open-source uptime monitoring
+and status page platform. This package is part of
+[`@openstatus/health`](https://github.com/openstatusHQ/health), the `/health`
+endpoints behind openstatus's own services, extracted so any JavaScript server
+can expose one. Point an
+[openstatus monitor](https://www.openstatus.dev/docs/reference/http-monitor)
+at the endpoint and assert on `status` in the body to be alerted on
+`degraded` before it becomes `unhealthy`.
+
+Source: [github.com/openstatusHQ/health](https://github.com/openstatusHQ/health).
+Issues and PRs welcome.
+
+## License
+
+[MIT](https://github.com/openstatusHQ/health/blob/main/LICENSE)

package/dist/_virtual/rolldown_runtime.cjs

@@ -0,0 +1,30 @@
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+
+Object.defineProperty(exports, '__toESM', {
+  enumerable: true,
+  get: function () {
+    return __toESM;
+  }
+});

package/dist/mod.cjs

@@ -0,0 +1,37 @@
+const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
+const __openstatus_health = require_rolldown_runtime.__toESM(require("@openstatus/health"));
+
+//#region src/mod.ts
+/** Probe name when `name` is unset. */
+const prismaDefaultName = "database";
+/** Connector when `connector` is unset. */
+const prismaDefaultConnector = "sql";
+/** A probe that runs `select 1` or, on MongoDB, `{ ping: 1 }`; critical by default. Throws `ProbeConfigError` when the client lacks the method for `connector`. */
+function prismaProbe(options) {
+	const client = options.client;
+	const connector = options.connector ?? prismaDefaultConnector;
+	if (connector !== "sql" && connector !== "mongodb") throw new __openstatus_health.ProbeConfigError("prismaProbe", "connector", `must be "sql" or "mongodb", got ${String(connector)}`);
+	const method = connector === "mongodb" ? "$runCommandRaw" : "$queryRawUnsafe";
+	if (typeof client?.[method] !== "function") throw new __openstatus_health.ProbeConfigError("prismaProbe", "client", `must expose ${method}() for the ${connector} connector, got ${describe(client)}`);
+	const run = connector === "mongodb" ? () => client.$runCommandRaw({ ping: 1 }) : () => client.$queryRawUnsafe("select 1");
+	return {
+		name: options.name ?? prismaDefaultName,
+		critical: options.critical ?? true,
+		timeoutMs: options.timeoutMs,
+		skip: options.skip,
+		run: async () => {
+			await run();
+		}
+	};
+}
+function describe(client) {
+	if (client == null) return String(client);
+	if (typeof client !== "object") return typeof client;
+	const keys = Object.keys(client);
+	return keys.length === 0 ? "an object with no keys" : `an object with keys ${keys.slice(0, 8).join(", ")}`;
+}
+
+//#endregion
+exports.prismaDefaultConnector = prismaDefaultConnector;
+exports.prismaDefaultName = prismaDefaultName;
+exports.prismaProbe = prismaProbe;

package/dist/mod.d.cts

@@ -0,0 +1,32 @@
+import { Probe, ProbeOverrides, ProbeResult } from "@openstatus/health";
+
+//#region src/mod.d.ts
+
+/** Probe name when `name` is unset. */
+declare const prismaDefaultName = "database";
+/** Connector when `connector` is unset. */
+declare const prismaDefaultConnector = "sql";
+/** Which raw entry point the probe calls. */
+type PrismaConnector = "sql" | "mongodb";
+/** The subset of a `PrismaClient` the probe uses; the method for the chosen `connector` must exist. */
+interface PrismaLikeClient {
+  /** SQL connectors. */
+  $queryRawUnsafe?(query: string): PromiseLike<ProbeResult>;
+  /** The MongoDB connector. */
+  $runCommandRaw?(command: {
+    readonly ping: 1;
+  }): PromiseLike<ProbeResult>;
+}
+/** Options for `prismaProbe()`. */
+interface PrismaProbeOptions extends ProbeOverrides {
+  /** A generated `PrismaClient`. */
+  readonly client: PrismaLikeClient;
+  /** `"mongodb"` calls `$runCommandRaw()`; anything else calls `$queryRawUnsafe()`. Default `prismaDefaultConnector`. */
+  readonly connector?: PrismaConnector;
+}
+/** A probe that runs `select 1` or, on MongoDB, `{ ping: 1 }`; critical by default. Throws `ProbeConfigError` when the client lacks the method for `connector`. */
+declare function prismaProbe(options: PrismaProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { PrismaConnector, PrismaLikeClient, PrismaProbeOptions, prismaDefaultConnector, prismaDefaultName, prismaProbe };
+//# sourceMappingURL=mod.d.cts.map

package/dist/mod.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.cts","names":[],"sources":["../src/mod.ts"],"sourcesContent":[],"mappings":";;;;;AAwC4C,cAhB/B,iBAAA,GAgB+B,UAAA;AAAc;AAQ1C,cAtBH,sBAAA,GAsBc,KAAA;;AAAU,KAnBzB,eAAA,GAmByB,KAAA,GAAA,SAAA;;AAA0B,UAhB9C,gBAAA,CAgB8C;;mCAd5B,YAAY;;;;MAEG,YAAY;;;UAI7C,kBAAA,SAA2B;;mBAEzB;;uBAEI;;;iBAIP,WAAA,UAAqB,qBAAqB"}

package/dist/mod.d.ts

@@ -0,0 +1,32 @@
+import { Probe, ProbeOverrides, ProbeResult } from "@openstatus/health";
+
+//#region src/mod.d.ts
+
+/** Probe name when `name` is unset. */
+declare const prismaDefaultName = "database";
+/** Connector when `connector` is unset. */
+declare const prismaDefaultConnector = "sql";
+/** Which raw entry point the probe calls. */
+type PrismaConnector = "sql" | "mongodb";
+/** The subset of a `PrismaClient` the probe uses; the method for the chosen `connector` must exist. */
+interface PrismaLikeClient {
+  /** SQL connectors. */
+  $queryRawUnsafe?(query: string): PromiseLike<ProbeResult>;
+  /** The MongoDB connector. */
+  $runCommandRaw?(command: {
+    readonly ping: 1;
+  }): PromiseLike<ProbeResult>;
+}
+/** Options for `prismaProbe()`. */
+interface PrismaProbeOptions extends ProbeOverrides {
+  /** A generated `PrismaClient`. */
+  readonly client: PrismaLikeClient;
+  /** `"mongodb"` calls `$runCommandRaw()`; anything else calls `$queryRawUnsafe()`. Default `prismaDefaultConnector`. */
+  readonly connector?: PrismaConnector;
+}
+/** A probe that runs `select 1` or, on MongoDB, `{ ping: 1 }`; critical by default. Throws `ProbeConfigError` when the client lacks the method for `connector`. */
+declare function prismaProbe(options: PrismaProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { PrismaConnector, PrismaLikeClient, PrismaProbeOptions, prismaDefaultConnector, prismaDefaultName, prismaProbe };
+//# sourceMappingURL=mod.d.ts.map

package/dist/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","names":[],"sources":["../src/mod.ts"],"sourcesContent":[],"mappings":";;;;;AAwC4C,cAhB/B,iBAAA,GAgB+B,UAAA;AAAc;AAQ1C,cAtBH,sBAAA,GAsBc,KAAA;;AAAU,KAnBzB,eAAA,GAmByB,KAAA,GAAA,SAAA;;AAA0B,UAhB9C,gBAAA,CAgB8C;;mCAd5B,YAAY;;;;MAEG,YAAY;;;UAI7C,kBAAA,SAA2B;;mBAEzB;;uBAEI;;;iBAIP,WAAA,UAAqB,qBAAqB"}

package/dist/mod.js

@@ -0,0 +1,35 @@
+import { ProbeConfigError } from "@openstatus/health";
+
+//#region src/mod.ts
+/** Probe name when `name` is unset. */
+const prismaDefaultName = "database";
+/** Connector when `connector` is unset. */
+const prismaDefaultConnector = "sql";
+/** A probe that runs `select 1` or, on MongoDB, `{ ping: 1 }`; critical by default. Throws `ProbeConfigError` when the client lacks the method for `connector`. */
+function prismaProbe(options) {
+	const client = options.client;
+	const connector = options.connector ?? prismaDefaultConnector;
+	if (connector !== "sql" && connector !== "mongodb") throw new ProbeConfigError("prismaProbe", "connector", `must be "sql" or "mongodb", got ${String(connector)}`);
+	const method = connector === "mongodb" ? "$runCommandRaw" : "$queryRawUnsafe";
+	if (typeof client?.[method] !== "function") throw new ProbeConfigError("prismaProbe", "client", `must expose ${method}() for the ${connector} connector, got ${describe(client)}`);
+	const run = connector === "mongodb" ? () => client.$runCommandRaw({ ping: 1 }) : () => client.$queryRawUnsafe("select 1");
+	return {
+		name: options.name ?? prismaDefaultName,
+		critical: options.critical ?? true,
+		timeoutMs: options.timeoutMs,
+		skip: options.skip,
+		run: async () => {
+			await run();
+		}
+	};
+}
+function describe(client) {
+	if (client == null) return String(client);
+	if (typeof client !== "object") return typeof client;
+	const keys = Object.keys(client);
+	return keys.length === 0 ? "an object with no keys" : `an object with keys ${keys.slice(0, 8).join(", ")}`;
+}
+
+//#endregion
+export { prismaDefaultConnector, prismaDefaultName, prismaProbe };
+//# sourceMappingURL=mod.js.map

package/dist/mod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.js","names":["options: PrismaProbeOptions","run: () => PromiseLike<ProbeResult>","client: PrismaLikeClient"],"sources":["../src/mod.ts"],"sourcesContent":["/**\n * Prisma probe for `@openstatus/health`: runs `select 1` through\n * `$queryRawUnsafe()` on SQL databases, or the `ping` command through\n * `$runCommandRaw()` when `connector` is `\"mongodb\"`.\n *\n * ```ts\n * import { PrismaClient } from \"@prisma/client\";\n * import { prismaProbe } from \"@openstatus/health-prisma\";\n *\n * const probe = prismaProbe({ client: new PrismaClient() });\n * const mongo = prismaProbe({ client: new PrismaClient(), connector: \"mongodb\" });\n * ```\n *\n * @module\n */\n\nimport {\n  type Probe,\n  ProbeConfigError,\n  type ProbeOverrides,\n  type ProbeResult,\n} from \"@openstatus/health\";\n\n/** Probe name when `name` is unset. */\nexport const prismaDefaultName = \"database\";\n/** Connector when `connector` is unset. */\nexport const prismaDefaultConnector = \"sql\";\n\n/** Which raw entry point the probe calls. */\nexport type PrismaConnector = \"sql\" | \"mongodb\";\n\n/** The subset of a `PrismaClient` the probe uses; the method for the chosen `connector` must exist. */\nexport interface PrismaLikeClient {\n  /** SQL connectors. */\n  $queryRawUnsafe?(query: string): PromiseLike<ProbeResult>;\n  /** The MongoDB connector. */\n  $runCommandRaw?(command: { readonly ping: 1 }): PromiseLike<ProbeResult>;\n}\n\n/** Options for `prismaProbe()`. */\nexport interface PrismaProbeOptions extends ProbeOverrides {\n  /** A generated `PrismaClient`. */\n  readonly client: PrismaLikeClient;\n  /** `\"mongodb\"` calls `$runCommandRaw()`; anything else calls `$queryRawUnsafe()`. Default `prismaDefaultConnector`. */\n  readonly connector?: PrismaConnector;\n}\n\n/** A probe that runs `select 1` or, on MongoDB, `{ ping: 1 }`; critical by default. Throws `ProbeConfigError` when the client lacks the method for `connector`. */\nexport function prismaProbe(options: PrismaProbeOptions): Probe {\n  const client = options.client;\n  const connector = options.connector ?? prismaDefaultConnector;\n  if (connector !== \"sql\" && connector !== \"mongodb\") {\n    throw new ProbeConfigError(\n      \"prismaProbe\",\n      \"connector\",\n      `must be \"sql\" or \"mongodb\", got ${String(connector)}`,\n    );\n  }\n  const method = connector === \"mongodb\" ? \"$runCommandRaw\" : \"$queryRawUnsafe\";\n  if (typeof client?.[method] !== \"function\") {\n    throw new ProbeConfigError(\n      \"prismaProbe\",\n      \"client\",\n      `must expose ${method}() for the ${connector} connector, got ${\n        describe(client)\n      }`,\n    );\n  }\n  const run: () => PromiseLike<ProbeResult> = connector === \"mongodb\"\n    ? () => client.$runCommandRaw!({ ping: 1 })\n    : () => client.$queryRawUnsafe!(\"select 1\");\n  return {\n    name: options.name ?? prismaDefaultName,\n    critical: options.critical ?? true,\n    timeoutMs: options.timeoutMs,\n    skip: options.skip,\n    run: async () => {\n      await run();\n    },\n  };\n}\n\nfunction describe(client: PrismaLikeClient): string {\n  if (client == null) return String(client);\n  if (typeof client !== \"object\") return typeof client;\n  const keys = Object.keys(client);\n  return keys.length === 0\n    ? \"an object with no keys\"\n    : `an object with keys ${keys.slice(0, 8).join(\", \")}`;\n}\n"],"mappings":";;;;AAwBA,MAAa,oBAAoB;;AAEjC,MAAa,yBAAyB;;AAsBtC,SAAgB,YAAYA,SAAoC;CAC9D,MAAM,SAAS,QAAQ;CACvB,MAAM,YAAY,QAAQ,aAAa;AACvC,KAAI,cAAc,SAAS,cAAc,UACvC,OAAM,IAAI,iBACR,eACA,cACC,kCAAkC,OAAO,UAAU,CAAC;CAGzD,MAAM,SAAS,cAAc,YAAY,mBAAmB;AAC5D,YAAW,SAAS,YAAY,WAC9B,OAAM,IAAI,iBACR,eACA,WACC,cAAc,OAAO,aAAa,UAAU,kBAC3C,SAAS,OAAO,CACjB;CAGL,MAAMC,MAAsC,cAAc,YACtD,MAAM,OAAO,eAAgB,EAAE,MAAM,EAAG,EAAC,GACzC,MAAM,OAAO,gBAAiB,WAAW;AAC7C,QAAO;EACL,MAAM,QAAQ,QAAQ;EACtB,UAAU,QAAQ,YAAY;EAC9B,WAAW,QAAQ;EACnB,MAAM,QAAQ;EACd,KAAK,YAAY;AACf,SAAM,KAAK;EACZ;CACF;AACF;AAED,SAAS,SAASC,QAAkC;AAClD,KAAI,UAAU,KAAM,QAAO,OAAO,OAAO;AACzC,YAAW,WAAW,SAAU,eAAc;CAC9C,MAAM,OAAO,OAAO,KAAK,OAAO;AAChC,QAAO,KAAK,WAAW,IACnB,4BACC,sBAAsB,KAAK,MAAM,GAAG,EAAE,CAAC,KAAK,KAAK,CAAC;AACxD"}

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@openstatus/health-prisma",
+  "version": "0.1.4-dev.0",
+  "description": "Prisma probe for @openstatus/health",
+  "keywords": [
+    "openstatus",
+    "health",
+    "healthcheck",
+    "prisma",
+    "orm",
+    "database"
+  ],
+  "license": "MIT",
+  "author": {
+    "name": "openstatus",
+    "url": "https://www.openstatus.dev/"
+  },
+  "homepage": "https://github.com/openstatusHQ/health",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/openstatusHQ/health.git",
+    "directory": "packages/prisma/"
+  },
+  "bugs": {
+    "url": "https://github.com/openstatusHQ/health/issues"
+  },
+  "type": "module",
+  "module": "./dist/mod.js",
+  "main": "./dist/mod.cjs",
+  "types": "./dist/mod.d.ts",
+  "exports": {
+    ".": {
+      "types": {
+        "import": "./dist/mod.d.ts",
+        "require": "./dist/mod.d.cts"
+      },
+      "import": "./dist/mod.js",
+      "require": "./dist/mod.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "files": [
+    "dist/"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "peerDependencies": {
+    "@openstatus/health": "^0.1.4-dev.0",
+    "@prisma/client": ">=5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@prisma/client": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "tsdown": "^0.12.7",
+    "typescript": "^5.8.3"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "prepack": "tsdown",
+    "test": "node --experimental-transform-types --test"
+  }
+}