tinybeeai 0.0.0-stage → 0.16.1

package/dist/runner/copyfiles.js

@@ -0,0 +1,221 @@
+// runner.copyFiles (KAT-293): files of the dot's working folder that a run in a temporary worktree needs but git does
+// not carry, such as `.env`. They are copied into the worktree before the setup steps.
+//
+// The paths are the owner's setting, but the folder and the worktree are not trusted to be what they look like:
+//  - a path is relative and has no `..` (copyFileError, command.ts);
+//  - the real path of the source (symlinks resolved) must be inside the real working folder, so a symlink that leads
+//    out of the folder is never followed and nothing outside it is read;
+//  - the worktree is a checkout of a commit, so it can hold a symlink where a folder is expected, the folders from the
+//    worktree root down to the working sub folder (apps/web) included. The copy walks every folder from the root,
+//    refuses a symlink on the way, checks with realpath that the destination folder stays inside the root, and opens
+//    the file with O_NOFOLLOW, so nothing is written outside the worktree;
+//  - the source is opened once (O_NOFOLLOW, O_NONBLOCK so a named pipe cannot block) and its type and size are read from that open file, so a swap after the
+//    check cannot change what is copied. The destination is written through its own open file the same way;
+//  - only regular files are copied, up to 1 MB. The notes never print file contents.
+// A missing file is skipped with a note; nothing here throws.
+import { closeSync, constants, fchmodSync, fstatSync, ftruncateSync, lstatSync, mkdirSync, openSync, readSync, realpathSync, statSync, writeSync, } from 'node:fs';
+import path from 'node:path';
+import { runTracked } from '../proc.js';
+import { cleanCopyFiles, copyFileError } from './command.js';
+/** The largest file that is copied. A dotfile with settings is far below it; anything bigger is not a dotfile. */
+const MAX_BYTES = 1024 * 1024;
+/** True when `child` is `parent` or below it. Both are real absolute paths. */
+function isInside(child, parent) {
+    const rel = path.relative(parent, child);
+    return rel === '' || (!rel.startsWith('..') && !path.isAbsolute(rel));
+}
+/** Makes the folders of `relDir` under `root` one at a time and fails on a symlink or a file on the way. */
+function ensureDir(root, relDir) {
+    let cur = root;
+    for (const seg of relDir.split(path.sep).filter((s) => s && s !== '.')) {
+        cur = path.join(cur, seg);
+        let st;
+        try {
+            st = lstatSync(cur);
+        }
+        catch {
+            mkdirSync(cur);
+            continue;
+        }
+        if (st.isSymbolicLink())
+            return `the worktree has a symlink at ${path.relative(root, cur)}`;
+        if (!st.isDirectory())
+            return `the worktree has a file where the folder ${path.relative(root, cur)} should be`;
+    }
+    return null;
+}
+/** Reads the whole open file `fd` (`size` bytes at most MAX_BYTES). */
+function readAll(fd, size) {
+    const buf = Buffer.alloc(size);
+    let got = 0;
+    while (got < size) {
+        const n = readSync(fd, buf, got, size - got, got);
+        if (n <= 0)
+            break;
+        got += n;
+    }
+    return buf.subarray(0, got);
+}
+/**
+ * Copies `files` (relative to `from`, the working folder) to the same places under `to` (the worktree's working
+ * folder, which is `root` or a sub folder of it). `root` is the worktree root: nothing is written outside it. Never throws.
+ */
+export function copyFilesIntoWorktree(o) {
+    const out = { copied: [], notes: [] };
+    const files = cleanCopyFiles([...o.files]);
+    if (!files.length)
+        return out;
+    let realFrom;
+    let realRoot;
+    let relTo;
+    try {
+        realFrom = realpathSync(o.from);
+        realRoot = realpathSync(o.root);
+        // The worktree's folder as the path below the root, taken from the names (not resolved), so every folder on it is checked below.
+        relTo = path.relative(path.resolve(o.root), path.resolve(o.to));
+        if (relTo.startsWith('..') || path.isAbsolute(relTo))
+            throw new Error('outside');
+    }
+    catch {
+        out.notes.push('copyFiles: the working folder or the worktree could not be read, so no file was copied.');
+        return out;
+    }
+    for (const rel of files) {
+        const skip = (why) => out.notes.push(`copyFiles: ${rel} ${why}, skipped.`);
+        const bad = copyFileError(rel);
+        if (bad) {
+            skip(`is not a usable path (${bad.replace(/^"[^"]*" /, '')})`);
+            continue;
+        }
+        const src = path.join(realFrom, rel);
+        let real;
+        try {
+            // Resolves every symlink on the way, a dangling one included (that one is missing).
+            real = realpathSync(src);
+        }
+        catch {
+            skip('is not in the working folder');
+            continue;
+        }
+        if (!isInside(real, realFrom)) {
+            skip('leads outside the working folder through a symlink and was not followed');
+            continue;
+        }
+        let srcFd;
+        let destFd;
+        try {
+            // The type and size come from the open file, so they are the ones of the bytes that are copied.
+            srcFd = openSync(real, constants.O_RDONLY | constants.O_NOFOLLOW | constants.O_NONBLOCK);
+            const st = fstatSync(srcFd);
+            if (!st.isFile()) {
+                skip('is not a regular file');
+                continue;
+            }
+            if (st.size > MAX_BYTES) {
+                skip('is larger than 1 MB');
+                continue;
+            }
+            const pathStat = statSync(real);
+            if (pathStat.ino !== st.ino || pathStat.dev !== st.dev) {
+                skip('changed while it was read');
+                continue;
+            }
+            // Every folder from the worktree root down, the working sub folder included: none may be a symlink.
+            const destRel = path.join(relTo, rel);
+            const blocked = ensureDir(realRoot, path.dirname(destRel));
+            if (blocked) {
+                skip(blocked);
+                continue;
+            }
+            const dir = path.join(realRoot, path.dirname(destRel));
+            if (!isInside(realpathSync(dir), realRoot)) {
+                skip('would be written outside the worktree');
+                continue;
+            }
+            const dest = path.join(dir, path.basename(destRel));
+            let existing;
+            try {
+                existing = lstatSync(dest);
+            }
+            catch {
+                existing = undefined;
+            }
+            if (existing && !existing.isFile()) {
+                skip('would replace a symlink or a folder of the worktree');
+                continue;
+            }
+            // O_NOFOLLOW: a symlink at the file is an error, never followed. The file is emptied only after it is known to be a regular one.
+            destFd = openSync(dest, constants.O_WRONLY | constants.O_CREAT | constants.O_NOFOLLOW | constants.O_NONBLOCK, 0o600);
+            if (!fstatSync(destFd).isFile()) {
+                skip('would replace a symlink or a folder of the worktree');
+                continue;
+            }
+            ftruncateSync(destFd, 0);
+            const data = readAll(srcFd, st.size);
+            let written = 0;
+            while (written < data.length)
+                written += writeSync(destFd, data, written, data.length - written);
+            fchmodSync(destFd, st.mode & 0o777);
+            out.copied.push(rel);
+            out.notes.push(`copyFiles: copied ${rel} into the worktree.`);
+        }
+        catch {
+            skip('could not be copied');
+        }
+        finally {
+            if (srcFd !== undefined)
+                closeSync(srcFd);
+            if (destFd !== undefined)
+                closeSync(destFd);
+        }
+    }
+    return out;
+}
+/** Dotfiles that say nothing about a failed run. */
+const NOISE = new Set(['.DS_Store', '.gitkeep', '.gitignore', '.gitattributes', '.keep', '.directory', '.localized']);
+/**
+ * The untracked dotfiles of the working folder `dir` (ignored ones included, such as `.env`) that are not in
+ * `listed`, at most `max`, as paths relative to `dir`. A folder that is entirely untracked counts as one entry and
+ * is not looked into, so `node_modules/` and build folders do not bury the answer. Never throws; [] on any error.
+ */
+export async function untrackedDotfiles(dir, listed, max = 5) {
+    try {
+        const r = await runTracked('git', ['ls-files', '-z', '--others', '--directory'], {
+            cwd: dir,
+            timeoutMs: 15_000,
+            maxBuffer: 500_000,
+            env: { ...process.env, GIT_OPTIONAL_LOCKS: '0' },
+        });
+        if (r.code !== 0)
+            return { files: [], more: 0 };
+        const have = new Set(cleanCopyFiles([...listed]));
+        const found = r.stdout
+            .split('\0')
+            .filter((f) => f && !f.endsWith('/'))
+            .filter((f) => {
+            const base = path.posix.basename(f);
+            return base.startsWith('.') && !NOISE.has(base) && !base.startsWith('.localdost-run-') && !have.has(f);
+        })
+            .sort();
+        return { files: found.slice(0, max), more: Math.max(0, found.length - max) };
+    }
+    catch {
+        return { files: [], more: 0 };
+    }
+}
+/**
+ * The sentence that names copyFiles when a worktree run failed and the working folder holds untracked dotfiles that were not copied.
+ * It is posted in PR comments, so it holds no file name: those describe the owner's local secret layout (see copyFilesHintFiles).
+ */
+export function copyFilesHint(found) {
+    if (!found.files.length)
+        return undefined;
+    return "The run happened in a clean worktree, and the working folder has untracked files that were not copied into it. If the tests need them, list them in Copy files in the dot's Test runner settings (runner.copyFiles).";
+}
+/** The names behind copyFilesHint, for the local run page only. Never put them in a PR comment or a ticket. */
+export function copyFilesHintFiles(found) {
+    if (!found.files.length)
+        return undefined;
+    return found.files.join(', ') + (found.more ? ` and ${found.more} more` : '');
+}
+//# sourceMappingURL=copyfiles.js.map

