@checkstack/healthcheck-common 0.11.0 → 0.13.0

package/CHANGELOG.md

@@ -1,5 +1,60 @@
 # @checkstack/healthcheck-common
 
+## 0.13.0
+
+### Minor Changes
+
+- 208ad71: Centralize realtime cache invalidation: signals now carry their owning `pluginId` end-to-end, and a single `SignalAutoInvalidator` mounted near the React Query client invalidates `[[pluginId]]` for every incoming signal automatically.
+
+  **Breaking change to `createSignal`** (`@checkstack/signal-common`): the factory now takes a single object argument with `pluginMetadata`, `event`, and `payloadSchema`. The signal id is constructed as `${pluginMetadata.pluginId}.${event}` and the resulting `Signal` carries a `pluginId` field. The `SignalMessage` wire envelope and `ServerToClientMessage` `signal` variant gained a `pluginId` field so the frontend can route invalidations without parsing the id.
+
+  ```ts
+  // Before
+  export const ANOMALY_STATE_CHANGED = createSignal(
+    "anomaly.state_changed",
+    z.object({ ... }),
+  );
+
+  // After
+  export const ANOMALY_STATE_CHANGED = createSignal({
+    pluginMetadata,
+    event: "state_changed",
+    payloadSchema: z.object({ ... }),
+  });
+  ```
+
+  **New plugin field**: `FrontendPlugin.foreignSignals?: Signal<unknown>[]` lets a plugin opt its `[[pluginId]]` cache into invalidation when another plugin's signal fires (e.g. `dependency-frontend` declares `[SYSTEM_STATUS_CHANGED]` because dependency payloads embed system status). Same-plugin signals must NOT be listed — they are always auto-invalidated.
+
+  **Removed boilerplate**: per-component `useSignal(X, () => refetch())` and `useSignal(X, () => queryClient.invalidateQueries(...))` calls have been removed across `incident-frontend`, `maintenance-frontend`, `healthcheck-frontend`, `slo-frontend`, `dependency-frontend`, `satellite-frontend`, `announcement-frontend`, `notification-frontend`, and `dashboard-frontend`. The `NotificationBell` unread count is now derived directly from the `getUnreadCount` query (auto-invalidated) instead of a local state mirror.
+
+  **User-visible bug fix**: the system detail page anomaly widget (`SystemAnomalyWidget`) now updates in real-time when anomalies change, with no per-widget signal subscription required. The dashboard status page also stays fresh on `ANOMALY_STATE_CHANGED`, `ANOMALY_BASELINE_UPDATED`, and `ANOMALY_TREND_DETECTED`.
+
+  UI-state consumers that legitimately need a `useSignal` (the dashboard activity terminal, the queue lag alert, and the rolling-preset date refresh in `useHealthCheckData`) keep their handlers; the auto-invalidator runs alongside them.
+
+### Patch Changes
+
+- Updated dependencies [208ad71]
+  - @checkstack/signal-common@0.2.0
+
+## 0.12.0
+
+### Minor Changes
+
+- 8d1ef12: ## Downstream consumer bumps for the anomaly detection + cache system rollout
+
+  Packages on this branch were updated as part of the anomaly detection feature (schema annotations on result fields, plugin metadata for the modular cache system) but were not listed in the upstream changesets.
+
+  - **`@checkstack/healthcheck-common`** (minor) — new RPC contract additions and schema changes supporting per-field anomaly metadata.
+  - **`@checkstack/cache-memory-common`** (minor) — new package providing access rules + plugin metadata for the in-memory cache backend.
+  - **healthcheck plugins** (patch) — adopt the new `x-anomaly-*` schema annotations on their result fields so anomaly detection works automatically against their checks. No public API changes.
+  - **integration / notification / auth / queue / collector plugins** (patch) — minor internal updates as consumers of upstream API changes (cache plugin registry, schema additions). No public API changes.
+
+### Patch Changes
+
+- Updated dependencies [8d1ef12]
+  - @checkstack/common@0.7.0
+  - @checkstack/signal-common@0.1.10
+
 ## 0.11.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/healthcheck-common",
