fix(plugins): match a pending PMTiles name to its archive so a panel add cannot take it

Author: clintonlunn

packages/plugins/src/plugins/maplibre-components.ts

@@ -1811,7 +1811,7 @@ async function addPMTilesLayerNow(
   // The control emits `layeradd` synchronously while adding, so the handler has already spent this
   // name by the time the await returns; the disposer is for the archive that throws before it.
   const clearPendingName =
-    options.name === undefined ? undefined : setPendingPMTilesName(options.name);
+    options.name === undefined ? undefined : setPendingPMTilesName(url, options.name);
   try {
     await pmtilesControl.addLayer(url);
   } finally {
@@ -4800,25 +4800,28 @@ function createZarrLayerAddHandler(): ZarrLayerEventHandler {
 
 // A name handed to addPMTilesLayerFromUrl, waiting for the `layeradd` it belongs to. The control's
 // own `addLayer(url)` takes no name, so a caller with a better one than the file name (a STAC item
-// and its asset, say) leaves it here. Adds are serialized, so only one is ever pending.
-let pendingPMTilesName: string | null = null;
+// and its asset, say) leaves it here. Adds through this module are serialized, so only one is ever
+// pending; it carries its archive so a layer the control's own panel adds meanwhile cannot take it.
+let pendingPMTiles: { url: string; name: string } | null = null;
 
 /**
  * @internal Exported for tests. Returns a disposer, so an add that never reaches `layeradd` (a
  * broken archive) leaves nothing behind it.
  */
-export function setPendingPMTilesName(name: string): () => void {
-  pendingPMTilesName = name;
+export function setPendingPMTilesName(url: string, name: string): () => void {
+  pendingPMTiles = { url, name };
   return () => {
-    pendingPMTilesName = null;
+    pendingPMTiles = null;
   };
 }
 
 /** @internal Spends the pending name, falling back to the control's own and then the file name. */
 export function resolvePMTilesLayerName(layerInfo: PMTilesLayerInfo, id: string): string {
-  const pending = pendingPMTilesName;
-  pendingPMTilesName = null;
-  return pending || layerInfo.name || layerNameFromUrl(layerInfo.url, id);
+  const fallback = layerInfo.name || layerNameFromUrl(layerInfo.url, id);
+  if (pendingPMTiles?.url !== layerInfo.url) return fallback;
+  const { name } = pendingPMTiles;
+  pendingPMTiles = null;
+  return name || fallback;
 }
 
 function createPMTilesLayerAddHandler(): PMTilesLayerEventHandler {

tests/pmtiles-layer-name.test.ts

@@ -22,34 +22,47 @@ function layerInfo(patch: Partial<PMTilesLayerInfo> = {}): PMTilesLayerInfo {
 
 describe("naming a PMTiles layer a caller asked for", () => {
   it("uses the name the caller left, not the file name", () => {
-    setPendingPMTilesName("item-1 — PMTiles vector tiles");
+    setPendingPMTilesName(layerInfo().url, "item-1 — PMTiles vector tiles");
 
     assert.equal(resolvePMTilesLayerName(layerInfo(), "layer-1"), "item-1 — PMTiles vector tiles");
   });
 
   it("spends the name once, so a layer the panel adds next is named for itself", () => {
     const info = layerInfo();
-    setPendingPMTilesName("item-1 — PMTiles vector tiles");
+    setPendingPMTilesName(layerInfo().url, "item-1 — PMTiles vector tiles");
     resolvePMTilesLayerName(info, "layer-1");
 
     assert.equal(resolvePMTilesLayerName(info, "layer-2"), "units");
   });
 
   it("drops a name whose add never produced a layer", () => {
     const info = layerInfo();
-    const clear = setPendingPMTilesName("item-1 — PMTiles vector tiles");
+    const clear = setPendingPMTilesName(info.url, "item-1 — PMTiles vector tiles");
     clear();
 
     assert.equal(resolvePMTilesLayerName(info, "layer-1"), "units");
   });
 
   it("falls back when a caller queues an empty name, rather than naming the layer nothing", () => {
     const info = layerInfo({ name: "Named by the panel" });
-    setPendingPMTilesName("");
+    setPendingPMTilesName(info.url, "");
 
     assert.equal(resolvePMTilesLayerName(info, "layer-1"), "Named by the panel");
   });
 
+  it("leaves a name alone for a layer the control's own panel added meanwhile", () => {
+    setPendingPMTilesName(
+      "https://example.org/warehouse/units.pmtiles",
+      "item-1 — PMTiles vector tiles",
+    );
+
+    // A panel add for a different archive must not take the name queued for ours.
+    const other = layerInfo({ url: "https://example.org/somebody-elses.pmtiles", name: "" });
+    assert.equal(resolvePMTilesLayerName(other, "layer-9"), "somebody-elses");
+    // And ours still gets it when it arrives.
+    assert.equal(resolvePMTilesLayerName(layerInfo(), "layer-1"), "item-1 — PMTiles vector tiles");
+  });
+
   it("keeps the control's own name when the caller supplied none", () => {
     assert.equal(
       resolvePMTilesLayerName(layerInfo({ name: "Named by the panel" }), "layer-1"),