@openmeet/snowglobe 0.3.0-rc.1 → 0.3.0

package/lib/apps.mjs

@@ -15,7 +15,7 @@ import { existsSync, mkdirSync, readFileSync, renameSync, writeFileSync } from '
 import { join } from 'node:path';
 import { ROOT, globeFacts, paths } from './env.mjs';
 
-const HEADER = '# Written by bin/snowglobe.mjs app from https/apps; rerun it instead of editing.\n';
+const HEADER = '# Written by snowglobe app from https/apps; rerun it instead of editing.\n';
 
 /**
  * The first saved route whose ending is `app`, or null. app.<domain> is where the apps are, so an
@@ -25,7 +25,7 @@ export const appEnding = (apps) => apps.find((a) => a.ending === 'app') ?? null;
 
 export const appEndingMessage = (file, a) =>
   `${file}: the line "${formatApps([a]).trim()}" claims the ending app, which is where the apps are (${a.name}.app.<domain>); ` +
-  `remove the route (bin/snowglobe.mjs app --remove ${a.name}) or give it another ending`;
+  `remove the route (snowglobe app --remove ${a.name}) or give it another ending`;
 
 /** The routes in an apps file's text: [{ name, port, ending }], ending null when none. */
 export function parseApps(text) {
@@ -85,7 +85,7 @@ export const writeApps = (p, apps) => put(p.apps, formatApps(apps));
 export function renderRoutes({ root = ROOT, state, env = process.env } = {}) {
   const p = paths(root, state);
   const pageJson = join(p.globe, 'page.json');
-  if (!existsSync(pageJson)) throw new Error(`No ${pageJson}: run bin/snowglobe.mjs up, which renders it`);
+  if (!existsSync(pageJson)) throw new Error(`No ${pageJson}: run snowglobe up, which renders it`);
   const { domain } = globeFacts({ root, state, env });
   const apps = readApps(p);
   const bad = appEnding(apps);

package/lib/render.mjs

@@ -452,14 +452,14 @@ export function renderGlobe(globe, base, { stateDir, globeDir = join(stateDir ??
   }
 
   const header = (c) =>
-    `${c} Written by bin/snowglobe.mjs render from ${source}; render again instead of editing.\n`;
+    `${c} Written by snowglobe render from ${source}; render again instead of editing.\n`;
 
   const compose =
     header('#') +
     `# The https globe "${globe.globe}" at ${D}: ${globe.pds.map((p) => p.name).join(', ')}` +
     (globe.grouphosts.length ? `; group hosts ${globe.grouphosts.map((g) => g.name).join(', ')}` : '') +
     '.\n' +
-    '# Run it with bin/snowglobe.mjs up, which renders this file first.\n\n' +
+    '# Run it with snowglobe up, which renders this file first.\n\n' +
     // YAML 1.1 quoting, so a value such as restart's "no" stays a string to compose.
     stringify({ services, volumes, networks: { [NETWORK]: null } }, { lineWidth: 0, nullStr: '', aliasDuplicateObjects: false, version: '1.1' });
 
@@ -514,15 +514,18 @@ export function renderGlobe(globe, base, { stateDir, globeDir = join(stateDir ??
     const named = Object.entries(IMAGE_NAMES).find(([, ref]) => ref === image)?.[0];
     return named ?? image.split('/').pop().replace(/@sha256:([0-9a-f]{12})[0-9a-f]+$/, '@sha256:$1…');
   };
+  // What the globe is made of, as the page's first line names it: only what runs.
+  const parts = [globe.pds.length === 1 ? 'PDS' : 'PDSs', 'PLC directory', on.relay && 'relay', on.jetstream && 'Jetstream'].filter(Boolean);
   const page = {
     globe: globe.globe,
     domain: D,
     about:
-      'An atproto network on this machine: its own PDSs, PLC directory, relay and Jetstream. Its accounts live in its own directory, not the public one, so Bluesky cannot find anything here. An app is handed this network\'s addresses (snowglobe env), not Bluesky\'s.',
+      `An atproto network on this machine: its own ${parts.slice(0, -1).join(', ')} and ${parts.at(-1)}. Its accounts live in its own directory, not the public one, so Bluesky cannot find anything here. An app is handed this network's addresses (snowglobe env), not Bluesky's.`,
     accountsNote:
       `Every account on the network, on each of its ${globe.pds.length} PDS${globe.pds.length === 1 ? '' : 's'}` +
       (globe.grouphosts.length ? `, and every group on its group host${globe.grouphosts.length === 1 ? '' : 's'}.` : '.'),
-    ...(on.jetstream ? { feed: '/subscribe' } : {}),
+    // Without Jetstream the page has no feed to follow, and says so instead of reconnecting.
+    feed: on.jetstream ? '/subscribe' : false,
     services: [
       ...globe.pds.map((p) => [
         'PDS',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmeet/snowglobe",
-  "version": "0.3.0-rc.1",
+  "version": "0.3.0",
   "description": "Standalone, testable ATProto development network for local development and CI",
   "type": "module",
   "bin": {

package/snowglobe.default.yml

@@ -1,8 +1,11 @@
 # The default snowglobe: one current PDS, a PLC directory and Jetstream, all at https names, with
 # Slingshot and PDSls (the record browser) beside them.
-# Copy this file to snowglobe.yml (here, or in your app's repo) and run bin/snowglobe.mjs up.
-# The commented sections below add more; docs/snowglobe.md says what each one does, and
-# docs/examples/atmo.yml is the whole thing: three PDSes, a relay and a lexicon authority.
+# Copy this file to snowglobe.yml (here, or in your app's repo) and run snowglobe up
+# (bin/snowglobe.mjs up from a checkout of snowglobe). The commented sections below add more.
+# What each one does:
+#   https://github.com/OpenMeet-Team/snowglobe/blob/main/docs/snowglobe.md
+# The whole thing, three PDSes, a relay and a lexicon authority:
+#   https://github.com/OpenMeet-Team/snowglobe/blob/main/docs/examples/atmo.yml
 
 globe: snowglobe
 domain: local.snowglobe.at     # every name below is under it
@@ -26,7 +29,7 @@ services:                      # these are the defaults, each true or false
   jetstream: true
   slingshot: true              # answers a handle's DID and PDS inside the network; needs jetstream
   pdsls: true                  # https://pdsls.local.snowglobe.at, a browser for the network's records
-  tap: false                   # sends an app the events of one collection (true, or a map; see docs/snowglobe.md)
+  tap: false                   # sends an app the events of one collection (true, or a map; see snowglobe.md above)
   # relay: auto                # auto: on when there is more than one PDS
 
 # Where every PDS resolves lexicons (NSIDs) from. Name a PDS that is in this file.
@@ -45,7 +48,8 @@ accounts:                      # <name>@<pds>; up makes each one
   - bob@main
 
 # Your app, reached at https://myapp.app.local.snowglobe.at, with settings from the snowglobe.
-# `snowglobe env` hands them over; docs/your-app.md has the names.
+# `snowglobe env` hands them over. The names:
+#   https://github.com/OpenMeet-Team/snowglobe/blob/main/docs/your-app.md
 # apps:
 #   - name: myapp
 #     local: { port: 5173 }

package/stack/https/nginx.conf.template

@@ -96,7 +96,7 @@ server {
     listen 443 ssl;
     server_name *.app.${SG_DOMAIN};
     if ($snowglobe_app = "") {
-        return 404 "No app is registered at $host (bin/snowglobe.mjs app).\n";
+        return 404 "No app is registered at $host (snowglobe app).\n";
     }
     location / {
         proxy_pass http://$snowglobe_app;

package/stack/page/index.html

@@ -233,7 +233,8 @@
     if (tally.people != null) parts.push(plural(tally.people, "person", "people"));
     if (tally.groups) parts.push(plural(tally.groups, "group", "groups"));
     var line = parts.length ? parts.join(" and ") + ". " : "";
-    document.getElementById("tally").textContent = line + plural(tally.writes, "write", "writes") + " in the last 24 hours.";
+    // writes is null on a network with no feed to count them from.
+    document.getElementById("tally").textContent = line + (tally.writes == null ? "" : plural(tally.writes, "write", "writes") + " in the last 24 hours.");
   }
 
   function health(domain, services) {
@@ -380,6 +381,15 @@
     connect();
   }
 
+  // A network with no Jetstream has no feed: the panel says so instead of reconnecting forever.
+  function noActivity() {
+    document.getElementById("stream").style.display = "none";
+    document.getElementById("count").parentNode.style.display = "none";
+    var body = document.getElementById("events");
+    body.textContent = "";
+    add(body, el("p", { "class": "empty" }, "This network runs no Jetstream, so its writes are not followed here."));
+  }
+
   getJSON("/snowglobe.json").then(function (g) {
     document.title = g.globe + " · Snowglobe network";
     document.getElementById("title").textContent = g.globe;
@@ -396,12 +406,14 @@
     }
     if (g.about) document.getElementById("about").textContent = g.about;
     if (g.accountsNote) document.getElementById("accounts-note").textContent = g.accountsNote;
-    var feed = g.feed || "wss://jetstream." + g.domain + "/subscribe";
-    if (feed.charAt(0) === "/") feed = "wss://" + location.host + feed;
+    // feed false: the network runs no Jetstream. Unset, Jetstream is at its usual public name.
+    var feed = g.feed === false ? null : g.feed || "wss://jetstream." + g.domain + "/subscribe";
+    if (feed && feed.charAt(0) === "/") feed = "wss://" + location.host + feed;
+    if (!feed) { tally.writes = null; noActivity(); }
     showTally();
     health(g.domain, g.services || SERVICES);
     // The feed names accounts by handle, so it waits for the account list.
-    accounts(g.accounts || ACCOUNTS).catch(function () {}).then(function () { activity(feed); });
+    accounts(g.accounts || ACCOUNTS).catch(function () {}).then(function () { if (feed) activity(feed); });
   });
 })();
 </script>