@checkstack/healthcheck-tcp-backend 0.1.13 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,59 @@
 # @checkstack/healthcheck-tcp-backend
 
+## 0.2.0
+
+### Minor Changes
+
+- 3dd1914: Migrate health check strategies to VersionedAggregated with \_type discriminator
+
+  All 13 health check strategies now use `VersionedAggregated` for their `aggregatedResult` property, enabling automatic bucket merging with 100% mathematical fidelity.
+
+  **Key changes:**
+
+  - **`_type` discriminator**: All aggregated state objects now include a required `_type` field (`"average"`, `"rate"`, `"counter"`, `"minmax"`) for reliable type detection
+  - The `HealthCheckStrategy` interface now requires `aggregatedResult` to be a `VersionedAggregated<AggregatedResultShape>`
+  - Strategy/collector `mergeResult` methods return state objects with `_type` (e.g., `{ _type: "average", _sum, _count, avg }`)
+  - `mergeAggregatedBucketResults`, `combineBuckets`, and `reaggregateBuckets` now require `registry` and `strategyId` parameters
+  - `HealthCheckService` constructor now requires both `registry` and `collectorRegistry` parameters
+  - Frontend `extractComputedValue` now uses `_type` discriminator for robust type detection
+
+  **Breaking Change**: State objects now require `_type`. Merge functions automatically add `_type` to output. The bucket merging functions and `HealthCheckService` now require additional required parameters.
+
+### Patch Changes
+
+- Updated dependencies [3dd1914]
+  - @checkstack/backend-api@0.7.0
+
+## 0.1.14
+
+### Patch Changes
+
+- 48c2080: Migrate aggregation from batch to incremental (`mergeResult`)
+
+  ### Breaking Changes (Internal)
+
+  - Replaced `aggregateResult(runs[])` with `mergeResult(existing, run)` interface across all HealthCheckStrategy and CollectorStrategy implementations
+
+  ### New Features
+
+  - Added incremental aggregation utilities in `@checkstack/backend-api`:
+    - `mergeCounter()` - track occurrences
+    - `mergeAverage()` - track sum/count, compute avg
+    - `mergeRate()` - track success/total, compute %
+    - `mergeMinMax()` - track min/max values
+  - Exported Zod schemas for internal state: `averageStateSchema`, `rateStateSchema`, `minMaxStateSchema`, `counterStateSchema`
+
+  ### Improvements
+
+  - Enables O(1) storage overhead by maintaining incremental aggregation state
+  - Prepares for real-time hourly aggregation without batch accumulation
+
+- Updated dependencies [f676e11]
+- Updated dependencies [48c2080]
+  - @checkstack/common@0.6.2
+  - @checkstack/backend-api@0.6.0
+  - @checkstack/healthcheck-common@0.8.2
+
 ## 0.1.13
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/healthcheck-tcp-backend",
-  "version": "0.1.13",
+  "version": "0.2.0",
   "type": "module",
   "main": "src/index.ts",
   "scripts": {
@@ -9,14 +9,14 @@
     "lint:code": "eslint . --max-warnings 0"
   },
   "dependencies": {
-    "@checkstack/backend-api": "0.5.1",
-    "@checkstack/common": "0.6.0",
-    "@checkstack/healthcheck-common": "0.7.0"
+    "@checkstack/backend-api": "0.5.2",
+    "@checkstack/common": "0.6.1",
+    "@checkstack/healthcheck-common": "0.8.1"
   },
   "devDependencies": {
     "@types/bun": "^1.0.0",
     "typescript": "^5.0.0",
-    "@checkstack/tsconfig": "0.0.2",
-    "@checkstack/scripts": "0.1.0"
+    "@checkstack/tsconfig": "0.0.3",
+    "@checkstack/scripts": "0.1.1"
   }
 }

package/src/banner-collector.test.ts

@@ -65,7 +65,7 @@ describe("BannerCollector", () => {
     });
   });
 
