@checkstack/healthcheck-postgres-backend 0.0.2

package/CHANGELOG.md

@@ -0,0 +1,37 @@
+# @checkstack/healthcheck-postgres-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,24 @@
+{
+  "name": "@checkstack/healthcheck-postgres-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:*",
+    "pg": "^8.11.0"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.0.0",
+    "@types/pg": "^8.11.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 { PostgresHealthCheckStrategy } 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 PostgreSQL Health Check Strategy...");
+        const strategy = new PostgresHealthCheckStrategy();
+        healthCheckRegistry.register(strategy);
+      },
+    });
+  },
+});

package/src/plugin-metadata.ts

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

package/src/strategy.test.ts

@@ -0,0 +1,222 @@
+import { describe, expect, it, mock } from "bun:test";
+import { PostgresHealthCheckStrategy, DbClient } from "./strategy";
+
+describe("PostgresHealthCheckStrategy", () => {
+  // Helper to create mock DB client
+  const createMockClient = (
+    config: {
+      rowCount?: number;
+      queryError?: Error;
+      connectError?: Error;
+    } = {}
+  ): DbClient => ({
+    connect: mock(() =>
+      config.connectError
+        ? Promise.reject(config.connectError)
+        : Promise.resolve({
+            query: mock(() =>
+              config.queryError
+                ? Promise.reject(config.queryError)
+                : Promise.resolve({ rowCount: config.rowCount ?? 1 })
+            ),
+            end: mock(() => Promise.resolve()),
+          })
+    ),
+  });
+
+  describe("execute", () => {
+    it("should return healthy for successful connection", async () => {
+      const strategy = new PostgresHealthCheckStrategy(createMockClient());
+
+      const result = await strategy.execute({
+        host: "localhost",
+        port: 5432,
+        database: "test",
+        user: "postgres",
+        password: "secret",
+        timeout: 5000,
+      });
+
+      expect(result.status).toBe("healthy");
+      expect(result.metadata?.connected).toBe(true);
+      expect(result.metadata?.querySuccess).toBe(true);
+    });
+
+    it("should return unhealthy for connection error", async () => {
+      const strategy = new PostgresHealthCheckStrategy(
+        createMockClient({ connectError: new Error("Connection refused") })
+      );
+
+      const result = await strategy.execute({
+        host: "localhost",
+        port: 5432,
+        database: "test",
+        user: "postgres",
+        password: "secret",
+        timeout: 5000,
+      });
+
+      expect(result.status).toBe("unhealthy");
+      expect(result.message).toContain("Connection refused");
+      expect(result.metadata?.connected).toBe(false);
+    });
+
+    it("should return unhealthy for query error", async () => {
+      const strategy = new PostgresHealthCheckStrategy(
+        createMockClient({ queryError: new Error("Syntax error") })
+      );
+
+      const result = await strategy.execute({
+        host: "localhost",
+        port: 5432,
+        database: "test",
+        user: "postgres",
+        password: "secret",
+        timeout: 5000,
+      });
+
+      expect(result.status).toBe("unhealthy");
+      expect(result.metadata?.querySuccess).toBe(false);
+    });
+
+    it("should pass connectionTime assertion when below threshold", async () => {
+      const strategy = new PostgresHealthCheckStrategy(createMockClient());
+
+      const result = await strategy.execute({
+        host: "localhost",
+        port: 5432,
+        database: "test",
+        user: "postgres",
+        password: "secret",
+        timeout: 5000,
+        assertions: [
+          { field: "connectionTime", operator: "lessThan", value: 5000 },
+        ],
+      });
+
+      expect(result.status).toBe("healthy");
+    });
+
+    it("should pass rowCount assertion", async () => {
+      const strategy = new PostgresHealthCheckStrategy(
+        createMockClient({ rowCount: 5 })
+      );
+
+      const result = await strategy.execute({
+        host: "localhost",
+        port: 5432,
+        database: "test",
+        user: "postgres",
+        password: "secret",
+        timeout: 5000,
+        assertions: [
+          { field: "rowCount", operator: "greaterThanOrEqual", value: 1 },
+        ],
+      });
+
+      expect(result.status).toBe("healthy");
+    });
+
+    it("should fail rowCount assertion when no rows", async () => {
+      const strategy = new PostgresHealthCheckStrategy(
+        createMockClient({ rowCount: 0 })
+      );
+
+      const result = await strategy.execute({
+        host: "localhost",
+        port: 5432,
+        database: "test",
+        user: "postgres",
+        password: "secret",
+        timeout: 5000,
+        assertions: [{ field: "rowCount", operator: "greaterThan", value: 0 }],
+      });
+
+      expect(result.status).toBe("unhealthy");
+      expect(result.message).toContain("Assertion failed");
+    });
+
+    it("should pass querySuccess assertion", async () => {
+      const strategy = new PostgresHealthCheckStrategy(createMockClient());
+
+      const result = await strategy.execute({
+        host: "localhost",
+        port: 5432,
+        database: "test",
+        user: "postgres",
+        password: "secret",
+        timeout: 5000,
+        assertions: [{ field: "querySuccess", operator: "isTrue" }],
+      });
+
+      expect(result.status).toBe("healthy");
+    });
+  });
+
+  describe("aggregateResult", () => {
+    it("should calculate averages correctly", () => {
+      const strategy = new PostgresHealthCheckStrategy();
+      const runs = [
+        {
+          id: "1",
+          status: "healthy" as const,
+          latencyMs: 100,
+          checkId: "c1",
+          timestamp: new Date(),
+          metadata: {
+            connected: true,
+            connectionTimeMs: 50,
+            queryTimeMs: 10,
+            rowCount: 1,
+            querySuccess: true,
+          },
+        },
+        {
+          id: "2",
+          status: "healthy" as const,
+          latencyMs: 150,
+          checkId: "c1",
+          timestamp: new Date(),
+          metadata: {
+            connected: true,
+            connectionTimeMs: 100,
+            queryTimeMs: 20,
+            rowCount: 5,
+            querySuccess: true,
+          },
+        },
+      ];
+
+      const aggregated = strategy.aggregateResult(runs);
+
+      expect(aggregated.avgConnectionTime).toBe(75);
+      expect(aggregated.avgQueryTime).toBe(15);
+      expect(aggregated.successRate).toBe(100);
+      expect(aggregated.errorCount).toBe(0);
+    });
+
+    it("should count errors", () => {
+      const strategy = new PostgresHealthCheckStrategy();
+      const runs = [
+        {
+          id: "1",
+          status: "unhealthy" as const,
+          latencyMs: 100,
+          checkId: "c1",
+          timestamp: new Date(),
+          metadata: {
+            connected: false,
+            connectionTimeMs: 100,
+            querySuccess: 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,339 @@
+import { Client, type ClientConfig } from "pg";
+import {
+  HealthCheckStrategy,
+  HealthCheckResult,
+  HealthCheckRunForAggregation,
+  Versioned,
+  z,
+  timeThresholdField,
+  numericField,
+  booleanField,
+  evaluateAssertions,
+  configString,
+  configNumber,
+  configBoolean,
+} from "@checkstack/backend-api";
+import {
+  healthResultBoolean,
+  healthResultNumber,
+  healthResultString,
+} from "@checkstack/healthcheck-common";
+
+// ============================================================================
+// SCHEMAS
+// ============================================================================
+
+/**
+ * Assertion schema for PostgreSQL health checks using shared factories.
+ */
+const postgresAssertionSchema = z.discriminatedUnion("field", [
+  timeThresholdField("connectionTime"),
+  timeThresholdField("queryTime"),
+  numericField("rowCount", { min: 0 }),
+  booleanField("querySuccess"),
+]);
+
+export type PostgresAssertion = z.infer<typeof postgresAssertionSchema>;
+
+/**
+ * Configuration schema for PostgreSQL health checks.
+ */
+export const postgresConfigSchema = z.object({
+  host: configString({}).describe("PostgreSQL server hostname"),
+  port: configNumber({})
+    .int()
+    .min(1)
+    .max(65_535)
+    .default(5432)
+    .describe("PostgreSQL port"),
+  database: configString({}).describe("Database name"),
+  user: configString({}).describe("Username for authentication"),
+  password: configString({ "x-secret": true }).describe(
+    "Password for authentication"
+  ),
+  ssl: configBoolean({}).default(false).describe("Use SSL/TLS connection"),
+  timeout: configNumber({})
+    .min(100)
+    .default(10_000)
+    .describe("Connection timeout in milliseconds"),
+  query: configString({})
+    .default("SELECT 1")
+    .describe("Health check query to execute"),
+  assertions: z
+    .array(postgresAssertionSchema)
+    .optional()
+    .describe("Validation conditions"),
+});
+
+export type PostgresConfig = z.infer<typeof postgresConfigSchema>;
+export type PostgresConfigInput = z.input<typeof postgresConfigSchema>;
+
+/**
+ * Per-run result metadata.
+ */
+const postgresResultSchema = 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",
+  }),
+  queryTimeMs: healthResultNumber({
+    "x-chart-type": "line",
+    "x-chart-label": "Query Time",
+    "x-chart-unit": "ms",
+  }).optional(),
+  rowCount: healthResultNumber({
+    "x-chart-type": "counter",
+    "x-chart-label": "Row Count",
+  }).optional(),
+  serverVersion: healthResultString({
+    "x-chart-type": "text",
+    "x-chart-label": "Server Version",
+  }).optional(),
+  querySuccess: healthResultBoolean({
+    "x-chart-type": "boolean",
+    "x-chart-label": "Query Success",
+  }),
+  failedAssertion: postgresAssertionSchema.optional(),
+  error: healthResultString({
+    "x-chart-type": "status",
+    "x-chart-label": "Error",
+  }).optional(),
+});
+
+export type PostgresResult = z.infer<typeof postgresResultSchema>;
+
+/**
+ * Aggregated metadata for buckets.
+ */
+const postgresAggregatedSchema = z.object({
+  avgConnectionTime: healthResultNumber({
+    "x-chart-type": "line",
+    "x-chart-label": "Avg Connection Time",
+    "x-chart-unit": "ms",
+  }),
+  avgQueryTime: healthResultNumber({
+    "x-chart-type": "line",
+    "x-chart-label": "Avg Query 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 PostgresAggregatedResult = z.infer<typeof postgresAggregatedSchema>;
+
+// ============================================================================
+// DATABASE CLIENT INTERFACE (for testability)
+// ============================================================================
+
+export interface DbQueryResult {
+  rowCount: number | null;
+}
+
+export interface DbClient {
+  connect(config: ClientConfig): Promise<{
+    query(sql: string): Promise<DbQueryResult>;
+    end(): Promise<void>;
+  }>;
+}
+
+// Default client using pg
+const defaultDbClient: DbClient = {
+  async connect(config) {
+    const client = new Client(config);
+    await client.connect();
+
+    return {
+      async query(sql: string): Promise<DbQueryResult> {
+        const result = await client.query(sql);
+        return { rowCount: result.rowCount };
+      },
+      async end() {
+        await client.end();
+      },
+    };
+  },
+};
+
+// ============================================================================
+// STRATEGY
+// ============================================================================
+
+export class PostgresHealthCheckStrategy
+  implements
+    HealthCheckStrategy<
+      PostgresConfig,
+      PostgresResult,
+      PostgresAggregatedResult
+    >
+{
+  id = "postgres";
+  displayName = "PostgreSQL Health Check";
+  description = "PostgreSQL database connectivity and query health check";
+
+  private dbClient: DbClient;
+
+  constructor(dbClient: DbClient = defaultDbClient) {
+    this.dbClient = dbClient;
+  }
+
+  config: Versioned<PostgresConfig> = new Versioned({
+    version: 1,
+    schema: postgresConfigSchema,
+  });
+
+  result: Versioned<PostgresResult> = new Versioned({
+    version: 1,
+    schema: postgresResultSchema,
+  });
+
+  aggregatedResult: Versioned<PostgresAggregatedResult> = new Versioned({
+    version: 1,
+    schema: postgresAggregatedSchema,
+  });
+
+  aggregateResult(
+    runs: HealthCheckRunForAggregation<PostgresResult>[]
+  ): PostgresAggregatedResult {
+    let totalConnectionTime = 0;
+    let totalQueryTime = 0;
+    let successCount = 0;
+    let errorCount = 0;
+    let validRuns = 0;
+    let queryRuns = 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.queryTimeMs !== undefined) {
+          totalQueryTime += run.metadata.queryTimeMs;
+          queryRuns++;
+        }
+        validRuns++;
+      }
+    }
+
+    return {
+      avgConnectionTime: validRuns > 0 ? totalConnectionTime / validRuns : 0,
+      avgQueryTime: queryRuns > 0 ? totalQueryTime / queryRuns : 0,
+      successRate: runs.length > 0 ? (successCount / runs.length) * 100 : 0,
+      errorCount,
+    };
+  }
+
+  async execute(
+    config: PostgresConfigInput
+  ): Promise<HealthCheckResult<PostgresResult>> {
+    const validatedConfig = this.config.validate(config);
+    const start = performance.now();
+
+    try {
+      // Connect to database
+      const connection = await this.dbClient.connect({
+        host: validatedConfig.host,
+        port: validatedConfig.port,
+        database: validatedConfig.database,
+        user: validatedConfig.user,
+        password: validatedConfig.password,
+        ssl: validatedConfig.ssl ? { rejectUnauthorized: false } : false,
+        connectionTimeoutMillis: validatedConfig.timeout,
+      });
+
+      const connectionTimeMs = Math.round(performance.now() - start);
+
+      // Execute health check query
+      const queryStart = performance.now();
+      let querySuccess = false;
+      let rowCount: number | undefined;
+      let queryTimeMs: number | undefined;
+
+      try {
+        const result = await connection.query(validatedConfig.query);
+        querySuccess = true;
+        rowCount = result.rowCount ?? 0;
+        queryTimeMs = Math.round(performance.now() - queryStart);
+      } catch {
+        querySuccess = false;
+        queryTimeMs = Math.round(performance.now() - queryStart);
+      }
+
+      await connection.end();
+
+      const result: Omit<PostgresResult, "failedAssertion" | "error"> = {
+        connected: true,
+        connectionTimeMs,
+        queryTimeMs,
+        rowCount,
+        querySuccess,
+      };
+
+      // Evaluate assertions using shared utility
+      const failedAssertion = evaluateAssertions(validatedConfig.assertions, {
+        connectionTime: connectionTimeMs,
+        queryTime: queryTimeMs ?? 0,
+        rowCount: rowCount ?? 0,
+        querySuccess,
+      });
+
+      if (failedAssertion) {
+        return {
+          status: "unhealthy",
+          latencyMs: connectionTimeMs + (queryTimeMs ?? 0),
+          message: `Assertion failed: ${failedAssertion.field} ${
+            failedAssertion.operator
+          }${"value" in failedAssertion ? ` ${failedAssertion.value}` : ""}`,
+          metadata: { ...result, failedAssertion },
+        };
+      }
+
+      if (!querySuccess) {
+        return {
+          status: "unhealthy",
+          latencyMs: connectionTimeMs + (queryTimeMs ?? 0),
+          message: "Health check query failed",
+          metadata: result,
+        };
+      }
+
+      return {
+        status: "healthy",
+        latencyMs: connectionTimeMs + (queryTimeMs ?? 0),
+        message: `PostgreSQL - query returned ${rowCount} row(s) in ${queryTimeMs}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 : "PostgreSQL connection failed",
+        metadata: {
+          connected: false,
+          connectionTimeMs: Math.round(end - start),
+          querySuccess: false,
+          error: isError ? error.name : "UnknownError",
+        },
+      };
+    }
+  }
+}

package/tsconfig.json

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