@checkstack/healthcheck-redis-backend 0.0.2

package/CHANGELOG.md

@@ -0,0 +1,37 @@
+# @checkstack/healthcheck-redis-backend
+
+## 0.0.2
+
+### Patch Changes
+
+- d20d274: Initial release of all @checkstack packages. Rebranded from Checkmate to Checkstack with new npm organization @checkstack and domain checkstack.dev.
+- Updated dependencies [d20d274]
+  - @checkstack/backend-api@0.0.2
+  - @checkstack/common@0.0.2
+  - @checkstack/healthcheck-common@0.0.2
+
+## 0.0.3
+
+### Patch Changes
+
+- Updated dependencies [b4eb432]
+- Updated dependencies [a65e002]
+  - @checkstack/backend-api@1.1.0
+  - @checkstack/common@0.2.0
+  - @checkstack/healthcheck-common@0.1.1
+
+## 0.0.2
+
+### Patch Changes
+
+- Updated dependencies [ffc28f6]
+- Updated dependencies [4dd644d]
+- Updated dependencies [71275dd]
+- Updated dependencies [ae19ff6]
+- Updated dependencies [0babb9c]
+- Updated dependencies [b55fae6]
+- Updated dependencies [b354ab3]
+- Updated dependencies [81f3f85]
+  - @checkstack/common@0.1.0
+  - @checkstack/backend-api@1.0.0
+  - @checkstack/healthcheck-common@0.1.0

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@checkstack/healthcheck-redis-backend",
+  "version": "0.0.2",
+  "type": "module",
+  "main": "src/index.ts",
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "lint": "bun run lint:code",
+    "lint:code": "eslint . --max-warnings 0"
+  },
+  "dependencies": {
+    "@checkstack/backend-api": "workspace:*",
+    "@checkstack/common": "workspace:*",
+    "@checkstack/healthcheck-common": "workspace:*",
+    "ioredis": "^5.3.0"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.0.0",
+    "typescript": "^5.0.0",
+    "@checkstack/tsconfig": "workspace:*",
+    "@checkstack/scripts": "workspace:*"
+  }
+}

package/src/index.ts

@@ -0,0 +1,23 @@
+import {
+  createBackendPlugin,
+  coreServices,
+} from "@checkstack/backend-api";
+import { RedisHealthCheckStrategy } from "./strategy";
+import { pluginMetadata } from "./plugin-metadata";
+
+export default createBackendPlugin({
+  metadata: pluginMetadata,
+  register(env) {
+    env.registerInit({
+      deps: {
+        healthCheckRegistry: coreServices.healthCheckRegistry,
+        logger: coreServices.logger,
+      },
+      init: async ({ healthCheckRegistry, logger }) => {
+        logger.debug("🔌 Registering Redis Health Check Strategy...");
+        const strategy = new RedisHealthCheckStrategy();
+        healthCheckRegistry.register(strategy);
+      },
+    });
+  },
+});

package/src/plugin-metadata.ts

@@ -0,0 +1,8 @@
+import { definePluginMetadata } from "@checkstack/common";
+
+/**
+ * Plugin metadata for the Redis Health Check backend.
+ */
+export const pluginMetadata = definePluginMetadata({
+  pluginId: "healthcheck-redis",
+});

package/src/strategy.test.ts