package/dist/runner/copyfiles.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"copyfiles.js","sourceRoot":"","sources":["../../src/runner/copyfiles.ts"],"names":[],"mappings":"AAAA,sHAAsH;AACtH,uFAAuF;AACvF,EAAE;AACF,gHAAgH;AAChH,qEAAqE;AACrE,qHAAqH;AACrH,yEAAyE;AACzE,uHAAuH;AACvH,kHAAkH;AAClH,qHAAqH;AACrH,2EAA2E;AAC3E,6JAA6J;AAC7J,4GAA4G;AAC5G,qFAAqF;AACrF,8DAA8D;AAC9D,OAAO,EACL,SAAS,EACT,SAAS,EACT,UAAU,EACV,SAAS,EACT,aAAa,EACb,SAAS,EACT,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,SAAS,GACV,MAAM,SAAS,CAAC;AACjB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE7D,kHAAkH;AAClH,MAAM,SAAS,GAAG,IAAI,GAAG,IAAI,CAAC;AAS9B,+EAA+E;AAC/E,SAAS,QAAQ,CAAC,KAAa,EAAE,MAAc;IAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACzC,OAAO,GAAG,KAAK,EAAE,IAAI,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;AACxE,CAAC;AAED,4GAA4G;AAC5G,SAAS,SAAS,CAAC,IAAY,EAAE,MAAc;IAC7C,IAAI,GAAG,GAAG,IAAI,CAAC;IACf,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,EAAE,CAAC;QACvE,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAC1B,IAAI,EAAE,CAAC;QACP,IAAI,CAAC;YACH,EAAE,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;QACtB,CAAC;QAAC,MAAM,CAAC;YACP,SAAS,CAAC,GAAG,CAAC,CAAC;YACf,SAAS;QACX,CAAC;QACD,IAAI,EAAE,CAAC,cAAc,EAAE;YAAE,OAAO,iCAAiC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;QAC5F,IAAI,CAAC,EAAE,CAAC,WAAW,EAAE;YAAE,OAAO,4CAA4C,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,YAAY,CAAC;IACjH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,uEAAuE;AACvE,SAAS,OAAO,CAAC,EAAU,EAAE,IAAY;IACvC,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/B,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,OAAO,GAAG,GAAG,IAAI,EAAE,CAAC;QAClB,MAAM,CAAC,GAAG,QAAQ,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,CAAC;YAAE,MAAM;QAClB,GAAG,IAAI,CAAC,CAAC;IACX,CAAC;IACD,OAAO,GAAG,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;AAC9B,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CAAC,CAAuE;IAC3G,MAAM,GAAG,GAAe,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;IAClD,MAAM,KAAK,GAAG,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAC3C,IAAI,CAAC,KAAK,CAAC,MAAM;QAAE,OAAO,GAAG,CAAC;IAC9B,IAAI,QAAgB,CAAC;IACrB,IAAI,QAAgB,CAAC;IACrB,IAAI,KAAa,CAAC;IAClB,IAAI,CAAC;QACH,QAAQ,GAAG,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAChC,QAAQ,GAAG,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAChC,iIAAiI;QACjI,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAChE,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC;IACnF,CAAC;IAAC,MAAM,CAAC;QACP,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,yFAAyF,CAAC,CAAC;QAC1G,OAAO,GAAG,CAAC;IACb,CAAC;IACD,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;QACxB,MAAM,IAAI,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,GAAG,IAAI,GAAG,YAAY,CAAC,CAAC;QACnF,MAAM,GAAG,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,GAAG,EAAE,CAAC;YACR,IAAI,CAAC,yBAAyB,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;YAC/D,SAAS;QACX,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QACrC,IAAI,IAAY,CAAC;QACjB,IAAI,CAAC;YACH,oFAAoF;YACpF,IAAI,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC;QAAC,MAAM,CAAC;YACP,IAAI,CAAC,8BAA8B,CAAC,CAAC;YACrC,SAAS;QACX,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,CAAC;YAC9B,IAAI,CAAC,yEAAyE,CAAC,CAAC;YAChF,SAAS;QACX,CAAC;QACD,IAAI,KAAyB,CAAC;QAC9B,IAAI,MAA0B,CAAC;QAC/B,IAAI,CAAC;YACH,gGAAgG;YAChG,KAAK,GAAG,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,QAAQ,GAAG,SAAS,CAAC,UAAU,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;YACzF,MAAM,EAAE,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;YAC5B,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC;gBACjB,IAAI,CAAC,uBAAuB,CAAC,CAAC;gBAC9B,SAAS;YACX,CAAC;YACD,IAAI,EAAE,CAAC,IAAI,GAAG,SAAS,EAAE,CAAC;gBACxB,IAAI,CAAC,qBAAqB,CAAC,CAAC;gBAC5B,SAAS;YACX,CAAC;YACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAChC,IAAI,QAAQ,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,IAAI,QAAQ,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,EAAE,CAAC;gBACvD,IAAI,CAAC,2BAA2B,CAAC,CAAC;gBAClC,SAAS;YACX,CAAC;YACD,oGAAoG;YACpG,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;YACtC,MAAM,OAAO,GAAG,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;YAC3D,IAAI,OAAO,EAAE,CAAC;gBACZ,IAAI,CAAC,OAAO,CAAC,CAAC;gBACd,SAAS;YACX,CAAC;YACD,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;YACvD,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,EAAE,CAAC;gBAC3C,IAAI,CAAC,uCAAuC,CAAC,CAAC;gBAC9C,SAAS;YACX,CAAC;YACD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YACpD,IAAI,QAAQ,CAAC;YACb,IAAI,CAAC;gBACH,QAAQ,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;YAC7B,CAAC;YAAC,MAAM,CAAC;gBACP,QAAQ,GAAG,SAAS,CAAC;YACvB,CAAC;YACD,IAAI,QAAQ,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC;gBACnC,IAAI,CAAC,qDAAqD,CAAC,CAAC;gBAC5D,SAAS;YACX,CAAC;YACD,iIAAiI;YACjI,MAAM,GAAG,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,QAAQ,GAAG,SAAS,CAAC,OAAO,GAAG,SAAS,CAAC,UAAU,GAAG,SAAS,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;YACrH,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC;gBAChC,IAAI,CAAC,qDAAqD,CAAC,CAAC;gBAC5D,SAAS;YACX,CAAC;YACD,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;YACzB,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;YACrC,IAAI,OAAO,GAAG,CAAC,CAAC;YAChB,OAAO,OAAO,GAAG,IAAI,CAAC,MAAM;gBAAE,OAAO,IAAI,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,CAAC;YACjG,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC;YACpC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACrB,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC,CAAC;QAChE,CAAC;QAAC,MAAM,CAAC;YACP,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAC9B,CAAC;gBAAS,CAAC;YACT,IAAI,KAAK,KAAK,SAAS;gBAAE,SAAS,CAAC,KAAK,CAAC,CAAC;YAC1C,IAAI,MAAM,KAAK,SAAS;gBAAE,SAAS,CAAC,MAAM,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,oDAAoD;AACpD,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,UAAU,EAAE,YAAY,EAAE,gBAAgB,EAAE,OAAO,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC,CAAC;AAEtH;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,GAAW,EAAE,MAAyB,EAAE,GAAG,GAAG,CAAC;IACrF,IAAI,CAAC;QACH,MAAM,CAAC,GAAG,MAAM,UAAU,CAAC,KAAK,EAAE,CAAC,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,aAAa,CAAC,EAAE;YAC/E,GAAG,EAAE,GAAG;YACR,SAAS,EAAE,MAAM;YACjB,SAAS,EAAE,OAAO;YAClB,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,kBAAkB,EAAE,GAAG,EAAE;SACjD,CAAC,CAAC;QACH,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC;YAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;QAChD,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QAClD,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM;aACnB,KAAK,CAAC,IAAI,CAAC;aACX,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;aACpC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;YACZ,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YACpC,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACzG,CAAC,CAAC;aACD,IAAI,EAAE,CAAC;QACV,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,GAAG,CAAC,EAAE,CAAC;IAC/E,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;IAChC,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,KAAwC;IACpE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM;QAAE,OAAO,SAAS,CAAC;IAC1C,OAAO,sNAAsN,CAAC;AAChO,CAAC;AAED,+GAA+G;AAC/G,MAAM,UAAU,kBAAkB,CAAC,KAAwC;IACzE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM;QAAE,OAAO,SAAS,CAAC;IAC1C,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,KAAK,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AAChF,CAAC"}

