@checkstack/healthcheck-backend 1.13.1 → 1.15.0

package/src/collector-assertions.ts

@@ -0,0 +1,169 @@
+import {
+  evaluateAssertions,
+  evaluateJsonPathAssertions,
+} from "@checkstack/backend-api";
+import type { CollectorAssertion } from "@checkstack/healthcheck-common";
+import { extractErrorMessage } from "@checkstack/common";
+import { JSONPath } from "jsonpath-plus";
+
+/**
+ * Suffix the AssertionBuilder appends to a JSONPath field's path: an
+ * `x-jsonpath` result field `body` is offered as the assertable field
+ * `body.$`, with the actual expression stored in `assertion.jsonPath`.
+ */
+const JSONPATH_FIELD_SUFFIX = ".$";
+
+/** Whether an assertion targets a JSONPath into a field, not the field itself. */
+function isJsonPathAssertion(assertion: CollectorAssertion): boolean {
+  return (
+    assertion.field.endsWith(JSONPATH_FIELD_SUFFIX) ||
+    (typeof assertion.jsonPath === "string" && assertion.jsonPath.trim() !== "")
+  );
+}
+
+/**
+ * Extract a JSONPath from a parsed JSON value. `wrap: false` returns the
+ * single matched value directly (or `undefined` for no match), so `exists` /
+ * `isEmpty` operate on the value itself, not on a match array. `eval: false`
+ * rejects script/filter expressions outright - assertion paths are authored
+ * by users and must never evaluate code on the core.
+ */
+/**
+ * Narrow an `unknown` to the input type `JSONPath` accepts. Parsed JSON is
+ * always one of these by construction; the guard exists because the shared
+ * `evaluateJsonPathAssertions` signature hands the json through as `unknown`.
+ */
+function isJsonPathInput(
+  value: unknown,
+): value is string | number | boolean | object | null {
+  return (
+    value === null ||
+    typeof value === "string" ||
+    typeof value === "number" ||
+    typeof value === "boolean" ||
+    typeof value === "object"
+  );
+}
+
+function extractJsonPath(path: string, json: unknown): unknown {
+  if (!isJsonPathInput(json)) return undefined;
+  return JSONPath({ path, json, wrap: false, eval: false });
+}
+
+/** Human-readable failure string, stored on the run as `_assertionFailed`. */
+function formatFailure({
+  assertion,
+  detail,
+}: {
+  assertion: CollectorAssertion;
+  detail?: string;
+}): string {
+  const path = assertion.jsonPath?.trim();
+  const parts = [
+    assertion.field,
+    ...(isJsonPathAssertion(assertion) && path ? [path] : []),
+    assertion.operator,
+    ...(assertion.value === undefined ? [] : [String(assertion.value)]),
+  ];
+  const base = parts.join(" ");
+  return detail ? `${base} (${detail})` : base;
+}
+
+/**
+ * Evaluate a collector's assertions - plain field assertions AND JSONPath
+ * assertions - against its result, in the order they were configured.
+ *
+ * Plain assertions compare `result[field]` directly (unchanged behaviour).
+ * JSONPath assertions parse the SOURCE field (e.g. `body` for the field
+ * `body.$`) as JSON when it is a string, extract `assertion.jsonPath`, and
+ * apply the operator to the extracted value. Fail-closed: a missing
+ * expression, a non-JSON source value, or an invalid/eval-blocked path fails
+ * the assertion (with a diagnostic suffix) - it never fails the collector.
+ *
+ * Returns the failure message of the FIRST failing assertion, or `undefined`
+ * when all pass.
+ */
+export function evaluateCollectorAssertions({
+  assertions,
+  result,
+}: {
+  assertions: CollectorAssertion[] | undefined;
+  result: Record<string, unknown>;
+}): string | undefined {
+  if (!assertions?.length) return undefined;
+
+  // Parse each JSON source field at most once, not once per assertion.
+  const parsedSources = new Map<string, { json?: unknown; error?: string }>();
+  const parseSource = (sourceField: string) => {
+    const cached = parsedSources.get(sourceField);
+    if (cached) return cached;
+
+    const raw = result[sourceField];
+    let entry: { json?: unknown; error?: string };
+    if (raw === undefined || raw === null) {
+      entry = { error: `field "${sourceField}" has no value` };
+    } else if (typeof raw === "string") {
+      try {
+        entry = { json: JSON.parse(raw) };
+      } catch {
+        entry = { error: `field "${sourceField}" is not valid JSON` };
+      }
+    } else {
+      // Already-structured value (object/array/number) - use as-is.
+      entry = { json: raw };
+    }
+    parsedSources.set(sourceField, entry);
+    return entry;
+  };
+
+  for (const assertion of assertions) {
+    if (!isJsonPathAssertion(assertion)) {
+      const failed = evaluateAssertions([assertion], result);
+      if (failed) return formatFailure({ assertion: failed });
+      continue;
+    }
+
+    const path = assertion.jsonPath?.trim();
+    if (!path) {
+      return formatFailure({
+        assertion,
+        detail: "missing JSONPath expression",
+      });
+    }
+
+    const sourceField = assertion.field.endsWith(JSONPATH_FIELD_SUFFIX)
+      ? assertion.field.slice(0, -JSONPATH_FIELD_SUFFIX.length)
+      : assertion.field;
+    const source = parseSource(sourceField);
+    if (source.error) {
+      return formatFailure({ assertion, detail: source.error });
+    }
+
+    try {
+      const failed = evaluateJsonPathAssertions(
+        [
+          {
+            path,
+            operator: assertion.operator,
+            value:
+              assertion.value === undefined
+                ? undefined
+                : String(assertion.value),
+          },
+        ],
+        source.json,
+        extractJsonPath,
+      );
+      if (failed) return formatFailure({ assertion });
+    } catch (error) {
+      // jsonpath-plus rejects malformed paths and (with eval disabled)
+      // filter/script expressions by throwing.
+      return formatFailure({
+        assertion,
+        detail: `invalid JSONPath: ${extractErrorMessage(error)}`,
+      });
+    }
+  }
+
+  return undefined;
+}

