@intentius/chant 0.112.1 → 0.113.0

package/dist/lifecycle/digest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"digest.d.ts","sourceRoot":"","sources":["../../src/lifecycle/digest.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAE5C,OAAO,KAAK,EAAE,WAAW,EAAkB,UAAU,EAAE,MAAM,SAAS,CAAC;AAIvE;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAGhD;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,WAAW,GAAG,WAAW,CA4BxE;AAED;;GAEG;AACH,wBAAgB,WAAW,CACzB,OAAO,EAAE,WAAW,EACpB,QAAQ,EAAE,WAAW,GAAG,SAAS,GAChC,UAAU,CAiCZ"}
+{"version":3,"file":"digest.d.ts","sourceRoot":"","sources":["../../src/lifecycle/digest.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAE5C,OAAO,KAAK,EAAE,WAAW,EAAkB,UAAU,EAAE,MAAM,SAAS,CAAC;AAKvE;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAGhD;AA0BD;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,WAAW,GAAG,WAAW,CA4BxE;AAED;;GAEG;AACH,wBAAgB,WAAW,CACzB,OAAO,EAAE,WAAW,EACpB,QAAQ,EAAE,WAAW,GAAG,SAAS,GAChC,UAAU,CAiCZ"}

package/dist/op/activities/lifecycle.d.ts

@@ -23,8 +23,8 @@ export interface LifecycleDiffResult {
     exitCode: number;
     /**
      * True when the diff output contains any drift indicators
-     * (MISSING / ORPHAN / DRIFTED / DISAPPEARED section headers from
-     * `chant lifecycle diff --live`).
+     * (MISSING / ORPHAN / DRIFTED / DISAPPEARED / PROPERTY DRIFT section
+     * headers from `chant lifecycle diff --live`).
      */
     drifted: boolean;
     /**
@@ -55,13 +55,15 @@ export interface LifecycleDiffResult {
  * approval would be stale the moment it was written.
  */
 export declare function normalizeDiffChangeSet(output: string): string[];
+/** True when a `chant lifecycle diff` render carries any of {@link DRIFT_HEADERS}' sections. */
+export declare function detectDrift(output: string): boolean;
 /**
  * Run `chant lifecycle diff <env>` and return the output + structured drift
  * flag. Read-only; intended for use inside watch/observation Ops.
  * Uses fastIdempotent profile.
  *
  * The `drifted` field is computed by scanning the output for any of the
- * MISSING / ORPHAN / DRIFTED / DISAPPEARED section headers documented in
+ * MISSING / ORPHAN / DRIFTED / DISAPPEARED / PROPERTY DRIFT section headers documented in
  * cli/state.mdx. Pair with `outcomeAttribute: { name: "Drift", from: "drifted" }`
  * on a WatchOp activity step to surface drift as the run's `Drift` outcome.
  */

package/dist/op/activities/lifecycle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lifecycle.d.ts","sourceRoot":"","sources":["../../../src/op/activities/lifecycle.ts"],"names":[],"mappings":"AAMA,MAAM,WAAW,qBAAqB;IACpC,wDAAwD;IACxD,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,wBAAsB,iBAAiB,CAAC,IAAI,EAAE,qBAAqB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAIxG;AAED,MAAM,WAAW,iBAAiB;IAChC,wDAAwD;IACxD,GAAG,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC,uDAAuD;IACvD,MAAM,EAAE,MAAM,CAAC;IACf,uCAAuC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;;;;;;;;OASG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAM/D;AAkCD;;;;;;;;;GASG;AACH,wBAAsB,aAAa,CAAC,IAAI,EAAE,iBAAiB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAa/G"}
+{"version":3,"file":"lifecycle.d.ts","sourceRoot":"","sources":["../../../src/op/activities/lifecycle.ts"],"names":[],"mappings":"AAMA,MAAM,WAAW,qBAAqB;IACpC,wDAAwD;IACxD,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,wBAAsB,iBAAiB,CAAC,IAAI,EAAE,qBAAqB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAIxG;AAED,MAAM,WAAW,iBAAiB;IAChC,wDAAwD;IACxD,GAAG,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,mBAAmB;IAClC,uDAAuD;IACvD,MAAM,EAAE,MAAM,CAAC;IACf,uCAAuC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;;;;;;;;OASG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAM/D;AAmBD,gGAAgG;AAChG,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEnD;AAgBD;;;;;;;;;GASG;AACH,wBAAsB,aAAa,CAAC,IAAI,EAAE,iBAAiB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAa/G"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intentius/chant",
-  "version": "0.112.1",
+  "version": "0.113.0",
   "description": "Declarative infrastructure-as-code toolkit — TypeScript on Node.js",
   "license": "Apache-2.0",
   "homepage": "https://intentius.io/chant",

package/src/lifecycle/digest.test.ts

@@ -2,6 +2,8 @@ import { describe, test, expect } from "vitest";
 import { computeBuildDigest, diffDigests, hashProps } from "./digest";
 import type { BuildResult } from "../build";
 import type { BuildDigest } from "./types";
+import { AttrRef } from "../attrref";
+import { LOGICAL_NAME_SYMBOL } from "../utils";
 
 function makeBuildResult(entitiesByLexicon: Record<string, Array<{ name: string; type: string; props: unknown }>>): BuildResult {
   const entities = new Map();
@@ -37,6 +39,30 @@ describe("hashProps", () => {
   test("produces different hashes for different props", () => {
     expect(hashProps({ a: 1 })).not.toBe(hashProps({ a: 2 }));
   });
+
+  // #3642: a sql index's `columns` holds AttrRefs the build never names, and
+  // their toJSON throws, so a snapshot of the project failed.
+  describe("an AttrRef the build did not name", () => {
+    const parent = { [LOGICAL_NAME_SYMBOL]: "orders" };
+
+    test("hashes instead of throwing, as the envelope named by its parent", () => {
+      const nested = { columns: [new AttrRef(parent, "status")] };
+      expect(() => JSON.stringify(nested)).toThrow(/logical name not set/);
+      const named = new AttrRef({}, "status");
+      named._setLogicalName("orders");
+      expect(hashProps(nested)).toBe(hashProps({ columns: [named] }));
+    });
+
+    test("tells two attributes apart", () => {
+      expect(hashProps({ c: [new AttrRef(parent, "status")] })).not.toBe(hashProps({ c: [new AttrRef(parent, "amount")] }));
+    });
+
+    test("hashes a named AttrRef as it always has", () => {
+      const ref = new AttrRef({}, "arn");
+      ref._setLogicalName("bucket");
+      expect(hashProps({ a: ref })).toBe(hashProps({ a: { __attrRef: { entity: "bucket", attribute: "arn" } } }));
+    });
+  });
 });
 
 describe("computeBuildDigest", () => {

package/src/lifecycle/digest.ts

@@ -9,6 +9,7 @@ import type { Declarable } from "../declarable";
 import type { BuildDigest, ResourceDigest, DigestDiff } from "./types";
 import { canonicalJson } from "../effect-receipt";
 import { contentDigest } from "../content-digest";
+import { isAttrRefLike, LOGICAL_NAME_SYMBOL } from "../utils";
 
 /**
  * Hash an entity's props deterministically: bare hex SHA-256 over their
@@ -18,10 +19,34 @@ import { contentDigest } from "../content-digest";
  * hashes rather than throwing.
  */
 export function hashProps(props: unknown): string {
-  const plain: unknown = JSON.parse(JSON.stringify(props) ?? "null");
+  const plain: unknown = JSON.parse(JSON.stringify(namedRefs(props)) ?? "null");
   return contentDigest(canonicalJson(plain)).slice("sha256:".length);
 }
 
+/**
+ * `props` with each AttrRef that has no logical name of its own written as
+ * the envelope its `toJSON` gives, named by its parent's logical name. The
+ * build names only an entity's top-level AttrRefs; one held in a record,
+ * such as a sql table's `columns`, is never named, and `toJSON` throws on
+ * it (chant#3642). Plain objects and arrays are walked; anything else is
+ * left for `JSON.stringify`, so a named AttrRef hashes as it always has.
+ */
+function namedRefs(value: unknown): unknown {
+  if (isAttrRefLike(value)) {
+    if (value.getLogicalName()) return value;
+    const parent = value.parent.deref() as Record<symbol, unknown> | undefined;
+    const entity = parent?.[LOGICAL_NAME_SYMBOL];
+    return { __attrRef: { entity: typeof entity === "string" ? entity : null, attribute: value.attribute } };
+  }
+  if (Array.isArray(value)) return value.map(namedRefs);
+  if (value !== null && typeof value === "object") {
+    const proto = Object.getPrototypeOf(value);
+    if (proto !== Object.prototype && proto !== null) return value;
+    return Object.fromEntries(Object.entries(value).map(([k, v]) => [k, namedRefs(v)]));
+  }
+  return value;
+}
+
 /**
  * Compute a full build digest from a BuildResult.
  */

package/src/op/activities/lifecycle.test.ts

@@ -0,0 +1,31 @@
+import { describe, expect, test } from "vitest";
+import { detectDrift } from "./lifecycle";
+
+const BOLD = "\u001b[1m";
+const RESET = "\u001b[0m";
+
+// Renders as `chant lifecycle diff <env> --live` printed them against the sql
+// emulator (#3642), bold headers included: the activity reads them off a
+// child process, colour and all.
+const HEAD = `${BOLD}sql${RESET} — environment: watch\n`;
+const CLEAN = `${HEAD}0 missing, 0 orphan, 0 disappeared, 0 newly observed, 0 drifted, 3 unchanged\n${"-".repeat(80)}\n\u001b[32mNo drift detected across 1 lexicon(s)${RESET}`;
+const PROPERTY = `${HEAD}0 missing, 0 orphan, 0 disappeared, 0 newly observed, 0 drifted, 3 unchanged\n${"-".repeat(80)}\n\n${BOLD}sql (properties)${RESET}\n1 property drift across 1 resource(s), 0 accepted, 2 unchanged\n${"-".repeat(80)}\n${BOLD}\nPROPERTY DRIFT (declared vs live; baseline shown where one exists):${RESET}\n  - events (ClickHouse::Table)\n      ttl: ts + INTERVAL 180 DAY → ts + toIntervalDay(30) [from: authored]`;
+const MISSING = `${HEAD}1 missing, 0 orphan, 0 disappeared, 0 newly observed, 0 drifted, 2 unchanged\n${"-".repeat(80)}\n${BOLD}\nMISSING (declared, provider reports not in cloud):${RESET}\n  - byKind [queried http://127.0.0.1:8123 yodel_3642.by_kind]`;
+
+describe("detectDrift", () => {
+  test("a clean render is not drift", () => {
+    expect(detectDrift(CLEAN)).toBe(false);
+  });
+
+  test("an owned object's property changed out of band is drift (PROPERTY DRIFT)", () => {
+    expect(detectDrift(PROPERTY)).toBe(true);
+  });
+
+  test("a declared object gone from the server is drift (MISSING)", () => {
+    expect(detectDrift(MISSING)).toBe(true);
+  });
+
+  test("the counts line alone, lower case, is not drift", () => {
+    expect(detectDrift("1 property drift across 1 resource(s)")).toBe(false);
+  });
+});

package/src/op/activities/lifecycle.ts

@@ -36,8 +36,8 @@ export interface LifecycleDiffResult {
   exitCode: number;
   /**
    * True when the diff output contains any drift indicators
-   * (MISSING / ORPHAN / DRIFTED / DISAPPEARED section headers from
-   * `chant lifecycle diff --live`).
+   * (MISSING / ORPHAN / DRIFTED / DISAPPEARED / PROPERTY DRIFT section
+   * headers from `chant lifecycle diff --live`).
    */
   drifted: boolean;
   /**
@@ -85,12 +85,16 @@ const DRIFT_HEADERS = [
   "ORPHAN",
   "DISAPPEARED",
   "DRIFTED",
+  // An owned resource whose live properties differ from its declaration (the
+  // deep read): a sql table's TTL changed out of band, say (#3642).
+  "PROPERTY DRIFT",
   "ARTIFACTS ADDED",
   "ARTIFACTS REMOVED",
   "ARTIFACTS CHANGED",
 ];
 
-function detectDrift(output: string): boolean {
+/** True when a `chant lifecycle diff` render carries any of {@link DRIFT_HEADERS}' sections. */
+export function detectDrift(output: string): boolean {
   return DRIFT_HEADERS.some((h) => output.includes(`${h} (`) || output.includes(`\n${h}`));
 }
 
@@ -114,7 +118,7 @@ function lifecycleDiffDigest(args: LifecycleDiffArgs, output: string): string {
  * Uses fastIdempotent profile.
  *
  * The `drifted` field is computed by scanning the output for any of the
- * MISSING / ORPHAN / DRIFTED / DISAPPEARED section headers documented in
+ * MISSING / ORPHAN / DRIFTED / DISAPPEARED / PROPERTY DRIFT section headers documented in
  * cli/state.mdx. Pair with `outcomeAttribute: { name: "Drift", from: "drifted" }`
  * on a WatchOp activity step to surface drift as the run's `Drift` outcome.
  */