Fix - Esri Attribution not removed when VectorBasemapLayer is removed (…

…#208) * fix: add / remove attribution * fix broken tests * fix: add a call to removeEsriAttribution method this method removes the "Powered by Esri" attribution * add a test to onRemove-attribution scenario * Update esri-leaflet version * check if function exists before calling it + avoid error when using previous versions of esri-leaflet that do not contain the function
Esri · Dec 20, 2023 · 4462d7d · 4462d7d
1 parent 4743313
commit 4462d7d
Show file tree

Hide file tree

Showing 3 changed files with 112 additions and 8 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/spec/VectorBasemapLayerSpec.js b/spec/VectorBasemapLayerSpec.js
@@ -1,3 +1,4 @@
+
 /* eslint-env mocha */
 const itemId = '287c07ef752246d08bb4712fd4b74438';
 const apikey = '1234';
@@ -249,4 +250,102 @@ describe('VectorBasemapLayer', function () {
       expect(attributionUrls[0]).to.equal('https://static.arcgis.com/attribution/Vector/World_Basemap_v2');
     });
   });
+
+  describe('_setupAttribution', function () {
+    it('should add attribution for non itemId item', function () {
+      const key = 'ArcGIS:Streets';
+      const layer = new L.esri.Vector.VectorBasemapLayer(key, {
+        token: apikey
+      });
+      layer._ready = false;
+      let attributionValue = '';
+      const fakeMap = {
+        attributionControl: {
+          setPrefix: function () {},
+          _container: { className: '', querySelector: () => {} },
+          addAttribution: function () {
+            attributionValue = arguments[0];
+          }
+        },
+        getSize: function () {
+          return { x: 0, y: 0 };
+        },
+        on: function () {}
+      };
+      layer.onAdd(fakeMap);
+      layer._setupAttribution();
+      expect(attributionValue).to.be.equal('<span class="esri-dynamic-attribution"></span>');
+    });
+
+    it('should add attribution for itemId item', function () {
+      const key = '3e1a00aeae81496587988075fe529f71';
+      const layer = new L.esri.Vector.VectorBasemapLayer(key, {
+        token: apikey
+      });
+      layer._ready = false;
+      let attributionValue = '?';
+      const fakeMap = {
+        attributionControl: {
+          setPrefix: function () {},
+          _container: { className: '', querySelector: () => {} },
+          addAttribution: function () {
+            attributionValue = arguments[0];
+          }
+        },
+        getSize: function () {
+          return { x: 0, y: 0 };
+        },
+        on: function () {}
+      };
+      layer.onAdd(fakeMap);
+      layer._maplibreGL.getMaplibreMap = function () {
+        return {
+          style: {
+            stylesheet: {
+              sources: {
+                one: {
+                  attribution: '@ my attribution',
+                  copyrightText: '@ my copyright text'
+                }
+              }
+            }
+          }
+        };
+      };
+
+      layer._setupAttribution();
+      const expectedAttributionValue = '<span class="esri-dynamic-attribution">@ my attribution, @ my copyright text</span>';
+      expect(attributionValue).to.be.equal(expectedAttributionValue);
+    });
+  });
+
+  describe('onRemove', function () {
+    it('should call esri-leaflet and attributionControl remove attribution methods', function () {
+      const key = 'ArcGIS:Streets';
+      const layer = new L.esri.Vector.VectorBasemapLayer(key, {
+        token: apikey
+      });
+      layer._ready = false;
+      const fakeMap = {
+        attributionControl: {
+          removeAttribution: function () {}
+        },
+        off: function () {},
+        removeLayer: function () {}
+      };
+
+      const attributionControlSpy = sinon.spy(fakeMap.attributionControl);
+      const utilSpy = sinon.spy(L.esri.Util, 'removeEsriAttribution');
+
+      sinon.stub(document, 'getElementsByClassName').callsFake(function () {
+        return [{ outerHTML: '<div>' }];
+      });
+
+      layer.onRemove(fakeMap);
+      document.getElementsByClassName.restore();
+
+      expect(utilSpy.calledWith(fakeMap)).to.be.true;
+      expect(attributionControlSpy.removeAttribution.callCount).to.be.equal(2);
+    });
+  });
 });
diff --git a/src/VectorBasemapLayer.js b/src/VectorBasemapLayer.js
@@ -83,7 +83,7 @@ export var VectorBasemapLayer = VectorTileLayer.extend({
         }
       });
 
-      this._map.attributionControl.addAttribution('<span class="">' + allAttributions.join(', ') + '</span>');
+      this._map.attributionControl.addAttribution(`<span class="esri-dynamic-attribution">${allAttributions.join(', ')}</span>`);
     } else {
       // this is an enum
       if (!this.options.attributionUrls) {
@@ -148,12 +148,17 @@ export var VectorBasemapLayer = VectorTileLayer.extend({
     map.removeLayer(this._maplibreGL);
 
     if (map.attributionControl) {
+      if (Util.removeEsriAttribution) Util.removeEsriAttribution(map);
+
       const element = document.getElementsByClassName('esri-dynamic-attribution');
 
       if (element && element.length > 0) {
         const vectorAttribution = element[0].outerHTML;
-        // this doesn't work, not sure why.
+        // call removeAttribution twice here
+        // this is needed due to the 2 different ways that addAttribution is called inside _setupAttribution.
+        // leaflet attributionControl.removeAttribution method ignore a call when the attribution sent is not present there
         map.attributionControl.removeAttribution(vectorAttribution);
+        map.attributionControl.removeAttribution('<span class="esri-dynamic-attribution"></span>');
       }
     }
   },