fedipod 1.55.2 → 1.56.0

package/lib/gateway/forum-pages.mjs

@@ -0,0 +1,59 @@
+// forum-pages.mjs — a forum's page at its own host (bb.<gateway>/<forum>/…).
+// Every address under a forum is handed to the forum's own code
+// (ctx.forum.renderPage, netlify/forum-support.mjs), which draws the ones it
+// draws; for the rest, or when drawing fails, the page as the site serves it,
+// which the reader's browser builds. Which addresses are drawn is the forum's
+// business, not this file's.
+
+// A forum's path, and anything under it.
+const VIEW = /^\/([^/]+)\//u;
+// First path segments the bb host gives to something other than a forum.
+const NOT_FORUMS = new Set(['api', 'bb', 'icons', 'u', '.well-known']);
+// How long the edge keeps a drawn page. The forum's documents are dropped
+// from the edge when a post lands and when the forum runs, under the labels
+// the page carries too, so an hour only bounds a change nothing announced.
+// Kept per region, not durably: a page names the scripts of the deploy that
+// drew it.
+const PAGE_EDGE_SECONDS = 3600;
+const MISSING_EDGE_SECONDS = 120;
+
+// The page as the site serves it, read once per running instance: it changes
+// only with a deploy, which starts new ones.
+const shells = new Map();
+async function shellOf(origin, f) {
+  if (shells.has(origin)) return shells.get(origin);
+  const r = await f(`${origin}/bb/index.html`).catch(() => null);
+  const text = r?.ok ? await r.text().catch(() => null) : null;
+  if (text) shells.set(origin, text);
+  return text;
+}
+
+/** The answer for a forum's page at its own host, or null for any other request. */
+export async function routeForumPage(request, ctx) {
+  const url = new URL(request.url);
+  if (!/^bb\./u.test(url.hostname)) return null;
+  const m = VIEW.exec(url.pathname);
+  if (!m || NOT_FORUMS.has(m[1])) return null;
+  if (request.method !== 'GET' && request.method !== 'HEAD') return { status: 405, headers: { allow: 'GET, HEAD' }, body: '' };
+  const shell = await shellOf(url.origin, ctx.siteFetch || globalThis.fetch.bind(globalThis));
+  if (!shell) return { status: 503, headers: { 'content-type': 'text/plain', 'cache-control': 'no-store', 'retry-after': '30' }, body: 'the forum\'s page is not available right now\n' };
+  const page = (status, body, headers) => ({ status, headers: { 'content-type': 'text/html; charset=utf-8', 'cache-control': 'no-cache', ...headers }, body });
+  // An address with a query is a sign-in coming back, or nothing a reader
+  // follows: the page builds it.
+  const draws = !!ctx.forum?.renderPage && !url.search;
+  // A drawing not done in time goes on after the page has gone, where the
+  // host lets work outlive its answer (ctx.waitUntil): the next reader's
+  // drawing then finds the forum's documents at hand.
+  const drawn = draws ? await ctx.forum.renderPage({ url: url.href, shell, keepGoing: ctx.waitUntil || null }).catch(() => null) : null;
+  if (drawn) {
+    const hold = drawn.status === 404 ? MISSING_EDGE_SECONDS : PAGE_EDGE_SECONDS;
+    return page(drawn.status, drawn.html, {
+      'netlify-cdn-cache-control': `public, s-maxage=${hold}, stale-while-revalidate=${hold * 4}`,
+      'netlify-cache-tag': drawn.tags.join(','),
+    });
+  }
+  // Not drawn. Where drawing was tried, this answer is not kept, so the next
+  // reader gets a drawn page; where nothing here draws, it is the same page
+  // for everyone and is kept like one.
+  return page(200, shell, draws || url.search ? {} : { 'netlify-cdn-cache-control': `public, s-maxage=${PAGE_EDGE_SECONDS}` });
+}

package/lib/gateway/front-core.mjs

