@openstatus/health-mongodb 0.1.4-dev.0

package/README.md

@@ -0,0 +1,70 @@
+# @openstatus/health-mongodb
+
+[MongoDB](https://www.mongodb.com/) probe for
+[`@openstatus/health`](https://jsr.io/@openstatus/health). Runs the
+[`ping`](https://www.mongodb.com/docs/manual/reference/command/ping/) command
+through the official [`mongodb`](https://github.com/mongodb/node-mongodb-native)
+driver and fails the check when the server does not answer.
+
+```sh
+deno add jsr:@openstatus/health jsr:@openstatus/health-mongodb
+npm install @openstatus/health @openstatus/health-mongodb
+```
+
+```ts
+import { MongoClient } from "mongodb";
+import { createHealthHandler } from "@openstatus/health";
+import { mongodbProbe } from "@openstatus/health-mongodb";
+
+const client = new MongoClient(env.MONGODB_URI);
+
+Deno.serve(
+  createHealthHandler({ probes: [mongodbProbe({ client })] }),
+);
+```
+
+`ping` is the command MongoDB recommends for connectivity checks: it needs
+no privileges beyond being authenticated, touches no collection and returns
+as soon as the server selected by the driver responds. It runs against the
+`admin` database by default; pass `db` to send the command to the database
+your application uses. Note that `ping` does not verify the credentials can
+read or write that database's collections.
+
+```ts
+mongodbProbe({
+  client,
+  db: "app",
+  // optional overrides from the Probe contract
+  name: "mongo",
+  critical: false,
+  timeoutMs: 2000,
+  skip: () => env.MONGODB_URI == null,
+});
+```
+
+Critical by default: a MongoDB 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 secondary or analytics cluster.
+
+The client is typed structurally as `{ db(name?): { command({ ping: 1 }) } }`,
+so `mongodb` 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 has no `db()`.
+
+## 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,34 @@
+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 mongodbDefaultName = "database";
+/** Database the `ping` command runs against when `db` is unset. */
+const mongodbDefaultDb = "admin";
+/** A probe that runs `{ ping: 1 }`; critical by default. Throws `ProbeConfigError` without `db()`. */
+function mongodbProbe(options) {
+	const client = options.client;
+	if (typeof client?.db !== "function") throw new __openstatus_health.ProbeConfigError("mongodbProbe", "client", `must expose db(), got ${describe(client)}`);
+	const dbName = options.db ?? mongodbDefaultDb;
+	return {
+		name: options.name ?? mongodbDefaultName,
+		critical: options.critical ?? true,
+		timeoutMs: options.timeoutMs,
+		skip: options.skip,
+		run: async (signal) => {
+			await client.db(dbName).command({ ping: 1 }, { signal });
+		}
+	};
+}
+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.mongodbDefaultDb = mongodbDefaultDb;
+exports.mongodbDefaultName = mongodbDefaultName;
+exports.mongodbProbe = mongodbProbe;

package/dist/mod.d.cts

@@ -0,0 +1,38 @@
+import { Probe, ProbeOverrides, ProbeResult } from "@openstatus/health";
+
+//#region src/mod.d.ts
+
+/** Probe name when `name` is unset. */
+declare const mongodbDefaultName = "database";
+/** Database the `ping` command runs against when `db` is unset. */
+declare const mongodbDefaultDb = "admin";
+/** What the probe passes to `command()`. */
+interface MongoCommandOptions {
+  /** Aborts when the probe times out. */
+  readonly signal?: AbortSignal;
+}
+/** The subset of a `mongodb` `Db` the probe uses. */
+interface MongoLikeDb {
+  /** Run a database command. */
+  command(command: {
+    readonly ping: 1;
+  }, options?: MongoCommandOptions): PromiseLike<ProbeResult>;
+}
+/** The subset of a `MongoClient` the probe uses. */
+interface MongoLikeClient {
+  /** Select a database. */
+  db(name?: string): MongoLikeDb;
+}
+/** Options for `mongodbProbe()`. */
+interface MongodbProbeOptions extends ProbeOverrides {
+  /** A `MongoClient`. */
+  readonly client: MongoLikeClient;
+  /** Database to run `ping` on. Default `mongodbDefaultDb`. */
+  readonly db?: string;
+}
+/** A probe that runs `{ ping: 1 }`; critical by default. Throws `ProbeConfigError` without `db()`. */
+declare function mongodbProbe(options: MongodbProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { MongoCommandOptions, MongoLikeClient, MongoLikeDb, MongodbProbeOptions, mongodbDefaultDb, mongodbDefaultName, mongodbProbe };
+//# 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":";;;;;AAkDmB,cA5BN,kBAAA,GA4BM,UAAA;;AAFwC,cAxB9C,gBAAA,GAwB8C,OAAA;AAQ3D;AAA4B,UA7BX,mBAAA,CA6BW;EAAA;EAA6B,SAAG,MAAA,CAAA,EA3BxC,WA2BwC;AAAK;;UAvBhD,WAAA;;;;eAIH,sBACT,YAAY;;;UAIA,eAAA;;qBAEI;;;UAIJ,mBAAA,SAA4B;;mBAE1B;;;;;iBAMH,YAAA,UAAsB,sBAAsB"}

package/dist/mod.d.ts

@@ -0,0 +1,38 @@
+import { Probe, ProbeOverrides, ProbeResult } from "@openstatus/health";
+
+//#region src/mod.d.ts
+
+/** Probe name when `name` is unset. */
+declare const mongodbDefaultName = "database";
+/** Database the `ping` command runs against when `db` is unset. */
+declare const mongodbDefaultDb = "admin";
+/** What the probe passes to `command()`. */
+interface MongoCommandOptions {
+  /** Aborts when the probe times out. */
+  readonly signal?: AbortSignal;
+}
+/** The subset of a `mongodb` `Db` the probe uses. */
+interface MongoLikeDb {
+  /** Run a database command. */
+  command(command: {
+    readonly ping: 1;
+  }, options?: MongoCommandOptions): PromiseLike<ProbeResult>;
+}
+/** The subset of a `MongoClient` the probe uses. */
+interface MongoLikeClient {
+  /** Select a database. */
+  db(name?: string): MongoLikeDb;
+}
+/** Options for `mongodbProbe()`. */
+interface MongodbProbeOptions extends ProbeOverrides {
+  /** A `MongoClient`. */
+  readonly client: MongoLikeClient;
+  /** Database to run `ping` on. Default `mongodbDefaultDb`. */
+  readonly db?: string;
+}
+/** A probe that runs `{ ping: 1 }`; critical by default. Throws `ProbeConfigError` without `db()`. */
+declare function mongodbProbe(options: MongodbProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { MongoCommandOptions, MongoLikeClient, MongoLikeDb, MongodbProbeOptions, mongodbDefaultDb, mongodbDefaultName, mongodbProbe };
+//# 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":";;;;;AAkDmB,cA5BN,kBAAA,GA4BM,UAAA;;AAFwC,cAxB9C,gBAAA,GAwB8C,OAAA;AAQ3D;AAA4B,UA7BX,mBAAA,CA6BW;EAAA;EAA6B,SAAG,MAAA,CAAA,EA3BxC,WA2BwC;AAAK;;UAvBhD,WAAA;;;;eAIH,sBACT,YAAY;;;UAIA,eAAA;;qBAEI;;;UAIJ,mBAAA,SAA4B;;mBAE1B;;;;;iBAMH,YAAA,UAAsB,sBAAsB"}

package/dist/mod.js

@@ -0,0 +1,32 @@
+import { ProbeConfigError } from "@openstatus/health";
+
+//#region src/mod.ts
+/** Probe name when `name` is unset. */
+const mongodbDefaultName = "database";
+/** Database the `ping` command runs against when `db` is unset. */
+const mongodbDefaultDb = "admin";
+/** A probe that runs `{ ping: 1 }`; critical by default. Throws `ProbeConfigError` without `db()`. */
+function mongodbProbe(options) {
+	const client = options.client;
+	if (typeof client?.db !== "function") throw new ProbeConfigError("mongodbProbe", "client", `must expose db(), got ${describe(client)}`);
+	const dbName = options.db ?? mongodbDefaultDb;
+	return {
+		name: options.name ?? mongodbDefaultName,
+		critical: options.critical ?? true,
+		timeoutMs: options.timeoutMs,
+		skip: options.skip,
+		run: async (signal) => {
+			await client.db(dbName).command({ ping: 1 }, { signal });
+		}
+	};
+}
+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 { mongodbDefaultDb, mongodbDefaultName, mongodbProbe };
+//# sourceMappingURL=mod.js.map

package/dist/mod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.js","names":["options: MongodbProbeOptions","client: MongoLikeClient"],"sources":["../src/mod.ts"],"sourcesContent":["/**\n * MongoDB probe for `@openstatus/health`: runs the `ping` command through the\n * official `mongodb` driver.\n *\n * ```ts\n * import { MongoClient } from \"mongodb\";\n * import { mongodbProbe } from \"@openstatus/health-mongodb\";\n *\n * const probe = mongodbProbe({ client: new MongoClient(env.MONGODB_URI) });\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 mongodbDefaultName = \"database\";\n/** Database the `ping` command runs against when `db` is unset. */\nexport const mongodbDefaultDb = \"admin\";\n\n/** What the probe passes to `command()`. */\nexport interface MongoCommandOptions {\n  /** Aborts when the probe times out. */\n  readonly signal?: AbortSignal;\n}\n\n/** The subset of a `mongodb` `Db` the probe uses. */\nexport interface MongoLikeDb {\n  /** Run a database command. */\n  command(\n    command: { readonly ping: 1 },\n    options?: MongoCommandOptions,\n  ): PromiseLike<ProbeResult>;\n}\n\n/** The subset of a `MongoClient` the probe uses. */\nexport interface MongoLikeClient {\n  /** Select a database. */\n  db(name?: string): MongoLikeDb;\n}\n\n/** Options for `mongodbProbe()`. */\nexport interface MongodbProbeOptions extends ProbeOverrides {\n  /** A `MongoClient`. */\n  readonly client: MongoLikeClient;\n  /** Database to run `ping` on. Default `mongodbDefaultDb`. */\n  readonly db?: string;\n}\n\n/** A probe that runs `{ ping: 1 }`; critical by default. Throws `ProbeConfigError` without `db()`. */\nexport function mongodbProbe(options: MongodbProbeOptions): Probe {\n  const client = options.client;\n  if (typeof client?.db !== \"function\") {\n    throw new ProbeConfigError(\n      \"mongodbProbe\",\n      \"client\",\n      `must expose db(), got ${describe(client)}`,\n    );\n  }\n  const dbName = options.db ?? mongodbDefaultDb;\n  return {\n    name: options.name ?? mongodbDefaultName,\n    critical: options.critical ?? true,\n    timeoutMs: options.timeoutMs,\n    skip: options.skip,\n    run: async (signal) => {\n      await client.db(dbName).command({ ping: 1 }, { signal });\n    },\n  };\n}\n\nfunction describe(client: MongoLikeClient): 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":";;;;AAsBA,MAAa,qBAAqB;;AAElC,MAAa,mBAAmB;;AAgChC,SAAgB,aAAaA,SAAqC;CAChE,MAAM,SAAS,QAAQ;AACvB,YAAW,QAAQ,OAAO,WACxB,OAAM,IAAI,iBACR,gBACA,WACC,wBAAwB,SAAS,OAAO,CAAC;CAG9C,MAAM,SAAS,QAAQ,MAAM;AAC7B,QAAO;EACL,MAAM,QAAQ,QAAQ;EACtB,UAAU,QAAQ,YAAY;EAC9B,WAAW,QAAQ;EACnB,MAAM,QAAQ;EACd,KAAK,OAAO,WAAW;AACrB,SAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAG,GAAE,EAAE,OAAQ,EAAC;EACzD;CACF;AACF;AAED,SAAS,SAASC,QAAiC;AACjD,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,68 @@
+{
+  "name": "@openstatus/health-mongodb",
+  "version": "0.1.4-dev.0",
+  "description": "MongoDB ping probe for @openstatus/health",
+  "keywords": [
+    "openstatus",
+    "health",
+    "healthcheck",
+    "mongodb",
+    "mongo",
+    "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/mongodb/"
+  },
+  "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",
+    "mongodb": ">=5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "mongodb": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "mongodb": "^6.17.0",
+    "tsdown": "^0.12.7",
+    "typescript": "^5.8.3"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "prepack": "tsdown",
+    "test": "node --experimental-transform-types --test"
+  }
+}