@checkstack/healthcheck-backend 0.16.1 → 0.16.3

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # @checkstack/healthcheck-backend
 
+## 0.16.3
+
+### Patch Changes
+
+- b53a40e: Fix GitOps entity update failures due to pending error records
+
+  - Ensured the `existingEntityId` parameter in the Reconciler engine is set to `undefined` instead of a `"pending-UUID"` when handling entities that failed to sync initially.
+  - Hardened the `Healthcheck` GitOps kind logic to explicitly ignore `"pending-"` IDs, preventing SQL update errors on synthetic provenance IDs.
+  - Fixed a bug where resolving YAML syntax errors would cause the subsequent sync to fail with `failed query: update [...]` because it attempted to update the nonexistent `"pending-"` entity instead of creating a new one.
+
+- Updated dependencies [b53a40e]
+  - @checkstack/gitops-backend@0.2.2
+  - @checkstack/catalog-backend@0.5.3
+  - @checkstack/satellite-backend@0.2.11
+
+## 0.16.2
+
+### Patch Changes
+
+- 57d54de: Fix GitOps Healthcheck reconciliation engine and Kind Registry UI
+
+  - Mandated fully qualified IDs for all healthcheck strategies and collector definitions.
+  - Refactored the Kind Registry UI to display schema documentation in beautifully formatted, interactive YAML examples.
+  - Entity Envelope Fields and Base Spec Schema are now displayed in collapsed accordions.
+  - Fixed condition logic that broke the collector documentation display.
+  - Enhanced UX by dynamically injecting fully-qualified strategy variants directly into the YAML examples.
+
+- Updated dependencies [57d54de]
+  - @checkstack/gitops-backend@0.2.1
+  - @checkstack/catalog-backend@0.5.2
+  - @checkstack/satellite-backend@0.2.10
+
 ## 0.16.1
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/healthcheck-backend",
-  "version": "0.16.1",
+  "version": "0.16.3",
   "type": "module",
   "main": "src/index.ts",
   "checkstack": {
@@ -14,8 +14,8 @@
   },
   "dependencies": {
     "@checkstack/backend-api": "0.12.0",
-    "@checkstack/catalog-backend": "0.5.0",
-    "@checkstack/catalog-common": "1.4.0",
+    "@checkstack/catalog-backend": "0.5.1",
+    "@checkstack/catalog-common": "1.4.1",
     "@checkstack/command-backend": "0.1.19",
     "@checkstack/common": "0.6.5",
     "@checkstack/gitops-backend": "0.2.0",
@@ -25,7 +25,7 @@
     "@checkstack/integration-backend": "0.1.19",
     "@checkstack/maintenance-common": "0.4.9",
     "@checkstack/queue-api": "0.2.13",
-    "@checkstack/satellite-backend": "0.2.8",
+    "@checkstack/satellite-backend": "0.2.9",
     "@checkstack/signal-common": "0.1.9",
     "@hono/zod-validator": "^0.7.6",
     "drizzle-orm": "^0.45.0",

package/src/healthcheck-gitops-kinds.test.ts

@@ -135,23 +135,31 @@ const cpuCollectorConfigSchema = z.object({
 function createMockHealthCheckRegistry() {
   const strategies = new Map<
     string,
-    { id: string; config: Versioned<unknown> }
+    { strategy: any; ownerPluginId: string; qualifiedId: string }
   >();
 
-  // Register a test strategy
-  strategies.set("postgres", {
+  const strategy = {
     id: "postgres",
+    displayName: "PostgreSQL",
+    description: "test",
     config: new Versioned({
       version: 1,
       schema: postgresConfigSchema,
     }),
+  };
+
+  // Register a test strategy
+  strategies.set("postgres", {
+    strategy,
+    ownerPluginId: "mock",
+    qualifiedId: "postgres",
   });
 
   return {
-    getStrategy: (id: string) => strategies.get(id) as ReturnType<import("@checkstack/backend-api").HealthCheckRegistry["getStrategy"]>,
+    getStrategy: (id: string) => strategies.get(id)?.strategy as ReturnType<import("@checkstack/backend-api").HealthCheckRegistry["getStrategy"]>,
     getStrategies: () =>
-      [...strategies.values()] as ReturnType<import("@checkstack/backend-api").HealthCheckRegistry["getStrategies"]>,
-    getStrategiesWithMeta: () => [],
+      [...strategies.values()].map(s => s.strategy) as ReturnType<import("@checkstack/backend-api").HealthCheckRegistry["getStrategies"]>,
+    getStrategiesWithMeta: () => [...strategies.values()] as any,
     register: () => {},
   };
 }
@@ -251,6 +259,36 @@ describe("Healthcheck GitOps Kind: Healthcheck", () => {
     expect(mockService.configs[0].strategyId).toBe("postgres");
   });
 
+  it("creates a new configuration when existingEntityId is a pending error record", async () => {
+    const kind = buildKind();
+
+    const result = await kind.reconcile({
+      entity: {
+        apiVersion: CHECKSTACK_API_VERSION,
+        kind: "Healthcheck",
+        metadata: { name: "payment-db-check" },
+        spec: {
+          strategy: "postgres",
+          intervalSeconds: 30,
+          config: {
+            host: "db.internal",
+            port: 5432,
+            database: "payments",
+            user: "monitor",
+            password: "secret",
+          },
+        },
+      },
+      existingEntityId: "pending-12345",
+      context: mockContext,
+    });
+
+    expect(result.entityId).toBe("hc-1");
+    expect(mockService.createConfiguration).toHaveBeenCalledTimes(1);
+    expect(mockService.updateConfiguration).not.toHaveBeenCalled();
+    expect(mockService.configs).toHaveLength(1);
+  });
+
   it("updates an existing configuration using existingEntityId", async () => {
     const kind = buildKind();
 

package/src/healthcheck-gitops-kinds.ts

@@ -117,18 +117,21 @@ export function buildHealthcheckKind(
       const service = deps.createService();
       const spec = entity.spec;
 
-      // Look up strategy first — we need its typed schema for secret resolution
+      // Look up strategy using strictly the fully qualified ID
       const healthCheckRegistry = deps.getHealthCheckRegistry();
-      const strategy = healthCheckRegistry.getStrategy(spec.strategy);
-      if (!strategy) {
+      const allStrategies = healthCheckRegistry.getStrategiesWithMeta();
+      const matchStrategy = allStrategies.find((s) => s.qualifiedId === spec.strategy);
+
+      if (!matchStrategy) {
         throw new Error(
           `Unknown health check strategy "${spec.strategy}". ` +
-            `Available: ${healthCheckRegistry
-              .getStrategies()
-              .map((s) => s.id)
+            `Available: ${allStrategies
+              .map((s) => s.qualifiedId)
               .join(", ")}`,
         );
       }
+      
+      const strategy = matchStrategy.strategy;
 
       // Resolve secrets using the strategy's typed schema.
       // Only fields marked with configString({ "x-secret": true }) get resolved.
@@ -151,17 +154,22 @@ export function buildHealthcheckKind(
       const resolvedCollectors = spec.collectors
         ? await Promise.all(
             spec.collectors.map(async (c) => {
+              // Look up collector using strictly the fully qualified ID
               const collectorReg = deps.getCollectorRegistry();
-              const registered = collectorReg.getCollector(c.collectorId);
-              if (!registered) {
+              const allCollectors = collectorReg.getCollectors();
+              const matchCollector = allCollectors.find(
+                (col) => col.qualifiedId === c.collectorId
+              );
+
+              if (!matchCollector) {
                 throw new Error(
                   `Unknown collector "${c.collectorId}". ` +
-                    `Available: ${collectorReg
-                      .getCollectors()
+                    `Available: ${allCollectors
                       .map((col) => col.qualifiedId)
                       .join(", ")}`,
                 );
               }
+              const registered = matchCollector;
 
               // Resolve secrets using the collector's typed schema
               const { resolved: resolvedCollectorConfig } =
@@ -188,7 +196,7 @@ export function buildHealthcheckKind(
       // Create or update configuration
       const displayName = entity.metadata.title ?? entity.metadata.name;
 
-      if (existingEntityId) {
+      if (existingEntityId && !existingEntityId.startsWith("pending-")) {
         await service.updateConfiguration(existingEntityId, {
           name: displayName,
           strategyId: spec.strategy,
@@ -370,15 +378,24 @@ export function registerHealthcheckGitOpsDocumentation({
       apiVersion: CHECKSTACK_API_VERSION,
       kind: "Healthcheck",
       fieldPath: "config",
-      variantId: registered.ownerPluginId,
+      variantId: registered.qualifiedId,
       label: registered.strategy.displayName,
-      description: `ID: ${registered.ownerPluginId}\n\n${registered.strategy.description}`,
+      description: `ID: ${registered.qualifiedId}\n\n${registered.strategy.description}`,
       schema: registered.strategy.config.schema,
     });
   }
 
   // 2. Register documentation for collector configs (fieldPath: "collectors[].config")
   for (const registered of collectorRegistry.getCollectors()) {
+    const supportedStrategyIds = healthCheckRegistry
+      .getStrategiesWithMeta()
+      .filter((s) =>
+        registered.collector.supportedPlugins.some(
+          (p) => p.pluginId === s.ownerPluginId,
+        ),
+      )
+      .map((s) => s.qualifiedId);
+
     kindRegistry.registerSpecSchemaDocumentation({
       apiVersion: CHECKSTACK_API_VERSION,
       kind: "Healthcheck",
@@ -390,9 +407,7 @@ export function registerHealthcheckGitOpsDocumentation({
       conditions: [
         {
           fieldPath: "config",
-          variantIds: registered.collector.supportedPlugins.map(
-            (p) => p.pluginId,
-          ),
+          variantIds: supportedStrategyIds,
         },
       ],
     });