@checkstack/healthcheck-tcp-backend 0.1.13 → 0.1.14

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # @checkstack/healthcheck-tcp-backend
 
+## 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.1.14",
   "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,7 +87,8 @@ 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);

package/src/banner-collector.ts

@@ -4,6 +4,12 @@ import {
   type HealthCheckRunForAggregation,
   type CollectorResult,
   type CollectorStrategy,
+  mergeAverage,
+  averageStateSchema,
+  mergeRate,
+  rateStateSchema,
+  type AverageState,
+  type RateState,
 } from "@checkstack/backend-api";
 import {
   healthResultNumber,
@@ -50,7 +56,7 @@ const bannerResultSchema = healthResultSchema({
 
 export type BannerResult = z.infer<typeof bannerResultSchema>;
 
-const bannerAggregatedSchema = healthResultSchema({
+const bannerAggregatedDisplaySchema = healthResultSchema({
   avgReadTimeMs: healthResultNumber({
     "x-chart-type": "line",
     "x-chart-label": "Avg Read Time",
@@ -63,6 +69,17 @@ const bannerAggregatedSchema = healthResultSchema({
   }),
 });
 
+const bannerAggregatedInternalSchema = z.object({
+  _readTime: averageStateSchema
+    .optional(),
+  _banner: rateStateSchema
+    .optional(),
+});
+
+const bannerAggregatedSchema = bannerAggregatedDisplaySchema.merge(
+  bannerAggregatedInternalSchema,
+);
+
 export type BannerAggregatedResult = z.infer<typeof bannerAggregatedSchema>;
 
 // ============================================================================
@@ -73,15 +90,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";
@@ -123,28 +137,27 @@ 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 metadata = run.metadata;
 
-    const hasBanners = runs
-      .map((r) => r.metadata?.hasBanner)
-      .filter((v): v is boolean => typeof v === "boolean");
+    const readTimeState = mergeAverage(
+      existing?._readTime as AverageState | undefined,
+      metadata?.readTimeMs,
+    );
 
-    const bannerCount = hasBanners.filter(Boolean).length;
+    const bannerState = mergeRate(
+      existing?._banner as RateState | undefined,
+      metadata?.hasBanner,
+    );
 
     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: readTimeState.avg,
+      bannerRate: bannerState.rate,
+      _readTime: readTimeState,
+      _banner: bannerState,
     };
   }
 }

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,7 +118,8 @@ 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);
@@ -153,7 +154,8 @@ 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);

package/src/strategy.ts

@@ -4,6 +4,15 @@ import {
   Versioned,
   z,
   type ConnectedClient,
+  mergeAverage,
+  averageStateSchema,
+  mergeRate,
+  rateStateSchema,
+  mergeCounter,
+  counterStateSchema,
+  type AverageState,
+  type RateState,
+  type CounterState,
 } from "@checkstack/backend-api";
 import {
   healthResultBoolean,
@@ -73,7 +82,8 @@ type TcpResult = z.infer<typeof tcpResultSchema>;
 /**
  * Aggregated metadata for buckets.
  */
-const tcpAggregatedSchema = healthResultSchema({
+// UI-visible aggregated fields
+const tcpAggregatedDisplaySchema = healthResultSchema({
   avgConnectionTime: healthResultNumber({
     "x-chart-type": "line",
     "x-chart-label": "Avg Connection Time",
@@ -90,6 +100,19 @@ const tcpAggregatedSchema = healthResultSchema({
   }),
 });
 
+// Internal state for incremental aggregation
+const tcpAggregatedInternalSchema = z.object({
+  _connectionTime: averageStateSchema
+    .optional(),
+  _success: rateStateSchema
+    .optional(),
+  _errors: counterStateSchema.optional(),
+});
+
+const tcpAggregatedSchema = tcpAggregatedDisplaySchema.merge(
+  tcpAggregatedInternalSchema,
+);
+
 type TcpAggregatedResult = z.infer<typeof tcpAggregatedSchema>;
 
 // ============================================================================
@@ -159,15 +182,12 @@ const defaultSocketFactory: SocketFactory = () => {
 // STRATEGY
 // ============================================================================
 
-export class TcpHealthCheckStrategy
-  implements
-    HealthCheckStrategy<
-      TcpConfig,
-      TcpTransportClient,
-      TcpResult,
-      TcpAggregatedResult
-    >
-{
+export class TcpHealthCheckStrategy implements HealthCheckStrategy<
+  TcpConfig,
+  TcpTransportClient,
+  TcpResult,
+  TcpAggregatedResult
+> {
   id = "tcp";
   displayName = "TCP Health Check";
   description = "TCP port connectivity check with optional banner grab";
@@ -213,40 +233,39 @@ export class TcpHealthCheckStrategy
     schema: tcpAggregatedSchema,
   });
 
-  aggregateResult(
-    runs: HealthCheckRunForAggregation<TcpResult>[]
+  mergeResult(
+    existing: TcpAggregatedResult | undefined,
+    run: HealthCheckRunForAggregation<TcpResult>,
   ): TcpAggregatedResult {
-    const validRuns = runs.filter((r) => r.metadata);
+    const metadata = run.metadata;
 
-    if (validRuns.length === 0) {
-      return { avgConnectionTime: 0, successRate: 0, errorCount: 0 };
-    }
+    const connectionTimeState = mergeAverage(
+      existing?._connectionTime as AverageState | undefined,
+      metadata?.connectionTimeMs,
+    );
 
-    const connectionTimes = validRuns
-      .map((r) => r.metadata?.connectionTimeMs)
-      .filter((t): t is number => typeof t === "number");
+    const successState = mergeRate(
+      existing?._success as RateState | undefined,
+      metadata?.connected,
+    );
 
-    const avgConnectionTime =
-      connectionTimes.length > 0
-        ? Math.round(
-            connectionTimes.reduce((a, b) => a + b, 0) / connectionTimes.length
-          )
-        : 0;
+    const errorState = mergeCounter(
+      existing?._errors as CounterState | undefined,
+      metadata?.error !== undefined,
+    );
 
-    const successCount = validRuns.filter(
-      (r) => r.metadata?.connected === true
-    ).length;
-    const successRate = Math.round((successCount / validRuns.length) * 100);
-
-    const errorCount = validRuns.filter(
-      (r) => r.metadata?.error !== undefined
-    ).length;
-
-    return { avgConnectionTime, successRate, errorCount };
+    return {
+      avgConnectionTime: connectionTimeState.avg,
+      successRate: successState.rate,
+      errorCount: errorState.count,
+      _connectionTime: connectionTimeState,
+      _success: successState,
+      _errors: errorState,
+    };
   }
 
   async createClient(
-    config: TcpConfig
+    config: TcpConfig,
   ): Promise<ConnectedClient<TcpTransportClient>> {
     const validatedConfig = this.config.validate(config);
     const socket = this.socketFactory();