@checkstack/satellite 0.2.11 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,60 @@
 # @checkstack/satellite
 
+## 0.3.0
+
+### Minor Changes
+
+- 35bc682: feat(healthcheck): expose check + system run-context to script collectors
+
+  Script health checks can now read which check and system a run is for.
+  Previously shell scripts got only a curated env whitelist and inline
+  scripts only `context.config`, so a script had no built-in way to know
+  its own check name or the system it was checking.
+
+  - `@checkstack/backend-api`: new `CollectorRunContext` type
+    (`{ check: { id, name, intervalSeconds }, system: { id, name } }`) and
+    an optional `runContext` param on `CollectorStrategy.execute`. Optional,
+    so existing collector implementations are unaffected.
+  - Shell-script collector: injects reserved `CHECKSTACK_CHECK_ID`,
+    `CHECKSTACK_CHECK_NAME`, `CHECKSTACK_CHECK_INTERVAL_SECONDS`,
+    `CHECKSTACK_SYSTEM_ID`, `CHECKSTACK_SYSTEM_NAME` env vars (user-supplied
+    `env` still wins on collision).
+  - Inline-script collector: exposes `context.check` and `context.system`
+    alongside `context.config`; the inline-script editor now types them for
+    autocomplete.
+  - Shell editors (health-check collectors and automation shell actions) now
+    also suggest the user's own `env` (JSON) keys as `$NAME` completions, via
+    the new exported `customShellEnvVars` helper. Keys that aren't valid shell
+    identifiers are omitted.
+  - Fix: the Typefox `CodeEditor` captured a stale `onChange` at editor start,
+    so editing one `DynamicForm` field reverted sibling fields changed since
+    mount (e.g. typing in a shell `script` field wiped an unsaved `env` value,
+    or deleted a sibling automation action added after mount). The change
+    handler now routes through a ref to the current `onChange`.
+  - Fix: focusing a JSON editor threw "LanguageStatusService.addStatus is not
+    supported" because the standalone service set omitted `ILanguageStatusService`.
+    That one service is now registered via `serviceOverrides`.
+  - Fix: the automation trigger card nested a `<Badge>` (a `<div>`) inside a
+    `<p>`, producing a `validateDOMNesting` warning. Switched the wrapper to a
+    `<div>`.
+  - Local runs (`queue-executor`) and satellite runs both populate the
+    context. `SatelliteAssignment` (and the `getAssignmentsForSatellite`
+    RPC output) gained optional `configName` / `systemName` so the metadata
+    reaches satellite-side execution; `HealthCheckService` resolves the
+    system name via the catalog client.
+
+  BREAKING CHANGE: `createHealthCheckRouter` now requires a `catalogClient`
+  option (used to resolve system names for satellite assignments). Update
+  call sites to pass the catalog RPC client.
+
+### Patch Changes
+
+- Updated dependencies [6d52276]
+- Updated dependencies [35bc682]
+  - @checkstack/common@0.12.0
+  - @checkstack/backend-api@0.18.0
+  - @checkstack/satellite-common@0.6.0
+
 ## 0.2.11
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/satellite",
-  "version": "0.2.11",
+  "version": "0.3.0",
   "license": "Elastic-2.0",
   "type": "module",
   "main": "src/index.ts",
@@ -11,8 +11,8 @@
     "lint:code": "eslint . --max-warnings 0"
   },
   "dependencies": {
-    "@checkstack/satellite-common": "0.5.2",
-    "@checkstack/backend-api": "0.17.0",
+    "@checkstack/satellite-common": "0.5.3",
+    "@checkstack/backend-api": "0.17.1",
     "@checkstack/common": "0.11.0"
   },
   "devDependencies": {

package/src/index.ts

@@ -5,10 +5,12 @@ import type {
 import type {
   ConnectedClient,
   TransportClient,
+  CollectorRunContext,
 } from "@checkstack/backend-api";
 import { SatelliteClient } from "./satellite-client";
 import { Scheduler } from "./scheduler";
 import { loadStrategies } from "./strategy-loader";
+import { buildRunContext } from "./run-context";
 
 // =============================================================================
 // Environment validation — fail fast if required vars are missing
@@ -92,6 +94,11 @@ async function executeAssignment(
     };
   }
 
+  // Curated, read-only run-context metadata exposed to collectors.
+  // Mirrors the core queue-executor; falls back to IDs when the optional
+  // name fields are absent (version-skew safety).
+  const runContext: CollectorRunContext = buildRunContext({ assignment });
+
   const start = performance.now();
   let connectedClient:
     | ConnectedClient<TransportClient<never, unknown>>
@@ -125,6 +132,7 @@ async function executeAssignment(
             config: collectorEntry.config,
             client: connectedClient!.client,
             pluginId: assignment.strategyId,
+            runContext,
           });
 
           return {

package/src/run-context.test.ts

@@ -0,0 +1,53 @@
+import { describe, test, expect } from "bun:test";
+import { buildRunContext } from "./run-context";
+import type { SatelliteAssignment } from "@checkstack/satellite-common";
+
+function makeAssignment(
+  overrides?: Partial<SatelliteAssignment>,
+): SatelliteAssignment {
+  return {
+    configId: "config-1",
+    systemId: "system-1",
+    strategyId: "http",
+    config: {},
+    intervalSeconds: 60,
+    ...overrides,
+  };
+}
+
+describe("buildRunContext", () => {
+  test("uses configName and systemName when present", () => {
+    const assignment = makeAssignment({
+      configName: "API health",
+      systemName: "Production API",
+    });
+
+    const runContext = buildRunContext({ assignment });
+
+    expect(runContext).toEqual({
+      check: { id: "config-1", name: "API health", intervalSeconds: 60 },
+      system: { id: "system-1", name: "Production API" },
+    });
+  });
+
+  test("falls back to ids when name fields are absent", () => {
+    const assignment = makeAssignment();
+
+    const runContext = buildRunContext({ assignment });
+
+    expect(runContext.check.name).toBe("config-1");
+    expect(runContext.check.id).toBe("config-1");
+    expect(runContext.check.intervalSeconds).toBe(60);
+    expect(runContext.system.name).toBe("system-1");
+    expect(runContext.system.id).toBe("system-1");
+  });
+
+  test("falls back per-field when only one name is present", () => {
+    const assignment = makeAssignment({ configName: "API health" });
+
+    const runContext = buildRunContext({ assignment });
+
+    expect(runContext.check.name).toBe("API health");
+    expect(runContext.system.name).toBe("system-1");
+  });
+});

package/src/run-context.ts

@@ -0,0 +1,28 @@
+import type { SatelliteAssignment } from "@checkstack/satellite-common";
+import type { CollectorRunContext } from "@checkstack/backend-api";
+
+/**
+ * Build the curated, read-only run-context metadata exposed to collectors
+ * from a satellite assignment.
+ *
+ * Mirrors the core queue-executor's run-context. The `configName` and
+ * `systemName` assignment fields are optional for version-skew safety, so
+ * they fall back to the corresponding IDs when absent.
+ */
+export function buildRunContext({
+  assignment,
+}: {
+  assignment: SatelliteAssignment;
+}): CollectorRunContext {
+  return {
+    check: {
+      id: assignment.configId,
+      name: assignment.configName ?? assignment.configId,
+      intervalSeconds: assignment.intervalSeconds,
+    },
+    system: {
+      id: assignment.systemId,
+      name: assignment.systemName ?? assignment.systemId,
+    },
+  };
+}