pmtiles-swarm 0.3.1 → 0.3.2

package/CHANGELOG.md

@@ -7,6 +7,23 @@
 ### 🐞 Bug fixes
 - _...Add new stuff here..._
 
+## 0.3.2
+### ✨ Features and improvements
+- **The console has a footer naming the version it is running**, beside `© <year> TechIdiots LLC`
+  and a link to the source. The version comes from `package.json` through `/api/status` rather than
+  being written into the page, since the number on screen is the one somebody quotes when reporting
+  a problem.
+
+### 📚 Documentation
+- **How to update an installed service**, which was missing: reinstall into the same prefix and
+  restart. The restart is not optional — the Python sidecar is started with the process and lives
+  as long as it does, so a new one sits on disk doing nothing until then, and most of what changes
+  between releases is in there.
+- The WebRTC check given in two places imported a directory path, which ESM refuses whatever the
+  state of the install — so it reported a failure that was never about WebRTC. It now imports
+  `node-datachannel` by name from the install directory, which is the binary the install script
+  fetches.
+
 ## 0.3.1
 
 Depends on pmtiles-torrent 0.3.0, which is what carries the resume-data fix below to an installed

package/docs/running-as-a-service.md

@@ -104,8 +104,8 @@ the prebuilt binary WebTorrent needs for WebRTC, and it is not in the published
 tarball. Check it landed:
 
 ```sh
-sudo -u pmtiles-swarm -H node -e \
-  "import('/var/lib/pmtiles-swarm/node_modules/webtorrent').then(() => console.log('ok'))"
+cd /var/lib/pmtiles-swarm && sudo -u pmtiles-swarm -H node -e \
+  "import('node-datachannel').then(() => console.log('webrtc ok'))"
 ```
 
 `npm approve-scripts node-datachannel` records the approval in `package.json`
@@ -243,6 +243,43 @@ Four listeners, and only the peer ports want a firewall rule. See
 | `port` — 8090 | your proxy or CDN |
 | `adminPort` — 8091, bound to `127.0.0.1` | nothing; that is the point |
 
+## Updating
+
+```sh
+sudo -u pmtiles-swarm -H npm install --prefix /var/lib/pmtiles-swarm pmtiles-swarm@latest
+sudo systemctl restart pmtiles-swarm
+```
+
+**The restart is not optional.** The Python sidecar is started with the process
+and lives as long as it does, so a new sidecar sits on disk doing nothing until
+the service is restarted. Most of what changes between releases is in there.
+
+Nothing under `/etc/pmtiles-swarm` is touched, and restarting does not re-check
+the archives: a clean stop writes resume data, and `TimeoutStopSec` above
+leaves room for it.
+
+Confirm both halves moved, since the sidecar has its own version:
+
+```sh
+sudo -u pmtiles-swarm -H npm ls --prefix /var/lib/pmtiles-swarm --depth 1 \
+  pmtiles-swarm pmtiles-torrent
+```
+
+An install runs the dependency install scripts again, so check WebRTC survived
+it — see [the allowScripts warning](#the-allowscripts-warning):
+
+```sh
+cd /var/lib/pmtiles-swarm && sudo -u pmtiles-swarm -H node -e \
+  "import('node-datachannel').then(() => console.log('webrtc ok'))"
+```
+
+To pin a version, or to go back to one:
+
+```sh
+sudo -u pmtiles-swarm -H npm install --prefix /var/lib/pmtiles-swarm pmtiles-swarm@0.3.0
+sudo systemctl restart pmtiles-swarm
+```
+
 ## Checking it
 
 ```sh

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pmtiles-swarm",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "BitTorrent distribution for PMTiles map archives: create torrents, watch folders, publish and subscribe to RSS feeds, and seed through qBittorrent or an embedded client",
   "type": "module",
   "main": "src/index.js",

package/src/api.js

@@ -1,4 +1,5 @@
 import crypto from 'node:crypto';
+import fsSync from 'node:fs';
 import fs from 'node:fs/promises';
 import { createRequire } from 'node:module';
 import path from 'node:path';
@@ -24,6 +25,17 @@ import { TileReadError } from './tiles.js';
 
 const here = path.dirname(fileURLToPath(import.meta.url));
 
+/**
+ * This package's version, for the console to show.
+ *
+ * Read from package.json rather than repeated in a constant: a version in two
+ * places is a version that disagrees with itself, and the one on screen is the
+ * one somebody will quote when reporting a problem.
+ */
+const VERSION = JSON.parse(
+  fsSync.readFileSync(path.join(here, '..', 'package.json'), 'utf8'),
+).version;
+
 /**
  * Wraps an async route so a rejection becomes a 500 rather than an unhandled
  * rejection that takes the process down.
@@ -395,6 +407,7 @@ export function createApp({
         engineError = error.message;
       }
       res.json({
+        version: VERSION,
         engine: { name: engine.name, ok: engineOk, error: engineError },
         archives: catalog.list().length,
         categories: catalog.categories(),

package/src/web/index.html

@@ -254,6 +254,20 @@
       }
       .choice > span { flex: 1; }
 
+      footer {
+        margin-top: 2.5rem;
+        padding: 1rem 0 0.5rem;
+        border-top: 1px solid var(--line);
+        color: var(--muted);
+        font-size: 0.8rem;
+        display: flex;
+        gap: 0.6rem;
+        flex-wrap: wrap;
+        align-items: baseline;
+      }
+      footer a { color: var(--muted); }
+      footer .version { font-variant-numeric: tabular-nums; }
+
       /* Speed limits. Declared after .field on purpose: `.field input` is
          width:100%, which would push the unit label onto its own line. */
       .rates { display: flex; gap: 1rem; flex-wrap: wrap; }
@@ -362,6 +376,14 @@
       </section>
     </main>
 
+    <footer>
+      <span>&copy; <span id="year"></span> TechIdiots LLC</span>
+      <span>·</span>
+      <span>pmtiles-swarm <span class="version" id="version">…</span></span>
+      <span>·</span>
+      <a href="https://github.com/TechIdiots-LLC/pmtiles-swarm" rel="noreferrer">source</a>
+    </footer>
+
     <dialog id="move-dialog">
       <form method="dialog" id="move-form">
         <h2>Set location</h2>
@@ -859,6 +881,7 @@
           ]);
           renderSpeed(speed);
           renderFetching(adds?.running);
+          if (status.version) $('version').textContent = `v${status.version}`;
           const engine = status.engine;
           $('status').innerHTML =
             `engine <b>${engine.name}</b> ${engine.ok ? 'ready' : 'unavailable'}` +
@@ -3436,6 +3459,11 @@
         if (name === 'settings') loadSettings().catch((e) => toast(e.message));
         if (name === 'categories') loadCategories().catch((e) => toast(e.message));
       };
+      // The footer's year, set from the clock rather than typed into a file
+      // nobody will remember to edit. The version beside it arrives with the
+      // first status, and reads "…" until then.
+      $('year').textContent = String(new Date().getFullYear());
+
       $('tab-archives').onclick = () => showTab('archives');
       $('tab-categories').onclick = () => showTab('categories');
       $('tab-settings').onclick = () => showTab('settings');