@xenonbyte/da-vinci-workflow 0.1.16 → 0.1.17

package/scripts/test-persistence-flows.js

@@ -0,0 +1,315 @@
+const assert = require("assert/strict");
+const fs = require("fs");
+const os = require("os");
+const path = require("path");
+const { spawnSync } = require("child_process");
+
+const repo = path.resolve(__dirname, "..");
+const cli = path.join(repo, "bin", "da-vinci.js");
+const fixture = JSON.parse(
+  fs.readFileSync(path.join(__dirname, "fixtures", "complex-sample.pen"), "utf8")
+);
+const changeId = "redesign-001";
+
+function runTest(name, fn) {
+  try {
+    fn();
+    console.log(`PASS ${name}`);
+  } catch (error) {
+    console.error(`FAIL ${name}`);
+    throw error;
+  }
+}
+
+function createHarness() {
+  const base = fs.mkdtempSync(path.join(os.tmpdir(), "da-vinci-flow-"));
+  return {
+    base,
+    home: path.join(base, "home")
+  };
+}
+
+function runCli(harness, args) {
+  const [command, ...rest] = args;
+  const result = spawnSync(process.execPath, [cli, command, "--home", harness.home, ...rest], {
+    cwd: repo,
+    encoding: "utf8",
+    maxBuffer: 8 * 1024 * 1024
+  });
+
+  return {
+    code: result.status,
+    stdout: (result.stdout || "").trim(),
+    stderr: (result.stderr || "").trim()
+  };
+}
+
+function expectOk(step, result) {
+  assert.equal(result.code, 0, `${step} failed:\n${result.stderr || result.stdout}`);
+}
+
+function expectFail(step, result, pattern) {
+  assert.notEqual(result.code, 0, `${step} unexpectedly succeeded:\n${result.stdout}`);
+  assert.match(`${result.stdout}\n${result.stderr}`, pattern, `${step} failed for the wrong reason.`);
+}
+
+function writeJson(filePath, payload) {
+  fs.mkdirSync(path.dirname(filePath), { recursive: true });
+  fs.writeFileSync(filePath, JSON.stringify(payload, null, 2));
+}
+
+function writeText(filePath, text) {
+  fs.mkdirSync(path.dirname(filePath), { recursive: true });
+  fs.writeFileSync(filePath, text);
+}
+
+function createProject(harness, name, options = {}) {
+  const root = path.join(harness.base, name);
+  const daVinciDir = path.join(root, ".da-vinci");
+  const penPath = path.join(daVinciDir, "designs", `${name}.pen`);
+  const changeDir = path.join(daVinciDir, "changes", changeId);
+  const nodesFile = path.join(root, `${name}-nodes.json`);
+  const variablesFile = path.join(root, `${name}-variables.json`);
+  const liveNodesFile = path.join(root, `${name}-live-nodes.json`);
+
+  writeText(path.join(root, "DA-VINCI.md"), "# Test\n");
+  writeText(path.join(daVinciDir, "project-inventory.md"), "# Inventory\n");
+  writeText(path.join(daVinciDir, "page-map.md"), "# Page Map\n");
+  writeText(
+    path.join(daVinciDir, "design-registry.md"),
+    `# Registry\n- Preferred .pen: .da-vinci/designs/${name}.pen\n`
+  );
+  writeText(path.join(changeDir, "design-brief.md"), "# Brief\n");
+  writeText(path.join(changeDir, "design.md"), "# Design\n");
+  writeText(path.join(changeDir, "pencil-design.md"), "# Pencil\n");
+  writeText(path.join(changeDir, "pencil-bindings.md"), "# Bindings\n");
+
+  writeJson(nodesFile, { nodes: fixture.children });
+  writeJson(variablesFile, { variables: fixture.variables });
+
+  const liveNodes = JSON.parse(JSON.stringify(fixture.children));
+  if (options.modifiedPayload) {
+    liveNodes.push({ id: `${name}-extra`, type: "frame", children: [] });
+  }
+  writeJson(liveNodesFile, { nodes: liveNodes });
+
+  if (options.withExistingPen) {
+    const seed = runCli(harness, [
+      "write-pen",
+      "--output",
+      penPath,
+      "--nodes-file",
+      nodesFile,
+      "--variables-file",
+      variablesFile,
+      "--version",
+      fixture.version
+    ]);
+    expectOk(`${name} precreate existing .pen`, seed);
+  }
+
+  return {
+    root,
+    penPath,
+    nodesFile,
+    variablesFile,
+    liveNodesFile
+  };
+}
+
+runTest("new project flow passes end-to-end", () => {
+  const harness = createHarness();
+  const project = createProject(harness, "fresh-project");
+
+  expectOk(
+    "fresh begin",
+    runCli(harness, ["pencil-session", "begin", "--project", project.root, "--pen", project.penPath])
+  );
+  expectOk(
+    "fresh persist",
+    runCli(harness, [
+      "pencil-session",
+      "persist",
+      "--project",
+      project.root,
+      "--pen",
+      project.penPath,
+      "--nodes-file",
+      project.nodesFile,
+      "--variables-file",
+      project.variablesFile,
+      "--version",
+      fixture.version
+    ])
+  );
+  expectOk(
+    "fresh end",
+    runCli(harness, [
+      "pencil-session",
+      "end",
+      "--project",
+      project.root,
+      "--pen",
+      project.penPath,
+      "--nodes-file",
+      project.nodesFile,
+      "--variables-file",
+      project.variablesFile,
+      "--version",
+      fixture.version
+    ])
+  );
+  expectOk(
+    "fresh completion audit",
+    runCli(harness, ["audit", "--mode", "completion", "--change", changeId, "--project", project.root])
+  );
+});
+
+runTest("existing .pen flow persists modified live payload", () => {
+  const harness = createHarness();
+  const project = createProject(harness, "existing-project", {
+    withExistingPen: true,
+    modifiedPayload: true
+  });
+
+  expectOk(
+    "existing begin",
+    runCli(harness, ["pencil-session", "begin", "--project", project.root, "--pen", project.penPath])
+  );
+  expectOk(
+    "existing persist",
+    runCli(harness, [
+      "pencil-session",
+      "persist",
+      "--project",
+      project.root,
+      "--pen",
+      project.penPath,
+      "--nodes-file",
+      project.liveNodesFile,
+      "--variables-file",
+      project.variablesFile,
+      "--version",
+      fixture.version
+    ])
+  );
+  expectOk(
+    "existing end",
+    runCli(harness, [
+      "pencil-session",
+      "end",
+      "--project",
+      project.root,
+      "--pen",
+      project.penPath,
+      "--nodes-file",
+      project.liveNodesFile,
+      "--variables-file",
+      project.variablesFile,
+      "--version",
+      fixture.version
+    ])
+  );
+  expectOk(
+    "existing completion audit",
+    runCli(harness, ["audit", "--mode", "completion", "--change", changeId, "--project", project.root])
+  );
+
+  const pen = JSON.parse(fs.readFileSync(project.penPath, "utf8"));
+  assert.equal(pen.children.some((node) => node.id === "existing-project-extra"), true);
+});
+
+runTest("parallel mixed projects are serialized by the global Pencil lock", () => {
+  const harness = createHarness();
+  const freshA = createProject(harness, "parallel-fresh-a");
+  const freshB = createProject(harness, "parallel-fresh-b");
+  const existing = createProject(harness, "parallel-existing", {
+    withExistingPen: true
+  });
+
+  expectOk(
+    "parallel A begin",
+    runCli(harness, ["pencil-session", "begin", "--project", freshA.root, "--pen", freshA.penPath])
+  );
+  expectFail(
+    "parallel B blocked while A is active",
+    runCli(harness, ["pencil-session", "begin", "--project", freshB.root, "--pen", freshB.penPath]),
+    /lock is already held/i
+  );
+  expectFail(
+    "parallel existing blocked while A is active",
+    runCli(harness, ["pencil-session", "begin", "--project", existing.root, "--pen", existing.penPath]),
+    /lock is already held/i
+  );
+  expectOk(
+    "parallel A end",
+    runCli(harness, ["pencil-session", "end", "--project", freshA.root, "--pen", freshA.penPath])
+  );
+
+  expectOk(
+    "parallel existing begin",
+    runCli(harness, ["pencil-session", "begin", "--project", existing.root, "--pen", existing.penPath])
+  );
+  expectFail(
+    "parallel B blocked while existing is active",
+    runCli(harness, ["pencil-session", "begin", "--project", freshB.root, "--pen", freshB.penPath]),
+    /lock is already held/i
+  );
+  expectOk(
+    "parallel existing end",
+    runCli(harness, [
+      "pencil-session",
+      "end",
+      "--project",
+      existing.root,
+      "--pen",
+      existing.penPath,
+      "--nodes-file",
+      existing.nodesFile,
+      "--variables-file",
+      existing.variablesFile,
+      "--version",
+      fixture.version
+    ])
+  );
+  expectOk(
+    "parallel B begin",
+    runCli(harness, ["pencil-session", "begin", "--project", freshB.root, "--pen", freshB.penPath])
+  );
+  expectOk(
+    "parallel B persist",
+    runCli(harness, [
+      "pencil-session",
+      "persist",
+      "--project",
+      freshB.root,
+      "--pen",
+      freshB.penPath,
+      "--nodes-file",
+      freshB.nodesFile,
+      "--variables-file",
+      freshB.variablesFile,
+      "--version",
+      fixture.version
+    ])
+  );
+  expectOk(
+    "parallel B end",
+    runCli(harness, [
+      "pencil-session",
+      "end",
+      "--project",
+      freshB.root,
+      "--pen",
+      freshB.penPath,
+      "--nodes-file",
+      freshB.nodesFile,
+      "--variables-file",
+      freshB.variablesFile,
+      "--version",
+      fixture.version
+    ])
+  );
+});
+
+console.log("All persistence flow integration tests passed.");