clavarium 0.1.5 → 0.2.0-next.2

package/npm-shrinkwrap.json

@@ -1,17 +1,17 @@
 {
   "name": "clavarium",
-  "version": "0.1.5",
+  "version": "0.2.0-next.2",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "clavarium",
-      "version": "0.1.5",
+      "version": "0.2.0-next.2",
       "license": "MIT",
       "dependencies": {
         "@xterm/addon-fit": "^0.11.0",
         "@xterm/xterm": "^6.0.0",
-        "clavarium-parley": "0.9.0",
+        "clavarium-parley": "0.10.0-next.2",
         "mermaid": "11.17.2",
         "node-pty": "^1.1.0",
         "pdfjs-dist": "6.4.299",
@@ -686,9 +686,9 @@
       }
     },
     "node_modules/clavarium-parley": {
-      "version": "0.9.0",
-      "resolved": "https://registry.npmjs.org/clavarium-parley/-/clavarium-parley-0.9.0.tgz",
-      "integrity": "sha512-9JjM2GVlAq/a3n3G47QG/MSze8RjwiDH4aMqGQhJ92T4W/uDlRjCJiRwVyuPWx7PVAId/+r8sHNIPDAz7K0tzQ==",
+      "version": "0.10.0-next.2",
+      "resolved": "https://registry.npmjs.org/clavarium-parley/-/clavarium-parley-0.10.0-next.2.tgz",
+      "integrity": "sha512-/6pAEMEKgug1FerqBKzqoMcWmnR6eYWtfiGt1Oa1gz9vWFuupxXlTeUFurukgfqLiEVOU6U+g1qJUff8PtTLBQ==",
       "license": "MIT",
       "bin": {
         "parley": "bin/parley.mjs",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clavarium",
-  "version": "0.1.5",
+  "version": "0.2.0-next.2",
   "license": "MIT",
   "type": "module",
   "description": "A conversation is a VM with a terminal in it. Everything else is a folder.",
@@ -43,7 +43,7 @@
   "dependencies": {
     "@xterm/addon-fit": "^0.11.0",
     "@xterm/xterm": "^6.0.0",
-    "clavarium-parley": "0.9.0",
+    "clavarium-parley": "0.10.0-next.2",
     "mermaid": "11.17.2",
     "node-pty": "^1.1.0",
     "pdfjs-dist": "6.4.299",

package/server/api.mjs

@@ -37,6 +37,8 @@
  *   POST /api/updates/apply                 { version }: update to the version that is out (in the background)
  *   POST /api/updates/back                  { version }: go back to a release that is kept (in the background)
  *   GET  /api/git/<name>/outgoing?target=<branch>&branch=<branch>   what would go from the agent's branch, to that branch of the remote
+ *   GET  /api/git/<name>/graph              the branch diagram: branches and their last commits
+ *   GET  /api/git/<name>/commit?id=<sha>    one commit, as a review shows it
  *   POST /api/git/<name>/push               {head, target?, sure?}: exactly that reviewed commit, to exactly that branch
  *   GET  /api/git/<name>/keep               origin kept up to date, checks, automatic sending, log
  *   POST /api/git/<name>/keep               {refreshMinutes?, alert?, checkCommand?, checkSeconds?, runHook?, requireForSend?, fsck?}
@@ -215,6 +217,8 @@ export async function handleApi(request, response, conversations, headers, resou
             if (answered && answerer) return send(200, answerer.log(decodeURIComponent(answered[1]))), true;
             /* A repository: where its commits go, and what would go now. */
             const repo = /^\/api\/git\/([a-z0-9-]{1,32})(\/outgoing|\/keep)?$/.exec(pathname);
+            const drawn = /^\/api\/git\/([a-z0-9-]{1,32})\/(graph|commit)$/.exec(pathname);
+            if (drawn && gitReview) return send(200, drawn[2] === 'graph' ? await gitReview.graph(drawn[1]) : await gitReview.commit(drawn[1], query.get('id'))), true;
             if (repo && repo[2] === '/keep' && gitKeeper) return send(200, gitKeeper.about(repo[1])), true;
             if (repo && gitReview) return send(200, repo[2] ? await gitReview.outgoing(repo[1], { target: query.get('target') ?? undefined, branch: query.get('branch') ?? undefined }) : gitReview.settings(repo[1])), true;
             const watched = /^\/api\/conversations\/([^/]+)\/signin$/.exec(pathname);
@@ -424,6 +428,10 @@ export async function handleApi(request, response, conversations, headers, resou
         if (asking) return send(200, conversations.setAskFirst(decodeURIComponent(asking[1]), body.on)), true;
         const naming = /^\/api\/conversations\/([^/]+)\/chat-name$/.exec(pathname);
         if (naming) return send(200, conversations.setChatName(decodeURIComponent(naming[1]), body.name)), true;
+        const titling = /^\/api\/conversations\/([^/]+)\/title$/.exec(pathname);
+        if (titling) return send(200, conversations.setTitle(decodeURIComponent(titling[1]), body.title)), true;
+        const hiding = /^\/api\/conversations\/([^/]+)\/hidden$/.exec(pathname);
+        if (hiding) return send(200, conversations.setHidden(decodeURIComponent(hiding[1]), body.on)), true;
         const marking = /^\/api\/conversations\/([^/]+)\/voice-mark$/.exec(pathname);
         if (marking) return send(200, conversations.setVoiceMark(decodeURIComponent(marking[1]), body.on)), true;
         const resuming = /^\/api\/conversations\/([^/]+)\/resume$/.exec(pathname);

package/server/conversations.mjs

@@ -6,7 +6,7 @@
  *   - Sleep is a button, never a guess: telling a long job from an idle tool
  *     cannot be done without reading the tool, and this server does not read.
  */
-import { isConversationName } from './names.mjs';
+import { isConversationName, identifierFrom, titleProblem } from './names.mjs';
 import { attachCommand, SOCKET } from './tmux.mjs';
 import { WORK, VM_USER, SHARING_STEP } from './vm.mjs';
 import { resumeOrFresh } from './tools.mjs';
@@ -189,7 +189,8 @@ export class Conversations {
 
     /* Whether a new machine may be made for this request: what `create`
        checks, and the server's room (capacity.mjs). Asked before `create`. */
-    async admit({ name, tool, memoryMb } = {}) {
+    async admit({ name, title, tool, memoryMb } = {}) {
+        if (!name && typeof title === 'string' && !titleProblem(title)) ({ name } = this.#naming({ title }));
         const chosen = this.#tools.find((t) => t.id === tool);
         /* What `create` refuses anyway is said by `create`. */
         if (!chosen || !isConversationName(name) || this.#store.get(name)) return;
@@ -201,7 +202,17 @@ export class Conversations {
     /* `workOnDisk`: the tool works on its machine's own disk instead of in a
        folder kept by the server. Faster for a large code project; but what
        it makes is then not seen from the page, and goes with the machine. */
-    create({ name, tool, memoryMb, workOnDisk }) {
+    /* A conversation is made from the name a person reads (`title`), its
+       identifier drawn from it, or from an identifier alone (the advanced
+       options, a blueprint). The identifier never changes afterwards. */
+    #naming({ name, title }) {
+        if (title !== undefined) { const problem = titleProblem(title); if (problem) throw new Refusal(400, problem); }
+        const id = name || (title !== undefined ? identifierFrom(title, (x) => Boolean(this.#store.get(x))) : name);
+        return { name: id, title: title !== undefined && title !== id ? title : undefined };
+    }
+
+    create({ name: given, title: read, tool, memoryMb, workOnDisk }) {
+        const { name, title } = this.#naming({ name: given, title: read });
         if (!isConversationName(name)) throw new Refusal(400, 'A name is 1 to 32 lower-case letters, digits or hyphens; it starts with a letter and does not end with a hyphen.');
         const chosen = this.#tools.find((t) => t.id === tool);
         if (!chosen) throw new Refusal(400, 'Unknown tool.');
@@ -211,7 +222,7 @@ export class Conversations {
         }
         if (this.#store.get(name)) throw new Refusal(409, 'A conversation already has this name.');
         const now = new Date().toISOString();
-        const conversation = { name, tool, memoryMb: memory, diskGb: DISK_GB, fixed: FIXES, work: workOnDisk === true ? 'disk' : 'kept', phase: 'building', step: 'Starting the machine', createdAt: now, buildingSince: now, progress: buildProgress(now) };
+        const conversation = { name, ...(title ? { title } : {}), tool, memoryMb: memory, diskGb: DISK_GB, fixed: FIXES, work: workOnDisk === true ? 'disk' : 'kept', phase: 'building', step: 'Starting the machine', createdAt: now, buildingSince: now, progress: buildProgress(now) };
         this.#store.put(conversation);
         this.built = this.#build(name, chosen, memory);
         return conversation;
@@ -450,6 +461,28 @@ export class Conversations {
         return this.#store.get(name);
     }
 
+    /* THE NAME A PERSON READS, changed at any time; its identifier stays.
+       Kept only when it differs from the identifier: a conversation made
+       before free names is read by its identifier, and nothing is rewritten. */
+    setTitle(name, title) {
+        const c = this.#store.get(name);
+        if (!c) throw new Refusal(404, 'No such conversation.');
+        const problem = titleProblem(title);
+        if (problem) throw new Refusal(400, problem);
+        this.#store.patch(name, { title: title === name ? undefined : title });
+        return this.#store.get(name);
+    }
+
+    /* Hidden from the list, like a hidden file: it runs, keeps its rights,
+       and is still in Access; the list says how many are hidden. */
+    setHidden(name, on) {
+        const c = this.#store.get(name);
+        if (!c) throw new Refusal(404, 'No such conversation.');
+        if (typeof on !== 'boolean') throw new Refusal(400, 'Say true (hidden from the list) or false (shown).');
+        this.#store.patch(name, { hidden: on ? true : undefined });
+        return this.#store.get(name);
+    }
+
     /* What is dictated into its terminal starts with a microphone sign, once
        per message (true, the default for a tool that is an AI), or not. */
     setVoiceMark(name, on) {

package/server/gitpush.mjs

@@ -40,6 +40,9 @@ export const UNCHANGED_MAX = 50;
 /* A commit message is shown up to this many characters, and the cut is said. */
 export const MESSAGE_MAX = 4000;
 export const REVIEWS_KEPT = 20;
+/* The branch diagram: so many commits, so many of the remote's branches. */
+export const GRAPH_COMMITS = 40;
+export const GRAPH_BRANCHES = 20;
 /* How long a review waits for the reference, and a send or a refresh. */
 export const REVIEW_WAIT_MS = 10_000;
 export const SEND_WAIT_MS = 60_000;
@@ -408,6 +411,66 @@ export class GitReview {
         } finally { got.remove(); }
     }
 
+    /* The workspace of one read, with the remote's history lent to it when
+       there is one, for `work(ws, remoteTips)`; deleted after. */
+    async #withRead(r, work) {
+        const got = await this.#read(r);
+        try {
+            let release = null; let remoteTips = new Map();
+            if (this.#remoteOf(r) && this.#resources.hasOrigin(r.name)) {
+                release = await this.#runner.lock(this.#reference(r.name), REVIEW_WAIT_MS);
+                this.#runner.borrow(got.path, this.#reference(r.name));
+                remoteTips = await this.#tipsIn(this.#reference(r.name));
+            }
+            try { return await work(got, remoteTips); } finally { release?.(); }
+        } finally { got.remove(); }
+    }
+
+    /* THE BRANCH DIAGRAM: the agent's branches, the remote's, and their
+       last commits, newest first in topological order: { branches: [{name,
+       id, side: 'agent'|'remote'}], commits: [{id, parents, subject, date,
+       refs: [{name, side}]}] }. What the agent wrote is escaped as everywhere. */
+    async graph(name) {
+        const r = this.#repository(name);
+        try {
+            return await this.#withRead(r, async (got, remoteTips) => {
+                const branches = got.branches.map((b) => ({ name: escaped(b.name), id: b.id, side: 'agent' }));
+                for (const [b, id] of [...remoteTips].sort(([a], [c]) => a.localeCompare(c)).slice(0, GRAPH_BRANCHES)) branches.push({ name: escaped(b), id, side: 'remote' });
+                const tips = [...new Set(branches.map((b) => b.id))];
+                if (tips.length === 0) return { branches, commits: [] };
+                const log = await this.#runner.in(got.path, ['log', '--topo-order', `--max-count=${GRAPH_COMMITS}`, '-z', '--format=%H%x00%P%x00%aI%x00%s', '--stdin', '--end-of-options'], { input: `${tips.join('\n')}\n`, deadlineMs: 60_000, maxBytes: 4 * 1024 * 1024 });
+                const fields = log.stdout.toString('utf8').split('\0');
+                const commits = [];
+                for (let i = 0; i + 3 < fields.length; i += 4) {
+                    const id = fields[i].replace(/^\n/, '');
+                    if (!isId(id)) break;
+                    commits.push({ id, parents: fields[i + 1].split(' ').filter(isId), date: fields[i + 2], subject: escaped(fields[i + 3]).slice(0, 300),
+                        refs: branches.filter((b) => b.id === id).map((b) => ({ name: b.name, side: b.side })) });
+                }
+                return { branches, commits };
+            });
+        } catch (error) {
+            if (error instanceof GitFailure && error.kind === 'empty') return { branches: [], commits: [] };
+            throw error;
+        }
+    }
+
+    /* ONE COMMIT, as a review shows it: against its first parent (or
+       nothing, for the first commit). Never sent from here. */
+    async commit(name, id) {
+        const r = this.#repository(name);
+        const asked = String(id ?? '');
+        if (!isId(asked)) throw new Refusal(400, 'A commit is named by its full identifier.');
+        return this.#withRead(r, async (got) => {
+            const p = await this.#runner.in(got.path, ['rev-list', '--parents', '--max-count=1', '--end-of-options', asked], { deadlineMs: 60_000 });
+            const ids = p.stdout.toString('latin1').trim().split(' ');
+            if (p.code !== 0 || ids[0] !== asked) throw new Refusal(404, 'This commit is not in the repository.');
+            const parents = ids.slice(1).filter(isId);
+            const shown = await this.#compare(got.path, { head: asked, base: parents[0] ?? EMPTY_TREE, range: [asked], negatives: parents });
+            return { ...shown, id: asked, parents, head: asked, state: 'commit', message: parents.length > 1 ? 'A merge: its changes against its first parent.' : '' };
+        });
+    }
+
     /* What a review shows of head against base, in a workspace: the commits
        (with their whole messages), the true count, the files, the changes,
        and what the changes alone could hide. `range` and `negatives` say

package/server/main.mjs

@@ -70,6 +70,10 @@ export const FILES = {
     '/voice-core.js': ['web/voice-core.js', 'text/javascript; charset=utf-8'],
     '/icons.js': ['web/icons.js', 'text/javascript; charset=utf-8'],
     '/links.js': ['web/links.js', 'text/javascript; charset=utf-8'],
+    '/gitgraph.js': ['web/gitgraph.js', 'text/javascript; charset=utf-8'],
+    /* The review's diff, drawn by diff2html (vendored, pinned: web/vendor/diff2html/LICENSE). */
+    '/vendor/diff2html.js': ['web/vendor/diff2html/diff2html-ui-slim.min.js', 'text/javascript; charset=utf-8'],
+    '/vendor/diff2html.css': ['web/vendor/diff2html/diff2html.min.css', 'text/css; charset=utf-8'],
     '/vendor/xterm.js': [packageFile('@xterm/xterm', 'lib/xterm.js'), 'text/javascript; charset=utf-8'],
     '/vendor/xterm.css': [packageFile('@xterm/xterm', 'css/xterm.css'), 'text/css; charset=utf-8'],
     '/vendor/fit.js': [packageFile('@xterm/addon-fit', 'lib/addon-fit.js'), 'text/javascript; charset=utf-8'],

package/server/names.mjs

@@ -8,3 +8,34 @@ const NAME = /^[a-z](?:[a-z0-9-]{0,30}[a-z0-9])?$/;
 export function isConversationName(value) {
     return typeof value === 'string' && value.length <= NAME_MAX && NAME.test(value);
 }
+
+/* THE NAME A PERSON READS is free: spaces, capitals, accents, emoji. It never
+   reaches a command line (the identifier above does), and the page shows it
+   as text only. Refused: what cannot be seen or reorders what is seen
+   (control characters, line breaks, zero-width and bidirectional marks), and
+   spaces at either end, which would make two names look alike. */
+export const TITLE_MAX = 60;
+const UNSEEN_RANGES = [[0x0, 0x1f], [0x7f, 0x9f], [0xad, 0xad], [0x61c, 0x61c], [0x180e, 0x180e], [0x200b, 0x200f], [0x2028, 0x202e], [0x2060, 0x206f], [0xfeff, 0xfeff], [0xfff9, 0xfffb]];
+const UNSEEN = new RegExp(`[${UNSEEN_RANGES.map(([a, b]) => `\\u{${a.toString(16)}}-\\u{${b.toString(16)}}`).join('')}]`, 'u');
+
+/* The reason it is refused, or '' when it may be a name. */
+export function titleProblem(value) {
+    if (typeof value !== 'string' || value === '') return 'Give a name.';
+    if (UNSEEN.test(value)) return 'A name has no line breaks and no invisible or direction characters.';
+    if (value.trim() !== value) return 'A name does not start or end with a space.';
+    if ([...value].length > TITLE_MAX) return `A name is ${TITLE_MAX} characters at most.`;
+    return '';
+}
+
+/* The identifier drawn from a name: "Location voiture" -> location-voiture;
+   one taken -> location-voiture-2. `taken(id)` says whether it is. */
+export function identifierFrom(title, taken = () => false) {
+    let base = String(title ?? '').normalize('NFKD').replace(/[̀-ͯ]/g, '').toLowerCase()
+        .replace(/[^a-z0-9]+/g, '-').replace(/^[^a-z]+/, '').replace(/-+$/, '');
+    if (!base) base = 'conversation';
+    for (let n = 1; ; n += 1) {
+        const tail = n === 1 ? '' : `-${n}`;
+        const id = `${base.slice(0, NAME_MAX - tail.length).replace(/-+$/, '')}${tail}`;
+        if (isConversationName(id) && !taken(id)) return id;
+    }
+}

package/server/toolbox.mjs

@@ -89,7 +89,7 @@ export class Toolbox {
             const sha256 = createHash('sha256').update(bytes).digest('hex');
             const there = existsSync(`${dir}/${file}`) ? createHash('sha256').update(readFileSync(`${dir}/${file}`)).digest('hex') : '';
             if (there !== sha256) { writeFileSync(`${dir}/.${file}.new`, bytes); renameSync(`${dir}/.${file}.new`, `${dir}/${file}`); }
-            const version = /-(\d+\.\d+\.\d+)\.tgz$/.exec(file)?.[1] ?? '';
+            const version = /-(\d+\.\d+\.\d+(?:-[0-9A-Za-z.]+)?)\.tgz$/.exec(file)?.[1] ?? '';
             tools.push({ name: source.name, version, file, sha256, usage: source.usage(`${TOOLS_PATH}/${file}`) });
         }
         const kept = new Set([...tools.map((t) => t.file), 'index.json', ...(this.#notes ? [NOTES] : [])]);