package/dist/runner/engines.js

@@ -0,0 +1,32 @@
+const RANK = { failed: 4, flaky: 3, passed: 2, skipped: 1, not_run: 0 };
+function resultOf(cases) {
+    if (cases.some((c) => c.status === 'failed' || c.status === 'timedOut'))
+        return 'failed';
+    if (cases.some((c) => c.status === 'flaky'))
+        return 'flaky';
+    if (cases.some((c) => c.status === 'passed'))
+        return 'passed';
+    if (cases.length && cases.every((c) => c.status === 'skipped'))
+        return 'skipped';
+    return 'not_run';
+}
+/**
+ * Folds one engine's result into an item: the worse result wins when another engine already set
+ * one in this run, and the engine joins coveredBy. Skipped cases count for nothing, unless
+ * skippedResult is set and nothing else set a result.
+ */
+export function withEngineResult(t, engine, cases, opts = {}) {
+    const counted = cases.filter((c) => c.status !== 'skipped');
+    if (!counted.length) {
+        // AI-Vision has always reported an all-skipped item as skipped; a discarded generated spec sets nothing.
+        if (opts.skippedResult && cases.length && !(t.resultSource === 'runner' && t.result))
+            return { ...t, result: 'skipped', resultSource: 'runner' };
+        return t;
+    }
+    const result = resultOf(counted);
+    const prior = t.resultSource === 'runner' && t.coveredBy?.length ? t.result : undefined;
+    const merged = prior && RANK[prior] > RANK[result] ? prior : result;
+    const coveredBy = [...new Set([...(t.resultSource === 'runner' ? (t.coveredBy ?? []) : []), engine])];
+    return { ...t, result: merged, resultSource: 'runner', coveredBy };
+}
+//# sourceMappingURL=engines.js.map