@@ -0,0 +1,207 @@
+import { describe, expect, it, mock } from "bun:test";
+import { RedisHealthCheckStrategy, RedisClient } from "./strategy";
+
+describe("RedisHealthCheckStrategy", () => {
+  // Helper to create mock Redis client
+  const createMockClient = (
+    config: {
+      pingResponse?: string;
+      infoResponse?: string;
+      pingError?: Error;
+      connectError?: Error;
+    } = {}
+  ): RedisClient => ({
+    connect: mock(() =>
+      config.connectError
+        ? Promise.reject(config.connectError)
+        : Promise.resolve({
+            ping: mock(() =>
+              config.pingError
+                ? Promise.reject(config.pingError)
+                : Promise.resolve(config.pingResponse ?? "PONG")
+            ),
+            info: mock(() =>
+              Promise.resolve(
+                config.infoResponse ?? "redis_version:7.0.0\r\nrole:master\r\n"
+              )
+            ),
+            quit: mock(() => Promise.resolve("OK")),
+          })
+    ),
+  });
+
+  describe("execute", () => {
+    it("should return healthy for successful connection", async () => {
+      const strategy = new RedisHealthCheckStrategy(createMockClient());
+
+      const result = await strategy.execute({
+        host: "localhost",
+        port: 6379,
+        timeout: 5000,
+      });
+
+      expect(result.status).toBe("healthy");
+      expect(result.metadata?.connected).toBe(true);
+      expect(result.metadata?.pingSuccess).toBe(true);
+      expect(result.metadata?.redisVersion).toBe("7.0.0");
+      expect(result.metadata?.role).toBe("master");
+    });
+
+    it("should return unhealthy for connection error", async () => {
+      const strategy = new RedisHealthCheckStrategy(
+        createMockClient({ connectError: new Error("Connection refused") })
+      );
+
+      const result = await strategy.execute({
+        host: "localhost",
+        port: 6379,
+        timeout: 5000,
+      });
+
+      expect(result.status).toBe("unhealthy");
+      expect(result.message).toContain("Connection refused");
+      expect(result.metadata?.connected).toBe(false);
+    });
+
+    it("should return unhealthy for PING failure", async () => {
+      const strategy = new RedisHealthCheckStrategy(
+        createMockClient({ pingError: new Error("NOAUTH") })
+      );
+
+      const result = await strategy.execute({
+        host: "localhost",
+        port: 6379,
+        timeout: 5000,
+      });
+
+      expect(result.status).toBe("unhealthy");
+      expect(result.metadata?.pingSuccess).toBe(false);
+    });
+
+    it("should pass connectionTime assertion when below threshold", async () => {
+      const strategy = new RedisHealthCheckStrategy(createMockClient());
+
+      const result = await strategy.execute({
+        host: "localhost",
+        port: 6379,
+        timeout: 5000,
+        assertions: [
+          { field: "connectionTime", operator: "lessThan", value: 5000 },
+        ],
+      });
+
+      expect(result.status).toBe("healthy");
+    });
+
+    it("should pass role assertion", async () => {
+      const strategy = new RedisHealthCheckStrategy(createMockClient());
+
+      const result = await strategy.execute({
+        host: "localhost",
+        port: 6379,
+        timeout: 5000,
+        assertions: [{ field: "role", operator: "equals", value: "master" }],
+      });
+
+      expect(result.status).toBe("healthy");
+    });
+
+    it("should fail role assertion when replica", async () => {
+      const strategy = new RedisHealthCheckStrategy(
+        createMockClient({
+          infoResponse: "redis_version:7.0.0\r\nrole:slave\r\n",
+        })
+      );
+
+      const result = await strategy.execute({
+        host: "localhost",
+        port: 6379,
+        timeout: 5000,
+        assertions: [{ field: "role", operator: "equals", value: "master" }],
+      });
+
+      expect(result.status).toBe("unhealthy");
+      expect(result.message).toContain("Assertion failed");
+    });
+
+    it("should pass pingSuccess assertion", async () => {
+      const strategy = new RedisHealthCheckStrategy(createMockClient());
+
+      const result = await strategy.execute({
+        host: "localhost",
+        port: 6379,
+        timeout: 5000,
+        assertions: [{ field: "pingSuccess", operator: "isTrue" }],
+      });
+
+      expect(result.status).toBe("healthy");
+    });
+  });
+
+  describe("aggregateResult", () => {
+    it("should calculate averages correctly", () => {
+      const strategy = new RedisHealthCheckStrategy();
+      const runs = [
+        {
+          id: "1",
+          status: "healthy" as const,
+          latencyMs: 10,
+          checkId: "c1",
+          timestamp: new Date(),
+          metadata: {
+            connected: true,
+            connectionTimeMs: 5,
+            pingTimeMs: 1,
+            pingSuccess: true,
+            role: "master",
+          },
+        },
+        {
+          id: "2",
+          status: "healthy" as const,
+          latencyMs: 20,
+          checkId: "c1",
+          timestamp: new Date(),
+          metadata: {
+            connected: true,
+            connectionTimeMs: 15,
+            pingTimeMs: 3,
+            pingSuccess: true,
+            role: "master",
+          },
+        },
+      ];
+
+      const aggregated = strategy.aggregateResult(runs);
+
+      expect(aggregated.avgConnectionTime).toBe(10);
+      expect(aggregated.avgPingTime).toBe(2);
+      expect(aggregated.successRate).toBe(100);
+      expect(aggregated.errorCount).toBe(0);
+    });
+
+    it("should count errors", () => {
+      const strategy = new RedisHealthCheckStrategy();
+      const runs = [
+        {
+          id: "1",
+          status: "unhealthy" as const,
+          latencyMs: 100,
+          checkId: "c1",
+          timestamp: new Date(),
+          metadata: {
+            connected: false,
+            connectionTimeMs: 100,
+            pingSuccess: false,
+            error: "Connection refused",
+          },
+        },
+      ];
+
+      const aggregated = strategy.aggregateResult(runs);
+
+      expect(aggregated.errorCount).toBe(1);
+      expect(aggregated.successRate).toBe(0);
+    });
+  });
+});

