pmtiles-swarm 0.4.3 → 0.4.4

package/CHANGELOG.md

@@ -7,6 +7,17 @@
 ### 🐞 Bug fixes
 - _...Add new stuff here..._
 
+## 0.4.4
+### 🐞 Bug fixes
+- **The console no longer claims an `.incomplete` file that is not there.** The marker was a
+  literal in the page, drawn beside every unfinished archive, with a tooltip naming the file it
+  was supposedly on disk as. libtorrent renames nothing — the rename would have to happen in the
+  sidecar — so on the engine most people run, that named a file which did not exist, next to one
+  sitting under its final name at 25% downloaded. Each engine now says whether it marks
+  incomplete files, the composite answers for its primary since that is the engine writing the
+  bytes, and `/api/status` combines that with `incompleteSuffix` — which can also be empty — to
+  report the marker actually in use, or none. The console draws only what it is told.
+
 ## 0.4.3
 ### 🐞 Bug fixes
 - **The lock file keeps the optional native builds `ws` asks for.** `bufferutil` and

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pmtiles-swarm",
-  "version": "0.4.3",
+  "version": "0.4.4",
   "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

@@ -408,6 +408,14 @@ export function createApp({
       }
       res.json({
         version: VERSION,
+        // What an unfinished archive is actually called on disk, or null when
+        // nothing renames it. Both halves matter: the setting can be empty,
+        // and an engine can ignore it entirely. The console showed the marker
+        // for every unfinished archive regardless, which on libtorrent was a
+        // filename that did not exist.
+        incompleteMarker: engine.marksIncomplete
+          ? config.incompleteSuffix || null
+          : null,
         engine: { name: engine.name, ok: engineOk, error: engineError },
         archives: catalog.list().length,
         categories: catalog.categories(),

package/src/engines/composite.js

@@ -58,6 +58,9 @@ export class CompositeEngine {
     this.shareIntervalMs = Math.max(5, shareIntervalSeconds) * 1000;
     this.shareTimeoutMs = Math.max(60, shareTimeoutSeconds) * 1000;
     this.name = [primary.name, ...this.#secondaries.map((e) => e.name)].join('+');
+    // The primary is the one that writes the file. A secondary only ever
+    // receives an archive that is already whole, so it never marks anything.
+    this.marksIncomplete = primary.marksIncomplete ?? false;
   }
 
   /** The engine that owns the data. @returns {object} - The primary. */

package/src/engines/libtorrent.js

@@ -78,6 +78,12 @@ export class LibtorrentEngine {
       throw new Error('libtorrent engine requires a savePath');
     }
     this.name = 'libtorrent';
+    // Whether `incompleteSuffix` means anything here: it does not. The rename
+    // would have to happen in the sidecar, so a partial archive sits under its
+    // final name from the first byte — which is why a web server must never be
+    // pointed at this engine's save path, and why the console must not claim
+    // a marker that is not there.
+    this.marksIncomplete = false;
     if (options.listen !== undefined && typeof options.listen !== 'string') {
       // Caught here because the alternative is a C++ converter error four
       // frames into a Python traceback, which says nothing about which setting

package/src/engines/webtorrent.js

@@ -54,6 +54,9 @@ export class WebTorrentSeedEngine {
       throw new Error('WebTorrent engine requires a savePath');
     }
     this.name = 'webtorrent';
+    // Honoured, by replacing the store — the only thing that decides where
+    // bytes land.
+    this.marksIncomplete = true;
     this.#options = { readyTimeoutMs: 300000, ...options };
   }
 

package/src/web/index.html

@@ -725,6 +725,9 @@
       // ── Archives ──────────────────────────────────────────────────────────
       let archives = [];
       let selected = null;
+      // Null until /api/status says otherwise, so nothing claims a marker
+      // before the node has said whether its engine applies one.
+      let incompleteMarker = null;
       let activeTab = 'general';
 
       // What the header switch shows, so a click knows what it is toggling to.
@@ -882,6 +885,9 @@
           renderSpeed(speed);
           renderFetching(adds?.running);
           if (status.version) $('version').textContent = `v${status.version}`;
+          // What an unfinished archive is really called on disk, or null when
+          // nothing renames it. The engine decides, not the setting alone.
+          incompleteMarker = status.incompleteMarker ?? null;
           const engine = status.engine;
           $('status').innerHTML =
             `engine <b>${engine.name}</b> ${engine.ok ? 'ready' : 'unavailable'}` +
@@ -994,8 +1000,8 @@
             <td class="sub">${
               entry.paused ? 'paused' : escapeHtml(s.state ?? '—')
             }${
-              entry.complete === false && progress < 1
-                ? `<div class="sub" title="on disk as ${escapeHtml(entry.name)}.incomplete until it is whole">.incomplete</div>`
+              entry.complete === false && progress < 1 && incompleteMarker
+                ? `<div class="sub" title="on disk as ${escapeHtml(entry.name)}${escapeHtml(incompleteMarker)} until it is whole">${escapeHtml(incompleteMarker)}</div>`
                 : ''
             }</td>`;
           tr.onclick = () => {