package/dist/runner/engines.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"engines.js","sourceRoot":"","sources":["../../src/runner/engines.ts"],"names":[],"mappings":"AAKA,MAAM,IAAI,GAAuD,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;AAE5H,SAAS,QAAQ,CAAC,KAAuB;IACvC,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,QAAQ,IAAI,CAAC,CAAC,MAAM,KAAK,UAAU,CAAC;QAAE,OAAO,QAAQ,CAAC;IACzF,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,OAAO,CAAC;QAAE,OAAO,OAAO,CAAC;IAC5D,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,QAAQ,CAAC;QAAE,OAAO,QAAQ,CAAC;IAC9D,IAAI,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,SAAS,CAAC;QAAE,OAAO,SAAS,CAAC;IACjF,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,CAAc,EAAE,MAAgB,EAAE,KAAuB,EAAE,OAAoC,EAAE;IAChI,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC;IAC5D,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QACpB,yGAAyG;QACzG,IAAI,IAAI,CAAC,aAAa,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,KAAK,QAAQ,IAAI,CAAC,CAAC,MAAM,CAAC;YAAE,OAAO,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC;QACjJ,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAE,CAAC;IAClC,MAAM,KAAK,GAAG,CAAC,CAAC,YAAY,KAAK,QAAQ,IAAI,CAAC,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;IACxF,MAAM,MAAM,GAAG,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;IACpE,MAAM,SAAS,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IACtG,OAAO,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;AACrE,CAAC"}

package/dist/runner/evidence.js