package/src/config-secrets-backfill.test.ts

@@ -0,0 +1,142 @@
+import { describe, it, expect, mock } from "bun:test";
+import { z } from "zod";
+import { configSecret, Versioned } from "@checkstack/backend-api";
+import type { InternalSecretsService } from "@checkstack/secrets-backend";
+import { internalSecretName } from "@checkstack/secrets-common";
+import { backfillConfigSecrets } from "./config-secrets-backfill";
+import {
+  healthcheckConfigLockKey,
+  isHealthcheckSecretMarker,
+} from "./config-secrets";
+
+const collectorSchema = z.object({
+  url: z.string(),
+  password: configSecret({ id: "password" }).optional(),
+});
+
+function fakeInternalSecrets(): InternalSecretsService & {
+  store: Map<string, string>;
+} {
+  const store = new Map<string, string>();
+  return {
+    store,
+    async set({ parts, value }) {
+      store.set(internalSecretName(...parts), value);
+    },
+    async get({ parts }) {
+      return store.get(internalSecretName(...parts));
+    },
+    async delete({ parts }) {
+      store.delete(internalSecretName(...parts));
+    },
+  };
+}
+
+const noopLogger = {
+  debug: mock(() => {}),
+  info: mock(() => {}),
+  warn: mock(() => {}),
+  error: mock(() => {}),
+} as never;
+
+describe("backfillConfigSecrets", () => {
+  it("migrates a registered collector's inline secret even under an UNREGISTERED strategy, per config lock", async () => {
+    // One legacy row: strategy plugin is gone, but the collector plugin is
+    // present and its config carries an inline plaintext secret.
+    let row: Record<string, unknown> = {
+      id: "cfg-bf",
+      strategyId: "gone.strategy",
+      config: { url: "https://x", password: "strategy-plain" }, // no schema -> left as-is
+      collectors: [
+        {
+          id: "c1",
+          collectorId: "reg.collector",
+          config: { url: "https://y", password: "collector-plain" },
+        },
+      ],
+    };
+    const updates: Record<string, unknown>[] = [];
+    const db = {
+      // Initial scan: `db.select().from(table)` awaited directly.
+      // Per-row re-read: `db.select().from(table).where(eq(...))`.
+      select: () => ({
+        from: () =>
+          Object.assign(Promise.resolve([row]), {
+            where: () => Promise.resolve([row]),
+          }),
+      }),
+      update: () => ({
+        set: (set: Record<string, unknown>) => {
+          updates.push(set);
+          row = { ...row, ...set };
+          return { where: () => Promise.resolve(undefined) };
+        },
+      }),
+    };
+
+    const registry = { getStrategy: mock(() => undefined) };
+    const collectorRegistry = {
+      getCollector: mock((id: string) =>
+        id === "reg.collector"
+          ? { collector: { config: new Versioned({ version: 1, schema: collectorSchema }) } }
+          : undefined,
+      ),
+    };
+
+    const lockKeys: string[] = [];
+    const advisoryLock = {
+      tryAcquire: mock(async () => ({ release: mock(async () => {}) })),
+      withXactLock: async ({ key, fn }: { key: string; fn: () => Promise<unknown> }) => {
+        lockKeys.push(key);
+        return fn();
+      },
+    };
+
+    const internalSecrets = fakeInternalSecrets();
+
+    await backfillConfigSecrets({
+      db: db as never,
+      registry: registry as never,
+      collectorRegistry: collectorRegistry as never,
+      internalSecrets,
+      advisoryLock: advisoryLock as never,
+      logger: noopLogger,
+    });
+
+    // Per-config lock was taken for the row.
+    expect(lockKeys).toEqual([healthcheckConfigLockKey("cfg-bf")]);
+
+    // The collector's inline secret was migrated to a marker + the store.
+    const persistedCollectors = updates.at(-1)?.collectors as Array<{
+      config: Record<string, unknown>;
+    }>;
+    expect(
+      isHealthcheckSecretMarker(persistedCollectors[0].config.password as string),
+    ).toBe(true);
+    expect([...internalSecrets.store.values()]).toContain("collector-plain");
+
+    // The strategy config (no schema to walk) is left untouched - never wiped,
+    // and its legacy plaintext is NOT migrated (nothing else we can do).
+    const persistedConfig = updates.at(-1)?.config as Record<string, unknown>;
+    expect(persistedConfig.password).toBe("strategy-plain");
+    expect([...internalSecrets.store.values()]).not.toContain("strategy-plain");
+  });
+
+  it("skips the scan entirely when another pod holds the backfill lock", async () => {
+    const advisoryLock = {
+      tryAcquire: mock(async () => undefined), // lock not acquired
+      withXactLock: mock(async () => {
+        throw new Error("must not run when the global lock is unavailable");
+      }),
+    };
+    await backfillConfigSecrets({
+      db: {} as never,
+      registry: {} as never,
+      collectorRegistry: {} as never,
+      internalSecrets: fakeInternalSecrets(),
+      advisoryLock: advisoryLock as never,
+      logger: noopLogger,
+    });
+    expect(advisoryLock.withXactLock).not.toHaveBeenCalled();
+  });
+});

