pmtiles-swarm 0.52.0 → 0.53.0

package/CHANGELOG.md

@@ -7,6 +7,25 @@
 ### 🐞 Bug fixes
 - _...Add new stuff here..._
 
+## 0.53.0
+### ✨ Features and improvements
+- **The three switches are now settable on every import, from the console.** **Serve file**, **Web
+  seed** and **Listed** columns on monitored folders, watched web locations, RSS feeds and remote
+  nodes, each offering `node` as well as yes and no — because unset is a real answer here, meaning
+  the archive follows the node rather than being switched off.
+
+### 🐞 Bug fixes
+- **An RSS feed could not ask for any of them.** 0.50.0 wired these through watched folders and
+  scheduled sources and stopped there, and an archive adopted from a feed takes a different path
+  through the library — which is the path a mirror node actually uses. A subscription now carries all
+  three, and there was no way to set them from the console on any import at all.
+
+- **`selfWebSeed` on an import waits for the download to finish.** Publishing a web seed URL for an
+  archive that is still arriving would advertise an address answering `409`, and a peer handed a URL
+  that refuses spends its retries on it — worse than no web seed, and unfixable afterwards because by
+  then the URL is in every copy of the `.torrent`. The intention is recorded when the archive joins
+  and acted on at the first moment this node holds the whole file.
+
 ## 0.52.0
 ### ✨ Features and improvements
 - **`publishingUrl`, for the URLs that have to be permanent.** Almost every URL this node emits is

package/docs/configuration.md

@@ -433,12 +433,23 @@ web seed, because a client spends its retries on it, and a download link that
 
 ### Per archive, per folder, per source
 
