visualproof 0.2.0 → 0.4.0

package/dist/server/live.js

@@ -39,6 +39,8 @@ import { join } from "node:path";
 import { PROJECT, viewTitle } from "../shared/views.js";
 import { boardSet } from "../shared/board.js";
 import { derivesOn, existsIn } from "../shared/noteplace.js";
+import { packageVersion } from "./version.js";
+import { withoutReasons } from "../shared/timeline.js";
 const TICK = 1000;
 /** outputs quiet this long, and no compile running: the build is over */
 const SETTLE = 2500;
@@ -58,8 +60,6 @@ export const MAX_BUFFERED = 4 << 20;
 const PRESENCE_EVERY = 500;
 /** The graph's modules and their files (meta.modules), per graph read (agentviews.ts, graphOf). */
 const moduleFiles = new WeakMap();
-/** What a stream's page alone is told of it (`hello`). */
-const helloOf = (st) => ({ id: st.id, token: st.token, ...(st.private ? { private: true } : {}) });
 export class Live {
     project;
     /** the site directory and the project's caches (server/dirs.ts) */
@@ -85,6 +85,15 @@ export class Live {
     /** review changes not yet sent: those made in one turn of the event loop go out as one */
     reviewPending = [];
     version = 0;
+    /** this server's process, as its pages know it (UpdateSpec decision 8): the graph's versions are
+     *  counted again by another */
+    instance = randomBytes(6).toString("base64url");
+    /** the VisualProof version this server runs, read as it started */
+    toolVersion = packageVersion();
+    /** what a page is told of VisualProof's releases (server/updates.ts): everything, or the version
+     *  alone (`full` false: a read-only reader, an agent); null where nobody follows them (a test's
+     *  server) */
+    updateStatus = null;
     /** the review's logs (ReviewSpec.md, server/review.ts) */
     review;
     /** who has a page open (CollabSpec.md) */
@@ -140,7 +149,7 @@ export class Live {
         this.editor = editor;
         this.usage = new UsagePass(project, dirs, saved ? 0 : jobs, (l) => this.say(l));
         this.tracker = new BuildTracker(project);
-        this.timeline = new Timeline(dirs.site, (e) => this.send("activity", e));
+        this.timeline = new Timeline(dirs.site, (e) => this.sendActivity(e));
         this.tokens = new AgentTokens(dirs.site);
         this.invites = new Invites(dirs.site);
         // every page knows the names the people invited by a link go by, so that what each did shows
@@ -304,7 +313,7 @@ export class Live {
         // a private reader cannot be followed: what they asked is withdrawn
         if (priv)
             this.asks.withdraw(s.token);
-        this.write(s.res, "hello", helloOf(s));
+        this.write(s.res, "hello", this.helloOf(s));
         if (s.session) {
             if (priv)
                 this.views.hold(s.session, was ? [...(was.view ? [was.view] : []), ...was.tabs] : []);
@@ -660,7 +669,7 @@ export class Live {
                 written = found.written;
                 return found;
             };
-            const r = this.history.record(ex.graph, { at: buildTime(this.project), fingerprint: ex.fingerprint, commit, toolchain: this.project.toolchain, missing, sources });
+            const r = this.history.record(ex.graph, { at: buildTime(this.project), fingerprint: ex.fingerprint, commit, toolchain: this.project.toolchain, missing, sources, tool: this.toolVersion });
             if (!r.written)
                 return renamed;
             const s = r.info;
@@ -913,6 +922,12 @@ export class Live {
         }
         return made;
     }
+    /** The holder of a personal link in force who goes by `name` (CollabSpec decision 9): whom an
+     *  opinion recorded for that name is for (ReviewSpec decision 8). */
+    invited(name) {
+        const r = this.invites.holder(name);
+        return r ? { id: r.id, name: r.name } : undefined;
+    }
     /** The usage pass's contexts of a module (shared/context.ts), when the graph on show has them. */
     contextsOf(module) {
         return this.graph?.prep.usage?.contexts[module] ?? null;
@@ -950,7 +965,53 @@ export class Live {
         if (!this.graph)
             return null;
         const { prep: _, ...info } = this.graph;
-        return info;
+        return { ...info, instance: this.instance };
+    }
+    /** What a stream's page alone is told of it (`hello`), and which server it is (UpdateSpec
+     *  decision 8): its version, and its process. */
+    helloOf(st) {
+        return { id: st.id, token: st.token, ...(st.private ? { private: true } : {}), server: { version: this.toolVersion, instance: this.instance } };
+    }
+    /** How many pages are open on the server (their event streams), read-only readers' too. */
+    get pages() {
+        return this.streams.size;
+    }
+    /** Whether the server is working on the build (an extraction, a re-layout, the usage pass):
+     *  no moment to restart in (UpdateSpec decision 6). */
+    get busy() {
+        return this.extracting || this.usage.status.state === "running";
+    }
+    /** What happened, to every page: a version set aside, without why, to those not told all
+     *  (UpdateSpec decision 11). */
+    sendActivity(e) {
+        if (e.kind !== "tool" || !e.setAside)
+            return this.send("activity", e);
+        const full = `event: activity\ndata: ${JSON.stringify(e)}\n\n`;
+        const slim = `event: activity\ndata: ${JSON.stringify(withoutReasons(e))}\n\n`;
+        for (const st of [...this.streams.values()])
+            this.push(st, st.toldAll ? full : slim);
+    }
+    /** What is known of VisualProof's releases changed: each page is told what it may know of it
+     *  (`toldAll`, as GET /api/updates says it). */
+    updatesChanged() {
+        const status = this.updateStatus;
+        if (!status)
+            return;
+        const full = `event: updates\ndata: ${JSON.stringify(status(true))}\n\n`;
+        const slim = `event: updates\ndata: ${JSON.stringify(status(false))}\n\n`;
+        for (const st of [...this.streams.values()])
+            this.push(st, st.toldAll ? full : slim);
+    }
+    /** The server stops (UpdateSpec decision 9): every page is told why — a restart into another
+     *  version (`update`), or a stop (`bye`) — and its stream ended, so that it comes back to the
+     *  server that answers next. */
+    end(why) {
+        const text = "update" in why ? `event: update\ndata: ${JSON.stringify(why.update)}\n\n` : `event: bye\ndata: ${JSON.stringify({ why: "stopped" })}\n\n`;
+        for (const st of [...this.streams.values()]) {
+            this.streams.delete(st.res);
+            this.byToken.delete(st.token);
+            st.res.end(text);
+        }
     }
     /** What /api/status says: enough for the loader and for a page that just connected. */
     status() {
@@ -975,7 +1036,7 @@ export class Live {
      *  it), `person` the personal link it came by. The stream is named by the server: the page is
      *  told its id, which everyone sees, and a secret for its heartbeats (`hello`); it is gone from
      *  presence when its stream closes. */
-    subscribe(res, session = null, person = null, readOnly = null) {
+    subscribe(res, session = null, person = null, readOnly = null, toldAll = readOnly === null) {
         if (session) {
             // a page that opens one more than a page needs (a reload whose old stream lingers) loses
             // its oldest
@@ -995,12 +1056,14 @@ export class Live {
             connection: "keep-alive",
         });
         res.write("retry: 2000\n\n");
-        const st = { res, id: randomBytes(9).toString("base64url"), token: randomBytes(24).toString("base64url"), session, private: false, person, readOnly };
+        const st = { res, id: randomBytes(9).toString("base64url"), token: randomBytes(24).toString("base64url"), session, private: false, person, readOnly, toldAll };
         this.streams.set(res, st);
         this.byToken.set(st.token, st);
         this.presence.open(st.id);
         res.on("close", () => this.close(st));
-        this.write(res, "hello", helloOf(st));
+        this.write(res, "hello", this.helloOf(st));
+        if (this.updateStatus)
+            this.write(res, "updates", this.updateStatus(st.toldAll));
         this.write(res, "presence", this.presence.list());
         this.write(res, "private", { count: this.presence.privateCount() });
         this.write(res, "people", this.invites.people());