-  describe("aggregateResult", () => {
+  describe("mergeResult", () => {
     it("should calculate average read time and banner rate", () => {
       const collector = new BannerCollector();
       const runs = [
@@ -87,10 +87,11 @@ describe("BannerCollector", () => {
         },
       ];
 
-      const aggregated = collector.aggregateResult(runs);
+      let aggregated = collector.mergeResult(undefined, runs[0]);
+      aggregated = collector.mergeResult(aggregated, runs[1]);
 
-      expect(aggregated.avgReadTimeMs).toBe(75);
-      expect(aggregated.bannerRate).toBe(50);
+      expect(aggregated.avgReadTimeMs.avg).toBe(75);
+      expect(aggregated.bannerRate.rate).toBe(50);
     });
   });
 

package/src/banner-collector.ts

@@ -4,6 +4,12 @@ import {
   type HealthCheckRunForAggregation,
   type CollectorResult,
   type CollectorStrategy,
+  mergeAverage,
+  mergeRate,
+  VersionedAggregated,
+  aggregatedAverage,
+  aggregatedRate,
+  type InferAggregatedResult,
 } from "@checkstack/backend-api";
 import {
   healthResultNumber,
@@ -50,20 +56,24 @@ const bannerResultSchema = healthResultSchema({
 
 export type BannerResult = z.infer<typeof bannerResultSchema>;
 
-const bannerAggregatedSchema = healthResultSchema({
-  avgReadTimeMs: healthResultNumber({
+// Aggregated result fields definition
+const bannerAggregatedFields = {
+  avgReadTimeMs: aggregatedAverage({
     "x-chart-type": "line",
     "x-chart-label": "Avg Read Time",
     "x-chart-unit": "ms",
   }),
-  bannerRate: healthResultNumber({
+  bannerRate: aggregatedRate({
     "x-chart-type": "gauge",
     "x-chart-label": "Banner Rate",
     "x-chart-unit": "%",
   }),
-});
+};
 
-export type BannerAggregatedResult = z.infer<typeof bannerAggregatedSchema>;
+// Type inferred from field definitions
+export type BannerAggregatedResult = InferAggregatedResult<
+  typeof bannerAggregatedFields
+>;
 
 // ============================================================================
 // BANNER COLLECTOR
@@ -73,15 +83,12 @@ export type BannerAggregatedResult = z.infer<typeof bannerAggregatedSchema>;
  * Built-in TCP banner collector.
  * Reads the initial banner/greeting from a TCP server.
  */
-export class BannerCollector
-  implements
-    CollectorStrategy<
-      TcpTransportClient,
-      BannerConfig,
-      BannerResult,
-      BannerAggregatedResult
-    >
-{
+export class BannerCollector implements CollectorStrategy<
+  TcpTransportClient,
+  BannerConfig,
+  BannerResult,
+  BannerAggregatedResult
+> {
   id = "banner";
   displayName = "TCP Banner";
   description = "Read the initial banner/greeting from the server";
@@ -92,9 +99,9 @@ export class BannerCollector
 
   config = new Versioned({ version: 1, schema: bannerConfigSchema });
   result = new Versioned({ version: 1, schema: bannerResultSchema });
-  aggregatedResult = new Versioned({
+  aggregatedResult = new VersionedAggregated({
     version: 1,
-    schema: bannerAggregatedSchema,
+    fields: bannerAggregatedFields,
   });
 
   async execute({
@@ -123,28 +130,18 @@ export class BannerCollector
     };
   }
 
-  aggregateResult(
-    runs: HealthCheckRunForAggregation<BannerResult>[]
+  mergeResult(
+    existing: BannerAggregatedResult | undefined,
+    run: HealthCheckRunForAggregation<BannerResult>,
   ): BannerAggregatedResult {
-    const times = runs
-      .map((r) => r.metadata?.readTimeMs)
-      .filter((v): v is number => typeof v === "number");
-
-    const hasBanners = runs
-      .map((r) => r.metadata?.hasBanner)
-      .filter((v): v is boolean => typeof v === "boolean");
-
-    const bannerCount = hasBanners.filter(Boolean).length;
+    const metadata = run.metadata;
 
     return {
-      avgReadTimeMs:
-        times.length > 0
-          ? Math.round(times.reduce((a, b) => a + b, 0) / times.length)
-          : 0,
-      bannerRate:
-        hasBanners.length > 0
-          ? Math.round((bannerCount / hasBanners.length) * 100)
-          : 0,
+      avgReadTimeMs: mergeAverage(
+        existing?.avgReadTimeMs,
+        metadata?.readTimeMs,
+      ),
+      bannerRate: mergeRate(existing?.bannerRate, metadata?.hasBanner),
     };
   }
 }

package/src/strategy.test.ts

@@ -90,7 +90,7 @@ describe("TcpHealthCheckStrategy", () => {
     });
   });
 
-  describe("aggregateResult", () => {
+  describe("mergeResult", () => {
     it("should calculate averages correctly", () => {
       const strategy = new TcpHealthCheckStrategy();
       const runs = [
@@ -118,11 +118,12 @@ describe("TcpHealthCheckStrategy", () => {
         },
       ];
 
-      const aggregated = strategy.aggregateResult(runs);
+      let aggregated = strategy.mergeResult(undefined, runs[0]);
+      aggregated = strategy.mergeResult(aggregated, runs[1]);
 
-      expect(aggregated.avgConnectionTime).toBe(15);
-      expect(aggregated.successRate).toBe(100);
-      expect(aggregated.errorCount).toBe(0);
+      expect(aggregated.avgConnectionTime.avg).toBe(15);
+      expect(aggregated.successRate.rate).toBe(100);
+      expect(aggregated.errorCount.count).toBe(0);
     });
 
     it("should count errors and calculate success rate", () => {
@@ -153,10 +154,11 @@ describe("TcpHealthCheckStrategy", () => {
         },
       ];
 
-      const aggregated = strategy.aggregateResult(runs);
+      let aggregated = strategy.mergeResult(undefined, runs[0]);
+      aggregated = strategy.mergeResult(aggregated, runs[1]);
 
-      expect(aggregated.successRate).toBe(50);
-      expect(aggregated.errorCount).toBe(1);
+      expect(aggregated.successRate.rate).toBe(50);
+      expect(aggregated.errorCount.count).toBe(1);
     });
   });
 });

package/src/strategy.ts

@@ -2,8 +2,16 @@ import {
   HealthCheckStrategy,
   HealthCheckRunForAggregation,
   Versioned,
+  VersionedAggregated,
+  aggregatedAverage,
+  aggregatedRate,
+  aggregatedCounter,
+  mergeAverage,
+  mergeRate,
+  mergeCounter,
   z,
   type ConnectedClient,
+  type InferAggregatedResult,
 } from "@checkstack/backend-api";
 import {
   healthResultBoolean,
@@ -70,27 +78,25 @@ const tcpResultSchema = healthResultSchema({
 
 type TcpResult = z.infer<typeof tcpResultSchema>;
 
-/**
- * Aggregated metadata for buckets.
- */
-const tcpAggregatedSchema = healthResultSchema({
-  avgConnectionTime: healthResultNumber({
+/** Aggregated field definitions for bucket merging */
+const tcpAggregatedFields = {
+  avgConnectionTime: aggregatedAverage({
     "x-chart-type": "line",
     "x-chart-label": "Avg Connection Time",
     "x-chart-unit": "ms",
   }),
-  successRate: healthResultNumber({
+  successRate: aggregatedRate({
     "x-chart-type": "gauge",
     "x-chart-label": "Success Rate",
     "x-chart-unit": "%",
   }),
-  errorCount: healthResultNumber({
+  errorCount: aggregatedCounter({
     "x-chart-type": "counter",
     "x-chart-label": "Errors",
   }),
-});
+};
 
-type TcpAggregatedResult = z.infer<typeof tcpAggregatedSchema>;
+type TcpAggregatedResult = InferAggregatedResult<typeof tcpAggregatedFields>;
 
 // ============================================================================
 // SOCKET INTERFACE (for testability)
@@ -159,15 +165,12 @@ const defaultSocketFactory: SocketFactory = () => {
 // STRATEGY
 // ============================================================================
 
-export class TcpHealthCheckStrategy
-  implements
-    HealthCheckStrategy<
-      TcpConfig,
-      TcpTransportClient,
-      TcpResult,
-      TcpAggregatedResult
-    >
-{
+export class TcpHealthCheckStrategy implements HealthCheckStrategy<
+  TcpConfig,
+  TcpTransportClient,
+  TcpResult,
+  typeof tcpAggregatedFields
+> {
   id = "tcp";
   displayName = "TCP Health Check";
   description = "TCP port connectivity check with optional banner grab";
@@ -208,45 +211,33 @@ export class TcpHealthCheckStrategy
     ],
   });
 
-  aggregatedResult: Versioned<TcpAggregatedResult> = new Versioned({
+  aggregatedResult = new VersionedAggregated({
     version: 1,
-    schema: tcpAggregatedSchema,
+    fields: tcpAggregatedFields,
   });
 
-  aggregateResult(
-    runs: HealthCheckRunForAggregation<TcpResult>[]
+  mergeResult(
+    existing: TcpAggregatedResult | undefined,
+    run: HealthCheckRunForAggregation<TcpResult>,
   ): TcpAggregatedResult {
-    const validRuns = runs.filter((r) => r.metadata);
-
-    if (validRuns.length === 0) {
-      return { avgConnectionTime: 0, successRate: 0, errorCount: 0 };
-    }
-
-    const connectionTimes = validRuns
-      .map((r) => r.metadata?.connectionTimeMs)
-      .filter((t): t is number => typeof t === "number");
+    const metadata = run.metadata;
 
-    const avgConnectionTime =
-      connectionTimes.length > 0
-        ? Math.round(
-            connectionTimes.reduce((a, b) => a + b, 0) / connectionTimes.length
-          )
-        : 0;
+    const avgConnectionTime = mergeAverage(
+      existing?.avgConnectionTime,
+      metadata?.connectionTimeMs,
+    );
 
-    const successCount = validRuns.filter(
-      (r) => r.metadata?.connected === true
-    ).length;
-    const successRate = Math.round((successCount / validRuns.length) * 100);
+    const isSuccess = metadata?.connected ?? false;
+    const successRate = mergeRate(existing?.successRate, isSuccess);
 
-    const errorCount = validRuns.filter(
-      (r) => r.metadata?.error !== undefined
-    ).length;
+    const hasError = metadata?.error !== undefined;
+    const errorCount = mergeCounter(existing?.errorCount, hasError);
 
     return { avgConnectionTime, successRate, errorCount };
   }
 
   async createClient(
-    config: TcpConfig
+    config: TcpConfig,
   ): Promise<ConnectedClient<TcpTransportClient>> {
     const validatedConfig = this.config.validate(config);
     const socket = this.socketFactory();