Don't call tile.added() for tiles that have been removed from the ren…

…der tree. Fixes issue #5837, which could cause symbols to be incorrectly hidden.
mapbox · Dec 14, 2017 · e2c9007 · e2c9007
1 parent 63fba0d
commit e2c9007
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/src/source/source_cache.js b/src/source/source_cache.js
@@ -256,8 +256,11 @@ class SourceCache extends Evented {
         if (this.map) this.map.painter.tileExtentVAO.vao = null;
 
         this._updatePlacement();
-        if (this.map)
+        if (this.map && this.getTileByID(id)) {
+            // Only add this tile to the CrossTileSymbolIndex if it is still in the retain set
+            // See issue #5837
             tile.added(this.map.painter.crossTileSymbolIndex);
+        }
     }
 
     /**

diff --git a/test/unit/source/source_cache.test.js b/test/unit/source/source_cache.test.js
@@ -249,6 +249,23 @@ test('SourceCache#removeTile', (t) => {
         t.end();
     });
 
+    t.test('_tileLoaded after _removeTile skips tile.added', (t) => {
+        const tileID = new OverscaledTileID(0, 0, 0, 0, 0);
+
+        const sourceCache = createSourceCache({
+            loadTile: function(tile, callback) {
+                tile.added = t.notOk();
+                sourceCache._removeTile(tileID.key);
+                callback();
+            }
+        });
+        sourceCache.map = { painter: { crossTileSymbolIndex: "", tileExtentVAO: {} } };
+
+        sourceCache._addTile(tileID);
+
+        t.end();
+    });
+
     t.end();
 });