@engine-room/after-effects-mcp 0.5.2 → 0.6.0

package/panel/client/panelhash.js

@@ -0,0 +1,79 @@
+// panelhash.js — the hash that names the panel's own code (issue #243).
+//
+// `bundleHash` on /health names the ExtendScript the panel evaluated. It says
+// nothing about the files beside it — this one, main.js, index.html, the
+// manifest — and a panel with a current bundle and old client code used to
+// pass the version gate. `clientHash` is the other half: every shipped file of
+// the panel except bundle.jsx, which has its own hash because /reload-jsx can
+// replace it without a restart.
+//
+// The server computes the same value over the panel it ships
+// (packages/mcp-server/src/setup/panelHash.ts) and over the installed copy;
+// tests/unit/panel-hash.mjs holds the two implementations to each other.
+// Change both together.
+//
+// Left out, and why:
+//   jsx/bundle.jsx          its own hash (bundleHash), which follows reloads
+//   node_modules/ (any)     `ws` is copied in beside the panel separately
+//   .DS_Store, Thumbs.db,   Finder and Explorer litter
+//   desktop.ini (any)
+//   META-INF/, mimetype     what a self-signed install adds (issues #91, #182);
+//                           a signed install is a current install
+//   package.json (root)     a version stamp; nothing at runtime reads it
+// and in CSXS/manifest.xml the two version attributes are blanked, so a
+// release that changes nothing in the panel does not ask every user to
+// reinstall it and restart After Effects.
+//
+// A pure function of the files: sorted paths, '/' separators, no timestamps.
+
+"use strict";
+
+var fs = require("fs");
+var path = require("path");
+var crypto = require("crypto");
+
+var SKIP_ANY_DEPTH = { "node_modules": true, ".DS_Store": true, "Thumbs.db": true, "desktop.ini": true };
+var SKIP_AT_ROOT = { "META-INF": true, "mimetype": true, "package.json": true };
+var SKIP_PATHS = { "jsx/bundle.jsx": true };
+var MANIFEST = "CSXS/manifest.xml";
+
+function listFiles(dir, prefix, out) {
+  var names = fs.readdirSync(dir);
+  for (var i = 0; i < names.length; i++) {
+    var name = names[i];
+    if (SKIP_ANY_DEPTH[name]) continue;
+    if (!prefix && SKIP_AT_ROOT[name]) continue;
+    var rel = prefix ? prefix + "/" + name : name;
+    if (SKIP_PATHS[rel]) continue;
+    var full = path.join(dir, name);
+    // stat, not lstat: a `--symlink` dev install links into the source tree.
+    if (fs.statSync(full).isDirectory()) listFiles(full, rel, out);
+    else out.push(rel);
+  }
+  return out;
+}
+
+function normalise(rel, bytes) {
+  if (rel !== MANIFEST) return bytes;
+  var text = bytes.toString("utf8")
+    .replace(/(ExtensionBundleVersion=")[^"]*(")/g, "$1$2")
+    .replace(/(<Extension\s+Id="[^"]*"\s+Version=")[^"]*(")/g, "$1$2");
+  return Buffer.from(text, "utf8");
+}
+
+/** sha256 over every panel file but the ones above, or null when the folder cannot be read. */
+function panelClientHash(dir) {
+  try {
+    var files = listFiles(dir, "", []).sort(function (a, b) { return a < b ? -1 : a > b ? 1 : 0; });
+    var h = crypto.createHash("sha256");
+    for (var i = 0; i < files.length; i++) {
+      var bytes = normalise(files[i], fs.readFileSync(path.join(dir, files[i])));
+      h.update(files[i] + "\u0000" + crypto.createHash("sha256").update(bytes).digest("hex") + "\n");
+    }
+    return h.digest("hex");
+  } catch (e) {
+    return null;
+  }
+}
+
+module.exports = { panelClientHash: panelClientHash };

package/panel/client/status.html

@@ -0,0 +1,27 @@
+<!doctype html>
+<html lang="en">
+<head>
+  <meta charset="utf-8" />
+  <title>AE MCP Bridge</title>
+  <style>
+    body { font-family: -apple-system, "Segoe UI", sans-serif; background: #2a2a2a; color: #ddd; padding: 12px; margin: 0; font-size: 12px; }
+    h1 { font-size: 13px; margin: 0 0 8px 0; color: #fff; }
+    .row { margin: 4px 0; }
+    .label { color: #888; }
+    .ok { color: #6f6; } .err { color: #f66; } .warn { color: #fc6; }
+    #log { margin-top: 8px; font-family: ui-monospace, Menlo, monospace; font-size: 10px; background: #1a1a1a; padding: 6px; border-radius: 4px; max-height: 220px; overflow: auto; }
+    #log div { white-space: pre-wrap; }
+  </style>
+</head>
+<body>
+  <h1>AE MCP Bridge</h1>
+  <div class="row"><span class="label">Status:</span> <span id="status">asking the bridge…</span></div>
+  <div class="row"><span class="label">Port:</span> <span id="port">—</span></div>
+  <div class="row"><span class="label">AE:</span> <span id="ae">—</span></div>
+  <div class="row"><span class="label">JSX:</span> <span id="jsx">—</span></div>
+  <div class="row"><span class="label">Requests:</span> <span id="reqs">0</span></div>
+  <div id="log"></div>
+  <script src="./csinterface.js"></script>
+  <script src="./status.js"></script>
+</body>
+</html>

package/panel/client/status.js

@@ -0,0 +1,112 @@
+// status.js — the visible status panel (Window > Extensions > AE MCP Bridge).
+//
+// Issue #283. The bridge itself runs in a hidden extension of this bundle
+// (games.engine-room.ae-mcp.bridge, client/index.html + main.js) that starts
+// with After Effects and is never shown. This page is a separate extension
+// with no Node: it runs no server, binds no port, writes no file. It only
+// shows what the bridge reports over a CEP event, so opening it — or opening
+// it twice — can never start a second bridge.
+//
+// It keeps the id the old visible bridge had (games.engine-room.ae-mcp.panel),
+// so a workspace saved with that panel docked restores this window into the
+// same frame rather than pointing a Panel slot at a hidden extension.
+//
+// Silence is not death. While After Effects runs a long script the bridge's
+// answers can stop for as long as the script runs, so a quiet bridge is shown
+// as "no answer for Ns (After Effects may be busy)" and the window goes back
+// to the bridge's own status the moment an answer arrives. The one active
+// thing this page does is for a bridge it has never heard from: ask CEP, once,
+// to open the bridge extension — a no-op for an extension already running,
+// and the recovery for a host that did not start it at launch.
+
+(function () {
+  "use strict";
+
+  var BRIDGE_ID = "games.engine-room.ae-mcp.bridge";
+  // Event types are their own namespace, never an extension id.
+  var STATUS_EVENT = "games.engine-room.ae-mcp.event.status";
+  var STATUS_REQUEST = "games.engine-room.ae-mcp.event.status-request";
+  var ASK_EVERY_MS = 2000;
+  var SILENT_AFTER_MS = 6000;
+  // A window restored by a saved workspace opens at launch, while the bridge
+  // takes 7–11 s to answer (measured on AE 26.5). Asking CEP to open it before
+  // then would be asked on nearly every launch, mid-startup.
+  var OPEN_AFTER_MS = 30000;
+  // Past this, a bridge that once answered is more likely gone than busy.
+  var STOPPED_AFTER_MS = 120000;
+
+  function $(id) { return document.getElementById(id); }
+  function set(id, text, klass) {
+    var el = $(id);
+    if (!el) return;
+    el.textContent = text;
+    el.className = klass || "";
+  }
+
+  var cs;
+  try { cs = new CSInterface(); }
+  catch (e) { set("status", "cannot ask the bridge — CSInterface is unavailable", "err"); return; }
+
+  var lastHeard = 0;
+  var openedBridge = false;
+  var startedAt = new Date().getTime();
+
+  function render(state) {
+    set("status", state.status || "—", state.statusClass);
+    set("port", state.port || "—", state.portClass);
+    set("ae", state.ae || "—");
+    set("jsx", state.jsx || "—", state.jsxClass);
+    set("reqs", String(state.reqs || 0));
+    var $log = $("log");
+    if (!$log) return;
+    while ($log.firstChild) $log.removeChild($log.firstChild);
+    var lines = state.log || [];
+    for (var i = 0; i < lines.length; i++) {
+      var d = document.createElement("div");
+      d.className = lines[i].level || "";
+      d.textContent = lines[i].text;
+      $log.appendChild(d);
+    }
+  }
+
+  cs.addEventListener(STATUS_EVENT, function (event) {
+    var data = event && event.data;
+    if (typeof data === "string") {
+      try { data = JSON.parse(data); } catch (e) { return; }
+    }
+    if (!data || typeof data !== "object") return;
+    lastHeard = new Date().getTime();
+    render(data);
+  });
+
+  function ask() {
+    try {
+      var ev = new CSEvent(STATUS_REQUEST, "APPLICATION");
+      ev.data = "";
+      cs.dispatchEvent(ev);
+    } catch (e) {}
+  }
+
+  function tick() {
+    var now = new Date().getTime();
+    var since = lastHeard || startedAt;
+    ask();
+    var quiet = now - since;
+    if (quiet < SILENT_AFTER_MS) return;
+    if (!lastHeard && !openedBridge && quiet >= OPEN_AFTER_MS) {
+      openedBridge = true;
+      try { cs.requestOpenExtension(BRIDGE_ID, ""); } catch (e) {}
+    }
+    var secs = Math.round(quiet / 1000);
+    // The port and the log stay as last reported: they are still true of a
+    // bridge that is busy, and the next answer replaces all of it.
+    if (quiet >= STOPPED_AFTER_MS) {
+      set("status", "no answer for " + secs + "s — the bridge may have stopped; ask the agent to run check_setup", "err");
+    } else {
+      set("status", "no answer for " + secs + "s (After Effects may be busy)", "warn");
+    }
+  }
+
+  ask();
+  setInterval(tick, ASK_EVERY_MS);
+})();