@checkstack/healthcheck-tcp-backend 0.0.2

package/CHANGELOG.md

@@ -0,0 +1,37 @@
+# @checkstack/healthcheck-tcp-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,22 @@
+{
+  "name": "@checkstack/healthcheck-tcp-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:*"
+  },
+  "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 { TcpHealthCheckStrategy } 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 TCP Health Check Strategy...");
+        const strategy = new TcpHealthCheckStrategy();
+        healthCheckRegistry.register(strategy);
+      },
+    });
+  },
+});

package/src/plugin-metadata.ts

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

package/src/strategy.test.ts

@@ -0,0 +1,210 @@
+import { describe, expect, it, mock } from "bun:test";
+import { TcpHealthCheckStrategy, TcpSocket, SocketFactory } from "./strategy";
+
+describe("TcpHealthCheckStrategy", () => {
+  // Helper to create mock socket factory
+  const createMockSocket = (
+    config: {
+      connectError?: Error;
+      banner?: string;
+    } = {}
+  ): SocketFactory => {
+    return () =>
+      ({
+        connect: mock(() =>
+          config.connectError
+            ? Promise.reject(config.connectError)
+            : Promise.resolve()
+        ),
+        read: mock(() => Promise.resolve(config.banner ?? null)),
+        close: mock(() => {}),
+      } as TcpSocket);
+  };
+
+  describe("execute", () => {
+    it("should return healthy for successful connection", async () => {
+      const strategy = new TcpHealthCheckStrategy(createMockSocket());
+
+      const result = await strategy.execute({
+        host: "localhost",
+        port: 80,
+        timeout: 5000,
+        readBanner: false,
+      });
+
+      expect(result.status).toBe("healthy");
+      expect(result.metadata?.connected).toBe(true);
+      expect(result.metadata?.connectionTimeMs).toBeDefined();
+    });
+
+    it("should return unhealthy for connection error", async () => {
+      const strategy = new TcpHealthCheckStrategy(
+        createMockSocket({ connectError: new Error("Connection refused") })
+      );
+
+      const result = await strategy.execute({
+        host: "localhost",
+        port: 12345,
+        timeout: 5000,
+        readBanner: false,
+      });
+
+      expect(result.status).toBe("unhealthy");
+      expect(result.message).toContain("Connection refused");
+      expect(result.metadata?.connected).toBe(false);
+    });
+
+    it("should read banner when requested", async () => {
+      const strategy = new TcpHealthCheckStrategy(
+        createMockSocket({ banner: "SSH-2.0-OpenSSH" })
+      );
+
+      const result = await strategy.execute({
+        host: "localhost",
+        port: 22,
+        timeout: 5000,
+        readBanner: true,
+      });
+
+      expect(result.status).toBe("healthy");
+      expect(result.metadata?.banner).toBe("SSH-2.0-OpenSSH");
+    });
+
+    it("should pass connectionTime assertion when below threshold", async () => {
+      const strategy = new TcpHealthCheckStrategy(createMockSocket());
+
+      const result = await strategy.execute({
+        host: "localhost",
+        port: 80,
+        timeout: 5000,
+        readBanner: false,
+        assertions: [
+          { field: "connectionTime", operator: "lessThan", value: 1000 },
+        ],
+      });
+
+      expect(result.status).toBe("healthy");
+    });
+
+    it("should pass banner assertion with matching pattern", async () => {
+      const strategy = new TcpHealthCheckStrategy(
+        createMockSocket({ banner: "SSH-2.0-OpenSSH_8.9" })
+      );
+
+      const result = await strategy.execute({
+        host: "localhost",
+        port: 22,
+        timeout: 5000,
+        readBanner: true,
+        assertions: [{ field: "banner", operator: "contains", value: "SSH" }],
+      });
+
+      expect(result.status).toBe("healthy");
+    });
+
+    it("should fail banner assertion when not matching", async () => {
+      const strategy = new TcpHealthCheckStrategy(
+        createMockSocket({ banner: "HTTP/1.1 200 OK" })
+      );
+
+      const result = await strategy.execute({
+        host: "localhost",
+        port: 80,
+        timeout: 5000,
+        readBanner: true,
+        assertions: [{ field: "banner", operator: "contains", value: "SSH" }],
+      });
+
+      expect(result.status).toBe("unhealthy");
+      expect(result.message).toContain("Assertion failed");
+    });
+
+    it("should close socket after execution", async () => {
+      const closeMock = mock(() => {});
+      const strategy = new TcpHealthCheckStrategy(() => ({
+        connect: mock(() => Promise.resolve()),
+        read: mock(() => Promise.resolve(undefined)),
+        close: closeMock,
+      }));
+
+      await strategy.execute({
+        host: "localhost",
+        port: 80,
+        timeout: 5000,
+        readBanner: false,
+      });
+
+      expect(closeMock).toHaveBeenCalled();
+    });
+  });
+
+  describe("aggregateResult", () => {
+    it("should calculate averages correctly", () => {
+      const strategy = new TcpHealthCheckStrategy();
+      const runs = [
+        {
+          id: "1",
+          status: "healthy" as const,
+          latencyMs: 10,
+          checkId: "c1",
+          timestamp: new Date(),
+          metadata: {
+            connected: true,
+            connectionTimeMs: 10,
+          },
+        },
+        {
+          id: "2",
+          status: "healthy" as const,
+          latencyMs: 20,
+          checkId: "c1",
+          timestamp: new Date(),
+          metadata: {
+            connected: true,
+            connectionTimeMs: 20,
+          },
+        },
+      ];
+
+      const aggregated = strategy.aggregateResult(runs);
+
+      expect(aggregated.avgConnectionTime).toBe(15);
+      expect(aggregated.successRate).toBe(100);
+      expect(aggregated.errorCount).toBe(0);
+    });
+
+    it("should count errors and calculate success rate", () => {
+      const strategy = new TcpHealthCheckStrategy();
+      const runs = [
+        {
+          id: "1",
+          status: "healthy" as const,
+          latencyMs: 10,
+          checkId: "c1",
+          timestamp: new Date(),
+          metadata: {
+            connected: true,
+            connectionTimeMs: 10,
+          },
+        },
+        {
+          id: "2",
+          status: "unhealthy" as const,
+          latencyMs: 0,
+          checkId: "c1",
+          timestamp: new Date(),
+          metadata: {
+            connected: false,
+            connectionTimeMs: 0,
+            error: "Connection refused",
+          },
+        },
+      ];
+
+      const aggregated = strategy.aggregateResult(runs);
+
+      expect(aggregated.successRate).toBe(50);
+      expect(aggregated.errorCount).toBe(1);
+    });
+  });
+});