@@ -0,0 +1,114 @@
+// Per-test evidence: which screenshots, video, and trace each test of a Playwright run left in the run's
+// artifacts. The names come from the same rule saveOutputs copies the files by (artifacts.outputArtifactName),
+// so the report can name a file before the copy happens.
+//
+// The JSON report comes from the repo's own test code, so a path in it can name any file on the machine.
+// Only a regular file whose real path lies inside the run's test-results folder is ever named here.
+import { lstatSync, realpathSync } from 'node:fs';
+import path from 'node:path';
+import { outputArtifactName } from './artifacts.js';
+import { reportTests } from './playwright-json.js';
+/** Most screenshots one test lists; a long test keeps its first ones. */
+export const MAX_SHOTS_PER_TEST = 40;
+/**
+ * A test title with the project prefix and the separator style removed, so the step reporter's
+ * "describe > title" and the JSON report's "[project] describe › title" compare equal.
+ */
+export function normTitle(title) {
+    return title
+        .replace(/^\[[^\]]+\]\s*/, '')
+        .split(/\s+[›>]\s+/)
+        .map((s) => s.trim())
+        .join(' > ');
+}
+/** The file a report path names inside `<outDir>/test-results`, as written lexically, or undefined when it is not one of ours. */
+export function outputFile(p, outDir) {
+    const results = path.join(outDir, 'test-results');
+    let root;
+    try {
+        root = realpathSync(results);
+    }
+    catch {
+        return undefined;
+    }
+    const candidates = [path.isAbsolute(p) ? p : path.join(outDir, p)];
+    // Docker writes /out/test-results/...; the same folder is outDir on the host.
+    const m = /(?:^|\/)test-results\/(.+)$/.exec(p.replace(/\\/g, '/'));
+    if (m)
+        candidates.push(path.join(results, m[1]));
+    for (const c of candidates) {
+        try {
+            const lexical = path.resolve(c);
+            const rel = path.relative(path.resolve(results), lexical);
+            if (!rel || rel.startsWith('..') || path.isAbsolute(rel))
+                continue;
+            const real = realpathSync(lexical);
+            const inside = path.relative(root, real);
+            if (!inside || inside.startsWith('..') || path.isAbsolute(inside) || !lstatSync(real).isFile())
+                continue;
+            return lexical;
+        }
+        catch {
+            /* not there */
+        }
+    }
+    return undefined;
+}
+/**
+ * The evidence of every test of a Playwright JSON report, in the order of reportTests() (and so of the parsed
+ * cases). A test with a failing attempt shows that attempt; otherwise its last one. Undefined for a test that
+ * left nothing.
+ */
+export function collectEvidence(report, o) {
+    if (!report || typeof report !== 'object')
+        return [];
+    const results = path.join(o.outDir, 'test-results');
+    const nameOf = (file) => o.storedName?.(file) ?? outputArtifactName(o.prefix, results, file);
+    return reportTests(report).map((t) => {
+        const attempts = (Array.isArray(t.test.results) ? t.test.results : []);
+        if (!attempts.length)
+            return undefined;
+        const pick = [...attempts].reverse().find((r) => r.status !== 'passed' && r.status !== 'skipped') ?? attempts[attempts.length - 1];
+        const retry = Number(pick.retry) || 0;
+        const key = normTitle(t.title);
+        const screenshots = [];
+        const seen = new Set();
+        const add = (name, step) => {
+            if (seen.has(name) || screenshots.length >= MAX_SHOTS_PER_TEST)
+                return;
+            seen.add(name);
+            screenshots.push(step ? { name, step } : { name });
+        };
+        for (const s of o.shots ?? []) {
+            if (s.retry === retry && normTitle(s.title) === key && (!s.project || !t.project || s.project === t.project))
+                add(s.name, s.step);
+        }
+        let video;
+        let trace;
+        const files = (Array.isArray(pick.attachments) ? pick.attachments : []);
+        for (const a of files) {
+            if (typeof a?.path !== 'string')
+                continue;
+            const type = String(a.contentType ?? '');
+            const isImage = type.startsWith('image/');
+            const isVideo = a.name === 'video' && type.startsWith('video/');
+            const isTrace = a.name === 'trace';
+            if (!isImage && !isVideo && !isTrace)
+                continue;
+            const file = outputFile(a.path, o.outDir);
+            if (!file)
+                continue;
+            const name = nameOf(file);
+            if (isVideo)
+                video = name;
+            else if (isTrace)
+                trace = name;
+            else
+                add(name, a.name === 'screenshot' ? 'End of test' : String(a.name ?? ''));
+        }
+        if (!screenshots.length && !video && !trace)
+            return undefined;
+        return { screenshots, ...(video ? { video } : {}), ...(trace ? { trace } : {}) };
+    });
+}
+//# sourceMappingURL=evidence.js.map

