@checkstack/healthcheck-ping-backend 0.1.14 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @checkstack/healthcheck-ping-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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/healthcheck-ping-backend",
-  "version": "0.1.14",
+  "version": "0.2.0",
   "type": "module",
   "main": "src/index.ts",
   "scripts": {

package/src/ping-collector.test.ts

@@ -117,8 +117,8 @@ describe("PingCollector", () => {
       let aggregated = collector.mergeResult(undefined, runs[0]);
       aggregated = collector.mergeResult(aggregated, runs[1]);
 
-      expect(aggregated.avgPacketLoss).toBe(5);
-      expect(aggregated.avgLatency).toBe(15);
+      expect(aggregated.avgPacketLoss.avg).toBe(5);
+      expect(aggregated.avgLatency.avg).toBe(15);
     });
   });
 

package/src/ping-collector.ts

@@ -5,8 +5,9 @@ import {
   type CollectorResult,
   type CollectorStrategy,
   mergeAverage,
-  averageStateSchema,
-  type AverageState,
+  VersionedAggregated,
+  aggregatedAverage,
+  type InferAggregatedResult,
 } from "@checkstack/backend-api";
 import {
   healthResultNumber,
@@ -74,29 +75,24 @@ const pingResultSchema = healthResultSchema({
 
 export type PingResult = z.infer<typeof pingResultSchema>;
 
-const pingAggregatedDisplaySchema = healthResultSchema({
-  avgPacketLoss: healthResultNumber({
+// Aggregated result fields definition
+const pingAggregatedFields = {
+  avgPacketLoss: aggregatedAverage({
     "x-chart-type": "gauge",
     "x-chart-label": "Avg Packet Loss",
     "x-chart-unit": "%",
   }),
-  avgLatency: healthResultNumber({
+  avgLatency: aggregatedAverage({
     "x-chart-type": "line",
     "x-chart-label": "Avg Latency",
     "x-chart-unit": "ms",
   }),
-});
-
-const pingAggregatedInternalSchema = z.object({
-  _packetLoss: averageStateSchema.optional(),
-  _latency: averageStateSchema.optional(),
-});
+};
 
-const pingAggregatedSchema = pingAggregatedDisplaySchema.merge(
-  pingAggregatedInternalSchema,
-);
-
-export type PingAggregatedResult = z.infer<typeof pingAggregatedSchema>;
+// Type inferred from field definitions
+export type PingAggregatedResult = InferAggregatedResult<
+  typeof pingAggregatedFields
+>;
 
 // ============================================================================
 // PING COLLECTOR
@@ -122,9 +118,9 @@ export class PingCollector implements CollectorStrategy<
 
   config = new Versioned({ version: 1, schema: pingConfigSchema });
   result = new Versioned({ version: 1, schema: pingResultSchema });
-  aggregatedResult = new Versioned({
+  aggregatedResult = new VersionedAggregated({
     version: 1,
-    schema: pingAggregatedSchema,
+    fields: pingAggregatedFields,
   });
 
   async execute({
@@ -160,21 +156,12 @@ export class PingCollector implements CollectorStrategy<
   ): PingAggregatedResult {
     const metadata = run.metadata;
 
-    const lossState = mergeAverage(
-      existing?._packetLoss as AverageState | undefined,
-      metadata?.packetLoss,
-    );
-
-    const latencyState = mergeAverage(
-      existing?._latency as AverageState | undefined,
-      metadata?.avgLatency,
-    );
-
     return {
-      avgPacketLoss: Math.round(lossState.avg * 10) / 10,
-      avgLatency: Math.round(latencyState.avg * 10) / 10,
-      _packetLoss: lossState,
-      _latency: latencyState,
+      avgPacketLoss: mergeAverage(
+        existing?.avgPacketLoss,
+        metadata?.packetLoss,
+      ),
+      avgLatency: mergeAverage(existing?.avgLatency, metadata?.avgLatency),
     };
   }
 }

package/src/strategy.test.ts

@@ -176,10 +176,10 @@ describe("PingHealthCheckStrategy", () => {
       aggregated = strategy.mergeResult(aggregated, runs[1]);
 
       // (0 + 33) / 2 = 16.5
-      expect(aggregated.avgPacketLoss).toBeCloseTo(16.5, 1);
-      expect(aggregated.avgLatency).toBeCloseTo(15, 1);
-      expect(aggregated.maxLatency).toBe(25);
-      expect(aggregated.errorCount).toBe(0);
+      expect(aggregated.avgPacketLoss.avg).toBeCloseTo(16.5, 1);
+      expect(aggregated.avgLatency.avg).toBeCloseTo(15, 1);
+      expect(aggregated.maxLatency.max).toBe(25);
+      expect(aggregated.errorCount.count).toBe(0);
     });
 
     it("should count errors", () => {
@@ -199,7 +199,7 @@ describe("PingHealthCheckStrategy", () => {
 
       const aggregated = strategy.mergeResult(undefined, run);
 
-      expect(aggregated.errorCount).toBe(1);
+      expect(aggregated.errorCount.count).toBe(1);
     });
   });
 });

package/src/strategy.ts

@@ -2,17 +2,16 @@ import {
   HealthCheckStrategy,
   HealthCheckRunForAggregation,
   Versioned,
-  z,
-  type ConnectedClient,
+  VersionedAggregated,
+  aggregatedAverage,
+  aggregatedMinMax,
+  aggregatedCounter,
   mergeAverage,
-  averageStateSchema,
   mergeCounter,
-  counterStateSchema,
   mergeMinMax,
-  minMaxStateSchema,
-  type AverageState,
-  type CounterState,
-  type MinMaxState,
+  z,
+  type ConnectedClient,
+  type InferAggregatedResult,
 } from "@checkstack/backend-api";
 import {
   healthResultNumber,
@@ -90,43 +89,30 @@ const pingResultSchema = healthResultSchema({
 
 type PingResult = z.infer<typeof pingResultSchema>;
 
-/**
- * Aggregated metadata for buckets.
- */
-const pingAggregatedDisplaySchema = healthResultSchema({
-  avgPacketLoss: healthResultNumber({
+/** Aggregated field definitions for bucket merging */
+const pingAggregatedFields = {
+  avgPacketLoss: aggregatedAverage({
     "x-chart-type": "gauge",
     "x-chart-label": "Avg Packet Loss",
     "x-chart-unit": "%",
   }),
-  avgLatency: healthResultNumber({
+  avgLatency: aggregatedAverage({
     "x-chart-type": "line",
     "x-chart-label": "Avg Latency",
     "x-chart-unit": "ms",
   }),
-  maxLatency: healthResultNumber({
+  maxLatency: aggregatedMinMax({
     "x-chart-type": "line",
     "x-chart-label": "Max Latency",
     "x-chart-unit": "ms",
   }),
-  errorCount: healthResultNumber({
+  errorCount: aggregatedCounter({
     "x-chart-type": "counter",
     "x-chart-label": "Errors",
   }),
-});
+};
 
-const pingAggregatedInternalSchema = z.object({
-  _packetLoss: averageStateSchema.optional(),
-  _latency: averageStateSchema.optional(),
-  _maxLatency: minMaxStateSchema.optional(),
-  _errors: counterStateSchema.optional(),
-});
-
-const pingAggregatedSchema = pingAggregatedDisplaySchema.merge(
-  pingAggregatedInternalSchema,
-);
-
-type PingAggregatedResult = z.infer<typeof pingAggregatedSchema>;
+type PingAggregatedResult = InferAggregatedResult<typeof pingAggregatedFields>;
 
 // ============================================================================
 // STRATEGY
@@ -136,7 +122,7 @@ export class PingHealthCheckStrategy implements HealthCheckStrategy<
   PingConfig,
   PingTransportClient,
   PingResult,
-  PingAggregatedResult
+  typeof pingAggregatedFields
 > {
   id = "ping";
   displayName = "Ping Health Check";
@@ -170,9 +156,9 @@ export class PingHealthCheckStrategy implements HealthCheckStrategy<
     ],
   });
 
-  aggregatedResult: Versioned<PingAggregatedResult> = new Versioned({
+  aggregatedResult = new VersionedAggregated({
     version: 1,
-    schema: pingAggregatedSchema,
+    fields: pingAggregatedFields,
   });
 
   mergeResult(
@@ -181,36 +167,19 @@ export class PingHealthCheckStrategy implements HealthCheckStrategy<
   ): PingAggregatedResult {
     const metadata = run.metadata;
 
-    const packetLossState = mergeAverage(
-      existing?._packetLoss as AverageState | undefined,
+    const avgPacketLoss = mergeAverage(
+      existing?.avgPacketLoss,
       metadata?.packetLoss,
     );
 
-    const latencyState = mergeAverage(
-      existing?._latency as AverageState | undefined,
-      metadata?.avgLatency,
-    );
+    const avgLatency = mergeAverage(existing?.avgLatency, metadata?.avgLatency);
 
-    const maxLatencyState = mergeMinMax(
-      existing?._maxLatency as MinMaxState | undefined,
-      metadata?.maxLatency,
-    );
+    const maxLatency = mergeMinMax(existing?.maxLatency, metadata?.maxLatency);
 
-    const errorState = mergeCounter(
-      existing?._errors as CounterState | undefined,
-      metadata?.error !== undefined,
-    );
+    const hasError = metadata?.error !== undefined;
+    const errorCount = mergeCounter(existing?.errorCount, hasError);
 
-    return {
-      avgPacketLoss: Math.round(packetLossState.avg * 10) / 10,
-      avgLatency: Math.round(latencyState.avg * 10) / 10,
-      maxLatency: maxLatencyState.max,
-      errorCount: errorState.count,
-      _packetLoss: packetLossState,
-      _latency: latencyState,
-      _maxLatency: maxLatencyState,
-      _errors: errorState,
-    };
+    return { avgPacketLoss, avgLatency, maxLatency, errorCount };
   }
 
   async createClient(