@checkstack/healthcheck-grpc-backend 0.1.14 → 0.2.1

package/CHANGELOG.md

@@ -1,5 +1,53 @@
 # @checkstack/healthcheck-grpc-backend
 
+## 0.2.1
+
+### Patch Changes
+
+- 869b4ab: ## Health Check Execution Improvements
+
+  ### Breaking Changes (backend-api)
+
+  - `HealthCheckStrategy.createClient()` now accepts `unknown` instead of `TConfig` due to TypeScript contravariance constraints. Implementations should use `this.config.validate(config)` to narrow the type.
+
+  ### Features
+
+  - **Platform-level hard timeout**: The executor now wraps the entire health check execution (connection + all collectors) in a single timeout, ensuring checks never hang indefinitely.
+  - **Parallel collector execution**: Collectors now run in parallel using `Promise.allSettled()`, improving performance while ensuring all collectors complete regardless of individual failures.
+  - **Base strategy config schema**: All strategy configs now extend `baseStrategyConfigSchema` which provides a standardized `timeout` field with sensible defaults (30s, min 100ms).
+
+  ### Fixes
+
+  - Fixed HTTP and Jenkins strategies clearing timeouts before reading the full response body.
+  - Simplified registry type signatures by using default type parameters.
+
+- Updated dependencies [869b4ab]
+  - @checkstack/backend-api@0.8.0
+
+## 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-grpc-backend",
-  "version": "0.1.14",
+  "version": "0.2.1",
   "type": "module",
   "main": "src/index.ts",
   "scripts": {
@@ -9,9 +9,9 @@
     "lint:code": "eslint . --max-warnings 0"
   },
   "dependencies": {
-    "@checkstack/backend-api": "0.5.2",
-    "@checkstack/common": "0.6.1",
-    "@checkstack/healthcheck-common": "0.8.1",
+    "@checkstack/backend-api": "0.7.0",
+    "@checkstack/common": "0.6.2",
+    "@checkstack/healthcheck-common": "0.8.2",
     "@grpc/grpc-js": "^1.9.0"
   },
   "devDependencies": {

package/src/health-collector.test.ts

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

@@ -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,
@@ -55,31 +55,24 @@ const grpcHealthResultSchema = healthResultSchema({
 
 export type HealthResult = z.infer<typeof grpcHealthResultSchema>;
 
-const healthAggregatedDisplaySchema = 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": "%",
   }),
-});
-
-const healthAggregatedInternalSchema = z.object({
-  _responseTime: averageStateSchema
-    .optional(),
-  _serving: rateStateSchema
-    .optional(),
-});
+};
 
-const healthAggregatedSchema = healthAggregatedDisplaySchema.merge(
-  healthAggregatedInternalSchema,
-);
-
-export type HealthAggregatedResult = z.infer<typeof healthAggregatedSchema>;
+// Type inferred from field definitions
+export type HealthAggregatedResult = InferAggregatedResult<
+  typeof healthAggregatedFields
+>;
 
 // ============================================================================
 // HEALTH COLLECTOR
@@ -105,9 +98,9 @@ export class HealthCollector implements CollectorStrategy<
 
   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({
@@ -144,21 +137,12 @@ export class HealthCollector implements CollectorStrategy<
   ): HealthAggregatedResult {
     const metadata = run.metadata;
 
-    const responseTimeState = mergeAverage(
-      existing?._responseTime as AverageState | undefined,
-      metadata?.responseTimeMs,
-    );
-
-    const servingState = mergeRate(
-      existing?._serving as RateState | undefined,
-      metadata?.serving,
-    );
-
     return {
-      avgResponseTimeMs: responseTimeState.avg,
-      servingRate: servingState.rate,
-      _responseTime: responseTimeState,
-      _serving: servingState,
+      avgResponseTimeMs: mergeAverage(
+        existing?.avgResponseTimeMs,
+        metadata?.responseTimeMs,
+      ),
+      servingRate: mergeRate(existing?.servingRate, metadata?.serving),
     };
   }
 }

package/src/strategy.test.ts

