clavarium 0.2.0-next.1 → 0.2.0-next.2

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "clavarium",
-  "version": "0.2.0-next.1",
+  "version": "0.2.0-next.2",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "clavarium",
-      "version": "0.2.0-next.1",
+      "version": "0.2.0-next.2",
       "license": "MIT",
       "dependencies": {
         "@xterm/addon-fit": "^0.11.0",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clavarium",
-  "version": "0.2.0-next.1",
+  "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.",

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);

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'],