package/src/strategy.ts

@@ -0,0 +1,309 @@
+import {
+  HealthCheckStrategy,
+  HealthCheckResult,
+  HealthCheckRunForAggregation,
+  Versioned,
+  z,
+  timeThresholdField,
+  stringField,
+  evaluateAssertions,
+} from "@checkstack/backend-api";
+import {
+  healthResultBoolean,
+  healthResultNumber,
+  healthResultString,
+} from "@checkstack/healthcheck-common";
+
+// ============================================================================
+// SCHEMAS
+// ============================================================================
+
+/**
+ * Assertion schema for TCP health checks using shared factories.
+ */
+const tcpAssertionSchema = z.discriminatedUnion("field", [
+  timeThresholdField("connectionTime"),
+  stringField("banner"),
+]);
+
+export type TcpAssertion = z.infer<typeof tcpAssertionSchema>;
+
+/**
+ * Configuration schema for TCP health checks.
+ */
+export const tcpConfigSchema = z.object({
+  host: z.string().describe("Hostname or IP address"),
+  port: z.number().int().min(1).max(65_535).describe("TCP port number"),
+  timeout: z
+    .number()
+    .min(100)
+    .default(5000)
+    .describe("Connection timeout in milliseconds"),
+  readBanner: z
+    .boolean()
+    .default(false)
+    .describe("Read initial banner/greeting from server"),
+  assertions: z
+    .array(tcpAssertionSchema)
+    .optional()
+    .describe("Validation conditions"),
+});
+
+export type TcpConfig = z.infer<typeof tcpConfigSchema>;
+
+/**
+ * Per-run result metadata.
+ */
+const tcpResultSchema = 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",
+  }),
+  banner: healthResultString({
+    "x-chart-type": "text",
+    "x-chart-label": "Banner",
+  }).optional(),
+  failedAssertion: tcpAssertionSchema.optional(),
+  error: healthResultString({
+    "x-chart-type": "status",
+    "x-chart-label": "Error",
+  }).optional(),
+});
+
+export type TcpResult = z.infer<typeof tcpResultSchema>;
+
+/**
+ * Aggregated metadata for buckets.
+ */
+const tcpAggregatedSchema = z.object({
+  avgConnectionTime: healthResultNumber({
+    "x-chart-type": "line",
+    "x-chart-label": "Avg Connection 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 TcpAggregatedResult = z.infer<typeof tcpAggregatedSchema>;
+
+// ============================================================================
+// SOCKET INTERFACE (for testability)
+// ============================================================================
+
+export interface TcpSocket {
+  connect(options: { host: string; port: number }): Promise<void>;
+  read(timeout: number): Promise<string | undefined>;
+  close(): void;
+}
+
+export type SocketFactory = () => TcpSocket;
+
+// Default factory using Bun.connect
+const defaultSocketFactory: SocketFactory = () => {
+  let socket: Awaited<ReturnType<typeof Bun.connect>> | undefined;
+  let receivedData = "";
+
+  return {
+    async connect(options: { host: string; port: number }): Promise<void> {
+      return new Promise((resolve, reject) => {
+        Bun.connect({
+          hostname: options.host,
+          port: options.port,
+          socket: {
+            open(sock) {
+              socket = sock;
+              resolve();
+            },
+            data(_sock, data) {
+              receivedData += new TextDecoder().decode(data);
+            },
+            error(_sock, error) {
+              reject(error);
+            },
+            close() {
+              // Connection closed
+            },
+          },
+        }).catch(reject);
+      });
+    },
+    async read(timeout: number): Promise<string | undefined> {
+      const start = Date.now();
+      while (Date.now() - start < timeout) {
+        if (receivedData.length > 0) {
+          const data = receivedData;
+          receivedData = "";
+          return data;
+        }
+        await new Promise((r) => setTimeout(r, 50));
+      }
+      return receivedData.length > 0 ? receivedData : undefined;
+    },
+    close(): void {
+      socket?.end();
+    },
+  };
+};
+
+// ============================================================================
+// STRATEGY
+// ============================================================================
+
+export class TcpHealthCheckStrategy
+  implements HealthCheckStrategy<TcpConfig, TcpResult, TcpAggregatedResult>
+{
+  id = "tcp";
+  displayName = "TCP Health Check";
+  description = "TCP port connectivity check with optional banner grab";
+
+  private socketFactory: SocketFactory;
+
+  constructor(socketFactory: SocketFactory = defaultSocketFactory) {
+    this.socketFactory = socketFactory;
+  }
+
+  config: Versioned<TcpConfig> = new Versioned({
+    version: 1,
+    schema: tcpConfigSchema,
+  });
+
+  result: Versioned<TcpResult> = new Versioned({
+    version: 1,
+    schema: tcpResultSchema,
+  });
+
+  aggregatedResult: Versioned<TcpAggregatedResult> = new Versioned({
+    version: 1,
+    schema: tcpAggregatedSchema,
+  });
+
+  aggregateResult(
+    runs: HealthCheckRunForAggregation<TcpResult>[]
+  ): TcpAggregatedResult {
+    let totalConnectionTime = 0;
+    let successCount = 0;
+    let errorCount = 0;
+    let validRuns = 0;
+
+    for (const run of runs) {
+      if (run.metadata?.error) {
+        errorCount++;
+        continue;
+      }
+      if (run.status === "healthy") {
+        successCount++;
+      }
+      if (run.metadata) {
+        totalConnectionTime += run.metadata.connectionTimeMs;
+        validRuns++;
+      }
+    }
+
+    return {
+      avgConnectionTime: validRuns > 0 ? totalConnectionTime / validRuns : 0,
+      successRate: runs.length > 0 ? (successCount / runs.length) * 100 : 0,
+      errorCount,
+    };
+  }
+
+  async execute(config: TcpConfig): Promise<HealthCheckResult<TcpResult>> {
+    const validatedConfig = this.config.validate(config);
+    const start = performance.now();
+
+    const socket = this.socketFactory();
+
+    try {
+      // Set up timeout
+      const timeoutPromise = new Promise<never>((_, reject) => {
+        setTimeout(
+          () => reject(new Error("Connection timeout")),
+          validatedConfig.timeout
+        );
+      });
+
+      // Connect to host
+      await Promise.race([
+        socket.connect({
+          host: validatedConfig.host,
+          port: validatedConfig.port,
+        }),
+        timeoutPromise,
+      ]);
+
+      const connectionTimeMs = Math.round(performance.now() - start);
+
+      // Read banner if requested
+      let banner: string | undefined;
+      if (validatedConfig.readBanner) {
+        const bannerTimeout = Math.max(
+          1000,
+          validatedConfig.timeout - connectionTimeMs
+        );
+        banner = (await socket.read(bannerTimeout)) ?? undefined;
+      }
+
+      socket.close();
+
+      const result: Omit<TcpResult, "failedAssertion" | "error"> = {
+        connected: true,
+        connectionTimeMs,
+        banner,
+      };
+
+      // Evaluate assertions using shared utility
+      const failedAssertion = evaluateAssertions(validatedConfig.assertions, {
+        connectionTime: connectionTimeMs,
+        banner: banner ?? "",
+      });
+
+      if (failedAssertion) {
+        return {
+          status: "unhealthy",
+          latencyMs: connectionTimeMs,
+          message: `Assertion failed: ${failedAssertion.field} ${
+            failedAssertion.operator
+          }${"value" in failedAssertion ? ` ${failedAssertion.value}` : ""}`,
+          metadata: { ...result, failedAssertion },
+        };
+      }
+
+      return {
+        status: "healthy",
+        latencyMs: connectionTimeMs,
+        message: `Connected to ${validatedConfig.host}:${
+          validatedConfig.port
+        } in ${connectionTimeMs}ms${
+          banner ? ` (banner: ${banner.slice(0, 50)}...)` : ""
+        }`,
+        metadata: result,
+      };
+    } catch (error: unknown) {
+      socket.close();
+      const end = performance.now();
+      const isError = error instanceof Error;
+      return {
+        status: "unhealthy",
+        latencyMs: Math.round(end - start),
+        message: isError ? error.message : "TCP connection failed",
+        metadata: {
+          connected: false,
+          connectionTimeMs: Math.round(end - start),
+          error: isError ? error.name : "UnknownError",
+        },
+      };
+    }
+  }
+}

package/tsconfig.json

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