package/dist/runner/evidence.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"evidence.js","sourceRoot":"","sources":["../../src/runner/evidence.ts"],"names":[],"mappings":"AAAA,yGAAyG;AACzG,+GAA+G;AAC/G,yDAAyD;AACzD,EAAE;AACF,yGAAyG;AACzG,oGAAoG;AAEpG,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAClD,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAInD,yEAAyE;AACzE,MAAM,CAAC,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAWrC;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAC,KAAa;IACrC,OAAO,KAAK;SACT,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC;SAC7B,KAAK,CAAC,YAAY,CAAC;SACnB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;SACpB,IAAI,CAAC,KAAK,CAAC,CAAC;AACjB,CAAC;AAED,kIAAkI;AAClI,MAAM,UAAU,UAAU,CAAC,CAAS,EAAE,MAAc;IAClD,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAClD,IAAI,IAAY,CAAC;IACjB,IAAI,CAAC;QACH,IAAI,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,UAAU,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IACnE,8EAA8E;IAC9E,MAAM,CAAC,GAAG,6BAA6B,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;IACpE,IAAI,CAAC;QAAE,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC;IAClD,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;QAC3B,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YAChC,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;YAC1D,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;gBAAE,SAAS;YACnE,MAAM,IAAI,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;YACnC,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACzC,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE;gBAAE,SAAS;YACzG,OAAO,OAAO,CAAC;QACjB,CAAC;QAAC,MAAM,CAAC;YACP,eAAe;QACjB,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAYD;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,MAAe,EAAE,CAAkB;IACjE,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ;QAAE,OAAO,EAAE,CAAC;IACrD,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACpD,MAAM,MAAM,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAC7G,OAAO,WAAW,CAAC,MAAc,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QAC3C,MAAM,QAAQ,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAW,CAAC;QACjF,IAAI,CAAC,QAAQ,CAAC,MAAM;YAAE,OAAO,SAAS,CAAC;QACvC,MAAM,IAAI,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,QAAQ,IAAI,CAAC,CAAC,MAAM,KAAK,SAAS,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAE,CAAC;QACpI,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACtC,MAAM,GAAG,GAAG,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAC/B,MAAM,WAAW,GAAgC,EAAE,CAAC;QACpD,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;QAC/B,MAAM,GAAG,GAAG,CAAC,IAAY,EAAE,IAAa,EAAE,EAAE;YAC1C,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,MAAM,IAAI,kBAAkB;gBAAE,OAAO;YACvE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACf,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;QACrD,CAAC,CAAC;QACF,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,IAAI,EAAE,EAAE,CAAC;YAC9B,IAAI,CAAC,CAAC,KAAK,KAAK,KAAK,IAAI,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,OAAO,CAAC;gBAAE,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;QACpI,CAAC;QACD,IAAI,KAAyB,CAAC;QAC9B,IAAI,KAAyB,CAAC;QAC9B,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAW,CAAC;QAClF,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;YACtB,IAAI,OAAO,CAAC,EAAE,IAAI,KAAK,QAAQ;gBAAE,SAAS;YAC1C,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC;YACzC,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YAC1C,MAAM,OAAO,GAAG,CAAC,CAAC,IAAI,KAAK,OAAO,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YAChE,MAAM,OAAO,GAAG,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC;YACnC,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO;gBAAE,SAAS;YAC/C,MAAM,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;YAC1C,IAAI,CAAC,IAAI;gBAAE,SAAS;YACpB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;YAC1B,IAAI,OAAO;gBAAE,KAAK,GAAG,IAAI,CAAC;iBACrB,IAAI,OAAO;gBAAE,KAAK,GAAG,IAAI,CAAC;;gBAC1B,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC;QACjF,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,MAAM,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK;YAAE,OAAO,SAAS,CAAC;QAC9D,OAAO,EAAE,WAAW,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;IACnF,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/runner/host-env.js

