@checkstack/satellite-common 0.5.2 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,67 @@
 # @checkstack/satellite-common
 
+## 0.6.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/healthcheck-common@1.3.0
+  - @checkstack/signal-common@0.2.5
+
+## 0.5.3
+
+### Patch Changes
+
+- Updated dependencies [ba07ae2]
+  - @checkstack/healthcheck-common@1.2.0
+
 ## 0.5.2
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/satellite-common",
-  "version": "0.5.2",
+  "version": "0.6.0",
   "license": "Elastic-2.0",
   "type": "module",
   "exports": {
@@ -9,16 +9,16 @@
     }
   },
   "dependencies": {
-    "@checkstack/common": "0.10.0",
-    "@checkstack/healthcheck-common": "1.1.1",
-    "@checkstack/signal-common": "0.2.3",
+    "@checkstack/common": "0.11.0",
+    "@checkstack/healthcheck-common": "1.2.0",
+    "@checkstack/signal-common": "0.2.4",
     "@orpc/contract": "^1.13.14",
     "zod": "^4.2.1"
   },
   "devDependencies": {
     "typescript": "^5.7.2",
     "@checkstack/tsconfig": "0.0.7",
-    "@checkstack/scripts": "0.3.2"
+    "@checkstack/scripts": "0.3.3"
   },
   "scripts": {
     "typecheck": "tsgo -b",

package/src/protocol.test.ts

@@ -0,0 +1,30 @@
+import { describe, test, expect } from "bun:test";
+import { SatelliteAssignmentSchema } from "./protocol";
+
+describe("SatelliteAssignmentSchema", () => {
+  const base = {
+    configId: "config-1",
+    systemId: "system-1",
+    strategyId: "http",
+    config: {},
+    intervalSeconds: 60,
+  };
+
+  test("parses an assignment WITH configName and systemName", () => {
+    const parsed = SatelliteAssignmentSchema.parse({
+      ...base,
+      configName: "API health",
+      systemName: "Production API",
+    });
+
+    expect(parsed.configName).toBe("API health");
+    expect(parsed.systemName).toBe("Production API");
+  });
+
+  test("parses an assignment WITHOUT configName and systemName (optional)", () => {
+    const parsed = SatelliteAssignmentSchema.parse(base);
+
+    expect(parsed.configName).toBeUndefined();
+    expect(parsed.systemName).toBeUndefined();
+  });
+});

package/src/protocol.ts

@@ -38,6 +38,9 @@ export const SatelliteAssignmentSchema = z.object({
   config: z.record(z.string(), z.unknown()),
   collectors: z.array(SatelliteCollectorConfigSchema).optional(),
   intervalSeconds: z.number(),
+  /** Curated run-context metadata. Optional for version-skew safety. */
+  configName: z.string().optional(),
+  systemName: z.string().optional(),
 });
 
 export type SatelliteAssignment = z.infer<typeof SatelliteAssignmentSchema>;