package/src/strategy.ts

@@ -0,0 +1,362 @@
+import Redis from "ioredis";
+import {
+  HealthCheckStrategy,
+  HealthCheckResult,
+  HealthCheckRunForAggregation,
+  Versioned,
+  z,
+  timeThresholdField,
+  booleanField,
+  enumField,
+  configString,
+  configNumber,
+  configBoolean,
+  evaluateAssertions,
+} from "@checkstack/backend-api";
+import {
+  healthResultBoolean,
+  healthResultNumber,
+  healthResultString,
+} from "@checkstack/healthcheck-common";
+
+// ============================================================================
+// SCHEMAS
+// ============================================================================
+
+/**
+ * Valid Redis server roles from the INFO replication command.
+ */
+const RedisRole = z.enum(["master", "slave", "sentinel"]);
+export type RedisRole = z.infer<typeof RedisRole>;
+
+/**
+ * Assertion schema for Redis health checks using shared factories.
+ */
+const redisAssertionSchema = z.discriminatedUnion("field", [
+  timeThresholdField("connectionTime"),
+  timeThresholdField("pingTime"),
+  booleanField("pingSuccess"),
+  enumField("role", RedisRole.options),
+]);
+
+export type RedisAssertion = z.infer<typeof redisAssertionSchema>;
+
+/**
+ * Configuration schema for Redis health checks.
+ */
+export const redisConfigSchema = z.object({
+  host: configString({}).describe("Redis server hostname"),
+  port: configNumber({})
+    .int()
+    .min(1)
+    .max(65_535)
+    .default(6379)
+    .describe("Redis port"),
+  password: configString({ "x-secret": true })
+    .describe("Password for authentication")
+    .optional(),
+  database: configNumber({}).int().min(0).default(0).describe("Database index"),
+  tls: configBoolean({}).default(false).describe("Use TLS connection"),
+  timeout: configNumber({})
+    .min(100)
+    .default(5000)
+    .describe("Connection timeout in milliseconds"),
+  assertions: z
+    .array(redisAssertionSchema)
+    .optional()
+    .describe("Validation conditions"),
+});
+
+export type RedisConfig = z.infer<typeof redisConfigSchema>;
+export type RedisConfigInput = z.input<typeof redisConfigSchema>;
+
+/**
+ * Per-run result metadata.
+ */
+const redisResultSchema = z.object({
+  connected: healthResultBoolean({
+    "x-chart-type": "boolean",
+    "x-chart-label": "Connected",
+  }),
+  connectionTimeMs: healthResultNumber({
+    "x-chart-type": "line",
+    "x-chart-label": "Connection Time",
+    "x-chart-unit": "ms",
+  }),
+  pingTimeMs: healthResultNumber({
+    "x-chart-type": "line",
+    "x-chart-label": "Ping Time",
+    "x-chart-unit": "ms",
+  }).optional(),
+  pingSuccess: healthResultBoolean({
+    "x-chart-type": "boolean",
+    "x-chart-label": "Ping Success",
+  }),
+  role: healthResultString({
+    "x-chart-type": "text",
+    "x-chart-label": "Role",
+  }).optional(),
+  redisVersion: healthResultString({
+    "x-chart-type": "text",
+    "x-chart-label": "Redis Version",
+  }).optional(),
+  failedAssertion: redisAssertionSchema.optional(),
+  error: healthResultString({
+    "x-chart-type": "status",
+    "x-chart-label": "Error",
+  }).optional(),
+});
+
+export type RedisResult = z.infer<typeof redisResultSchema>;
+
+/**
+ * Aggregated metadata for buckets.
+ */
+const redisAggregatedSchema = z.object({
+  avgConnectionTime: healthResultNumber({
+    "x-chart-type": "line",
+    "x-chart-label": "Avg Connection Time",
+    "x-chart-unit": "ms",
+  }),
+  avgPingTime: healthResultNumber({
+    "x-chart-type": "line",
+    "x-chart-label": "Avg Ping Time",
+    "x-chart-unit": "ms",
+  }),
+  successRate: healthResultNumber({
+    "x-chart-type": "gauge",
+    "x-chart-label": "Success Rate",
+    "x-chart-unit": "%",
+  }),
+  errorCount: healthResultNumber({
+    "x-chart-type": "counter",
+    "x-chart-label": "Errors",
+  }),
+});
+
+export type RedisAggregatedResult = z.infer<typeof redisAggregatedSchema>;
+
+// ============================================================================
+// REDIS CLIENT INTERFACE (for testability)
+// ============================================================================
+
+export interface RedisConnection {
+  ping(): Promise<string>;
+  info(section: string): Promise<string>;
+  quit(): Promise<string>;
+}
+
+export interface RedisClient {
+  connect(config: {
+    host: string;
+    port: number;
+    password?: string;
+    db: number;
+    tls: boolean;
+    connectTimeout: number;
+  }): Promise<RedisConnection>;
+}
+
+// Default client using ioredis
+const defaultRedisClient: RedisClient = {
+  async connect(config) {
+    const redis = new Redis({
+      host: config.host,
+      port: config.port,
+      password: config.password,
+      db: config.db,
+      tls: config.tls ? {} : undefined,
+      connectTimeout: config.connectTimeout,
+      lazyConnect: true,
+    });
+
+    await redis.connect();
+
+    return {
+      ping: () => redis.ping(),
+      info: (section: string) => redis.info(section),
+      quit: () => redis.quit(),
+    };
+  },
+};
+
+// ============================================================================
+// STRATEGY
+// ============================================================================
+
+export class RedisHealthCheckStrategy
+  implements
+    HealthCheckStrategy<RedisConfig, RedisResult, RedisAggregatedResult>
+{
+  id = "redis";
+  displayName = "Redis Health Check";
+  description = "Redis server connectivity and health monitoring";
+
+  private redisClient: RedisClient;
+
+  constructor(redisClient: RedisClient = defaultRedisClient) {
+    this.redisClient = redisClient;
+  }
+
+  config: Versioned<RedisConfig> = new Versioned({
+    version: 1,
+    schema: redisConfigSchema,
+  });
+
+  result: Versioned<RedisResult> = new Versioned({
+    version: 1,
+    schema: redisResultSchema,
+  });
+
+  aggregatedResult: Versioned<RedisAggregatedResult> = new Versioned({
+    version: 1,
+    schema: redisAggregatedSchema,
+  });
+
+  aggregateResult(
+    runs: HealthCheckRunForAggregation<RedisResult>[]
+  ): RedisAggregatedResult {
+    let totalConnectionTime = 0;
+    let totalPingTime = 0;
+    let successCount = 0;
+    let errorCount = 0;
+    let validRuns = 0;
+    let pingRuns = 0;
+
+    for (const run of runs) {
+      if (run.metadata?.error) {
+        errorCount++;
+        continue;
+      }
+      if (run.status === "healthy") {
+        successCount++;
+      }
+      if (run.metadata) {
+        totalConnectionTime += run.metadata.connectionTimeMs;
+        if (run.metadata.pingTimeMs !== undefined) {
+          totalPingTime += run.metadata.pingTimeMs;
+          pingRuns++;
+        }
+        validRuns++;
+      }
+    }
+
+    return {
+      avgConnectionTime: validRuns > 0 ? totalConnectionTime / validRuns : 0,
+      avgPingTime: pingRuns > 0 ? totalPingTime / pingRuns : 0,
+      successRate: runs.length > 0 ? (successCount / runs.length) * 100 : 0,
+      errorCount,
+    };
+  }
+
+  async execute(
+    config: RedisConfigInput
+  ): Promise<HealthCheckResult<RedisResult>> {
+    const validatedConfig = this.config.validate(config);
+    const start = performance.now();
+
+    try {
+      // Connect to Redis
+      const connection = await this.redisClient.connect({
+        host: validatedConfig.host,
+        port: validatedConfig.port,
+        password: validatedConfig.password,
+        db: validatedConfig.database,
+        tls: validatedConfig.tls,
+        connectTimeout: validatedConfig.timeout,
+      });
+
+      const connectionTimeMs = Math.round(performance.now() - start);
+
+      // Execute PING command
+      const pingStart = performance.now();
+      let pingSuccess = false;
+      let pingTimeMs: number | undefined;
+
+      try {
+        const pong = await connection.ping();
+        pingSuccess = pong === "PONG";
+        pingTimeMs = Math.round(performance.now() - pingStart);
+      } catch {
+        pingSuccess = false;
+        pingTimeMs = Math.round(performance.now() - pingStart);
+      }
+
+      // Get server info
+      let role: string | undefined;
+      let redisVersion: string | undefined;
+
+      try {
+        const info = await connection.info("server");
+        const roleMatch = /role:(\w+)/i.exec(info);
+        const versionMatch = /redis_version:([^\r\n]+)/i.exec(info);
+        role = roleMatch?.[1];
+        redisVersion = versionMatch?.[1];
+      } catch {
+        // Info command failed, continue without it
+      }
+
+      await connection.quit();
+
+      const result: Omit<RedisResult, "failedAssertion" | "error"> = {
+        connected: true,
+        connectionTimeMs,
+        pingTimeMs,
+        pingSuccess,
+        role,
+        redisVersion,
+      };
+
+      // Evaluate assertions using shared utility
+      const failedAssertion = evaluateAssertions(validatedConfig.assertions, {
+        connectionTime: connectionTimeMs,
+        pingTime: pingTimeMs ?? 0,
+        pingSuccess,
+        role: role ?? "",
+      });
+
+      if (failedAssertion) {
+        return {
+          status: "unhealthy",
+          latencyMs: connectionTimeMs + (pingTimeMs ?? 0),
+          message: `Assertion failed: ${failedAssertion.field} ${
+            failedAssertion.operator
+          }${"value" in failedAssertion ? ` ${failedAssertion.value}` : ""}`,
+          metadata: { ...result, failedAssertion },
+        };
+      }
+
+      if (!pingSuccess) {
+        return {
+          status: "unhealthy",
+          latencyMs: connectionTimeMs + (pingTimeMs ?? 0),
+          message: "Redis PING failed",
+          metadata: result,
+        };
+      }
+
+      return {
+        status: "healthy",
+        latencyMs: connectionTimeMs + (pingTimeMs ?? 0),
+        message: `Redis ${redisVersion ?? "unknown"} (${
+          role ?? "unknown"
+        }) - PONG in ${pingTimeMs}ms`,
+        metadata: result,
+      };
+    } catch (error: unknown) {
+      const end = performance.now();
+      const isError = error instanceof Error;
+      return {
+        status: "unhealthy",
+        latencyMs: Math.round(end - start),
+        message: isError ? error.message : "Redis connection failed",
+        metadata: {
+          connected: false,
+          connectionTimeMs: Math.round(end - start),
+          pingSuccess: false,
+          error: isError ? error.name : "UnknownError",
+        },
+      };
+    }
+  }
+}

package/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "extends": "@checkstack/tsconfig/backend.json",
+  "include": [
+    "src"
+  ]
+}