package/src/config-secrets-backfill.ts

@@ -0,0 +1,129 @@
+import { eq } from "drizzle-orm";
+import type {
+  AdvisoryLockService,
+  HealthCheckRegistry,
+  CollectorRegistry,
+  Logger,
+  SafeDatabase,
+} from "@checkstack/backend-api";
+import type { InternalSecretsService } from "@checkstack/secrets-backend";
+import type { CollectorConfigEntry } from "@checkstack/healthcheck-common";
+import { healthCheckConfigurations } from "./schema";
+import * as schema from "./schema";
+import {
+  extractConfigurationSecrets,
+  healthcheckConfigLockKey,
+} from "./config-secrets";
+
+/**
+ * One-time (idempotent) boot backfill: move inline `x-secret` values that
+ * pre-date the config-secrets channel out of stored health-check
+ * configurations and into internal secrets.
+ *
+ * Rows written after the channel shipped hold only markers / `${{ secrets.* }}`
+ * references, which the extraction walk skips - so re-running is a no-op and
+ * the job is safe to run on EVERY boot. A cross-pod advisory lock ensures a
+ * single pod performs the scan; the others skip (the winner's result is in
+ * the shared DB either way).
+ *
+ * Fail-open per row: one row with an unregistered strategy (plugin removed)
+ * or a broken shape must not wedge boot - it is logged and left as-is; the
+ * executor treats its bare literal exactly as before (legacy pass-through).
+ */
+export async function backfillConfigSecrets({
+  db,
+  registry,
+  collectorRegistry,
+  internalSecrets,
+  advisoryLock,
+  logger,
+}: {
+  db: SafeDatabase<typeof schema>;
+  registry: HealthCheckRegistry;
+  collectorRegistry: CollectorRegistry;
+  internalSecrets: InternalSecretsService;
+  advisoryLock: AdvisoryLockService;
+  logger: Logger;
+}): Promise<void> {
+  const lock = await advisoryLock.tryAcquire("healthcheck:config-secrets-backfill");
+  if (!lock) {
+    logger.debug("Config-secrets backfill already running on another pod, skipping");
+    return;
+  }
+
+  try {
+    const rows = await db.select().from(healthCheckConfigurations);
+    let migratedRows = 0;
+    let movedValues = 0;
+
+    for (const { id: rowId } of rows) {
+      // Serialize each row's read-modify-write under the SAME per-config lock
+      // updateConfiguration uses, and re-read the row INSIDE the lock. Without
+      // this the backfill could write back a pre-lock snapshot over a concurrent
+      // edit - resurrecting a just-rotated secret and reverting the edit.
+      await advisoryLock.withXactLock({
+        key: healthcheckConfigLockKey(rowId),
+        fn: async () => {
+          const [row] = await db
+            .select()
+            .from(healthCheckConfigurations)
+            .where(eq(healthCheckConfigurations.id, rowId));
+          if (!row) return; // deleted between the scan and the lock
+
+          // An unregistered strategy has no schema: its own strategy-level
+          // legacy secrets stay as-is (pass-through, as before), but we still
+          // migrate every REGISTERED collector's inline secrets rather than
+          // skipping the whole row - leaving those plaintext would defeat the
+          // backfill. extractConfigurationSecrets handles the undefined schema.
+          const strategySchema =
+            registry.getStrategy(row.strategyId)?.config.schema;
+          if (!strategySchema) {
+            logger.warn(
+              `Config-secrets backfill: strategy ${row.strategyId} not registered; leaving its strategy config as-is and migrating collector secrets for configuration ${row.id}`,
+            );
+          }
+
+          try {
+            const collectors: CollectorConfigEntry[] | undefined =
+              row.collectors ?? undefined;
+            const extracted = await extractConfigurationSecrets({
+              configurationId: row.id,
+              strategySchema,
+              config: row.config as Record<string, unknown>,
+              collectors,
+              getCollectorSchema: (collectorId) =>
+                collectorRegistry.getCollector(collectorId)?.collector.config
+                  .schema,
+              internalSecrets,
+            });
+            if (extracted.extracted === 0) return;
+
+            await db
+              .update(healthCheckConfigurations)
+              .set({
+                config: extracted.config,
+                collectors: extracted.collectors,
+                updatedAt: new Date(),
+              })
+              .where(eq(healthCheckConfigurations.id, row.id));
+            migratedRows++;
+            movedValues += extracted.extracted;
+          } catch (error) {
+            logger.warn(
+              `Config-secrets backfill: failed for configuration ${row.id}, leaving as-is`,
+              error,
+            );
+          }
+        },
+      });
+    }
+
+    if (migratedRows > 0) {
+      logger.info(
+        `Config-secrets backfill: moved ${movedValues} inline secret value(s) from ${migratedRows} configuration(s) into the internal secret store`,
+      );
+    }
+  } finally {
+    await lock.release();
+  }
+}