@@ -0,0 +1,160 @@
+// The host environment a test process may see (KAT-361). A local run and its setup steps get the server's
+// environment minus every credential the server itself holds, plus the test login the dot names in
+// runner.passEnv. A Docker run gets no host variables at all, only the passEnv ones. This file is the one
+// place that lists what is held back, and test/runner-env.test.ts runs a real child process against it.
+import { PRESETS } from '../connections/presets.js';
+import { listConnections } from '../connections/store.js';
+import { list } from '../db.js';
+import { isPassEnvName, passEnvTarget } from './command.js';
+/**
+ * Names that look like a credential. A match stays out of the test process. This is a net for names nobody
+ * listed; the names the server reads are in SERVER_CREDENTIALS, and a connection's header variable is added
+ * by connectionHeaderNames().
+ */
+export const CREDENTIAL_ENV = /TOKEN|SECRET|PASSWORD|PRIVATE|API_KEY|_KEY$|_HEADERS$|COOKIE|^AWS_|^GITHUB_|^JIRA_|^LINEAR_|^ANTHROPIC_|^NTFY_|^OPENAI_|^SLACK_|^ELEVENLABS_|^LOCALDOST_/i;
+/**
+ * The model and integration credentials the localdost server reads from its own environment. Each one is held back
+ * by name, so a rename of the pattern above cannot let one through. A name the server starts reading and the
+ * pattern misses fails the drift check in test/runner-env.test.ts.
+ */
+export const SERVER_CREDENTIALS = [
+    // Server access and stored secrets.
+    'LOCALDOST_TOKEN',
+    'LOCALDOST_SECRET_KEY',
+    // Model accounts.
+    'ANTHROPIC_API_KEY',
+    'CLAUDE_CODE_OAUTH_TOKEN',
+    'OPENAI_API_KEY',
+    // GitHub.
+    'GITHUB_TOKEN',
+    'GITHUB_APP_ID',
+    'GITHUB_PRIVATE_KEY',
+    'GITHUB_WEBHOOK_SECRET',
+    // Trackers, Slack, phone push.
+    'JIRA_EMAIL',
+    'JIRA_API_TOKEN',
+    'JIRA_WEBHOOK_SECRET',
+    'LINEAR_API_KEY',
+    'LINEAR_WEBHOOK_SECRET',
+    'SLACK_BOT_TOKEN',
+    'SLACK_APP_TOKEN',
+    'NTFY_TOKEN',
+    'VAPID_PRIVATE_KEY',
+    // TinyBee: where the laptop's device key lives.
+    'TINYBEE_DEVICE_KEY_PATH',
+    'TINYBEE_STATE_PATH',
+    'HIVE_ADMIN_TOKEN',
+    'HIVE_JWT_PRIVATE_KEY',
+    'HIVE_VAPID_PRIVATE_KEY',
+    'CF_API_TOKEN',
+    // AI-Vision, Midscene, and the Katalon MCP connection.
+    'AIVISION_INTERNAL_TOKEN',
+    'VEESAN_SESSION_COOKIE',
+    'VEESAN_USER',
+    'VEESAN_PASSWORD',
+    'MIDSCENE_MODEL_API_KEY',
+    'KATALON_MCP_HEADERS',
+    // The True Platform sync (KAT-406): the API key, or the path of the file that holds it. Both stay on the server.
+    'LOCALDOST_KATALON_API_KEY',
+    'LOCALDOST_KATALON_API_KEY_FILE',
+];
+/** The localdost server's own listen address. A test project that reads PORT would start its app on the port of localdost (KAT-97). */
+const SERVER_ENV = new Set(['PORT', 'HOST']);
+/**
+ * Env var names that hold request headers for an MCP connection: the one every preset names (headersEnv) and
+ * the one each saved connection names (headersSecretRef). The value is JSON with a bearer token in it, so no name
+ * pattern is enough: a person may call it anything.
+ */
+export function connectionHeaderNames() {
+    const out = new Set();
+    for (const p of PRESETS)
+        if (p.headersEnv)
+            out.add(p.headersEnv);
+    try {
+        for (const c of listConnections())
+            if (c.headersSecretRef)
+                out.add(c.headersSecretRef);
+    }
+    catch {
+        /* no connection table yet: the presets above still hold */
+    }
+    return out;
+}
+/** The variables the AI-Vision server backend reads when a dot names none of its own (src/runner/aivision/server.ts). */
+const AIVISION_AUTH_DEFAULTS = ['AIVISION_INTERNAL_TOKEN', 'VEESAN_SESSION_COOKIE', 'VEESAN_USER', 'VEESAN_PASSWORD'];
+/**
+ * The AI-Vision sign-in variables of the server: the default names, and each name a dot gives in runner.aivision as
+ * tokenEnv, cookieEnv, userEnv or passwordEnv. The server reads them from its own environment to sign in to the
+ * AI-Vision server, and a dot may call them anything under AIVISION_ or VEESAN_, so no name pattern is enough.
+ * Archived dots count: the variable is still on the host.
+ */
+export function aivisionAuthNames() {
+    const out = new Set(AIVISION_AUTH_DEFAULTS);
+    try {
+        for (const w of list('watches')) {
+            const o = w.runner?.aivision;
+            if (!o)
+                continue;
+            for (const name of [o.tokenEnv, o.cookieEnv, o.userEnv, o.passwordEnv])
+                if (typeof name === 'string' && name.trim())
+                    out.add(name.trim());
+        }
+    }
+    catch {
+        /* no dots table yet: the default names above still hold */
+    }
+    return out;
+}
+/** The names held back by exact match: the server's credentials, every connection's header variable, and the AI-Vision sign-in variables. */
+export function heldBackNames() {
+    return new Set([...SERVER_CREDENTIALS, ...connectionHeaderNames(), ...aivisionAuthNames()]);
+}
+/** True when a test process must not see this variable. `held` defaults to heldBackNames(). */
+export function isCredentialName(name, held = heldBackNames()) {
+    return CREDENTIAL_ENV.test(name) || held.has(name);
+}
+/** The host environment minus anything that holds a credential, and minus the server's PORT and HOST. */
+export function hostVars(env = process.env) {
+    const held = heldBackNames();
+    const out = {};
+    for (const [k, v] of Object.entries(env))
+        if (v !== undefined && !isCredentialName(k, held) && !SERVER_ENV.has(k))
+            out[k] = v;
+    return out;
+}
+/**
+ * The test login a dot passes on: each name in runner.passEnv that is set on the host, under the name the test sees
+ * (`LOCALDOST_TEST_USER` becomes `TEST_USER`). Added after hostVars(), which holds back every LOCALDOST_ name. A name that does not
+ * start with LOCALDOST_TEST_ is dropped here as well as at save, so a row edited by hand cannot forward GITHUB_TOKEN.
+ */
+export function passEnvVars(names, env = process.env) {
+    const out = {};
+    for (const name of names ?? []) {
+        const v = isPassEnvName(name) ? env[name] : undefined;
+        if (v !== undefined && v !== '')
+            out[passEnvTarget(name)] = v;
+    }
+    return out;
+}
+/** A name that says the value is a user or an email: `TEST_USER`, `TEST_ADMIN_EMAIL`. Not a secret, unless the name also says password, token or key. */
+const IDENTIFIER_NAME = /(?:^|_)(?:USER|USERNAME|EMAIL)(?:_|$)/;
+const SECRET_NAME = /PASS|SECRET|TOKEN|KEY|CREDENTIAL|(?:^|_)(?:PWD|PIN|OTP)(?:_|$)/;
+/**
+ * Masks the values of the test login in text a person or a PR comment may read. Playwright's call log of a failed fill()
+ * prints the value it typed, so a password would reach the run page and a comment through the error text. A value of
+ * fewer than 4 characters is left alone: masking it would damage every line. The value of a user or email variable is
+ * left alone as well: a user called `admin` would turn every `/admin/users` in an error line into `[redacted]/users`, and a
+ * user name is no secret. Any other name is masked, so an odd name stays safe.
+ */
+export function valueMasker(vars) {
+    const masked = Object.entries(vars).filter(([name]) => !(IDENTIFIER_NAME.test(name.toUpperCase()) && !SECRET_NAME.test(name.toUpperCase())));
+    const secrets = [...new Set(masked.map(([, v]) => v))].filter((v) => v.length >= 4).sort((a, b) => b.length - a.length);
+    if (!secrets.length)
+        return (text) => text;
+    return (text) => secrets.reduce((acc, v) => acc.split(v).join('[redacted]'), text);
+}
+/** The dot form's view of runner.passEnv: each valid name, what the test sees it as, and whether the host has it set. Never a value. */
+export function passEnvStatus(names, env = process.env) {
+    return names.filter(isPassEnvName).map((name) => ({ name, as: passEnvTarget(name), set: !!env[name] }));
+}
+//# sourceMappingURL=host-env.js.map

