@syntax-syllogism/flow-delta 0.3.0 → 0.5.0

package/examples/gitlab-ci.yml

@@ -0,0 +1,23 @@
+FlowDelta:
+  image: node:24-alpine
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+  variables:
+    GIT_DEPTH: 0
+  before_script:
+    - apk add --no-cache git
+  script:
+    - |
+      # see /docs/ci.md for details on how this works
+      npx --yes -p @syntax-syllogism/flow-delta@latest flow-delta \
+        --repo . \
+        --from "$CI_MERGE_REQUEST_DIFF_BASE_SHA" \
+        --to   "${CI_MERGE_REQUEST_SOURCE_BRANCH_SHA:-$CI_COMMIT_SHA}" \
+        --path 'force-app/**/*.flow-meta.xml' \
+        --changed-only \
+        --out flow-delta-out --json
+    - npx --yes -p @syntax-syllogism/flow-delta@latest flow-delta-gitlab --in flow-delta-out
+  artifacts:
+    paths: [flow-delta-out]
+    expire_in: 30 days
+  allow_failure: true

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syntax-syllogism/flow-delta",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "type": "module",
   "description": "Semantic visual diff for Salesforce Flows",
   "license": "MIT",
@@ -27,14 +27,15 @@
   "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/smoke-gitlab.test.ts",
+    "smoke:github": "node --import tsx scripts/smoke-github.ts",
+    "test": "node --import tsx --test test/parser.test.ts test/semantic-diff.test.ts test/report-core.test.ts test/gitlab-report.test.ts test/github-report.test.ts test/smoke-gitlab.test.ts test/r2-publish.test.ts test/cloudflare-worker.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": "^25.9.2",
+    "@types/node": "^26.1.0",
     "@types/xml2js": "^0.4.14",
     "tsx": "^4.19.0"
   },
@@ -44,10 +45,13 @@
   },
   "bin": {
     "flow-delta": "dist/cli.js",
-    "flow-delta-gitlab": "dist/gitlab-report.js"
+    "flow-delta-gitlab": "dist/gitlab-report.js",
+    "flow-delta-github": "dist/github-report.js"
   },
   "files": [
     "dist",
+    "examples",
+    "scripts/r2-publish.mjs",
     "NOTICE",
     "LICENSE",
     "LICENSE-APACHE",

package/scripts/r2-publish.mjs

@@ -0,0 +1,132 @@
+#!/usr/bin/env node
+import { createHmac } from "node:crypto";
+import { readFileSync, readdirSync } from "node:fs";
+import { basename, join } from "node:path";
+import { spawnSync } from "node:child_process";
+import { fileURLToPath } from "node:url";
+
+if (process.argv[1] && fileURLToPath(import.meta.url) === process.argv[1]) {
+  const [outDir = "flow-delta-out", keyPrefix = defaultKeyPrefix()] = process.argv.slice(2);
+
+  try {
+    const urls = publishDirectory(outDir, keyPrefix);
+    process.stdout.write(`${JSON.stringify(urls, null, 2)}\n`);
+  } catch (error) {
+    console.error(error instanceof Error ? error.message : String(error));
+    process.exitCode = 1;
+  }
+}
+
+export function publishDirectory(outDir, keyPrefix, env = process.env) {
+  const bucket = required(env.R2_BUCKET, "R2_BUCKET");
+  const endpoint = r2Endpoint(env);
+  const htmlFiles = readdirSync(outDir).filter((file) => file.endsWith(".html")).sort();
+  const urls = {};
+
+  for (const file of htmlFiles) {
+    const key = joinKey(keyPrefix, file);
+    uploadHtml(join(outDir, file), bucket, key, endpoint);
+    urls[file] = resolveUrl(bucket, key, endpoint, env);
+  }
+
+  return urls;
+}
+
+export function signedWorkerUrl(baseUrl, key, secret, exp) {
+  const base = baseUrl.replace(/\/+$/, "");
+  const encodedKey = key.split("/").map(encodeURIComponent).join("/");
+  const sig = hmacHex(secret, `${key}:${exp}`);
+  return `${base}/${encodedKey}?exp=${exp}&sig=${sig}`;
+}
+
+export function hmacHex(secret, message) {
+  return createHmac("sha256", secret).update(message).digest("hex");
+}
+
+function resolveUrl(bucket, key, endpoint, env) {
+  if (env.ARTIFACT_BASE_URL) {
+    const secret = required(env.ARTIFACT_HMAC_KEY, "ARTIFACT_HMAC_KEY");
+    const exp = String(Math.floor(Date.now() / 1000) + expirySeconds(env));
+    return signedWorkerUrl(env.ARTIFACT_BASE_URL, key, secret, exp);
+  }
+
+  return presignUrl(bucket, key, endpoint, expirySeconds(env));
+}
+
+function uploadHtml(path, bucket, key, endpoint) {
+  runAws([
+    "s3",
+    "cp",
+    path,
+    `s3://${bucket}/${key}`,
+    "--endpoint-url",
+    endpoint,
+    "--content-type",
+    "text/html",
+  ]);
+}
+
+function presignUrl(bucket, key, endpoint, expiresIn) {
+  return runAws([
+    "s3",
+    "presign",
+    `s3://${bucket}/${key}`,
+    "--endpoint-url",
+    endpoint,
+    "--expires-in",
+    String(expiresIn),
+  ]);
+}
+
+function runAws(args) {
+  const result = spawnSync("aws", args, { encoding: "utf8", stdio: ["ignore", "pipe", "pipe"] });
+  if (result.status !== 0) {
+    throw new Error(result.stderr.trim() || `aws ${args.join(" ")} failed`);
+  }
+  return result.stdout.trim();
+}
+
+function r2Endpoint(env) {
+  const accountId = required(env.R2_ACCOUNT_ID, "R2_ACCOUNT_ID");
+  return `https://${accountId}.r2.cloudflarestorage.com`;
+}
+
+function expirySeconds(env) {
+  const raw = env.ARTIFACT_EXPIRES_IN_SECONDS ?? "86400";
+  const value = Number(raw);
+  if (!Number.isInteger(value) || value <= 0) {
+    throw new Error("ARTIFACT_EXPIRES_IN_SECONDS must be a positive integer");
+  }
+  return Math.min(value, 604800);
+}
+
+function joinKey(prefix, file) {
+  return [prefix.replace(/^\/+|\/+$/g, ""), basename(file)].filter(Boolean).join("/");
+}
+
+function defaultKeyPrefix() {
+  const repo = required(process.env.GITHUB_REPOSITORY, "GITHUB_REPOSITORY");
+  const sha = required(process.env.GITHUB_SHA, "GITHUB_SHA");
+  const pr = process.env.GITHUB_PR_NUMBER ?? process.env.PR_NUMBER ?? readGitHubEventPrNumber() ?? "unknown-pr";
+  return `${repo}/${pr}/${sha}`;
+}
+
+function readGitHubEventPrNumber() {
+  const eventPath = process.env.GITHUB_EVENT_PATH;
+  if (!eventPath) {
+    return undefined;
+  }
+  try {
+    const event = JSON.parse(readFileSync(eventPath, "utf8"));
+    return typeof event?.number === "number" ? String(event.number) : undefined;
+  } catch {
+    return undefined;
+  }
+}
+
+function required(value, name) {
+  if (!value) {
+    throw new Error(`Missing required value: ${name}`);
+  }
+  return value;
+}