@checkstack/healthcheck-tls-backend 0.1.13 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,59 @@
 # @checkstack/healthcheck-tls-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-tls-backend",
-  "version": "0.1.13",
+  "version": "0.2.0",
   "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/certificate-collector.test.ts

@@ -76,7 +76,7 @@ describe("CertificateCollector", () => {
     });
   });
 
-  describe("aggregateResult", () => {
+  describe("mergeResult", () => {
     it("should calculate average days remaining", () => {
       const collector = new CertificateCollector();
       const runs = [
@@ -112,10 +112,11 @@ describe("CertificateCollector", () => {
         },
       ];
 
-      const aggregated = collector.aggregateResult(runs);
+      let aggregated = collector.mergeResult(undefined, runs[0]);
+      aggregated = collector.mergeResult(aggregated, runs[1]);
 
-      expect(aggregated.avgDaysRemaining).toBe(45);
-      expect(aggregated.validRate).toBe(100);
+      expect(aggregated.avgDaysRemaining.avg).toBe(45);
+      expect(aggregated.validRate.rate).toBe(100);
     });
 
     it("should calculate valid rate correctly", () => {
@@ -153,9 +154,10 @@ describe("CertificateCollector", () => {
         },
       ];
 
-      const aggregated = collector.aggregateResult(runs);
+      let aggregated = collector.mergeResult(undefined, runs[0]);
+      aggregated = collector.mergeResult(aggregated, runs[1]);
 
-      expect(aggregated.validRate).toBe(50);
+      expect(aggregated.validRate.rate).toBe(50);
     });
   });
 

package/src/certificate-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,
@@ -58,21 +64,23 @@ const certificateResultSchema = healthResultSchema({
 
 export type CertificateResult = z.infer<typeof certificateResultSchema>;
 
-const certificateAggregatedSchema = healthResultSchema({
-  avgDaysRemaining: healthResultNumber({
+// Aggregated result fields definition
+const certificateAggregatedFields = {
+  avgDaysRemaining: aggregatedAverage({
     "x-chart-type": "gauge",
     "x-chart-label": "Avg Days Remaining",
     "x-chart-unit": "days",
   }),
-  validRate: healthResultNumber({
+  validRate: aggregatedRate({
     "x-chart-type": "gauge",
     "x-chart-label": "Valid Rate",
     "x-chart-unit": "%",
   }),
-});
+};
 
-export type CertificateAggregatedResult = z.infer<
-  typeof certificateAggregatedSchema
+// Type inferred from field definitions
+export type CertificateAggregatedResult = InferAggregatedResult<
+  typeof certificateAggregatedFields
 >;
 
 // ============================================================================
@@ -83,15 +91,12 @@ export type CertificateAggregatedResult = z.infer<
  * Built-in TLS certificate collector.
  * Returns certificate information from the TLS connection.
  */
-export class CertificateCollector
-  implements
-    CollectorStrategy<
-      TlsTransportClient,
-      CertificateConfig,
-      CertificateResult,
-      CertificateAggregatedResult
-    >
-{
+export class CertificateCollector implements CollectorStrategy<
+  TlsTransportClient,
+  CertificateConfig,
+  CertificateResult,
+  CertificateAggregatedResult
+> {
   id = "certificate";
   displayName = "TLS Certificate";
   description = "Check TLS certificate validity and expiration";
@@ -102,9 +107,9 @@ export class CertificateCollector
 
   config = new Versioned({ version: 1, schema: certificateConfigSchema });
   result = new Versioned({ version: 1, schema: certificateResultSchema });
-  aggregatedResult = new Versioned({
+  aggregatedResult = new VersionedAggregated({
     version: 1,
-    schema: certificateAggregatedSchema,
+    fields: certificateAggregatedFields,
   });
 
   async execute({
@@ -142,30 +147,18 @@ export class CertificateCollector
     };
   }
 
-  aggregateResult(
-    runs: HealthCheckRunForAggregation<CertificateResult>[]
+  mergeResult(
+    existing: CertificateAggregatedResult | undefined,
+    run: HealthCheckRunForAggregation<CertificateResult>,
   ): CertificateAggregatedResult {
-    const daysRemaining = runs
-      .map((r) => r.metadata?.daysRemaining)
-      .filter((v): v is number => typeof v === "number");
-
-    const validResults = runs
-      .map((r) => r.metadata?.valid)
-      .filter((v): v is boolean => typeof v === "boolean");
-
-    const validCount = validResults.filter(Boolean).length;
+    const metadata = run.metadata;
 
     return {
-      avgDaysRemaining:
-        daysRemaining.length > 0
-          ? Math.round(
-              daysRemaining.reduce((a, b) => a + b, 0) / daysRemaining.length
-            )
-          : 0,
-      validRate:
-        validResults.length > 0
-          ? Math.round((validCount / validResults.length) * 100)
-          : 0,
+      avgDaysRemaining: mergeAverage(
+        existing?.avgDaysRemaining,
+        metadata?.daysRemaining,
+      ),
+      validRate: mergeRate(existing?.validRate, metadata?.valid),
     };
   }
 }

package/src/strategy.test.ts

@@ -164,7 +164,7 @@ describe("TlsHealthCheckStrategy", () => {
     });
   });
 
-  describe("aggregateResult", () => {
+  describe("mergeResult", () => {
     it("should calculate averages correctly", () => {
       const strategy = new TlsHealthCheckStrategy();
       const runs = [
@@ -204,12 +204,13 @@ describe("TlsHealthCheckStrategy", () => {
         },
       ];
 
-      const aggregated = strategy.aggregateResult(runs);
+      let aggregated = strategy.mergeResult(undefined, runs[0]);
+      aggregated = strategy.mergeResult(aggregated, runs[1]);
 
-      expect(aggregated.avgDaysUntilExpiry).toBe(25);
-      expect(aggregated.minDaysUntilExpiry).toBe(20);
-      expect(aggregated.invalidCount).toBe(0);
-      expect(aggregated.errorCount).toBe(0);
+      expect(aggregated.avgDaysUntilExpiry.avg).toBe(25);
+      expect(aggregated.minDaysUntilExpiry.min).toBe(20);
+      expect(aggregated.invalidCount.count).toBe(0);
+      expect(aggregated.errorCount.count).toBe(0);
     });
 
     it("should count invalid and errors", () => {
@@ -252,10 +253,11 @@ describe("TlsHealthCheckStrategy", () => {
         },
       ];
 
-      const aggregated = strategy.aggregateResult(runs);
+      let aggregated = strategy.mergeResult(undefined, runs[0]);
+      aggregated = strategy.mergeResult(aggregated, runs[1]);
 
-      expect(aggregated.invalidCount).toBe(2);
-      expect(aggregated.errorCount).toBe(1);
+      expect(aggregated.invalidCount.count).toBe(2);
+      expect(aggregated.errorCount.count).toBe(1);
     });
   });
 });

package/src/strategy.ts

@@ -3,8 +3,16 @@ import {
   HealthCheckStrategy,
   HealthCheckRunForAggregation,
   Versioned,
+  VersionedAggregated,
+  aggregatedAverage,
+  aggregatedMinMax,
+  aggregatedCounter,
+  mergeAverage,
+  mergeCounter,
+  mergeMinMax,
   z,
   type ConnectedClient,
+  type InferAggregatedResult,
 } from "@checkstack/backend-api";
 import {
   healthResultBoolean,
@@ -80,31 +88,29 @@ const tlsResultSchema = healthResultSchema({
 
 type TlsResult = z.infer<typeof tlsResultSchema>;
 
-/**
- * Aggregated metadata for buckets.
- */
-const tlsAggregatedSchema = healthResultSchema({
-  avgDaysUntilExpiry: healthResultNumber({
+/** Aggregated field definitions for bucket merging */
+const tlsAggregatedFields = {
+  avgDaysUntilExpiry: aggregatedAverage({
     "x-chart-type": "line",
     "x-chart-label": "Avg Days Until Expiry",
     "x-chart-unit": "days",
   }),
-  minDaysUntilExpiry: healthResultNumber({
+  minDaysUntilExpiry: aggregatedMinMax({
     "x-chart-type": "line",
     "x-chart-label": "Min Days Until Expiry",
     "x-chart-unit": "days",
   }),
-  invalidCount: healthResultNumber({
+  invalidCount: aggregatedCounter({
     "x-chart-type": "counter",
     "x-chart-label": "Invalid Certificates",
   }),
-  errorCount: healthResultNumber({
+  errorCount: aggregatedCounter({
     "x-chart-type": "counter",
     "x-chart-label": "Errors",
   }),
-});
+};
 
-type TlsAggregatedResult = z.infer<typeof tlsAggregatedSchema>;
+type TlsAggregatedResult = InferAggregatedResult<typeof tlsAggregatedFields>;
 
 // ============================================================================
 // TLS CLIENT INTERFACE (for testability)
@@ -156,7 +162,7 @@ const defaultTlsClient: TlsClient = {
             getCipher: () => socket.getCipher(),
             end: () => socket.end(),
           });
-        }
+        },
       );
 
       socket.on("error", reject);
@@ -172,15 +178,12 @@ const defaultTlsClient: TlsClient = {
 // STRATEGY
 // ============================================================================
 
-export class TlsHealthCheckStrategy
-  implements
-    HealthCheckStrategy<
-      TlsConfig,
-      TlsTransportClient,
-      TlsResult,
-      TlsAggregatedResult
-    >
-{
+export class TlsHealthCheckStrategy implements HealthCheckStrategy<
+  TlsConfig,
+  TlsTransportClient,
+  TlsResult,
+  typeof tlsAggregatedFields
+> {
   id = "tls";
   displayName = "TLS/SSL Health Check";
   description = "SSL/TLS certificate validation and expiry monitoring";
@@ -217,55 +220,38 @@ export class TlsHealthCheckStrategy
     ],
   });
 
-  aggregatedResult: Versioned<TlsAggregatedResult> = new Versioned({
+  aggregatedResult = new VersionedAggregated({
     version: 1,
-    schema: tlsAggregatedSchema,
+    fields: tlsAggregatedFields,
   });
 
-  aggregateResult(
-    runs: HealthCheckRunForAggregation<TlsResult>[]
+  mergeResult(
+    existing: TlsAggregatedResult | undefined,
+    run: HealthCheckRunForAggregation<TlsResult>,
   ): TlsAggregatedResult {
-    const validRuns = runs.filter((r) => r.metadata);
+    const metadata = run.metadata;
 
-    if (validRuns.length === 0) {
-      return {
-        avgDaysUntilExpiry: 0,
-        minDaysUntilExpiry: 0,
-        invalidCount: 0,
-        errorCount: 0,
-      };
-    }
-
-    const daysValues = validRuns
-      .map((r) => r.metadata?.daysUntilExpiry)
-      .filter((d): d is number => typeof d === "number");
-
-    const avgDaysUntilExpiry =
-      daysValues.length > 0
-        ? Math.round(daysValues.reduce((a, b) => a + b, 0) / daysValues.length)
-        : 0;
+    const avgDaysUntilExpiry = mergeAverage(
+      existing?.avgDaysUntilExpiry,
+      metadata?.daysUntilExpiry,
+    );
 
-    const minDaysUntilExpiry =
-      daysValues.length > 0 ? Math.min(...daysValues) : 0;
+    const minDaysUntilExpiry = mergeMinMax(
+      existing?.minDaysUntilExpiry,
+      metadata?.daysUntilExpiry,
+    );
 
-    const invalidCount = validRuns.filter(
-      (r) => r.metadata?.isValid === false
-    ).length;
+    const isInvalid = metadata?.isValid === false;
+    const invalidCount = mergeCounter(existing?.invalidCount, isInvalid);
 
-    const errorCount = validRuns.filter(
-      (r) => r.metadata?.error !== undefined
-    ).length;
+    const hasError = metadata?.error !== undefined;
+    const errorCount = mergeCounter(existing?.errorCount, hasError);
 
-    return {
-      avgDaysUntilExpiry,
-      minDaysUntilExpiry,
-      invalidCount,
-      errorCount,
-    };
+    return { avgDaysUntilExpiry, minDaysUntilExpiry, invalidCount, errorCount };
   }
 
   async createClient(
-    config: TlsConfig
+    config: TlsConfig,
   ): Promise<ConnectedClient<TlsTransportClient>> {
     const validatedConfig = this.config.validate(config);
 
@@ -280,7 +266,7 @@ export class TlsHealthCheckStrategy
     const cert = connection.getPeerCertificate();
     const validTo = new Date(cert.valid_to);
     const daysUntilExpiry = Math.floor(
-      (validTo.getTime() - Date.now()) / (1000 * 60 * 60 * 24)
+      (validTo.getTime() - Date.now()) / (1000 * 60 * 60 * 24),
     );
 
     const certInfo: TlsCertificateInfo = {