@forwardimpact/libwiki 0.2.27 → 0.2.28

package/src/issue-list-renderer.js

@@ -1,5 +1,22 @@
 import { addDays } from "@forwardimpact/libutil";
 import { createLogger } from "@forwardimpact/libtelemetry";
+import { sanitizeCrossingField, sanitizeTitle } from "./sanitize.js";
+
+/**
+ * Thrown when the tracker query for the agent-experiments materialization fails
+ * (non-zero exit or unparseable JSON). Distinct from returning `[]` so the
+ * refresh command can keep the previously materialized block instead of wiping
+ * the routing surface when the tracker is briefly unavailable.
+ */
+export class TrackerQueryError extends Error {
+  /** @param {string} reason */
+  constructor(reason) {
+    super(reason);
+    this.name = "TrackerQueryError";
+  }
+}
+
+const AGENT_LABEL_RE = /^agent:([a-z][a-z-]*)$/;
 
 /** Parse `owner/repo` from a git origin URL. Tolerates http(s), ssh, and proxy-rewritten URLs (e.g. `http://host/git/owner/repo`) by taking the last two path segments after stripping `.git`. Returns null when nothing parseable is found. */
 export function parseRepoSlug(originUrl) {
@@ -88,3 +105,57 @@ export async function renderIssueList({
   }
   return lines;
 }
+
+/**
+ * Render the attributed per-agent experiments surface. Fetches open
+ * issues labeled `experiment`, keeps only those also carrying an
+ * `agent:{name}` label, and emits one sanitized, body-free line per issue:
+ * `- #<number> [<agent>] <title> (by <author>)`. Issue bodies are never read.
+ * Throws {@link TrackerQueryError} on tracker failure so the caller can keep the
+ * previously materialized block; never returns `[]` on failure.
+ *
+ * @param {object} options
+ * @param {string} options.cwd
+ * @param {string} [options.repo]
+ * @param {string} [options.token]
+ * @param {import('@forwardimpact/libutil/runtime').Runtime} options.runtime
+ * @returns {Promise<string[]>}
+ */
+export async function renderAgentExperiments({ cwd, repo, token, runtime }) {
+  const args = ["issue", "list"];
+  if (repo) args.push("--repo", repo);
+  args.push(
+    "--label",
+    "experiment",
+    "--state",
+    "open",
+    "--json",
+    "number,title,labels,author",
+    "--limit",
+    "100",
+  );
+  const env = token ? { ...runtime.proc.env, GH_TOKEN: token } : undefined;
+  const result = await runtime.subprocess.run("gh", args, { cwd, env });
+  if (result.exitCode !== 0) {
+    throw new TrackerQueryError("gh issue list failed for agent-experiments");
+  }
+  let issues;
+  try {
+    issues = JSON.parse(result.stdout || "[]");
+  } catch {
+    throw new TrackerQueryError("gh issue list JSON parse failed");
+  }
+
+  const lines = [];
+  for (const issue of issues) {
+    const agentLabel = (issue.labels || [])
+      .map((l) => (typeof l === "string" ? l : l.name))
+      .map((name) => name?.match(AGENT_LABEL_RE)?.[1])
+      .find(Boolean);
+    if (!agentLabel) continue;
+    const title = sanitizeTitle(issue.title);
+    const author = sanitizeCrossingField(issue.author?.login?.toLowerCase());
+    lines.push(`- #${issue.number} [${agentLabel}] ${title} (by ${author})`);
+  }
+  return lines;
+}

package/src/marker-scanner.js

@@ -1,4 +1,6 @@
 import {
+  AGENT_EXPERIMENTS_CLOSE_RE,
+  AGENT_EXPERIMENTS_OPEN_RE,
   ISSUE_CLOSE_RE,
   ISSUE_OPEN_RE,
   XMR_CLOSE_RE,
@@ -6,7 +8,9 @@ import {
 } from "./constants.js";
 
 function openLabel(open) {
-  return open.kind === "xmr" ? open.metric : open.topic;
+  if (open.kind === "xmr") return open.metric;
+  if (open.kind === "agent-experiments") return "agent-experiments";
+  return open.topic;
 }
 
 function warnDangling(open, warn) {
@@ -34,6 +38,9 @@ function tryOpen(line, i) {
       openLine: i,
     };
   }
+  if (AGENT_EXPERIMENTS_OPEN_RE.test(line)) {
+    return { kind: "agent-experiments", openLine: i };
+  }
   return null;
 }
 
@@ -48,6 +55,13 @@ function closePair(open, i) {
       closeLine: i,
     };
   }