-The same three-level rule as [`md5`](#md5). The node's setting is the default; a
-[watched folder](#watched-folders) or a [scheduled source](#scheduled-sources)
-may carry its own; and any individual archive can be switched in the console,
-under **HTTP sources** in its details. An archive that says nothing goes on
-following the node, so changing the node's answer reaches every archive that
-never had one of its own.
+The node's setting is the default. A [watched folder](#watched-folders), a
+[scheduled source](#scheduled-sources), an [RSS feed](#subscriptions) and a
+remote node may each carry their own — the **Serve file**, **Web seed** and
+**Listed** columns on those tables, where `node` means "no opinion" rather than
+"off". And any individual archive can be switched in the console, under **HTTP
+sources** in its details.
+
+An archive that says nothing goes on following the node, so changing the node's
+answer reaches every archive that never had one of its own.
+
+Unlike `md5`, these do apply to a subscription. `md5` is a hashing pass that only
+happens where a torrent is built, and a subscription adopts one somebody else
+built; this is about what happens to the archive afterwards, which is this node's
+business whoever made it. **`selfWebSeed` waits for the download to finish**: a
+web seed URL for an archive still arriving answers `409`, and a peer handed a URL
+that refuses spends its retries on it — worse than no web seed, and unfixable
+afterwards, because by then the URL is in every copy of the `.torrent`.
 
 ## Trackers
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pmtiles-swarm",
-  "version": "0.52.0",
+  "version": "0.53.0",
   "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/library.js

@@ -526,6 +526,39 @@ export class Library {
    * @returns {Promise<object>} - The updated catalog entry.
    */
   async finalize(infoHash) {
+    const settled = await this.#finalizeOnce(infoHash);
+
+    // Only now, and never at import. A web seed URL for an archive that is
+    // still arriving answers 409, and a peer handed a URL that refuses spends
+    // its retries on it — worse than no web seed at all, and unfixable
+    // afterwards, because the URL is in the .torrent every peer holds. So a
+    // subscription records the intention when it joins and it is acted on
+    // here, at the first moment this node actually holds the whole file.
+    //
+    // Safe to reach on an archive that was already complete: setPublishing
+    // works from what is on record rather than from a transition, so this does
+    // nothing the second time — and does the right thing the first time for an
+    // archive that finished before the setting existed.
+    if (settled && publishingFor(settled, this.#config).selfWebSeed) {
+      try {
+        await this.setPublishing(infoHash, {});
+        return this.#catalog.get(infoHash) ?? settled;
+      } catch (error) {
+        console.warn(
+          `[web seed] ${settled.name} is not published as a web seed by this ` +
+            `node: ${error.message}`,
+        );
+      }
+    }
+    return settled;
+  }
+
+  /**
+   * The rename and the bookkeeping, without the publishing that follows it.
+   * @param {string} infoHash - The archive that finished.
+   * @returns {Promise<object>} - The updated catalog entry.
+   */
+  async #finalizeOnce(infoHash) {
     const entry = this.#catalog.get(infoHash);
     if (!entry) throw new Error('unknown archive');
     if (entry.complete) return entry;
@@ -1145,6 +1178,11 @@ export class Library {
       complete,
       // Held until the download finishes, which may be hours away.
       originMtime: options.originMtime,
+      // Recorded now, applied when the download finishes. Unset leaves the
+      // archive following the node, which is the rule everywhere else.
+      serveArchive: options.serveArchive,
+      selfWebSeed: options.selfWebSeed,
+      publicDownload: options.publicDownload,
       // What the peer that offered this says it holds, where it said anything.
       // The head warmer replaces it with what the archive's own header says as
       // soon as it can read one; until then this is what makes the archive

package/src/subscriptions.js

@@ -423,6 +423,14 @@ export class SubscriptionManager {
       // 698 GiB download before starting one, which means it is populated
       // before a single byte exists here.
       summarySource: 'feed',
+      // What this node will offer of the archive once it holds it. Unset here
+      // means the node's own answer applies, the same rule as everywhere else.
+      // Nothing takes effect until the download finishes: a web seed URL for
+      // an archive that is still arriving answers 409, which is worse than no
+      // web seed because peers spend their retries on it.
+      serveArchive: subscription.serveArchive,
+      selfWebSeed: subscription.selfWebSeed,
+      publicDownload: subscription.publicDownload,
     };
 
     // The .torrent is preferred where there is one: it carries the trackers

package/src/web/index.html

@@ -4654,6 +4654,34 @@ Every piece is hashed against the ` +
         await renderTokenEditor(body);
         renderHookEditor(body, config, restartKeys);
 
+        // The three switches the details panel offers, as import defaults.
+        // Each has a blank option as well as yes and no, because unset is a
+        // real answer here: it means the archive follows the node, and a row
+        // that has never said anything must keep not saying it. See
+        // publishingFor() -- the node's setting reaches everything that never
+        // had one of its own, and that only works if "no opinion" is storable.
+        const publishing = ['', 'node'];
+        const publishingColumns = [
+          {
+            field: 'serveArchive',
+            label: 'Serve file',
+            boolean: true,
+            options: [publishing, ['true', 'yes'], ['false', 'no']],
+          },
+          {
+            field: 'selfWebSeed',
+            label: 'Web seed',
+            boolean: true,
+            options: [publishing, ['true', 'yes'], ['false', 'no']],
+          },
+          {
+            field: 'publicDownload',
+            label: 'Listed',
+            boolean: true,
+            options: [publishing, ['true', 'yes'], ['false', 'no']],
+          },
+        ];
+
         renderRowEditor({
           into: body,
           key: 'locations',
@@ -4747,6 +4775,7 @@ Every piece is hashed against the ` +
               placeholder: 'for ever',
               number: true,
             },
+                      ...publishingColumns,
           ],
           rows: config.watch ?? [],
           footnote:
@@ -4855,6 +4884,7 @@ Every piece is hashed against the ` +
               placeholder: 'for ever',
               number: true,
             },
+                      ...publishingColumns,
           ],
           rows: config.sources ?? [],
           checkNow: '/api/sources/check',
@@ -4979,6 +5009,7 @@ Every piece is hashed against the ` +
                 ['false', 'no'],
               ],
             },
+                      ...publishingColumns,
           ],
           rows: following.filter((row) => !isPeer(row)),
           checkNow: '/api/subscriptions/refresh',
@@ -5053,6 +5084,7 @@ Every piece is hashed against the ` +
                 ['false', 'no'],
               ],
             },
+                      ...publishingColumns,
           ],
           rows: following.filter(isPeer),
           checkNow: '/api/subscriptions/refresh',