@openstatus/health-redis 0.1.4-dev.0

package/README.md

@@ -0,0 +1,73 @@
+# @openstatus/health-redis
+
+[Redis](https://redis.io/) / [Valkey](https://valkey.io/) probe for
+[`@openstatus/health`](https://jsr.io/@openstatus/health). Sends `PING`
+through the client you already have — [`redis`](https://github.com/redis/node-redis)
+(node-redis), [`ioredis`](https://github.com/redis/ioredis),
+[`@upstash/redis`](https://github.com/upstash/redis-js) or `@vercel/kv` — and
+fails the check unless the server answers `PONG`.
+
+```sh
+deno add jsr:@openstatus/health jsr:@openstatus/health-redis
+npm install @openstatus/health @openstatus/health-redis
+```
+
+```ts
+import { Redis } from "ioredis";
+import { createHealthHandler } from "@openstatus/health";
+import { redisProbe } from "@openstatus/health-redis";
+
+const redis = new Redis(env.REDIS_URL);
+
+Deno.serve(
+  createHealthHandler({ probes: [redisProbe({ client: redis })] }),
+);
+```
+
+Any object with `ping()` works, so the probe covers TCP clients against a
+self-hosted Redis, Valkey, Railway, Fly or ElastiCache instance as well as
+the HTTP clients from Upstash and Vercel. For an Upstash database without a
+client, `@openstatus/health-upstash` pings the REST endpoint with `fetch`
+alone.
+
+With node-redis, connect the client before it is probed: `createClient()`
+does not connect until `await client.connect()`, and a `ping()` on a closed
+client rejects — which the probe reports as a failed check.
+
+```ts
+redisProbe({
+  client: redis,
+  // optional overrides from the Probe contract
+  name: "cache",
+  critical: true,
+  timeoutMs: 1000,
+  skip: () => env.REDIS_URL == null,
+});
+```
+
+Non-critical by default: a Redis used as a cache degrades the report instead
+of taking the service down. Set `critical: true` when Redis holds sessions,
+queues or rate limits that requests cannot proceed without.
+
+The client is typed structurally as `{ ping(): PromiseLike<...> }`, so
+`redis` and `ioredis` 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 no `ping()`.
+
+## 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,31 @@
+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 redisDefaultName = "redis";
+/** A probe that sends `PING` and expects `PONG`; non-critical by default. Throws `ProbeConfigError` without `ping()`. */
+function redisProbe(options) {
+	const client = options.client;
+	if (typeof client?.ping !== "function") throw new __openstatus_health.ProbeConfigError("redisProbe", "client", `must expose ping(), got ${describe(client)}`);
+	return {
+		name: options.name ?? redisDefaultName,
+		critical: options.critical ?? false,
+		timeoutMs: options.timeoutMs,
+		skip: options.skip,
+		run: async () => {
+			const reply = await client.ping();
+			if (typeof reply === "string" && reply.toUpperCase() !== "PONG") throw new Error(`unexpected reply ${JSON.stringify(reply)}`);
+		}
+	};
+}
+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.redisDefaultName = redisDefaultName;
+exports.redisProbe = redisProbe;

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 redisDefaultName = "redis";
+/** The subset of a Redis client the probe uses. */
+interface RedisLikeClient {
+  /** Send `PING`; resolves with the server's reply, normally `"PONG"`. */
+  ping(): PromiseLike<ProbeResult>;
+}
+/** Options for `redisProbe()`. */
+interface RedisProbeOptions extends ProbeOverrides {
+  /** A node-redis, ioredis or Upstash client. */
+  readonly client: RedisLikeClient;
+}
+/** A probe that sends `PING` and expects `PONG`; non-critical by default. Throws `ProbeConfigError` without `ping()`. */
+declare function redisProbe(options: RedisProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { RedisLikeClient, RedisProbeOptions, redisDefaultName, redisProbe };
+//# 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;AAA0B,cAfb,gBAAA,GAea,OAAA;;AAA8B,UAZvC,eAAA,CAYuC;EAAK;UAVnD,YAAY;;;UAIL,iBAAA,SAA0B;;mBAExB;;;iBAIH,UAAA,UAAoB,oBAAoB"}

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 redisDefaultName = "redis";
+/** The subset of a Redis client the probe uses. */
+interface RedisLikeClient {
+  /** Send `PING`; resolves with the server's reply, normally `"PONG"`. */
+  ping(): PromiseLike<ProbeResult>;
+}
+/** Options for `redisProbe()`. */
+interface RedisProbeOptions extends ProbeOverrides {
+  /** A node-redis, ioredis or Upstash client. */
+  readonly client: RedisLikeClient;
+}
+/** A probe that sends `PING` and expects `PONG`; non-critical by default. Throws `ProbeConfigError` without `ping()`. */
+declare function redisProbe(options: RedisProbeOptions): Probe;
+//# sourceMappingURL=mod.d.ts.map
+//#endregion
+export { RedisLikeClient, RedisProbeOptions, redisDefaultName, redisProbe };
+//# 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;AAA0B,cAfb,gBAAA,GAea,OAAA;;AAA8B,UAZvC,eAAA,CAYuC;EAAK;UAVnD,YAAY;;;UAIL,iBAAA,SAA0B;;mBAExB;;;iBAIH,UAAA,UAAoB,oBAAoB"}

package/dist/mod.js

@@ -0,0 +1,30 @@
+import { ProbeConfigError } from "@openstatus/health";
+
+//#region src/mod.ts
+/** Probe name when `name` is unset. */
+const redisDefaultName = "redis";
+/** A probe that sends `PING` and expects `PONG`; non-critical by default. Throws `ProbeConfigError` without `ping()`. */
+function redisProbe(options) {
+	const client = options.client;
+	if (typeof client?.ping !== "function") throw new ProbeConfigError("redisProbe", "client", `must expose ping(), got ${describe(client)}`);
+	return {
+		name: options.name ?? redisDefaultName,
+		critical: options.critical ?? false,
+		timeoutMs: options.timeoutMs,
+		skip: options.skip,
+		run: async () => {
+			const reply = await client.ping();
+			if (typeof reply === "string" && reply.toUpperCase() !== "PONG") throw new Error(`unexpected reply ${JSON.stringify(reply)}`);
+		}
+	};
+}
+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 { redisDefaultName, redisProbe };
+//# sourceMappingURL=mod.js.map

package/dist/mod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.js","names":["options: RedisProbeOptions","client: RedisLikeClient"],"sources":["../src/mod.ts"],"sourcesContent":["/**\n * Redis probe for `@openstatus/health`: sends `PING` through `redis`\n * (node-redis), `ioredis`, `@upstash/redis` or any client with `ping()`.\n *\n * ```ts\n * import { Redis } from \"ioredis\";\n * import { redisProbe } from \"@openstatus/health-redis\";\n *\n * const probe = redisProbe({ client: new Redis(env.REDIS_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 redisDefaultName = \"redis\";\n\n/** The subset of a Redis client the probe uses. */\nexport interface RedisLikeClient {\n  /** Send `PING`; resolves with the server's reply, normally `\"PONG\"`. */\n  ping(): PromiseLike<ProbeResult>;\n}\n\n/** Options for `redisProbe()`. */\nexport interface RedisProbeOptions extends ProbeOverrides {\n  /** A node-redis, ioredis or Upstash client. */\n  readonly client: RedisLikeClient;\n}\n\n/** A probe that sends `PING` and expects `PONG`; non-critical by default. Throws `ProbeConfigError` without `ping()`. */\nexport function redisProbe(options: RedisProbeOptions): Probe {\n  const client = options.client;\n  if (typeof client?.ping !== \"function\") {\n    throw new ProbeConfigError(\n      \"redisProbe\",\n      \"client\",\n      `must expose ping(), got ${describe(client)}`,\n    );\n  }\n  return {\n    name: options.name ?? redisDefaultName,\n    critical: options.critical ?? false,\n    timeoutMs: options.timeoutMs,\n    skip: options.skip,\n    run: async () => {\n      const reply = await client.ping();\n      if (typeof reply === \"string\" && reply.toUpperCase() !== \"PONG\") {\n        throw new Error(`unexpected reply ${JSON.stringify(reply)}`);\n      }\n    },\n  };\n}\n\nfunction describe(client: RedisLikeClient): 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,mBAAmB;;AAehC,SAAgB,WAAWA,SAAmC;CAC5D,MAAM,SAAS,QAAQ;AACvB,YAAW,QAAQ,SAAS,WAC1B,OAAM,IAAI,iBACR,cACA,WACC,0BAA0B,SAAS,OAAO,CAAC;AAGhD,QAAO;EACL,MAAM,QAAQ,QAAQ;EACtB,UAAU,QAAQ,YAAY;EAC9B,WAAW,QAAQ;EACnB,MAAM,QAAQ;EACd,KAAK,YAAY;GACf,MAAM,QAAQ,MAAM,OAAO,MAAM;AACjC,cAAW,UAAU,YAAY,MAAM,aAAa,KAAK,OACvD,OAAM,IAAI,OAAO,mBAAmB,KAAK,UAAU,MAAM,CAAC;EAE7D;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,74 @@
+{
+  "name": "@openstatus/health-redis",
+  "version": "0.1.4-dev.0",
+  "description": "Redis PING probe for @openstatus/health",
+  "keywords": [
+    "openstatus",
+    "health",
+    "healthcheck",
+    "redis",
+    "ioredis",
+    "valkey",
+    "cache"
+  ],
+  "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/redis/"
+  },
+  "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",
+    "redis": ">=4.0.0",
+    "ioredis": ">=5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "redis": {
+      "optional": true
+    },
+    "ioredis": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "redis": "^5.5.0",
+    "ioredis": "^5.6.0",
+    "tsdown": "^0.12.7",
+    "typescript": "^5.8.3"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "prepack": "tsdown",
+    "test": "node --experimental-transform-types --test"
+  }
+}