@@ -26,6 +26,7 @@ import { routeQuietApi, noteOpened, noteReceived, closedState, accountState, clo
 import { holdsMail, mayBeAway, isPresent, holdingPut, afterHeld, routeHereApi, routeKeeperApi, routePushApi, routeAlertApi } from './held-mail.mjs';
 import { routeCheckApi, missingLetter } from './check-letter.mjs';
 import { routeNoticesApi } from './notices.mjs';
+import { routeForumPage } from './forum-pages.mjs';
 import { withSecurityHeaders } from './headers.mjs';
 import { claimedWebId, verifyPodToken } from './token-claims.mjs';
 
@@ -307,7 +308,7 @@ function identFor(rec, policy = null) {
 //                                          an adapter that reads a store directly and so
 //                                          must confine the read itself.
 export async function routeFront(request, ctx) {
-  const out = await route(request, ctx);
+  const out = (await routeForumPage(request, ctx)) || await route(request, ctx);
   return { ...out, headers: withSecurityHeaders(out.headers, out.body) };
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fedipod",
-  "version": "1.55.2",
+  "version": "1.56.0",
   "description": "Standalone single-actor ActivityPub agent whose wire face, RDF truth and state all live on a Solid pod (CSS). Bundles a Phanpy UI and a Mastodon client-API facade.",
   "type": "module",
   "license": "MIT",
@@ -55,7 +55,7 @@
     "install-service": "node bin/fedipod.mjs install-service",
     "uninstall-service": "node bin/fedipod.mjs uninstall-service",
     "prepublishOnly": "npm test",
-    "test": "node claude/smoke-tests/agent-smoke.mjs && node claude/smoke-tests/front-hard-test.mjs && node claude/smoke-tests/copy-test.mjs && node claude/smoke-tests/copy-mode-test.mjs && node claude/smoke-tests/hold-test.mjs && node claude/smoke-tests/masto-gateway-test.mjs && node claude/smoke-tests/admin-facade-smoke.mjs && node scripts/check-pod-calls.mjs && node scripts/verify-ui.mjs && node --test claude/smoke-tests/forum-signup-form.test.mjs claude/smoke-tests/door-verify.test.mjs claude/smoke-tests/oauth-signin.test.mjs claude/smoke-tests/app-registration.test.mjs claude/smoke-tests/push-signout.test.mjs claude/smoke-tests/token-fetches.test.mjs claude/smoke-tests/signin-hardening.test.mjs claude/smoke-tests/load-fixes.test.mjs claude/smoke-tests/unread-docs.test.mjs claude/smoke-tests/post-text-once.test.mjs claude/smoke-tests/connected-pod-only.test.mjs claude/smoke-tests/check-letter.test.mjs claude/smoke-tests/gone-through-relay.test.mjs claude/smoke-tests/connected-feeds.test.mjs && node scripts/check-sizes.mjs && node scripts/test-dependents.mjs && node claude/validation/browser-agent/all.mjs",
+    "test": "node claude/smoke-tests/agent-smoke.mjs && node claude/smoke-tests/front-hard-test.mjs && node claude/smoke-tests/copy-test.mjs && node claude/smoke-tests/copy-mode-test.mjs && node claude/smoke-tests/hold-test.mjs && node claude/smoke-tests/masto-gateway-test.mjs && node claude/smoke-tests/admin-facade-smoke.mjs && node scripts/check-pod-calls.mjs && node scripts/verify-ui.mjs && node --test claude/smoke-tests/forum-signup-form.test.mjs claude/smoke-tests/door-verify.test.mjs claude/smoke-tests/oauth-signin.test.mjs claude/smoke-tests/app-registration.test.mjs claude/smoke-tests/push-signout.test.mjs claude/smoke-tests/token-fetches.test.mjs claude/smoke-tests/signin-hardening.test.mjs claude/smoke-tests/load-fixes.test.mjs claude/smoke-tests/unread-docs.test.mjs claude/smoke-tests/post-text-once.test.mjs claude/smoke-tests/connected-pod-only.test.mjs claude/smoke-tests/check-letter.test.mjs claude/smoke-tests/gone-through-relay.test.mjs claude/smoke-tests/connected-feeds.test.mjs claude/smoke-tests/forum-pages.test.mjs && node scripts/check-sizes.mjs && node scripts/test-dependents.mjs && node claude/validation/browser-agent/all.mjs",
     "verify-ui": "node scripts/verify-ui.mjs",
     "build:sw": "node scripts/build-app.mjs --entry web/app/sw-src.mjs --out web/app/dist/sw.js",
     "build:boot": "node scripts/build-app.mjs --entry web/app/boot.mjs --out web/app/dist/boot.js",
@@ -97,7 +97,6 @@
     "package-lock.json": "npm:empty-npm-package@1.0.0"
   },
   "devDependencies": {
-    "esbuild": "^0.28.2",
-    "fedipod-bb": "^0.4.4"
+    "esbuild": "^0.28.2"
   }
 }

package/scripts/build-app.mjs

@@ -67,6 +67,9 @@ if (import.meta.url === `file://${process.argv[1]}`) {
   const entry = args[args.indexOf('--entry') + 1] || path.join(root, 'web/app/agent.mjs');
   const out = args[args.indexOf('--out') + 1] || path.join(root, 'web/app/dist/agent.js');
   const format = args.includes('--format') ? args[args.indexOf('--format') + 1] : 'esm';
+  // The app's "make a forum" is built from the forum's own folder, as it is now.
+  const { bringForum } = await import('./forum-package.mjs');
+  bringForum();
   const { bytes } = await buildApp({ entry, out, format });
   console.log(`built ${path.relative(root, out)} — ${Math.round(bytes / 1024)} KB`);
 }

package/scripts/check-netlify-bundles.mjs

@@ -18,6 +18,9 @@ const tmp = fs.mkdtempSync(path.join(os.tmpdir(), 'fn-bundles-'));
 let fails = 0;
 const check = (ok, msg) => { console.log(`${ok ? 'PASS' : 'FAIL'}  ${msg}`); if (!ok) fails++; };
 try {
+  // The functions carry the forum as it is in its own folder now.
+  const { bringForum } = await import('./forum-package.mjs');
+  bringForum();
   execFileSync('netlify', ['functions:build', '--src', path.join(root, 'netlify/functions'), '--functions', path.join(tmp, 'zips')],
     { cwd: root, stdio: 'ignore' });
   const manifest = JSON.parse(fs.readFileSync(path.join(tmp, 'zips/manifest.json'), 'utf8'));

package/scripts/forum-package.mjs

@@ -0,0 +1,26 @@
+// forum-package.mjs — the forum (fedipod-bb) that fedipod.net runs and
+// serves, taken from the forum's own folder every time, not from a version
+// FediPod pins: the checkout beside FediPod, or a clone of the forum's GitHub
+// main where there is none (scripts/dependents.mjs). It is packed as npm would
+// publish it and put in node_modules without touching FediPod's package list,
+// so nothing FediPod records names a forum version. Staging the site, the
+// bundle check and the app build each bring it first.
+import fs from 'node:fs'; import os from 'node:os'; import path from 'node:path';
+import { execFileSync } from 'node:child_process';
+import { fetchDependent, root } from './dependents.mjs';
+
+/** The forum from its folder, installed in node_modules. Returns its folder and version. */
+export function bringForum({ log = console.log } = {}) {
+  const dir = fetchDependent('fedipod-bb', { log });
+  const tmp = fs.mkdtempSync(path.join(os.tmpdir(), 'forum-pack-'));
+  try {
+    const packed = JSON.parse(execFileSync('npm', ['pack', dir, '--pack-destination', tmp, '--ignore-scripts', '--json'],
+      { cwd: root, encoding: 'utf8', stdio: ['ignore', 'pipe', 'ignore'] }))[0];
+    execFileSync('npm', ['install', '--no-save', '--no-audit', '--no-fund', '--ignore-scripts', path.join(tmp, packed.filename)],
+      { cwd: root, stdio: 'ignore' });
+    log(`forum: fedipod-bb ${packed.version} from ${path.relative(root, dir) || dir}`);
+    return { dir, version: packed.version };
+  } finally { fs.rmSync(tmp, { recursive: true, force: true }); }
+}
+
+if (import.meta.url === `file://${process.argv[1]}`) bringForum();

package/scripts/stage-site.mjs

@@ -14,8 +14,11 @@
 import fs from 'node:fs'; import path from 'node:path'; import { fileURLToPath } from 'node:url';
 import { createHash } from 'node:crypto';
 import { readyDependent } from './dependents.mjs';
+import { bringForum } from './forum-package.mjs';
 const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..');
 const site = path.join(root, 'web/app/site');
+// The forum's page is copied from the forum's own folder, as it is now.
+bringForum({ log: () => {} });
 fs.rmSync(site, { recursive: true, force: true }); fs.mkdirSync(path.join(site, 'app'), { recursive: true });
 const cp = (from, to) => fs.copyFileSync(path.resolve(root, from), path.join(site, to));
 cp('web/app/index.html', 'index.html');
@@ -219,6 +222,12 @@ fs.writeFileSync(path.join(site, '_redirects'), [
     `https://${h}/update.js /update.js      200!`,
     `https://${h}/build.json /build.json     200!`,
     `https://${h}/api/*     /.netlify/functions/front  200!`,
+    // The forum's host answers /robots.txt with the forum's own.
+    `https://${h}/robots.txt /bb/robots.txt  200!`,
+    // Every address under a forum goes to the forum's code, which draws the
+    // ones it draws (lib/gateway/forum-pages.mjs); the rest get the page.
+    `https://${h}/:forum/        /.netlify/functions/front  200!`,
+    `https://${h}/:forum/*       /.netlify/functions/front  200!`,
     `https://${h}/*         /bb/index.html  200!`,
   ]),
   '# the in-browser app, served static (these win over the project catch-all)',
@@ -267,7 +276,13 @@ fs.writeFileSync(path.join(site, '_redirects'), [
 // own /u/<handle>/ or a pod named outright. Its script is a module file of
 // its own, so it is served under the same `script-src 'self'` as the app.
 fs.mkdirSync(path.join(site, 'bb'), { recursive: true });
-for (const f of ['index.html', 'bb.js', 'read.mjs', 'masto.mjs', 'pod.mjs', 'markdown.mjs', 'seen.mjs', 'mine.mjs', 'private.mjs', 'oidc-session.mjs']) cp(`node_modules/fedipod-bb/site/${f}`, `bb/${f}`);
+// Every file the forum's page ships, whatever the forum names them (its
+// robots.txt among them): the forum decides what its page is made of.
+// Editor leftovers and hidden files are not part of it.
+for (const f of fs.readdirSync(path.join(root, 'node_modules/fedipod-bb/site'))) {
+  if (/^[.#]|~$/u.test(f)) continue;
+  cp(`node_modules/fedipod-bb/site/${f}`, `bb/${f}`);
+}
 cp('web/admin/tokens.css', 'bb/tokens.css');   // the site's shared palette, size and family
 cp('node_modules/fediverse-session/oidc-session.mjs', 'bb/solid-oidc-session.mjs');   // signing in to a pod: the library the forum's binding names
 // The account library's demo page, with the library beside it, under /demo/:
@@ -292,15 +307,22 @@ cp(path.join(sessionRepo, 'demo.html'), 'demo/index.html');
   const sub = (n, pairs) => { let t = fs.readFileSync(bb(n), 'utf8');
     for (const [a, b] of pairs) t = t.split(a).join(b); fs.writeFileSync(bb(n), t); };
   sub('oidc-session.mjs', [["'fediverse-session/oidc-session.mjs'", `'./solid-oidc-session.mjs?v=${stamp('solid-oidc-session.mjs')}'`]]);
-  sub('pod.mjs', [["'./oidc-session.mjs'", `'./oidc-session.mjs?v=${stamp('oidc-session.mjs')}'`],
-    ["'./markdown.mjs'", `'./markdown.mjs?v=${stamp('markdown.mjs')}'`],
-    ["'./private.mjs'", `'./private.mjs?v=${stamp('private.mjs')}'`],
-    ["'./mine.mjs'", `'./mine.mjs?v=${stamp('mine.mjs')}'`]]);
-  sub('bb.js', [["'./read.mjs'", `'./read.mjs?v=${stamp('read.mjs')}'`], ["'./masto.mjs'", `'./masto.mjs?v=${stamp('masto.mjs')}'`],
-    ["'./pod.mjs'", `'./pod.mjs?v=${stamp('pod.mjs')}'`], ["'./seen.mjs'", `'./seen.mjs?v=${stamp('seen.mjs')}'`],
-    ["'./markdown.mjs'", `'./markdown.mjs?v=${stamp('markdown.mjs')}'`],
-    ["'./mine.mjs'", `'./mine.mjs?v=${stamp('mine.mjs')}'`]]);
-  sub('index.html', [['"/bb/bb.js"', `"/bb/bb.js?v=${stamp('bb.js')}"`], ['"/bb/tokens.css"', `"/bb/tokens.css?v=${stamp('tokens.css')}"`]]);
+  // Every module names the others it loads by their stamped address, and each
+  // is stamped only after the ones it names, so one module is one address
+  // wherever it is loaded from.
+  const modules = fs.readdirSync(path.join(site, 'bb')).filter((n) => /\.m?js$/u.test(n));
+  const loads = (n) => [...fs.readFileSync(bb(n), 'utf8').matchAll(/from '\.\/([^'?]+)'/gu)].map((m) => m[1]).filter((m) => modules.includes(m));
+  const done = new Set();
+  while (done.size < modules.length) {
+    const ready = modules.filter((n) => !done.has(n) && loads(n).every((m) => done.has(m)));
+    if (!ready.length) throw new Error(`stage-site: the forum page's modules load each other in a circle (${modules.filter((n) => !done.has(n)).join(', ')})`);
+    for (const n of ready) {
+      sub(n, loads(n).map((m) => [`'./${m}'`, `'./${m}?v=${stamp(m)}'`]));
+      done.add(n);
+    }
+  }
+  sub('index.html', [...fs.readFileSync(bb('index.html'), 'utf8').matchAll(/"\/bb\/([^"?]+)"/gu)].map((m) => m[1])
+    .filter((n) => fs.existsSync(bb(n))).map((n) => [`"/bb/${n}"`, `"/bb/${n}?v=${stamp(n)}"`]));
 }
 injectUpdate(path.join(site, 'bb/index.html'));
 injectUpdate(path.join(site, 'index.html'));