@openstatus/health-postgres 0.1.4-dev.0

package/README.md

@@ -0,0 +1,80 @@
+# @openstatus/health-postgres
+
+[PostgreSQL](https://www.postgresql.org/) probe for
+[`@openstatus/health`](https://jsr.io/@openstatus/health). Runs `select 1`
+through the client you already have — a [`pg`](https://node-postgres.com/)
+pool or client, a [postgres.js](https://github.com/porsager/postgres) `sql`
+instance, `@neondatabase/serverless` or `@vercel/postgres` — and fails the
+check when the round trip does.
+
+```sh
+deno add jsr:@openstatus/health jsr:@openstatus/health-postgres
+npm install @openstatus/health @openstatus/health-postgres
+```
+
+```ts
+import { Pool } from "pg";
+import { createHealthHandler } from "@openstatus/health";
+import { postgresProbe } from "@openstatus/health-postgres";
+
+const pool = new Pool({ connectionString: env.DATABASE_URL });
+
+Deno.serve(
+  createHealthHandler({ probes: [postgresProbe({ client: pool })] }),
+);
+```
+
+The probe picks the first method the client exposes:
+
+| Client | Call |
+| ------ | ---- |
+| `pg` `Pool` / `Client`, `@vercel/postgres` `sql`, Neon `Pool` / `Client` / `neon()` | `client.query("select 1")` |
+| postgres.js `sql` | `sql.unsafe("select 1")` |
+
+Pass a pool rather than a single connection where you can: a pool checks a
+connection out per probe and hands it back, so the health endpoint never
+holds one open and never collides with request traffic on a shared client.
+
+A timed-out check is reported `timeout` and the round moves on; the driver
+query is not cancelled, because none of the supported clients expose a
+portable abort (`pg` and `@vercel/postgres` take query text only, and
+postgres.js cancels through the pending query's `.cancel()` rather than a
+signal). With a pool, the connection returns to it once the query settles.
+
+```ts
+postgresProbe({
+  client: pool,
+  // optional overrides from the Probe contract
+  name: "primary",
+  critical: false,
+  timeoutMs: 2000,
+  skip: () => env.DATABASE_URL == null,
+});
+```
+
+Critical by default: a Postgres 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 `{ query(text) }` or `{ unsafe(text) }`,
+so `pg` and `postgres` are optional peer dependencies for their types only
+and the probe adds no runtime import of either. The factory throws
+`ProbeConfigError` at construction when the client has neither method.
+
+## 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,33 @@
+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 postgresDefaultName = "database";
+/** A probe that runs `select 1`; critical by default. Throws `ProbeConfigError` without `query()` or `unsafe()`. */
+function postgresProbe(options) {
+	const client = options.client;
+	let run;
+	if (typeof client?.query === "function") run = () => client.query("select 1");
+	else if (typeof client?.unsafe === "function") run = () => client.unsafe("select 1");
+	else throw new __openstatus_health.ProbeConfigError("postgresProbe", "client", `must expose query() or unsafe(), got ${describe(client)}`);
+	return {
+		name: options.name ?? postgresDefaultName,
+		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" && typeof client !== "function") return typeof client;
+	const keys = Object.keys(client);
+	return keys.length === 0 ? `${typeof client === "function" ? "a function" : "an object"} with no keys` : `an object with keys ${keys.slice(0, 8).join(", ")}`;
+}
+
+//#endregion
+exports.postgresDefaultName = postgresDefaultName;
+exports.postgresProbe = postgresProbe;

package/dist/mod.d.cts

@@ -0,0 +1,24 @@
+import { Probe, ProbeOverrides, ProbeResult } from "@openstatus/health";
+
+//#region src/mod.d.ts
+
+/** Probe name when `name` is unset. */
+declare const postgresDefaultName = "database";
+/** The subset of a Postgres client the probe uses; one of the two methods must exist. */
+interface PostgresLikeClient {
+  /** `pg` pools and clients, `@vercel/postgres`, Neon's `Pool` and `sql.query()`. */
+  query?(text: string): PromiseLike<ProbeResult>;
+  /** postgres.js's `sql.unsafe()`. */
+  unsafe?(query: string): PromiseLike<ProbeResult>;
+}
+/** Options for `postgresProbe()`. */
+interface PostgresProbeOptions extends ProbeOverrides {
+  /** A Postgres pool, client or postgres.js `sql` instance. */
+  readonly client: PostgresLikeClient;
+}
+/** A probe that runs `select 1`; critical by default. Throws `ProbeConfigError` without `query()` or `unsafe()`. */
+declare function postgresProbe(options: PostgresProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { PostgresLikeClient, PostgresProbeOptions, postgresDefaultName, postgresProbe };
+//# 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":";;;;;AA2C8D,cAjBjD,mBAAA,GAiBiD,UAAA;AAAK;UAdlD,kBAAA;;wBAEO,YAAY;;0BAEV,YAAY;;;UAIrB,oBAAA,SAA6B;;mBAE3B;;;iBAIH,aAAA,UAAuB,uBAAuB"}

package/dist/mod.d.ts

@@ -0,0 +1,24 @@
+import { Probe, ProbeOverrides, ProbeResult } from "@openstatus/health";
+
+//#region src/mod.d.ts
+
+/** Probe name when `name` is unset. */
+declare const postgresDefaultName = "database";
+/** The subset of a Postgres client the probe uses; one of the two methods must exist. */
+interface PostgresLikeClient {
+  /** `pg` pools and clients, `@vercel/postgres`, Neon's `Pool` and `sql.query()`. */
+  query?(text: string): PromiseLike<ProbeResult>;
+  /** postgres.js's `sql.unsafe()`. */
+  unsafe?(query: string): PromiseLike<ProbeResult>;
+}
+/** Options for `postgresProbe()`. */
+interface PostgresProbeOptions extends ProbeOverrides {
+  /** A Postgres pool, client or postgres.js `sql` instance. */
+  readonly client: PostgresLikeClient;
+}
+/** A probe that runs `select 1`; critical by default. Throws `ProbeConfigError` without `query()` or `unsafe()`. */
+declare function postgresProbe(options: PostgresProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { PostgresLikeClient, PostgresProbeOptions, postgresDefaultName, postgresProbe };
+//# 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":";;;;;AA2C8D,cAjBjD,mBAAA,GAiBiD,UAAA;AAAK;UAdlD,kBAAA;;wBAEO,YAAY;;0BAEV,YAAY;;;UAIrB,oBAAA,SAA6B;;mBAE3B;;;iBAIH,aAAA,UAAuB,uBAAuB"}

package/dist/mod.js

@@ -0,0 +1,32 @@
+import { ProbeConfigError } from "@openstatus/health";
+
+//#region src/mod.ts
+/** Probe name when `name` is unset. */
+const postgresDefaultName = "database";
+/** A probe that runs `select 1`; critical by default. Throws `ProbeConfigError` without `query()` or `unsafe()`. */
+function postgresProbe(options) {
+	const client = options.client;
+	let run;
+	if (typeof client?.query === "function") run = () => client.query("select 1");
+	else if (typeof client?.unsafe === "function") run = () => client.unsafe("select 1");
+	else throw new ProbeConfigError("postgresProbe", "client", `must expose query() or unsafe(), got ${describe(client)}`);
+	return {
+		name: options.name ?? postgresDefaultName,
+		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" && typeof client !== "function") return typeof client;
+	const keys = Object.keys(client);
+	return keys.length === 0 ? `${typeof client === "function" ? "a function" : "an object"} with no keys` : `an object with keys ${keys.slice(0, 8).join(", ")}`;
+}
+
+//#endregion
+export { postgresDefaultName, postgresProbe };
+//# sourceMappingURL=mod.js.map

package/dist/mod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.js","names":["options: PostgresProbeOptions","run: () => PromiseLike<ProbeResult>","client: PostgresLikeClient"],"sources":["../src/mod.ts"],"sourcesContent":["/**\n * Postgres probe for `@openstatus/health`: runs `select 1` through `pg`,\n * postgres.js, `@neondatabase/serverless`, `@vercel/postgres` or any client\n * with a `query()` or `unsafe()` method.\n *\n * ```ts\n * import { Pool } from \"pg\";\n * import { postgresProbe } from \"@openstatus/health-postgres\";\n *\n * const probe = postgresProbe({ client: new Pool({ connectionString }) });\n * ```\n *\n * A timed-out check is reported `timeout` without cancelling the in-flight\n * driver query: none of the supported clients accept an `AbortSignal`.\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 postgresDefaultName = \"database\";\n\n/** The subset of a Postgres client the probe uses; one of the two methods must exist. */\nexport interface PostgresLikeClient {\n  /** `pg` pools and clients, `@vercel/postgres`, Neon's `Pool` and `sql.query()`. */\n  query?(text: string): PromiseLike<ProbeResult>;\n  /** postgres.js's `sql.unsafe()`. */\n  unsafe?(query: string): PromiseLike<ProbeResult>;\n}\n\n/** Options for `postgresProbe()`. */\nexport interface PostgresProbeOptions extends ProbeOverrides {\n  /** A Postgres pool, client or postgres.js `sql` instance. */\n  readonly client: PostgresLikeClient;\n}\n\n/** A probe that runs `select 1`; critical by default. Throws `ProbeConfigError` without `query()` or `unsafe()`. */\nexport function postgresProbe(options: PostgresProbeOptions): Probe {\n  const client = options.client;\n  let run: () => PromiseLike<ProbeResult>;\n  if (typeof client?.query === \"function\") {\n    run = () => client.query!(\"select 1\");\n  } else if (typeof client?.unsafe === \"function\") {\n    run = () => client.unsafe!(\"select 1\");\n  } else {\n    throw new ProbeConfigError(\n      \"postgresProbe\",\n      \"client\",\n      `must expose query() or unsafe(), got ${describe(client)}`,\n    );\n  }\n  return {\n    name: options.name ?? postgresDefaultName,\n    critical: options.critical ?? true,\n    timeoutMs: options.timeoutMs,\n    skip: options.skip,\n    // The signal is ignored: no supported driver takes an AbortSignal, so a\n    // timed-out query keeps running. See the README.\n    run: async () => {\n      await run();\n    },\n  };\n}\n\nfunction describe(client: PostgresLikeClient): string {\n  if (client == null) return String(client);\n  if (typeof client !== \"object\" && typeof client !== \"function\") {\n    return typeof client;\n  }\n  const keys = Object.keys(client);\n  return keys.length === 0\n    ? `${\n      typeof client === \"function\" ? \"a function\" : \"an object\"\n    } with no keys`\n    : `an object with keys ${keys.slice(0, 8).join(\", \")}`;\n}\n"],"mappings":";;;;AA0BA,MAAa,sBAAsB;;AAiBnC,SAAgB,cAAcA,SAAsC;CAClE,MAAM,SAAS,QAAQ;CACvB,IAAIC;AACJ,YAAW,QAAQ,UAAU,WAC3B,OAAM,MAAM,OAAO,MAAO,WAAW;iBACrB,QAAQ,WAAW,WACnC,OAAM,MAAM,OAAO,OAAQ,WAAW;KAEtC,OAAM,IAAI,iBACR,iBACA,WACC,uCAAuC,SAAS,OAAO,CAAC;AAG7D,QAAO;EACL,MAAM,QAAQ,QAAQ;EACtB,UAAU,QAAQ,YAAY;EAC9B,WAAW,QAAQ;EACnB,MAAM,QAAQ;EAGd,KAAK,YAAY;AACf,SAAM,KAAK;EACZ;CACF;AACF;AAED,SAAS,SAASC,QAAoC;AACpD,KAAI,UAAU,KAAM,QAAO,OAAO,OAAO;AACzC,YAAW,WAAW,mBAAmB,WAAW,WAClD,eAAc;CAEhB,MAAM,OAAO,OAAO,KAAK,OAAO;AAChC,QAAO,KAAK,WAAW,KAClB,SACM,WAAW,aAAa,eAAe,YAC/C,kBACE,sBAAsB,KAAK,MAAM,GAAG,EAAE,CAAC,KAAK,KAAK,CAAC;AACxD"}

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@openstatus/health-postgres",
+  "version": "0.1.4-dev.0",
+  "description": "Postgres probe for @openstatus/health",
+  "keywords": [
+    "openstatus",
+    "health",
+    "healthcheck",
+    "postgres",
+    "postgresql",
+    "pg",
+    "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/postgres/"
+  },
+  "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",
+    "pg": ">=8.0.0",
+    "postgres": ">=3.0.0"
+  },
+  "peerDependenciesMeta": {
+    "pg": {
+      "optional": true
+    },
+    "postgres": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "pg": "^8.16.0",
+    "@types/pg": "^8.15.0",
+    "postgres": "^3.4.0",
+    "tsdown": "^0.12.7",
+    "typescript": "^5.8.3"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "prepack": "tsdown",
+    "test": "node --experimental-transform-types --test"
+  }
+}