@@ -144,10 +144,10 @@ describe("GrpcHealthCheckStrategy", () => {
       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", () => {
@@ -183,9 +183,9 @@ describe("GrpcHealthCheckStrategy", () => {
       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,17 +3,17 @@ 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,
+  baseStrategyConfigSchema,
 } from "@checkstack/backend-api";
 import {
   healthResultBoolean,
@@ -46,7 +46,7 @@ export type GrpcHealthStatusType = z.infer<typeof GrpcHealthStatus>;
 /**
  * Configuration schema for gRPC health checks.
  */
-export const grpcConfigSchema = z.object({
+export const grpcConfigSchema = baseStrategyConfigSchema.extend({
   host: z.string().describe("gRPC server hostname"),
   port: z.number().int().min(1).max(65_535).describe("gRPC port"),
   service: z
@@ -54,11 +54,6 @@ export const grpcConfigSchema = z.object({
     .default("")
     .describe("Service name to check (empty for server health)"),
   useTls: z.boolean().default(false).describe("Use TLS connection"),
-  timeout: z
-    .number()
-    .min(100)
-    .default(5000)
-    .describe("Request timeout in milliseconds"),
 });
 
 export type GrpcConfig = z.infer<typeof grpcConfigSchema>;
@@ -89,44 +84,29 @@ const grpcResultSchema = healthResultSchema({
 
 type GrpcResult = z.infer<typeof grpcResultSchema>;
 
-/**
- * Aggregated metadata for buckets.
- */
-const grpcAggregatedDisplaySchema = 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",
   }),
-});
-
-const grpcAggregatedInternalSchema = z.object({
-  _responseTime: averageStateSchema
-    .optional(),
-  _success: rateStateSchema
-    .optional(),
-  _errors: counterStateSchema.optional(),
-  _serving: counterStateSchema.optional(),
-});
-
-const grpcAggregatedSchema = grpcAggregatedDisplaySchema.merge(
-  grpcAggregatedInternalSchema,
-);
+};
 
-type GrpcAggregatedResult = z.infer<typeof grpcAggregatedSchema>;
+type GrpcAggregatedResult = InferAggregatedResult<typeof grpcAggregatedFields>;
 
 // ============================================================================
 // GRPC CLIENT INTERFACE (for testability)
@@ -212,7 +192,7 @@ export class GrpcHealthCheckStrategy implements HealthCheckStrategy<
   GrpcConfig,
   GrpcTransportClient,
   GrpcResult,
-  GrpcAggregatedResult
+  typeof grpcAggregatedFields
 > {
   id = "grpc";
   displayName = "gRPC Health Check";
@@ -251,9 +231,9 @@ export class GrpcHealthCheckStrategy implements HealthCheckStrategy<
     ],
   });
 
-  aggregatedResult: Versioned<GrpcAggregatedResult> = new Versioned({
+  aggregatedResult = new VersionedAggregated({
     version: 1,
-    schema: grpcAggregatedSchema,
+    fields: grpcAggregatedFields,
   });
 
   mergeResult(
@@ -262,36 +242,20 @@ export class GrpcHealthCheckStrategy implements HealthCheckStrategy<
   ): GrpcAggregatedResult {
     const metadata = run.metadata;
 
-    const responseTimeState = mergeAverage(
-      existing?._responseTime as AverageState | undefined,
+    const avgResponseTime = mergeAverage(
+      existing?.avgResponseTime,
       metadata?.responseTimeMs,
     );
 
-    const successState = mergeRate(
-      existing?._success as RateState | undefined,
-      metadata?.status === "SERVING",
-    );
+    const isSuccess = metadata?.status === "SERVING";
+    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);
 
-    const servingState = mergeCounter(
-      existing?._serving as CounterState | undefined,
-      metadata?.status === "SERVING",
-    );
+    const servingCount = mergeCounter(existing?.servingCount, isSuccess);
 
-    return {
-      avgResponseTime: responseTimeState.avg,
-      successRate: successState.rate,
-      errorCount: errorState.count,
-      servingCount: servingState.count,
-      _responseTime: responseTimeState,
-      _success: successState,
-      _errors: errorState,
-      _serving: servingState,
-    };
+    return { avgResponseTime, successRate, errorCount, servingCount };
   }
 
   async createClient(