pmtiles-swarm 0.25.0 → 0.26.0

package/CHANGELOG.md

@@ -7,6 +7,29 @@
 ### 🐞 Bug fixes
 - _...Add new stuff here..._
 
+## 0.26.0
+### 🐞 Bug fixes
+- **The add dialog stayed on screen for the length of a download.** `POST /api/torrents` awaited
+  the entire transfer before answering, so for a URL the response arrived hours after the request
+  — and the console, which closes the dialog when the response lands, sat there over an archive
+  visibly appearing behind it.
+
+  The console was always written for the other arrangement: it says "fetching — watch the log" as
+  it closes, polls `/api/adds` for progress, and offers `DELETE /api/adds` to cancel. Only the
+  route was missing. It now answers **202** as soon as the URL has been checked — it answers, it is
+  an archive of a publishable kind, it is not a credential about to be broadcast — and lets the
+  transfer run behind it. Everything a person can correct is still reported in the dialog, because
+  all of it is found before the first byte moves.
+
+  Both shortcuts inside `addRemoteArchive` had to be taught the same signal. A URL already in the
+  catalog, or one already being fetched by somebody else, returns without ever reaching the checks
+  — so a response waiting on them would have waited for something that had already happened, or
+  for the whole of a download another caller had started.
+
+  `url` bodies now answer 202 with an acknowledgement rather than 201 with the finished entry.
+  Paths, magnets and `.torrent` URLs are unchanged: they were always fast, and still answer 201
+  with the entry.
+
 ## 0.25.0
 ### ✨ Features and improvements
 - **A stopped download is kept, and adding the same URL again resumes it.** Staging directories

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pmtiles-swarm",
-  "version": "0.25.0",
+  "version": "0.26.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/api.js

@@ -1387,7 +1387,40 @@ export function createApp({
       if (body.path) {
         entry = await library.addLocalArchive(body.path, options);
       } else if (body.url) {
-        entry = await library.addRemoteArchive(body.url, options);
+        // Answered as soon as the URL has been checked, not when the transfer
+        // finishes. Awaiting the whole thing held the response open for the
+        // length of the download -- hours for a planet archive -- so the
+        // console's add dialog stayed on screen throughout, over an archive
+        // that was visibly appearing behind it.
+        //
+        // Progress has its own route already: runningAdds() feeds /api/adds,
+        // the console polls it, and DELETE /api/adds cancels one. This is the
+        // piece that was missing rather than a new mechanism.
+        const validated = Promise.withResolvers();
+        const running = library
+          .addRemoteArchive(body.url, {
+            ...options,
+            onValidated: validated.resolve,
+          })
+          // A failure after validation has nowhere to be reported: the
+          // response has gone. It is logged where the rest of the fetch is,
+          // and swallowed here so it cannot take the process down as an
+          // unhandled rejection.
+          .catch((error) => {
+            validated.reject(error);
+            console.error(`[fetch] ${body.url}: ${error.message}`);
+          });
+
+        // Whichever comes first: the checks passing, or the whole attempt
+        // failing. A URL that does not answer, or is not an archive, still
+        // reports itself in the dialog where somebody can correct it.
+        await validated.promise;
+        void running;
+        return res.status(202).json({
+          accepted: true,
+          url: body.url,
+          message: 'fetching; progress is reported by /api/adds',
+        });
       } else if (body.magnet) {
         entry = await library.addExistingTorrent(
           { magnet: body.magnet },

package/src/library.js

@@ -541,8 +541,15 @@ export class Library {
    * @returns {Promise<object>} - The catalog entry.
    */
   async addRemoteArchive(url, options = {}) {
+    // Both shortcuts below have to fire onValidated before returning, and for
+    // the same reason: a caller waiting on it to answer a request would
+    // otherwise wait for something that has already happened, or -- worse --
+    // for the whole of a download somebody else started.
     const existing = this.#catalog.findBySource(url);
-    if (existing) return existing;
+    if (existing) {
+      options.onValidated?.({ url, kind: existing.kind, held: true });
+      return existing;
+    }
 
     // A second request for a URL already being fetched joins the first; the
     // catalog cannot answer this, since an entry exists only once the download
@@ -550,6 +557,7 @@ export class Library {
     const inFlight = this.#inFlight.get(url);
     if (inFlight) {
       console.log(`[fetch] ${url} is already being fetched; joining that one`);
+      options.onValidated?.({ url, joined: true });
       return inFlight;
     }
 
@@ -590,6 +598,18 @@ export class Library {
       allowUnknown: options.allowUnknown ?? this.#config.allowUnknownArchives,
     });
 
+    // Everything a caller can do something about has now been checked: the URL
+    // answers, it is an archive of a kind this will publish, and it is not a
+    // credential being broadcast to a swarm. What remains is the transfer,
+    // which for a planet archive is hours.
+    //
+    // A caller that wants to stop waiting there says so with onValidated. That
+    // is the difference between a dialog that closes on a bad URL with the
+    // reason in it, and one that sits open for the length of the download --
+    // and the console was always written for the former, since it reports
+    // progress through runningAdds() and says "watch the log" as it closes.
+    options.onValidated?.({ url, kind: identified.kind });
+
     const summary =
       identified.kind === 'pmtiles'
         ? await probePMTiles(url).catch(() => undefined)