-  "version": "0.11.0",
+  "version": "0.13.0",
   "type": "module",
   "exports": {
     ".": {
@@ -8,8 +8,8 @@
     }
   },
   "dependencies": {
-    "@checkstack/common": "0.6.5",
-    "@checkstack/signal-common": "0.1.9",
+    "@checkstack/common": "0.7.0",
+    "@checkstack/signal-common": "0.1.10",
     "zod": "^4.2.1"
   },
   "devDependencies": {

package/src/index.ts

@@ -49,14 +49,16 @@ export { healthcheckRoutes } from "./routes";
 
 import { createSignal } from "@checkstack/signal-common";
 import { z } from "zod";
+import { pluginMetadata } from "./plugin-metadata";
 
 /**
  * Broadcast when a health check run completes.
  * Frontend components listening to this signal can update live activity feeds.
  */
-export const HEALTH_CHECK_RUN_COMPLETED = createSignal(
-  "healthcheck.run.completed",
-  z.object({
+export const HEALTH_CHECK_RUN_COMPLETED = createSignal({
+  pluginMetadata,
+  event: "run.completed",
+  payloadSchema: z.object({
     systemId: z.string(),
     systemName: z.string(),
     configurationId: z.string(),
@@ -64,7 +66,7 @@ export const HEALTH_CHECK_RUN_COMPLETED = createSignal(
     status: z.enum(["healthy", "degraded", "unhealthy"]),
     latencyMs: z.number().optional(),
   }),
-);
+});
 
 /**
  * Broadcast when a system's overall health status transitions.
@@ -72,11 +74,12 @@ export const HEALTH_CHECK_RUN_COMPLETED = createSignal(
  * NOT on every individual health check run. Use this for coarse-grained reactivity
  * like dashboard badges and dependency map node statuses.
  */
-export const SYSTEM_STATUS_CHANGED = createSignal(
-  "healthcheck.system.status-changed",
-  z.object({
+export const SYSTEM_STATUS_CHANGED = createSignal({
+  pluginMetadata,
+  event: "system.status_changed",
+  payloadSchema: z.object({
     systemId: z.string(),
     previousStatus: z.enum(["healthy", "degraded", "unhealthy"]),
     newStatus: z.enum(["healthy", "degraded", "unhealthy"]),
   }),
-);
+});

package/src/rpc-contract.ts

@@ -443,6 +443,31 @@ export const healthCheckContract = {
       }),
     )
     .output(z.void()),
+
+  getRunsForAnalysis: proc({
+    operationType: "query",
+    userType: "service",
+    access: [],
+  })
+    .input(
+      z.object({
+        startDate: z.date(),
+        limitPerAssignment: z.number().optional().default(200),
+      }),
+    )
+    .output(
+      z.array(
+        z.object({
+          systemId: z.string(),
+          configurationId: z.string(),
+          runs: z.array(
+            z.object({
+              result: z.record(z.string(), z.unknown()).nullable().optional(),
+            }),
+          ),
+        }),
+      ),
+    ),
 };
 // Export contract type
 export type HealthCheckContract = typeof healthCheckContract;

package/src/zod-health-result.test.ts

@@ -12,7 +12,7 @@ import {
 describe("stripEphemeralFields", () => {
   it("should strip fields marked with x-ephemeral", () => {
     const schema = healthResultSchema({
-      statusCode: healthResultNumber({ "x-chart-type": "counter" }),
+      statusCode: healthResultNumber({ "x-chart-type": "counter", "x-anomaly-enabled": false }),
       body: healthResultJSONPath({ "x-ephemeral": true }), // Explicitly marked ephemeral
     });
 
@@ -29,8 +29,8 @@ describe("stripEphemeralFields", () => {
 
   it("should preserve non-ephemeral fields", () => {
     const schema = healthResultSchema({
-      responseTimeMs: healthResultNumber({ "x-chart-type": "line" }),
-      statusText: healthResultString({ "x-chart-type": "text" }),
+      responseTimeMs: healthResultNumber({ "x-chart-type": "line", "x-anomaly-enabled": false }),
+      statusText: healthResultString({ "x-chart-type": "text", "x-anomaly-enabled": false }),
     });
 
     const result = {
@@ -45,7 +45,7 @@ describe("stripEphemeralFields", () => {
 
   it("should preserve unknown fields like _collectorId", () => {
     const schema = healthResultSchema({
-      value: healthResultNumber({ "x-chart-type": "counter" }),
+      value: healthResultNumber({ "x-chart-type": "counter", "x-anomaly-enabled": false }),
       body: healthResultJSONPath({ "x-ephemeral": true }),
     });
 

package/src/zod-health-result.ts

@@ -96,7 +96,8 @@ export function healthResultSchema<T extends HealthResultShape>(
 // ============================================================================
 
 /** Chart metadata (excludes x-jsonpath, use healthResultJSONPath for that) */
-type ChartMeta = Omit<HealthResultMeta, "x-jsonpath">;
+type DistributiveOmit<T, K extends PropertyKey> = T extends unknown ? Omit<T, K> : never;
+type ChartMeta = DistributiveOmit<HealthResultMeta, "x-jsonpath">;
 
 /**
  * Create a health result string field with typed chart metadata.
@@ -114,7 +115,8 @@ export function healthResultString(
   meta: ChartMeta,
 ): HealthResultField<z.ZodString> {
   const schema = z.string();
-  schema.register(healthResultRegistry, meta);
+  const finalMeta = (meta["x-ephemeral"] ? { ...meta, "x-anomaly-enabled": false as const } : meta) as HealthResultMeta;
+  schema.register(healthResultRegistry, finalMeta);
   return schema as HealthResultField<z.ZodString>;
 }
 
@@ -125,7 +127,8 @@ export function healthResultNumber(
   meta: ChartMeta,
 ): HealthResultField<z.ZodNumber> {
   const schema = z.number();
-  schema.register(healthResultRegistry, meta);
+  const finalMeta = (meta["x-ephemeral"] ? { ...meta, "x-anomaly-enabled": false as const } : meta) as HealthResultMeta;
+  schema.register(healthResultRegistry, finalMeta);
   return schema as HealthResultField<z.ZodNumber>;
 }
 
@@ -136,7 +139,8 @@ export function healthResultBoolean(
   meta: ChartMeta,
 ): HealthResultField<z.ZodBoolean> {
   const schema = z.boolean();
-  schema.register(healthResultRegistry, meta);
+  const finalMeta = (meta["x-ephemeral"] ? { ...meta, "x-anomaly-enabled": false as const } : meta) as HealthResultMeta;
+  schema.register(healthResultRegistry, finalMeta);
   return schema as HealthResultField<z.ZodBoolean>;
 }
 
@@ -155,7 +159,8 @@ export function healthResultArray(
   meta: ChartMeta,
 ): HealthResultField<z.ZodArray<z.ZodString>> {
   const schema = z.array(z.string());
-  schema.register(healthResultRegistry, meta);
+  const finalMeta = (meta["x-ephemeral"] ? { ...meta, "x-anomaly-enabled": false as const } : meta) as HealthResultMeta;
+  schema.register(healthResultRegistry, finalMeta);
   return schema as HealthResultField<z.ZodArray<z.ZodString>>;
 }
 
@@ -176,7 +181,11 @@ export function healthResultJSONPath(
   meta: ChartMeta,
 ): HealthResultField<z.ZodString> {
   const schema = z.string();
-  schema.register(healthResultRegistry, { ...meta, "x-jsonpath": true });
+  schema.register(healthResultRegistry, { 
+    ...meta, 
+    "x-jsonpath": true,
+    "x-anomaly-enabled": false as const // Always disable anomaly detection for raw body payloads
+  } as HealthResultMeta);
   return schema as HealthResultField<z.ZodString>;
 }