pmtiles-swarm 0.5.2 → 0.5.3

package/CHANGELOG.md

@@ -7,6 +7,25 @@
 ### 🐞 Bug fixes
 - _...Add new stuff here..._
 
+## 0.5.3
+### 🐞 Bug fixes
+- **A "high" priority hint asked for nothing at all.** libtorrent's scale runs 0 to 7 and **4 is
+  the default every piece already has** — and high was mapped to 4. So the JSON metadata, which
+  the source hints the moment it reads a header, was raised to precisely what the other eighteen
+  thousand pieces already had, and waited its turn: hours, on a 72 GiB archive. It is 6 now,
+  above the default and below critical, so it arrives soon without ever going ahead of a tile
+  somebody is waiting for. `normal` stays at 1, deliberately below the default, because that is
+  what the idle leaf hydration uses and it must yield to everything.
+
+  There is a test for the mapping itself, since a priority that is merely ordinary fails by
+  doing nothing, which no behavioural test would notice.
+- **A partial head-read no longer reports itself as a complete one.** The header sits at byte
+  zero while the JSON metadata is wherever the writer put it — planetiler puts it after every
+  tile, so at the far end of the file — and `summarize` treats the second as decoration, so a
+  pass that got only the header still returned a summary and logged "read the head". It then
+  came back two minutes later, having genuinely succeeded and genuinely not finished, with
+  nothing in the log to explain the repetition. The two are now reported separately.
+
 ## 0.5.2
 ### 🐞 Bug fixes
 - **Asks for the `pmtiles-torrent` that 0.5.1 actually needs.** It shipped declaring `^0.3.2`,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pmtiles-swarm",
-  "version": "0.5.2",
+  "version": "0.5.3",
   "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/prewarm.js

@@ -128,12 +128,25 @@ export class HeadWarmer {
         infoHash: entry.infoHash,
         pmtiles: { ...entry.pmtiles, ...summary },
       });
-      console.log(
-        `[warm] read the head of ${entry.name}` +
-          (summary.vectorLayers
-            ? ` (${summary.vectorLayers.length} vector layers)`
-            : ''),
-      );
+      // Said accurately, because the two halves arrive separately and the
+      // difference matters: the header is at byte zero, while the JSON
+      // metadata is wherever the writer put it — planetiler puts it after every
+      // tile, so on a 72 GiB archive it is the very end of the file. Reporting
+      // both as "read the head" made a pass that got half of it look complete,
+      // and left the repeat every couple of minutes unexplained.
+      if (summary.vectorLayers) {
+        console.log(
+          `[warm] ${entry.name}: header and metadata read ` +
+            `(${summary.vectorLayers.length} vector layers)`,
+        );
+      } else if (summary.format === 'pbf') {
+        console.log(
+          `[warm] ${entry.name}: header read; its metadata is at the far end ` +
+            'of the archive and has not arrived yet',
+        );
+      } else {
+        console.log(`[warm] ${entry.name}: header read`);
+      }
       return stored;
     } catch (error) {
       if (tooEarly(error)) {

package/src/read-engine.js

@@ -9,7 +9,21 @@
  */
 
 /** libtorrent piece priorities. 0 means "do not fetch". */
-const LT_PRIORITY = { critical: 7, high: 4, normal: 1 };
+/**
+ * What a hint's priority means to libtorrent.
+ *
+ * libtorrent's scale runs 0 (do not download) to 7 (highest), and **4 is the
+ * default every piece already has**. So "high" was mapped to the default: the
+ * JSON metadata, which the source hints as high the moment it reads the header,
+ * was never prioritised at all — it waited its turn like the other eighteen
+ * thousand pieces, which on a 72 GiB archive is hours.
+ *
+ * 6 is above the default and below critical, which is what "fetch this sooner
+ * than the rest, but not ahead of a tile somebody is waiting for" should mean.
+ * `normal` stays at 1, deliberately *below* the default: it is what the idle
+ * leaf hydration uses, and that must yield to everything.
+ */
+const LT_PRIORITY = { critical: 7, high: 6, normal: 1 };
 
 /**
  * A TorrentEngine over the libtorrent sidecar the seed engine already runs.