@syntax-syllogism/flow-delta 0.0.1

package/dist/gitlab-report.js

@@ -0,0 +1,188 @@
+#!/usr/bin/env node
+
+// src/ci/gitlab-report.ts
+import { readFileSync, readdirSync } from "node:fs";
+import { join } from "node:path";
+import { parseArgs } from "node:util";
+
+// src/util/file-name.ts
+function safeFileName(value) {
+  return value.replace(/[^a-zA-Z0-9._-]+/g, "_");
+}
+
+// src/ci/gitlab-report.ts
+var DEFAULT_MARKER = "<!-- FlowDelta:report -->";
+var REPORTER_USAGE = `Usage:
+  flow-delta-gitlab --in <flow-delta-out> [--api-url <url>] [--project-id <id>] [--mr-iid <iid>]
+                    [--project-url <url>] [--job-id <id>] [--token <token>] [--commit-sha <sha>]
+`;
+function buildComment(results, opts = {}) {
+  const marker = opts.marker ?? DEFAULT_MARKER;
+  const sorted = [...results].sort((left, right) => left.flowName.localeCompare(right.flowName));
+  const lines = [marker, "", `## \u{1F50D} FlowDelta \u2014 ${sorted.length} flow(s) changed`, ""];
+  if (sorted.length === 0) {
+    lines.push("_No Flow changes in this MR._");
+  } else {
+    lines.push("| Flow | +nodes | -nodes | ~nodes | +/-edges | Diff |");
+    lines.push("| --- | ---: | ---: | ---: | ---: | --- |");
+    for (const result of sorted) {
+      lines.push(
+        `| ${escapeTableCell(result.flowName)} | ${result.summary.addedNodes} | ${result.summary.removedNodes} | ${result.summary.modifiedNodes} | ${result.summary.addedEdges} / ${result.summary.removedEdges} | [Open interactive diff \u25B8](${result.artifactUrl}) |`
+      );
+    }
+  }
+  if (opts.commitSha) {
+    lines.push("", `Commit: \`${opts.commitSha.slice(0, 7)}\``);
+  }
+  return lines.join("\n");
+}
+function artifactUrl(env, relPath, stem) {
+  const base = env.projectUrl.replace(/\/+$/, "");
+  const relativePath = normalizePath(relPath);
+  const encodedPath = [relativePath, `${stem}.html`].filter(Boolean).flatMap((segment) => segment.split("/").filter(Boolean)).map(encodeURIComponent).join("/");
+  return `${base}/-/jobs/${env.jobId}/artifacts/file/${encodedPath}`;
+}
+function findStickyNote(notes, marker, authorId) {
+  return notes.find((note) => note.body.includes(marker) && (authorId === void 0 || note.author?.id === authorId));
+}
+async function upsertComment(env, body, fetchImpl = fetch) {
+  const headers = {
+    "PRIVATE-TOKEN": env.token,
+    "Content-Type": "application/json"
+  };
+  const marker = env.marker ?? DEFAULT_MARKER;
+  const user = await requestJson(fetchImpl, `${env.apiUrl}/user`, {
+    headers
+  });
+  const notes = await listNotes(fetchImpl, env, headers);
+  const sticky = findStickyNote(notes, marker, user.id);
+  const notePath = sticky ? `/notes/${sticky.id}` : "/notes";
+  const method = sticky ? "PUT" : "POST";
+  await requestJson(fetchImpl, `${env.apiUrl}/projects/${env.projectId}/merge_requests/${env.mergeRequestIid}${notePath}`, {
+    method,
+    headers,
+    body: JSON.stringify({ body })
+  });
+}
+async function main(argv = process.argv.slice(2)) {
+  try {
+    const parsed = parseArgs({
+      args: argv,
+      options: {
+        in: { type: "string" },
+        "api-url": { type: "string" },
+        "project-id": { type: "string" },
+        "mr-iid": { type: "string" },
+        "project-url": { type: "string" },
+        "job-id": { type: "string" },
+        token: { type: "string" },
+        "commit-sha": { type: "string" },
+        marker: { type: "string" },
+        help: { type: "boolean", short: "h" }
+      },
+      allowPositionals: false
+    });
+    if (parsed.values.help) {
+      console.log(REPORTER_USAGE.trimEnd());
+      return;
+    }
+    const inputDir = parsed.values.in ?? process.env.FLOW_LENS_OUT_DIR ?? "./flow-delta-out";
+    const records = readResults(inputDir);
+    if (records.length === 0) {
+      return;
+    }
+    const env = resolveEnv(parsed.values);
+    const results = records.map((record) => ({
+      flowName: record.flowName,
+      summary: record.summary,
+      artifactUrl: artifactUrl(env, inputDir, record.stem)
+    }));
+    const body = buildComment(results, {
+      marker: env.marker,
+      commitSha: env.commitSha
+    });
+    await upsertComment(env, body);
+  } catch (error) {
+    console.error(error.message);
+    process.exitCode = 1;
+  }
+}
+function readResults(inputDir) {
+  return readdirSync(inputDir).filter((file) => file.endsWith(".diff.json")).map((file) => {
+    const diff = JSON.parse(readFileSync(join(inputDir, file), "utf8"));
+    if (isZeroSummary(diff.summary)) {
+      return null;
+    }
+    return {
+      flowName: diff.flowName,
+      summary: diff.summary,
+      stem: safeFileName(diff.flowName)
+    };
+  }).filter((value) => value !== null);
+}
+function isZeroSummary(summary) {
+  return summary.addedNodes === 0 && summary.removedNodes === 0 && summary.modifiedNodes === 0 && summary.addedEdges === 0 && summary.removedEdges === 0;
+}
+function resolveEnv(values) {
+  const apiUrl = stringValue(values["api-url"] ?? process.env.CI_API_V4_URL, "CI_API_V4_URL");
+  const projectId = stringValue(values["project-id"] ?? process.env.CI_PROJECT_ID, "CI_PROJECT_ID");
+  const mergeRequestIid = stringValue(values["mr-iid"] ?? process.env.CI_MERGE_REQUEST_IID, "CI_MERGE_REQUEST_IID");
+  const projectUrl = stringValue(values["project-url"] ?? process.env.CI_PROJECT_URL, "CI_PROJECT_URL");
+  const jobId = stringValue(values["job-id"] ?? process.env.CI_JOB_ID, "CI_JOB_ID");
+  const token = stringValue(values.token ?? process.env.FlowDelta_GITLAB_TOKEN, "FlowDelta_GITLAB_TOKEN");
+  const commitSha = stringValueOptional(values["commit-sha"] ?? process.env.CI_COMMIT_SHA);
+  const marker = stringValueOptional(values.marker) ?? DEFAULT_MARKER;
+  return { apiUrl, projectId, mergeRequestIid, projectUrl, jobId, token, commitSha, marker };
+}
+function stringValue(value, name) {
+  if (typeof value !== "string" || value.length === 0) {
+    throw new Error(`Missing required value: ${name}`);
+  }
+  return value;
+}
+function stringValueOptional(value) {
+  return typeof value === "string" && value.length > 0 ? value : void 0;
+}
+async function listNotes(fetchImpl, env, headers) {
+  const notes = [];
+  let page = 1;
+  while (true) {
+    const response = await fetchImpl(
+      `${env.apiUrl}/projects/${env.projectId}/merge_requests/${env.mergeRequestIid}/notes?per_page=100&page=${page}`,
+      { headers }
+    );
+    const pageNotes = await parseResponse(response, "list MR notes");
+    notes.push(...pageNotes);
+    if (pageNotes.length < 100) {
+      return notes;
+    }
+    page += 1;
+  }
+}
+async function requestJson(fetchImpl, url, init, label = url) {
+  const response = await fetchImpl(url, init);
+  return parseResponse(response, label);
+}
+async function parseResponse(response, label) {
+  const body = await response.text();
+  if (!response.ok) {
+    throw new Error(`${label} failed: ${response.status} ${body}`);
+  }
+  return body.length > 0 ? JSON.parse(body) : void 0;
+}
+function normalizePath(value) {
+  return value.replaceAll("\\", "/").replace(/^\.\/+/, "").replace(/^\/+/, "").replace(/\/+$/, "");
+}
+function escapeTableCell(value) {
+  return value.replaceAll("|", "\\|").replaceAll("`", "\\`").replace(/\r?\n/g, "<br>");
+}
+if (import.meta.url === `file://${process.argv[1]}`) {
+  void main();
+}
+export {
+  artifactUrl,
+  buildComment,
+  findStickyNote,
+  main,
+  upsertComment
+};

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@syntax-syllogism/flow-delta",
+  "version": "0.0.1",
+  "type": "module",
+  "description": "Semantic visual diff for Salesforce Flows",
+  "license": "MIT",
+  "author": "Jacob Richter",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/syntax-syllogism/flow-delta.git"
+  },
+  "bugs": {
+    "url": "https://github.com/syntax-syllogism/flow-delta/issues"
+  },
+  "homepage": "https://github.com/syntax-syllogism/flow-delta#readme",
+  "keywords": [
+    "salesforce",
+    "flow",
+    "diff",
+    "visual-diff",
+    "metadata",
+    "ci"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "node scripts/build.mjs",
+    "smoke:gitlab": "node --import tsx scripts/smoke-gitlab.ts",
+    "test": "node --import tsx --test test/parser.test.ts test/semantic-diff.test.ts test/gitlab-report.test.ts",
+    "test:parser": "node --import tsx --test test/parser.test.ts",
+    "prepublishOnly": "npm run build && npm test",
+    "render:fixtures": "bash bin/render-fixtures.sh"
+  },
+  "devDependencies": {
+    "esbuild": "^0.28.0",
+    "@types/node": "^22.0.0",
+    "@types/xml2js": "^0.4.14",
+    "tsx": "^4.19.0"
+  },
+  "dependencies": {
+    "elkjs": "^0.10.0",
+    "xml2js": "^0.6.2"
+  },
+  "bin": {
+    "flow-delta": "dist/cli.js",
+    "flow-delta-gitlab": "dist/gitlab-report.js"
+  },
+  "files": [
+    "dist",
+    "NOTICE",
+    "LICENSE",
+    "LICENSE-APACHE",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=18"
+  }
+}