@checkstack/healthcheck-ping-backend 0.1.13 → 0.1.14

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # @checkstack/healthcheck-ping-backend
 
+## 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-ping-backend",
-  "version": "0.1.13",
+  "version": "0.1.14",
   "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/ping-collector.test.ts

@@ -82,7 +82,7 @@ describe("PingCollector", () => {
     });
   });
 
-  describe("aggregateResult", () => {
+  describe("mergeResult", () => {
     it("should calculate average packet loss and latency", () => {
       const collector = new PingCollector();
       const runs = [
@@ -114,7 +114,8 @@ describe("PingCollector", () => {
         },
       ];
 
-      const aggregated = collector.aggregateResult(runs);
+      let aggregated = collector.mergeResult(undefined, runs[0]);
+      aggregated = collector.mergeResult(aggregated, runs[1]);
 
       expect(aggregated.avgPacketLoss).toBe(5);
       expect(aggregated.avgLatency).toBe(15);

package/src/ping-collector.ts

@@ -4,6 +4,9 @@ import {
   type HealthCheckRunForAggregation,
   type CollectorResult,
   type CollectorStrategy,
+  mergeAverage,
+  averageStateSchema,
+  type AverageState,
 } from "@checkstack/backend-api";
 import {
   healthResultNumber,
@@ -71,7 +74,7 @@ const pingResultSchema = healthResultSchema({
 
 export type PingResult = z.infer<typeof pingResultSchema>;
 
-const pingAggregatedSchema = healthResultSchema({
+const pingAggregatedDisplaySchema = healthResultSchema({
   avgPacketLoss: healthResultNumber({
     "x-chart-type": "gauge",
     "x-chart-label": "Avg Packet Loss",
@@ -84,6 +87,15 @@ const pingAggregatedSchema = healthResultSchema({
   }),
 });
 
+const pingAggregatedInternalSchema = z.object({
+  _packetLoss: averageStateSchema.optional(),
+  _latency: averageStateSchema.optional(),
+});
+
+const pingAggregatedSchema = pingAggregatedDisplaySchema.merge(
+  pingAggregatedInternalSchema,
+);
+
 export type PingAggregatedResult = z.infer<typeof pingAggregatedSchema>;
 
 // ============================================================================
@@ -94,15 +106,12 @@ export type PingAggregatedResult = z.infer<typeof pingAggregatedSchema>;
  * Built-in Ping collector.
  * Performs ICMP ping and checks latency.
  */
-export class PingCollector
-  implements
-    CollectorStrategy<
-      PingTransportClient,
-      PingConfig,
-      PingResult,
-      PingAggregatedResult
-    >
-{
+export class PingCollector implements CollectorStrategy<
+  PingTransportClient,
+  PingConfig,
+  PingResult,
+  PingAggregatedResult
+> {
   id = "ping";
   displayName = "ICMP Ping";
   description = "Ping a host and check latency";
@@ -145,30 +154,27 @@ export class PingCollector
     };
   }
 
-  aggregateResult(
-    runs: HealthCheckRunForAggregation<PingResult>[]
+  mergeResult(
+    existing: PingAggregatedResult | undefined,
+    run: HealthCheckRunForAggregation<PingResult>,
   ): PingAggregatedResult {
-    const losses = runs
-      .map((r) => r.metadata?.packetLoss)
-      .filter((v): v is number => typeof v === "number");
+    const metadata = run.metadata;
+
+    const lossState = mergeAverage(
+      existing?._packetLoss as AverageState | undefined,
+      metadata?.packetLoss,
+    );
 
-    const latencies = runs
-      .map((r) => r.metadata?.avgLatency)
-      .filter((v): v is number => typeof v === "number");
+    const latencyState = mergeAverage(
+      existing?._latency as AverageState | undefined,
+      metadata?.avgLatency,
+    );
 
     return {
-      avgPacketLoss:
-        losses.length > 0
-          ? Math.round(
-              (losses.reduce((a, b) => a + b, 0) / losses.length) * 10
-            ) / 10
-          : 0,
-      avgLatency:
-        latencies.length > 0
-          ? Math.round(
-              (latencies.reduce((a, b) => a + b, 0) / latencies.length) * 10
-            ) / 10
-          : 0,
+      avgPacketLoss: Math.round(lossState.avg * 10) / 10,
+      avgLatency: Math.round(latencyState.avg * 10) / 10,
+      _packetLoss: lossState,
+      _latency: latencyState,
     };
   }
 }

package/src/strategy.test.ts

@@ -14,8 +14,8 @@ const mockSpawn = mock(() => ({
 
 --- 8.8.8.8 ping statistics ---
 3 packets transmitted, 3 packets received, 0.0% packet loss
-round-trip min/avg/max/stddev = 10.123/11.456/12.456/0.957 ms`
-        )
+round-trip min/avg/max/stddev = 10.123/11.456/12.456/0.957 ms`,
+        ),
       );
       controller.close();
     },
@@ -83,8 +83,8 @@ describe("PingHealthCheckStrategy", () => {
                 `PING 10.0.0.1 (10.0.0.1): 56 data bytes
 
 --- 10.0.0.1 ping statistics ---
-3 packets transmitted, 0 packets received, 100.0% packet loss`
-              )
+3 packets transmitted, 0 packets received, 100.0% packet loss`,
+              ),
             );
             controller.close();
           },
@@ -139,7 +139,7 @@ describe("PingHealthCheckStrategy", () => {
     });
   });
 
-  describe("aggregateResult", () => {
+  describe("mergeResult", () => {
     it("should calculate averages correctly", () => {
       const runs = [
         {
@@ -172,8 +172,10 @@ describe("PingHealthCheckStrategy", () => {
         },
       ];
 
-      const aggregated = strategy.aggregateResult(runs);
+      let aggregated = strategy.mergeResult(undefined, runs[0]);
+      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);
@@ -181,23 +183,21 @@ describe("PingHealthCheckStrategy", () => {
     });
 
     it("should count errors", () => {
-      const runs = [
-        {
-          id: "1",
-          status: "unhealthy" as const,
-          latencyMs: 0,
-          checkId: "c1",
-          timestamp: new Date(),
-          metadata: {
-            packetsSent: 3,
-            packetsReceived: 0,
-            packetLoss: 100,
-            error: "Timeout",
-          },
+      const run = {
+        id: "1",
+        status: "unhealthy" as const,
+        latencyMs: 0,
+        checkId: "c1",
+        timestamp: new Date(),
+        metadata: {
+          packetsSent: 3,
+          packetsReceived: 0,
+          packetLoss: 100,
+          error: "Timeout",
         },
-      ];
+      };
 
-      const aggregated = strategy.aggregateResult(runs);
+      const aggregated = strategy.mergeResult(undefined, run);
 
       expect(aggregated.errorCount).toBe(1);
     });

package/src/strategy.ts

@@ -4,6 +4,15 @@ import {
   Versioned,
   z,
   type ConnectedClient,
+  mergeAverage,
+  averageStateSchema,
+  mergeCounter,
+  counterStateSchema,
+  mergeMinMax,
+  minMaxStateSchema,
+  type AverageState,
+  type CounterState,
+  type MinMaxState,
 } from "@checkstack/backend-api";
 import {
   healthResultNumber,
@@ -84,7 +93,7 @@ type PingResult = z.infer<typeof pingResultSchema>;
 /**
  * Aggregated metadata for buckets.
  */
-const pingAggregatedSchema = healthResultSchema({
+const pingAggregatedDisplaySchema = healthResultSchema({
   avgPacketLoss: healthResultNumber({
     "x-chart-type": "gauge",
     "x-chart-label": "Avg Packet Loss",
@@ -106,21 +115,29 @@ const pingAggregatedSchema = healthResultSchema({
   }),
 });
 
+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>;
 
 // ============================================================================
 // STRATEGY
 // ============================================================================
 
-export class PingHealthCheckStrategy
-  implements
-    HealthCheckStrategy<
-      PingConfig,
-      PingTransportClient,
-      PingResult,
-      PingAggregatedResult
-    >
-{
+export class PingHealthCheckStrategy implements HealthCheckStrategy<
+  PingConfig,
+  PingTransportClient,
+  PingResult,
+  PingAggregatedResult
+> {
   id = "ping";
   displayName = "Ping Health Check";
   description = "ICMP ping check for network reachability and latency";
@@ -158,52 +175,46 @@ export class PingHealthCheckStrategy
     schema: pingAggregatedSchema,
   });
 
-  aggregateResult(
-    runs: HealthCheckRunForAggregation<PingResult>[]
+  mergeResult(
+    existing: PingAggregatedResult | undefined,
+    run: HealthCheckRunForAggregation<PingResult>,
   ): PingAggregatedResult {
-    const validRuns = runs.filter((r) => r.metadata);
-
-    if (validRuns.length === 0) {
-      return { avgPacketLoss: 0, avgLatency: 0, maxLatency: 0, errorCount: 0 };
-    }
-
-    const packetLosses = validRuns
-      .map((r) => r.metadata?.packetLoss)
-      .filter((l): l is number => typeof l === "number");
-
-    const avgPacketLoss =
-      packetLosses.length > 0
-        ? Math.round(
-            (packetLosses.reduce((a, b) => a + b, 0) / packetLosses.length) * 10
-          ) / 10
-        : 0;
+    const metadata = run.metadata;
 
-    const latencies = validRuns
-      .map((r) => r.metadata?.avgLatency)
-      .filter((l): l is number => typeof l === "number");
-
-    const avgLatency =
-      latencies.length > 0
-        ? Math.round(
-            (latencies.reduce((a, b) => a + b, 0) / latencies.length) * 10
-          ) / 10
-        : 0;
+    const packetLossState = mergeAverage(
+      existing?._packetLoss as AverageState | undefined,
+      metadata?.packetLoss,
+    );
 
-    const maxLatencies = validRuns
-      .map((r) => r.metadata?.maxLatency)
-      .filter((l): l is number => typeof l === "number");
+    const latencyState = mergeAverage(
+      existing?._latency as AverageState | undefined,
+      metadata?.avgLatency,
+    );
 
-    const maxLatency = maxLatencies.length > 0 ? Math.max(...maxLatencies) : 0;
+    const maxLatencyState = mergeMinMax(
+      existing?._maxLatency as MinMaxState | undefined,
+      metadata?.maxLatency,
+    );
 
-    const errorCount = validRuns.filter(
-      (r) => r.metadata?.error !== undefined
-    ).length;
+    const errorState = mergeCounter(
+      existing?._errors as CounterState | undefined,
+      metadata?.error !== undefined,
+    );
 
-    return { avgPacketLoss, avgLatency, maxLatency, errorCount };
+    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,
+    };
   }
 
   async createClient(
-    config: PingConfig
+    config: PingConfig,
   ): Promise<ConnectedClient<PingTransportClient>> {
     const validatedConfig = this.config.validate(config);
 
@@ -212,7 +223,7 @@ export class PingHealthCheckStrategy
         return this.runPing(
           request.host,
           request.count,
-          request.timeout ?? validatedConfig.timeout
+          request.timeout ?? validatedConfig.timeout,
         );
       },
     };
@@ -228,7 +239,7 @@ export class PingHealthCheckStrategy
   private async runPing(
     host: string,
     count: number,
-    timeout: number
+    timeout: number,
   ): Promise<PingResultType> {
     const isMac = process.platform === "darwin";
     const args = isMac
@@ -260,11 +271,11 @@ export class PingHealthCheckStrategy
   private parsePingOutput(
     output: string,
     expectedCount: number,
-    _exitCode: number
+    _exitCode: number,
   ): PingResultType {
     // Parse packet statistics
     const statsMatch = output.match(
-      /(\d+) packets transmitted, (\d+) (?:packets )?received/
+      /(\d+) packets transmitted, (\d+) (?:packets )?received/,
     );
     const packetsSent = statsMatch
       ? Number.parseInt(statsMatch[1], 10)
@@ -279,7 +290,7 @@ export class PingHealthCheckStrategy
     // macOS: round-trip min/avg/max/stddev = 0.043/0.059/0.082/0.016 ms
     // Linux: rtt min/avg/max/mdev = 0.039/0.049/0.064/0.009 ms
     const latencyMatch = output.match(
-      /(?:round-trip|rtt) min\/avg\/max\/(?:stddev|mdev) = ([\d.]+)\/([\d.]+)\/([\d.]+)/
+      /(?:round-trip|rtt) min\/avg\/max\/(?:stddev|mdev) = ([\d.]+)\/([\d.]+)\/([\d.]+)/,
     );
 
     let minLatency: number | undefined;