@checkstack/healthcheck-tcp-backend 0.1.14 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @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

package/package.json

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

package/src/banner-collector.test.ts

@@ -90,8 +90,8 @@ describe("BannerCollector", () => {
       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

@@ -5,11 +5,11 @@ import {
   type CollectorResult,
   type CollectorStrategy,
   mergeAverage,
-  averageStateSchema,
   mergeRate,
-  rateStateSchema,
-  type AverageState,
-  type RateState,
+  VersionedAggregated,
+  aggregatedAverage,
+  aggregatedRate,
+  type InferAggregatedResult,
 } from "@checkstack/backend-api";
 import {
   healthResultNumber,
@@ -56,31 +56,24 @@ const bannerResultSchema = healthResultSchema({
 
 export type BannerResult = z.infer<typeof bannerResultSchema>;
 
-const bannerAggregatedDisplaySchema = 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": "%",
   }),
-});
-
-const bannerAggregatedInternalSchema = z.object({
-  _readTime: averageStateSchema
-    .optional(),
-  _banner: rateStateSchema
-    .optional(),
-});
+};
 
-const bannerAggregatedSchema = bannerAggregatedDisplaySchema.merge(
-  bannerAggregatedInternalSchema,
-);
-
-export type BannerAggregatedResult = z.infer<typeof bannerAggregatedSchema>;
+// Type inferred from field definitions
+export type BannerAggregatedResult = InferAggregatedResult<
+  typeof bannerAggregatedFields
+>;
 
 // ============================================================================
 // BANNER COLLECTOR
@@ -106,9 +99,9 @@ export class BannerCollector implements CollectorStrategy<
 
   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({
@@ -143,21 +136,12 @@ export class BannerCollector implements CollectorStrategy<
   ): BannerAggregatedResult {
     const metadata = run.metadata;
 
-    const readTimeState = mergeAverage(
-      existing?._readTime as AverageState | undefined,
-      metadata?.readTimeMs,
-    );
-
-    const bannerState = mergeRate(
-      existing?._banner as RateState | undefined,
-      metadata?.hasBanner,
-    );
-
     return {
-      avgReadTimeMs: readTimeState.avg,
-      bannerRate: bannerState.rate,
-      _readTime: readTimeState,
-      _banner: bannerState,
+      avgReadTimeMs: mergeAverage(
+        existing?.avgReadTimeMs,
+        metadata?.readTimeMs,
+      ),
+      bannerRate: mergeRate(existing?.bannerRate, metadata?.hasBanner),
     };
   }
 }

package/src/strategy.test.ts

@@ -121,9 +121,9 @@ describe("TcpHealthCheckStrategy", () => {
       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", () => {
@@ -157,8 +157,8 @@ describe("TcpHealthCheckStrategy", () => {
       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,17 +2,16 @@ import {
   HealthCheckStrategy,
   HealthCheckRunForAggregation,
   Versioned,
-  z,
-  type ConnectedClient,
+  VersionedAggregated,
+  aggregatedAverage,
+  aggregatedRate,
+  aggregatedCounter,
   mergeAverage,
-  averageStateSchema,
   mergeRate,
-  rateStateSchema,
   mergeCounter,
-  counterStateSchema,
-  type AverageState,
-  type RateState,
-  type CounterState,
+  z,
+  type ConnectedClient,
+  type InferAggregatedResult,
 } from "@checkstack/backend-api";
 import {
   healthResultBoolean,
@@ -79,41 +78,25 @@ const tcpResultSchema = healthResultSchema({
 
 type TcpResult = z.infer<typeof tcpResultSchema>;
 
-/**
- * Aggregated metadata for buckets.
- */
-// UI-visible aggregated fields
-const tcpAggregatedDisplaySchema = 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",
   }),
-});
-
-// 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>;
+type TcpAggregatedResult = InferAggregatedResult<typeof tcpAggregatedFields>;
 
 // ============================================================================
 // SOCKET INTERFACE (for testability)
@@ -186,7 +169,7 @@ export class TcpHealthCheckStrategy implements HealthCheckStrategy<
   TcpConfig,
   TcpTransportClient,
   TcpResult,
-  TcpAggregatedResult
+  typeof tcpAggregatedFields
 > {
   id = "tcp";
   displayName = "TCP Health Check";
@@ -228,9 +211,9 @@ export class TcpHealthCheckStrategy implements HealthCheckStrategy<
     ],
   });
 
-  aggregatedResult: Versioned<TcpAggregatedResult> = new Versioned({
+  aggregatedResult = new VersionedAggregated({
     version: 1,
-    schema: tcpAggregatedSchema,
+    fields: tcpAggregatedFields,
   });
 
   mergeResult(
@@ -239,29 +222,18 @@ export class TcpHealthCheckStrategy implements HealthCheckStrategy<
   ): TcpAggregatedResult {
     const metadata = run.metadata;
 
-    const connectionTimeState = mergeAverage(
-      existing?._connectionTime as AverageState | undefined,
+    const avgConnectionTime = mergeAverage(
+      existing?.avgConnectionTime,
       metadata?.connectionTimeMs,
     );
 
-    const successState = mergeRate(
-      existing?._success as RateState | undefined,
-      metadata?.connected,
-    );
+    const isSuccess = metadata?.connected ?? false;
+    const successRate = mergeRate(existing?.successRate, isSuccess);
 
-    const errorState = mergeCounter(
-      existing?._errors as CounterState | undefined,
-      metadata?.error !== undefined,
-    );
+    const hasError = metadata?.error !== undefined;
+    const errorCount = mergeCounter(existing?.errorCount, hasError);
 
-    return {
-      avgConnectionTime: connectionTimeState.avg,
-      successRate: successState.rate,
-      errorCount: errorState.count,
-      _connectionTime: connectionTimeState,
-      _success: successState,
-      _errors: errorState,
-    };
+    return { avgConnectionTime, successRate, errorCount };
   }
 
   async createClient(