+  if (open.kind === "agent-experiments") {
+    return {
+      kind: "agent-experiments",
+      openLine: open.openLine,
+      closeLine: i,
+    };
+  }
   return {
     kind: "issue-list",
     topic: open.topic,
@@ -61,6 +75,9 @@ function closePair(open, i) {
 function matchClose(line, open) {
   if (!open) return false;
   if (open.kind === "xmr") return XMR_CLOSE_RE.test(line);
+  if (open.kind === "agent-experiments") {
+    return AGENT_EXPERIMENTS_CLOSE_RE.test(line);
+  }
   const m = line.match(ISSUE_CLOSE_RE);
   return Boolean(m && open.kind === "issue-list" && open.topic === m[1]);
 }

package/src/sanitize.js

@@ -0,0 +1,53 @@
+const FIELD_CAP = 200;
+const ELLIPSIS = "…";
+const ZERO_WIDTH_SPACE = "\u200b";
+
+// Replace every newline, control character, or whitespace code point with a
+// single space, then collapse runs. Done by code-point inspection rather than a
+// character-class range so no literal hyphen is ever folded into a range and
+// hyphenated identifiers ("staff-engineer", "dick-olsson") survive intact.
+function flattenWhitespace(input) {
+  let out = "";
+  for (const ch of input) {
+    const code = ch.codePointAt(0);
+    const isControl = code <= 0x1f || code === 0x7f;
+    const isSpace = /\s/.test(ch);
+    out += isControl || isSpace ? " " : ch;
+  }
+  return out.replace(/ {2,}/g, " ");
+}
+
+/**
+ * Neutralize an anyone-editable issue-tracker field before it crosses into a
+ * boot-readable wiki surface. Flattens newlines / control characters /
+ * whitespace to single spaces (a multi-line value is what would let a field
+ * inject a heading or block marker and move section boundaries), escapes a
+ * leading protocol sigil ("[" or "<") so "[ask#N]" / "<tag>" / HTML-comment
+ * lookalikes render inert, and length-caps the result.
+ * @param {string|null|undefined} value
+ * @param {number} [maxLen]
+ * @returns {string}
+ */
+export function sanitizeCrossingField(value, maxLen = FIELD_CAP) {
+  if (value == null) return "";
+  let s = flattenWhitespace(String(value)).trim();
+  s = s.replace(/^\[/, "\\[").replace(/^</, "\\<");
+  if (s.length > maxLen) s = s.slice(0, maxLen - 1) + ELLIPSIS;
+  return s;
+}
+
+/**
+ * Sanitize a materialized item title. Beyond {@link sanitizeCrossingField}, it
+ * defuses the literal author-suffix token " (by " by inserting a zero-width
+ * space after "(by", so a title can never be mistaken for the trailing
+ * "(by <author>)" provenance suffix when the line is parsed back at boot.
+ * @param {string|null|undefined} value
+ * @param {number} [maxLen]
+ * @returns {string}
+ */
+export function sanitizeTitle(value, maxLen = FIELD_CAP) {
+  return sanitizeCrossingField(value, maxLen).replace(
+    / \(by /g,
+    " (by" + ZERO_WIDTH_SPACE + " ",
+  );
+}