@checkstack/healthcheck-grpc-backend 0.1.13 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,59 @@
 # @checkstack/healthcheck-grpc-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-grpc-backend",
-  "version": "0.1.13",
+  "version": "0.2.0",
   "type": "module",
   "main": "src/index.ts",
   "scripts": {
@@ -9,15 +9,15 @@
     "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",
     "@grpc/grpc-js": "^1.9.0"
   },
   "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/health-collector.test.ts

@@ -65,7 +65,7 @@ describe("HealthCollector", () => {
     });
   });
 
-  describe("aggregateResult", () => {
+  describe("mergeResult", () => {
     it("should calculate average response time and serving rate", () => {
       const collector = new HealthCollector();
       const runs = [
@@ -87,10 +87,11 @@ describe("HealthCollector", () => {
         },
       ];
 
-      const aggregated = collector.aggregateResult(runs);
+      let aggregated = collector.mergeResult(undefined, runs[0]);
+      aggregated = collector.mergeResult(aggregated, runs[1]);
 
-      expect(aggregated.avgResponseTimeMs).toBe(75);
-      expect(aggregated.servingRate).toBe(100);
+      expect(aggregated.avgResponseTimeMs.avg).toBe(75);
+      expect(aggregated.servingRate.rate).toBe(100);
     });
 
     it("should calculate serving rate correctly", () => {
@@ -118,9 +119,10 @@ describe("HealthCollector", () => {
         },
       ];
 
-      const aggregated = collector.aggregateResult(runs);
+      let aggregated = collector.mergeResult(undefined, runs[0]);
+      aggregated = collector.mergeResult(aggregated, runs[1]);
 
-      expect(aggregated.servingRate).toBe(50);
+      expect(aggregated.servingRate.rate).toBe(50);
     });
   });
 

package/src/health-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,
@@ -49,20 +55,24 @@ const grpcHealthResultSchema = healthResultSchema({
 
 export type HealthResult = z.infer<typeof grpcHealthResultSchema>;
 
-const healthAggregatedSchema = healthResultSchema({
-  avgResponseTimeMs: healthResultNumber({
+// Aggregated result fields definition
+const healthAggregatedFields = {
+  avgResponseTimeMs: aggregatedAverage({
     "x-chart-type": "line",
     "x-chart-label": "Avg Response Time",
     "x-chart-unit": "ms",
   }),
-  servingRate: healthResultNumber({
+  servingRate: aggregatedRate({
     "x-chart-type": "gauge",
     "x-chart-label": "Serving Rate",
     "x-chart-unit": "%",
   }),
-});
+};
 
-export type HealthAggregatedResult = z.infer<typeof healthAggregatedSchema>;
+// Type inferred from field definitions
+export type HealthAggregatedResult = InferAggregatedResult<
+  typeof healthAggregatedFields
+>;
 
 // ============================================================================
 // HEALTH COLLECTOR
@@ -72,15 +82,12 @@ export type HealthAggregatedResult = z.infer<typeof healthAggregatedSchema>;
  * Built-in gRPC health collector.
  * Checks gRPC health status using the standard Health Checking Protocol.
  */
-export class HealthCollector
-  implements
-    CollectorStrategy<
-      GrpcTransportClient,
-      HealthConfig,
-      HealthResult,
-      HealthAggregatedResult
-    >
-{
+export class HealthCollector implements CollectorStrategy<
+  GrpcTransportClient,
+  HealthConfig,
+  HealthResult,
+  HealthAggregatedResult
+> {
   id = "health";
   displayName = "gRPC Health Check";
   description = "Check gRPC service health status";
@@ -91,9 +98,9 @@ export class HealthCollector
 
   config = new Versioned({ version: 1, schema: healthConfigSchema });
   result = new Versioned({ version: 1, schema: grpcHealthResultSchema });
-  aggregatedResult = new Versioned({
+  aggregatedResult = new VersionedAggregated({
     version: 1,
-    schema: healthAggregatedSchema,
+    fields: healthAggregatedFields,
   });
 
   async execute({
@@ -124,28 +131,18 @@ export class HealthCollector
     };
   }
 
-  aggregateResult(
-    runs: HealthCheckRunForAggregation<HealthResult>[]
+  mergeResult(
+    existing: HealthAggregatedResult | undefined,
+    run: HealthCheckRunForAggregation<HealthResult>,
   ): HealthAggregatedResult {
-    const times = runs
-      .map((r) => r.metadata?.responseTimeMs)
-      .filter((v): v is number => typeof v === "number");
-
-    const servingResults = runs
-      .map((r) => r.metadata?.serving)
-      .filter((v): v is boolean => typeof v === "boolean");
-
-    const servingCount = servingResults.filter(Boolean).length;
+    const metadata = run.metadata;
 
     return {
-      avgResponseTimeMs:
-        times.length > 0
-          ? Math.round(times.reduce((a, b) => a + b, 0) / times.length)
-          : 0,
-      servingRate:
-        servingResults.length > 0
-          ? Math.round((servingCount / servingResults.length) * 100)
-          : 0,
+      avgResponseTimeMs: mergeAverage(
+        existing?.avgResponseTimeMs,
+        metadata?.responseTimeMs,
+      ),
+      servingRate: mergeRate(existing?.servingRate, metadata?.serving),
     };
   }
 }

package/src/strategy.test.ts

@@ -111,7 +111,7 @@ describe("GrpcHealthCheckStrategy", () => {
     });
   });
 
-  describe("aggregateResult", () => {
+  describe("mergeResult", () => {
     it("should calculate averages correctly", () => {
       const strategy = new GrpcHealthCheckStrategy();
       const runs = [
@@ -141,12 +141,13 @@ describe("GrpcHealthCheckStrategy", () => {
         },
       ];
 
-      const aggregated = strategy.aggregateResult(runs);
+      let aggregated = strategy.mergeResult(undefined, runs[0]);
+      aggregated = strategy.mergeResult(aggregated, runs[1]);
 
-      expect(aggregated.avgResponseTime).toBe(10);
-      expect(aggregated.successRate).toBe(100);
-      expect(aggregated.servingCount).toBe(2);
-      expect(aggregated.errorCount).toBe(0);
+      expect(aggregated.avgResponseTime.avg).toBe(10);
+      expect(aggregated.successRate.rate).toBe(100);
+      expect(aggregated.servingCount.count).toBe(2);
+      expect(aggregated.errorCount.count).toBe(0);
     });
 
     it("should count errors and non-serving", () => {
@@ -179,11 +180,12 @@ describe("GrpcHealthCheckStrategy", () => {
         },
       ];
 
-      const aggregated = strategy.aggregateResult(runs);
+      let aggregated = strategy.mergeResult(undefined, runs[0]);
+      aggregated = strategy.mergeResult(aggregated, runs[1]);
 
-      expect(aggregated.errorCount).toBe(1);
-      expect(aggregated.servingCount).toBe(0);
-      expect(aggregated.successRate).toBe(0);
+      expect(aggregated.errorCount.count).toBe(1);
+      expect(aggregated.servingCount.count).toBe(0);
+      expect(aggregated.successRate.rate).toBe(0);
     });
   });
 });

package/src/strategy.ts

@@ -3,8 +3,16 @@ import {
   HealthCheckStrategy,
   HealthCheckRunForAggregation,
   Versioned,
+  VersionedAggregated,
+  aggregatedAverage,
+  aggregatedRate,
+  aggregatedCounter,
+  mergeAverage,
+  mergeRate,
+  mergeCounter,
   z,
   type ConnectedClient,
+  type InferAggregatedResult,
 } from "@checkstack/backend-api";
 import {
   healthResultBoolean,
@@ -80,31 +88,29 @@ const grpcResultSchema = healthResultSchema({
 
 type GrpcResult = z.infer<typeof grpcResultSchema>;
 
-/**
- * Aggregated metadata for buckets.
- */
-const grpcAggregatedSchema = healthResultSchema({
-  avgResponseTime: healthResultNumber({
+/** Aggregated field definitions for bucket merging */
+const grpcAggregatedFields = {
+  avgResponseTime: aggregatedAverage({
     "x-chart-type": "line",
     "x-chart-label": "Avg Response 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",
   }),
-  servingCount: healthResultNumber({
+  servingCount: aggregatedCounter({
     "x-chart-type": "counter",
     "x-chart-label": "Serving",
   }),
-});
+};
 
-type GrpcAggregatedResult = z.infer<typeof grpcAggregatedSchema>;
+type GrpcAggregatedResult = InferAggregatedResult<typeof grpcAggregatedFields>;
 
 // ============================================================================
 // GRPC CLIENT INTERFACE (for testability)
@@ -176,7 +182,7 @@ const defaultGrpcClient: GrpcHealthClient = {
           resolve({
             status: statusMap[response?.status ?? 0] ?? "UNKNOWN",
           });
-        }
+        },
       );
     });
   },
@@ -186,15 +192,12 @@ const defaultGrpcClient: GrpcHealthClient = {
 // STRATEGY
 // ============================================================================
 
-export class GrpcHealthCheckStrategy
-  implements
-    HealthCheckStrategy<
-      GrpcConfig,
-      GrpcTransportClient,
-      GrpcResult,
-      GrpcAggregatedResult
-    >
-{
+export class GrpcHealthCheckStrategy implements HealthCheckStrategy<
+  GrpcConfig,
+  GrpcTransportClient,
+  GrpcResult,
+  typeof grpcAggregatedFields
+> {
   id = "grpc";
   displayName = "gRPC Health Check";
   description =
@@ -232,55 +235,35 @@ export class GrpcHealthCheckStrategy
     ],
   });
 
-  aggregatedResult: Versioned<GrpcAggregatedResult> = new Versioned({
+  aggregatedResult = new VersionedAggregated({
     version: 1,
-    schema: grpcAggregatedSchema,
+    fields: grpcAggregatedFields,
   });
 
-  aggregateResult(
-    runs: HealthCheckRunForAggregation<GrpcResult>[]
+  mergeResult(
+    existing: GrpcAggregatedResult | undefined,
+    run: HealthCheckRunForAggregation<GrpcResult>,
   ): GrpcAggregatedResult {
-    const validRuns = runs.filter((r) => r.metadata);
-
-    if (validRuns.length === 0) {
-      return {
-        avgResponseTime: 0,
-        successRate: 0,
-        errorCount: 0,
-        servingCount: 0,
-      };
-    }
+    const metadata = run.metadata;
 
-    const responseTimes = validRuns
-      .map((r) => r.metadata?.responseTimeMs)
-      .filter((t): t is number => typeof t === "number");
+    const avgResponseTime = mergeAverage(
+      existing?.avgResponseTime,
+      metadata?.responseTimeMs,
+    );
 
-    const avgResponseTime =
-      responseTimes.length > 0
-        ? Math.round(
-            responseTimes.reduce((a, b) => a + b, 0) / responseTimes.length
-          )
-        : 0;
+    const isSuccess = metadata?.status === "SERVING";
+    const successRate = mergeRate(existing?.successRate, isSuccess);
 
-    const servingCount = validRuns.filter(
-      (r) => r.metadata?.status === "SERVING"
-    ).length;
-    const successRate = Math.round((servingCount / validRuns.length) * 100);
+    const hasError = metadata?.error !== undefined;
+    const errorCount = mergeCounter(existing?.errorCount, hasError);
 
-    const errorCount = validRuns.filter(
-      (r) => r.metadata?.error !== undefined
-    ).length;
+    const servingCount = mergeCounter(existing?.servingCount, isSuccess);
 
-    return {
-      avgResponseTime,
-      successRate,
-      errorCount,
-      servingCount,
-    };
+    return { avgResponseTime, successRate, errorCount, servingCount };
   }
 
   async createClient(
-    config: GrpcConfigInput
+    config: GrpcConfigInput,
   ): Promise<ConnectedClient<GrpcTransportClient>> {
     const validatedConfig = this.config.validate(config);