@openstatus/health-planetscale 0.1.4-dev.0

package/README.md

@@ -0,0 +1,73 @@
+# @openstatus/health-planetscale
+
+[PlanetScale](https://planetscale.com/) probe for
+[`@openstatus/health`](https://jsr.io/@openstatus/health). Runs `select 1`
+over the serverless HTTP driver,
+[`@planetscale/database`](https://github.com/planetscale/database-js), and
+fails the check when the round trip does.
+
+```sh
+deno add jsr:@openstatus/health jsr:@openstatus/health-planetscale
+npm install @openstatus/health @openstatus/health-planetscale
+```
+
+```ts
+import { connect } from "@planetscale/database";
+import { createHealthHandler } from "@openstatus/health";
+import { planetscaleProbe } from "@openstatus/health-planetscale";
+
+const connection = connect({ url: env.DATABASE_URL });
+
+Deno.serve(
+  createHealthHandler({
+    probes: [planetscaleProbe({ connection })],
+  }),
+);
+```
+
+Every probe is one stateless `fetch` against PlanetScale's HTTP API, so
+nothing stays open between health requests and the probe runs on edge
+runtimes. A `Client` from the same package works too — the probe only calls
+`execute("select 1")`. The driver's `execute()` takes no `AbortSignal`, so a
+check that outlives `timeoutMs` is reported `timeout` while the HTTP request
+runs to completion in the background; pass a `fetch` with its own deadline to
+`connect()` if that matters. For a PlanetScale database reached through
+`mysql2` instead, use `@openstatus/health-mysql`.
+
+```ts
+planetscaleProbe({
+  connection,
+  // 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 connection is typed structurally as `{ execute(query): PromiseLike<...> }`,
+so `@planetscale/database` 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 connection has no `execute()`.
+
+## 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,30 @@
+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 planetscaleDefaultName = "database";
+/** A probe that runs `select 1`; critical by default. The driver's `execute()` takes no `AbortSignal`, so a timed-out request is not cancelled. Throws `ProbeConfigError` without `execute()`. */
+function planetscaleProbe(options) {
+	const connection = options.connection;
+	if (typeof connection?.execute !== "function") throw new __openstatus_health.ProbeConfigError("planetscaleProbe", "connection", `must expose execute(), got ${describe(connection)}`);
+	return {
+		name: options.name ?? planetscaleDefaultName,
+		critical: options.critical ?? true,
+		timeoutMs: options.timeoutMs,
+		skip: options.skip,
+		run: async () => {
+			await connection.execute("select 1");
+		}
+	};
+}
+function describe(connection) {
+	if (connection == null) return String(connection);
+	if (typeof connection !== "object") return typeof connection;
+	const keys = Object.keys(connection);
+	return keys.length === 0 ? "an object with no keys" : `an object with keys ${keys.slice(0, 8).join(", ")}`;
+}
+
+//#endregion
+exports.planetscaleDefaultName = planetscaleDefaultName;
+exports.planetscaleProbe = planetscaleProbe;

package/dist/mod.d.cts

@@ -0,0 +1,22 @@
+import { Probe, ProbeOverrides, ProbeResult } from "@openstatus/health";
+
+//#region src/mod.d.ts
+
+/** Probe name when `name` is unset. */
+declare const planetscaleDefaultName = "database";
+/** The subset of a `@planetscale/database` `Connection` or `Client` the probe uses. */
+interface PlanetScaleLikeConnection {
+  /** Run one statement. */
+  execute(query: string): PromiseLike<ProbeResult>;
+}
+/** Options for `planetscaleProbe()`. */
+interface PlanetScaleProbeOptions extends ProbeOverrides {
+  /** A `connect()` connection or a `Client`. */
+  readonly connection: PlanetScaleLikeConnection;
+}
+/** A probe that runs `select 1`; critical by default. The driver's `execute()` takes no `AbortSignal`, so a timed-out request is not cancelled. Throws `ProbeConfigError` without `execute()`. */
+declare function planetscaleProbe(options: PlanetScaleProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { PlanetScaleLikeConnection, PlanetScaleProbeOptions, planetscaleDefaultName, planetscaleProbe };
+//# 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":";;;;AAqCA;AAAgC,cAfnB,sBAAA,GAemB,UAAA;;AAAoC,UAZnD,yBAAA,CAYmD;EAAK;0BAV/C,YAAY;;;UAIrB,uBAAA,SAAgC;;uBAE1B;;;iBAIP,gBAAA,UAA0B,0BAA0B"}

package/dist/mod.d.ts

@@ -0,0 +1,22 @@
+import { Probe, ProbeOverrides, ProbeResult } from "@openstatus/health";
+
+//#region src/mod.d.ts
+
+/** Probe name when `name` is unset. */
+declare const planetscaleDefaultName = "database";
+/** The subset of a `@planetscale/database` `Connection` or `Client` the probe uses. */
+interface PlanetScaleLikeConnection {
+  /** Run one statement. */
+  execute(query: string): PromiseLike<ProbeResult>;
+}
+/** Options for `planetscaleProbe()`. */
+interface PlanetScaleProbeOptions extends ProbeOverrides {
+  /** A `connect()` connection or a `Client`. */
+  readonly connection: PlanetScaleLikeConnection;
+}
+/** A probe that runs `select 1`; critical by default. The driver's `execute()` takes no `AbortSignal`, so a timed-out request is not cancelled. Throws `ProbeConfigError` without `execute()`. */
+declare function planetscaleProbe(options: PlanetScaleProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { PlanetScaleLikeConnection, PlanetScaleProbeOptions, planetscaleDefaultName, planetscaleProbe };
+//# 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":";;;;AAqCA;AAAgC,cAfnB,sBAAA,GAemB,UAAA;;AAAoC,UAZnD,yBAAA,CAYmD;EAAK;0BAV/C,YAAY;;;UAIrB,uBAAA,SAAgC;;uBAE1B;;;iBAIP,gBAAA,UAA0B,0BAA0B"}

package/dist/mod.js

@@ -0,0 +1,29 @@
+import { ProbeConfigError } from "@openstatus/health";
+
+//#region src/mod.ts
+/** Probe name when `name` is unset. */
+const planetscaleDefaultName = "database";
+/** A probe that runs `select 1`; critical by default. The driver's `execute()` takes no `AbortSignal`, so a timed-out request is not cancelled. Throws `ProbeConfigError` without `execute()`. */
+function planetscaleProbe(options) {
+	const connection = options.connection;
+	if (typeof connection?.execute !== "function") throw new ProbeConfigError("planetscaleProbe", "connection", `must expose execute(), got ${describe(connection)}`);
+	return {
+		name: options.name ?? planetscaleDefaultName,
+		critical: options.critical ?? true,
+		timeoutMs: options.timeoutMs,
+		skip: options.skip,
+		run: async () => {
+			await connection.execute("select 1");
+		}
+	};
+}
+function describe(connection) {
+	if (connection == null) return String(connection);
+	if (typeof connection !== "object") return typeof connection;
+	const keys = Object.keys(connection);
+	return keys.length === 0 ? "an object with no keys" : `an object with keys ${keys.slice(0, 8).join(", ")}`;
+}
+
+//#endregion
+export { planetscaleDefaultName, planetscaleProbe };
+//# sourceMappingURL=mod.js.map

package/dist/mod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.js","names":["options: PlanetScaleProbeOptions","connection: PlanetScaleLikeConnection"],"sources":["../src/mod.ts"],"sourcesContent":["/**\n * PlanetScale probe for `@openstatus/health`: runs `select 1` over the\n * serverless HTTP driver from `@planetscale/database`.\n *\n * ```ts\n * import { connect } from \"@planetscale/database\";\n * import { planetscaleProbe } from \"@openstatus/health-planetscale\";\n *\n * const probe = planetscaleProbe({ connection: connect({ url }) });\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 planetscaleDefaultName = \"database\";\n\n/** The subset of a `@planetscale/database` `Connection` or `Client` the probe uses. */\nexport interface PlanetScaleLikeConnection {\n  /** Run one statement. */\n  execute(query: string): PromiseLike<ProbeResult>;\n}\n\n/** Options for `planetscaleProbe()`. */\nexport interface PlanetScaleProbeOptions extends ProbeOverrides {\n  /** A `connect()` connection or a `Client`. */\n  readonly connection: PlanetScaleLikeConnection;\n}\n\n/** A probe that runs `select 1`; critical by default. The driver's `execute()` takes no `AbortSignal`, so a timed-out request is not cancelled. Throws `ProbeConfigError` without `execute()`. */\nexport function planetscaleProbe(options: PlanetScaleProbeOptions): Probe {\n  const connection = options.connection;\n  if (typeof connection?.execute !== \"function\") {\n    throw new ProbeConfigError(\n      \"planetscaleProbe\",\n      \"connection\",\n      `must expose execute(), got ${describe(connection)}`,\n    );\n  }\n  return {\n    name: options.name ?? planetscaleDefaultName,\n    critical: options.critical ?? true,\n    timeoutMs: options.timeoutMs,\n    skip: options.skip,\n    run: async () => {\n      await connection.execute(\"select 1\");\n    },\n  };\n}\n\nfunction describe(connection: PlanetScaleLikeConnection): string {\n  if (connection == null) return String(connection);\n  if (typeof connection !== \"object\") return typeof connection;\n  const keys = Object.keys(connection);\n  return keys.length === 0\n    ? \"an object with no keys\"\n    : `an object with keys ${keys.slice(0, 8).join(\", \")}`;\n}\n"],"mappings":";;;;AAsBA,MAAa,yBAAyB;;AAetC,SAAgB,iBAAiBA,SAAyC;CACxE,MAAM,aAAa,QAAQ;AAC3B,YAAW,YAAY,YAAY,WACjC,OAAM,IAAI,iBACR,oBACA,eACC,6BAA6B,SAAS,WAAW,CAAC;AAGvD,QAAO;EACL,MAAM,QAAQ,QAAQ;EACtB,UAAU,QAAQ,YAAY;EAC9B,WAAW,QAAQ;EACnB,MAAM,QAAQ;EACd,KAAK,YAAY;AACf,SAAM,WAAW,QAAQ,WAAW;EACrC;CACF;AACF;AAED,SAAS,SAASC,YAA+C;AAC/D,KAAI,cAAc,KAAM,QAAO,OAAO,WAAW;AACjD,YAAW,eAAe,SAAU,eAAc;CAClD,MAAM,OAAO,OAAO,KAAK,WAAW;AACpC,QAAO,KAAK,WAAW,IACnB,4BACC,sBAAsB,KAAK,MAAM,GAAG,EAAE,CAAC,KAAK,KAAK,CAAC;AACxD"}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@openstatus/health-planetscale",
+  "version": "0.1.4-dev.0",
+  "description": "PlanetScale serverless driver probe for @openstatus/health",
+  "keywords": [
+    "openstatus",
+    "health",
+    "healthcheck",
+    "planetscale",
+    "mysql",
+    "serverless",
+    "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/planetscale/"
+  },
+  "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",
+    "@planetscale/database": ">=1.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@planetscale/database": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@planetscale/database": "^1.19.0",
+    "tsdown": "^0.12.7",
+    "typescript": "^5.8.3"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "prepack": "tsdown",
+    "test": "node --experimental-transform-types --test"
+  }
+}