package/dist/runner/host-env.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"host-env.js","sourceRoot":"","sources":["../../src/runner/host-env.ts"],"names":[],"mappings":"AAAA,0GAA0G;AAC1G,mGAAmG;AACnG,0GAA0G;AAC1G,wGAAwG;AACxG,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAEhC,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE5D;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GACzB,2JAA2J,CAAC;AAE9J;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAsB;IACnD,oCAAoC;IACpC,iBAAiB;IACjB,sBAAsB;IACtB,kBAAkB;IAClB,mBAAmB;IACnB,yBAAyB;IACzB,gBAAgB;IAChB,UAAU;IACV,cAAc;IACd,eAAe;IACf,oBAAoB;IACpB,uBAAuB;IACvB,+BAA+B;IAC/B,YAAY;IACZ,gBAAgB;IAChB,qBAAqB;IACrB,gBAAgB;IAChB,uBAAuB;IACvB,iBAAiB;IACjB,iBAAiB;IACjB,YAAY;IACZ,mBAAmB;IACnB,gDAAgD;IAChD,yBAAyB;IACzB,oBAAoB;IACpB,kBAAkB;IAClB,sBAAsB;IACtB,wBAAwB;IACxB,cAAc;IACd,uDAAuD;IACvD,yBAAyB;IACzB,uBAAuB;IACvB,aAAa;IACb,iBAAiB;IACjB,wBAAwB;IACxB,qBAAqB;IACrB,iHAAiH;IACjH,2BAA2B;IAC3B,gCAAgC;CACjC,CAAC;AAEF,uIAAuI;AACvI,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAE7C;;;;GAIG;AACH,MAAM,UAAU,qBAAqB;IACnC,MAAM,GAAG,GAAG,IAAI,GAAG,EAAU,CAAC;IAC9B,KAAK,MAAM,CAAC,IAAI,OAAO;QAAE,IAAI,CAAC,CAAC,UAAU;YAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IACjE,IAAI,CAAC;QACH,KAAK,MAAM,CAAC,IAAI,eAAe,EAAE;YAAE,IAAI,CAAC,CAAC,gBAAgB;gBAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;IACzF,CAAC;IAAC,MAAM,CAAC;QACP,2DAA2D;IAC7D,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,yHAAyH;AACzH,MAAM,sBAAsB,GAAG,CAAC,yBAAyB,EAAE,uBAAuB,EAAE,aAAa,EAAE,iBAAiB,CAAC,CAAC;AAEtH;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB;IAC/B,MAAM,GAAG,GAAG,IAAI,GAAG,CAAS,sBAAsB,CAAC,CAAC;IACpD,IAAI,CAAC;QACH,KAAK,MAAM,CAAC,IAAI,IAAI,CAAQ,SAAS,CAAC,EAAE,CAAC;YACvC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC;YAC7B,IAAI,CAAC,CAAC;gBAAE,SAAS;YACjB,KAAK,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,WAAW,CAAC;gBAAE,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,EAAE;oBAAE,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QAC5I,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,2DAA2D;IAC7D,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,6IAA6I;AAC7I,MAAM,UAAU,aAAa;IAC3B,OAAO,IAAI,GAAG,CAAC,CAAC,GAAG,kBAAkB,EAAE,GAAG,qBAAqB,EAAE,EAAE,GAAG,iBAAiB,EAAE,CAAC,CAAC,CAAC;AAC9F,CAAC;AAED,+FAA+F;AAC/F,MAAM,UAAU,gBAAgB,CAAC,IAAY,EAAE,OAA4B,aAAa,EAAE;IACxF,OAAO,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AACrD,CAAC;AAED,yGAAyG;AACzG,MAAM,UAAU,QAAQ,CAAC,MAAyB,OAAO,CAAC,GAAG;IAC3D,MAAM,IAAI,GAAG,aAAa,EAAE,CAAC;IAC7B,MAAM,GAAG,GAA2B,EAAE,CAAC;IACvC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC;QAAE,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,gBAAgB,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;YAAE,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAC9H,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,KAAoC,EAAE,MAAyB,OAAO,CAAC,GAAG;IACpG,MAAM,GAAG,GAA2B,EAAE,CAAC;IACvC,KAAK,MAAM,IAAI,IAAI,KAAK,IAAI,EAAE,EAAE,CAAC;QAC/B,MAAM,CAAC,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACtD,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,EAAE;YAAE,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IAChE,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,yJAAyJ;AACzJ,MAAM,eAAe,GAAG,uCAAuC,CAAC;AAChE,MAAM,WAAW,GAAG,gEAAgE,CAAC;AAErF;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,IAA4B;IACtD,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC;IAC7I,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC;IACxH,IAAI,CAAC,OAAO,CAAC,MAAM;QAAE,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC;IAC3C,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,CAAC;AACrF,CAAC;AAED,wIAAwI;AACxI,MAAM,UAAU,aAAa,CAAC,KAAwB,EAAE,MAAyB,OAAO,CAAC,GAAG;IAC1F,OAAO,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,aAAa,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;AAC1G,CAAC"}