forked from maplibre/maplibre-gl-js
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtile_manager.test.ts
More file actions
2635 lines (2227 loc) · 101 KB
/
Copy pathtile_manager.test.ts
File metadata and controls
2635 lines (2227 loc) · 101 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import type {StyleSpecification} from '@maplibre/maplibre-gl-style-spec';
import {afterEach, beforeEach, describe, expect, test, vi} from 'vitest';
import {TileManager} from './tile_manager.ts';
import {addSourceType, type Source} from '../source/source.ts';
import {FadingDirections, FadingRoles, Tile} from './tile.ts';
import {CanonicalTileID, OverscaledTileID} from './tile_id.ts';
import {LngLat} from '../geo/lng_lat.ts';
import Point from '@mapbox/point-geometry';
import {ErrorEvent, Event, Evented} from '../util/evented.ts';
import {extend} from '../util/util.ts';
import {type Dispatcher} from '../util/dispatcher.ts';
import {TileBounds} from './tile_bounds.ts';
import {beforeMapTest, createMap as globalCreateMap, sleep, waitForEvent} from '../util/test/util.ts';
import {now} from '../util/time_control.ts';
import {type Map} from '../ui/map.ts';
import {type TileCache} from './tile_cache.ts';
import {MercatorTransform} from '../geo/projection/mercator_transform.ts';
import {GlobeTransform} from '../geo/projection/globe_transform.ts';
import {coveringTiles} from '../geo/projection/covering_tiles.ts';
class SourceMock extends Evented implements Source {
id: string;
minzoom: number;
maxzoom: number;
hasTile: (tileID: OverscaledTileID) => boolean;
sourceOptions: any;
type: string;
tileSize: number;
constructor(id: string, sourceOptions: any, _dispatcher: Dispatcher, eventedParent: Evented) {
super();
this.id = id;
this.minzoom = 0;
this.maxzoom = 22;
extend(this, sourceOptions);
this.sourceOptions = sourceOptions;
this.setEventedParent(eventedParent);
if (sourceOptions.hasTile) {
this.hasTile = sourceOptions.hasTile;
}
if (sourceOptions.raster) {
this.type = 'raster';
}
}
loadTile(tile: Tile): Promise<void> {
if (this.sourceOptions.expires) {
tile.setExpiryData({
expires: this.sourceOptions.expires
});
}
return sleep(0);
}
loaded() {
return true;
}
onAdd() {
if (this.sourceOptions.noLoad) return;
if (this.sourceOptions.error) {
this.fire(new ErrorEvent(this.sourceOptions.error));
} else {
this.fire(new Event('data', {dataType: 'source', sourceDataType: 'metadata'}));
}
}
async abortTile() {}
async unloadTile() {}
serialize() {}
hasTransition(): boolean {
return false;
}
}
// Add a mocked source type for use in these tests
function createSource(id: string, sourceOptions: any, _dispatcher: any, eventedParent: Evented) {
// allow tests to override mocked methods/properties by providing
// them in the source definition object that's given to Source.create()
return new SourceMock(id, sourceOptions, _dispatcher, eventedParent);
}
addSourceType('mock-source-type', createSource as any);
function createTileManager(options?, used?) {
const sc = new TileManager('id', extend({
tileSize: 512,
minzoom: 0,
maxzoom: 14,
type: 'mock-source-type'
}, options), {} as Dispatcher);
return extend(sc, {
used: typeof used === 'boolean' ? used : true,
addTile(tileID: OverscaledTileID): Tile {
return this._addTile(tileID);
},
getCache(): TileCache {
return this._cache;
},
getTiles(): { [_: string]: Tile } {
return this._tiles;
}
});
}
type MapOptions = {
style: StyleSpecification;
};
function createMap(options: MapOptions) {
const container = window.document.createElement('div');
window.document.body.appendChild(container);
Object.defineProperty(container, 'clientWidth', {value: 512});
Object.defineProperty(container, 'clientHeight', {value: 512});
return globalCreateMap({container, ...options});
}
beforeEach(() => {
beforeMapTest();
});
afterEach(() => {
vi.clearAllMocks();
});
describe('TileManager.addTile', () => {
test('loads tile when uncached', () => {
const tileID = new OverscaledTileID(0, 0, 0, 0, 0);
const tileManager = createTileManager();
const spy = vi.fn();
tileManager._source.loadTile = spy;
tileManager.onAdd(undefined);
tileManager._addTile(tileID);
expect(spy).toHaveBeenCalledTimes(1);
expect(spy.mock.calls[0][0].tileID).toEqual(tileID);
expect(spy.mock.calls[0][0].uses).toBe(1);
});
test('adds tile when uncached', async () => {
const tileID = new OverscaledTileID(0, 0, 0, 0, 0);
const tileManager = createTileManager({});
const dataLoadingPromise = tileManager.once('dataloading');
tileManager.onAdd(undefined);
tileManager._addTile(tileID);
const data = await dataLoadingPromise;
expect(data.tile.tileID).toEqual(tileID);
expect(data.tile.uses).toBe(1);
});
test('updates feature state on added uncached tile', async () => {
const tileID = new OverscaledTileID(0, 0, 0, 0, 0);
let updateFeaturesSpy;
const tileManager = createTileManager({});
let dataPromise: any;
tileManager._source.loadTile = async (tile) => {
dataPromise = tileManager.once('data');
updateFeaturesSpy = vi.spyOn(tile, 'setFeatureState');
tile.state = 'loaded';
};
tileManager.onAdd(undefined);
tileManager._addTile(tileID);
await dataPromise;
expect(updateFeaturesSpy).toHaveBeenCalledTimes(1);
});
test('uses cached tile', () => {
const tileID = new OverscaledTileID(0, 0, 0, 0, 0);
let load = 0,
add = 0;
const tileManager = createTileManager({});
tileManager._source.loadTile = async (tile) => {
tile.state = 'loaded';
load++;
};
tileManager.on('dataloading', () => add++);
const tr = new MercatorTransform();
tr.resize(512, 512);
tileManager.updateCacheSize(tr);
tileManager._addTile(tileID);
tileManager._removeTile(tileID.key);
tileManager._addTile(tileID);
expect(load).toBe(1);
expect(add).toBe(1);
});
test('updates feature state on cached tile', () => {
const tileID = new OverscaledTileID(0, 0, 0, 0, 0);
const tileManager = createTileManager({});
tileManager._source.loadTile = async (tile) => {
tile.state = 'loaded';
};
const tr = new MercatorTransform();
tr.resize(512, 512);
tileManager.updateCacheSize(tr);
const tile = tileManager._addTile(tileID);
const updateFeaturesSpy = vi.spyOn(tile, 'setFeatureState');
tileManager._removeTile(tileID.key);
tileManager._addTile(tileID);
expect(updateFeaturesSpy).toHaveBeenCalledTimes(1);
});
test('moves timers when adding tile from cache', () => {
const tileID = new OverscaledTileID(0, 0, 0, 0, 0);
const time = new Date();
time.setSeconds(time.getSeconds() + 5);
const tileManager = createTileManager();
tileManager._setTileReloadTimer = (id) => {
tileManager._timers[id] = setTimeout(() => {}, 0);
};
tileManager._source.loadTile = async (tile) => {
tile.state = 'loaded';
tile.getExpiryTimeout = () => 1000 * 60;
tileManager._setTileReloadTimer(tileID.key, tile);
};
const tr = new MercatorTransform();
tr.resize(512, 512);
tileManager.updateCacheSize(tr);
const id = tileID.key;
expect(tileManager._timers[id]).toBeFalsy();
expect(tileManager._outOfViewCache.has(tileID)).toBeFalsy();
tileManager._addTile(tileID);
expect(tileManager._timers[id]).toBeTruthy();
expect(tileManager._outOfViewCache.has(tileID)).toBeFalsy();
tileManager._removeTile(tileID.key);
expect(tileManager._timers[id]).toBeFalsy();
expect(tileManager._outOfViewCache.has(tileID)).toBeTruthy();
tileManager._addTile(tileID);
expect(tileManager._timers[id]).toBeTruthy();
expect(tileManager._outOfViewCache.has(tileID)).toBeFalsy();
});
test('does not reuse wrapped tile', () => {
const tileID = new OverscaledTileID(0, 0, 0, 0, 0);
let load = 0,
add = 0;
const tileManager = createTileManager();
tileManager._source.loadTile = async (tile) => {
tile.state = 'loaded';
load++;
};
tileManager.on('dataloading', () => add++);
const t1 = tileManager._addTile(tileID);
const t2 = tileManager._addTile(new OverscaledTileID(0, 1, 0, 0, 0));
expect(load).toBe(2);
expect(add).toBe(2);
expect(t1).not.toBe(t2);
});
test('should load tiles with identical overscaled Z but different canonical Z', () => {
const tileManager = createTileManager();
const tileIDs = [
new OverscaledTileID(1, 0, 0, 0, 0),
new OverscaledTileID(1, 0, 1, 0, 0),
new OverscaledTileID(1, 0, 1, 1, 0),
new OverscaledTileID(1, 0, 1, 0, 1),
new OverscaledTileID(1, 0, 1, 1, 1)
];
for (const tileID of tileIDs)
tileManager._addTile(tileID);
for (const id of tileIDs) {
const key = id.key;
expect(tileManager._inViewTiles.getTileById(key)).toBeTruthy();
expect(tileManager._inViewTiles.getTileById(key).tileID).toEqual(id);
}
});
});
describe('TileManager.removeTile', () => {
test('removes tile', async () => {
const tileID = new OverscaledTileID(0, 0, 0, 0, 0);
const tileManager = createTileManager({});
tileManager._addTile(tileID);
await tileManager.once('data');
tileManager._removeTile(tileID.key);
expect(tileManager._inViewTiles.getTileById(tileID.key)).toBeFalsy();
});
test('caches (does not unload) loaded tile', () => {
const tileID = new OverscaledTileID(0, 0, 0, 0, 0);
const tileManager = createTileManager();
tileManager._source.loadTile = async (tile) => {
tile.state = 'loaded';
};
tileManager._source.unloadTile = vi.fn();
const tr = new MercatorTransform();
tr.resize(512, 512);
tileManager.updateCacheSize(tr);
tileManager._addTile(tileID);
tileManager._removeTile(tileID.key);
expect(tileManager._source.unloadTile).not.toHaveBeenCalled();
});
test('aborts and unloads unfinished tile', () => {
const tileID = new OverscaledTileID(0, 0, 0, 0, 0);
let abort = 0,
unload = 0;
const tileManager = createTileManager();
tileManager._source.abortTile = async (tile) => {
expect(tile.tileID).toEqual(tileID);
abort++;
};
tileManager._source.unloadTile = async (tile) => {
expect(tile.tileID).toEqual(tileID);
unload++;
};
tileManager._addTile(tileID);
tileManager._removeTile(tileID.key);
expect(abort).toBe(1);
expect(unload).toBe(1);
});
test('_tileLoaded after _removeTile skips tile.added', () => {
const tileID = new OverscaledTileID(0, 0, 0, 0, 0);
const tileManager = createTileManager();
tileManager._source.loadTile = async () => {
tileManager._removeTile(tileID.key);
};
tileManager.map = {painter: {crossTileSymbolIndex: '', tileExtentVAO: {}}} as any;
tileManager._addTile(tileID);
});
test('fires dataabort event', async () => {
const tileManager = createTileManager();
tileManager._source.loadTile = () => {
// Do not call back in order to make sure the tile is removed before it is loaded.
return new Promise(() => {});
};
const tileID = new OverscaledTileID(0, 0, 0, 0, 0);
const tile = tileManager._addTile(tileID);
const abortPromise = tileManager.once('dataabort');
tileManager._removeTile(tileID.key);
const event = await abortPromise;
expect(event.dataType).toBe('source');
expect(event.tile).toBe(tile);
expect(event.coord).toBe(tileID);
});
test('does not fire dataabort event when the tile has already been loaded', () => {
const tileManager = createTileManager();
tileManager._source.loadTile = async (tile) => {
tile.state = 'loaded';
};
const tileID = new OverscaledTileID(0, 0, 0, 0, 0);
tileManager._addTile(tileID);
const onAbort = vi.fn();
tileManager.once('dataabort', onAbort);
tileManager._removeTile(tileID.key);
expect(onAbort).toHaveBeenCalledTimes(0);
});
test('does not fire data event when the tile has already been aborted', () => {
const onData = vi.fn();
const tileManager = createTileManager();
tileManager._source.loadTile = async (tile) => {
tileManager.once('dataabort', () => {
tile.state = 'loaded';
expect(onData).toHaveBeenCalledTimes(0);
});
};
tileManager.once('data', onData);
const tileID = new OverscaledTileID(0, 0, 0, 0, 0);
tileManager._addTile(tileID);
tileManager._removeTile(tileID.key);
});
test('resets raster fade timer upon load of unloaded edge tiles', async () => {
const tileManager = createTileManager();
tileManager._rasterFadeDuration = 300;
let tile: Tile;
let endMs: number;
tileManager._source.loadTile = async (_tile) => {
tile = _tile;
tile.selfFading = true;
tile.fadeEndTime = now() + tileManager._rasterFadeDuration;
await sleep(100);
endMs = now();
};
tileManager._addTile(new OverscaledTileID(0, 0, 0, 0, 0));
await sleep(200);
const deltaMs = tile.fadeEndTime - endMs;
expect(deltaMs).toBeGreaterThanOrEqual(290);
expect(deltaMs).toBeLessThanOrEqual(310);
});
});
describe('TileManager / Source lifecycle', () => {
test('does not fire load or change before source load event', async () => {
const tileManager = createTileManager({noLoad: true});
const spy = vi.fn();
tileManager.on('data', spy);
tileManager.onAdd(undefined);
await sleep(1);
expect(spy).not.toHaveBeenCalled();
});
test('forward load event', async () => {
const tileManager = createTileManager({});
const dataPromise = waitForEvent(tileManager, 'data', e => e.sourceDataType === 'metadata');
tileManager.onAdd(undefined);
await expect(dataPromise).resolves.toBeDefined();
});
test('forward change event', async () => {
const tileManager = createTileManager();
const dataPromise = waitForEvent(tileManager, 'data', e => e.sourceDataType === 'metadata');
tileManager.onAdd(undefined);
tileManager.getSource().fire(new Event('data'));
await expect(dataPromise).resolves.toBeDefined();
});
test('forward error event', async () => {
const tileManager = createTileManager({error: 'Error loading source'});
const errorPromise = tileManager.once('error');
tileManager.onAdd(undefined);
const err = await errorPromise;
expect(err.error).toBe('Error loading source');
});
test('suppress 404 errors', () => {
const tileManager = createTileManager({status: 404, message: 'Not found'});
tileManager.on('error', () => { throw new Error('test failed: error event fired'); });
tileManager.onAdd(undefined);
});
test('loaded() true after source error', async () => {
const tileManager = createTileManager({error: 'Error loading source'});
const errorPromise = tileManager.once('error');
tileManager.onAdd(undefined);
await errorPromise;
expect(tileManager.loaded()).toBeTruthy();
});
test('loaded() true after tile error', async () => {
const transform = new MercatorTransform();
transform.resize(511, 511);
transform.setZoom(0);
const tileManager = createTileManager();
tileManager._source.loadTile = async () => {
throw new Error('Error loading tile');
};
tileManager.on('data', (e) => {
if (e.dataType === 'source' && e.sourceDataType === 'metadata') {
tileManager.update(transform);
}
});
const errorPromise = tileManager.once('error');
tileManager.onAdd(undefined);
await errorPromise;
expect(tileManager.loaded()).toBeTruthy();
});
test('loaded() false after source begins loading following error', async () => {
const tileManager = createTileManager({error: 'Error loading source'});
const errorPromise = tileManager.once('error');
tileManager.onAdd(undefined);
await errorPromise;
const dataLoadingProimse = tileManager.once('dataloading');
tileManager.getSource().fire(new Event('dataloading'));
await dataLoadingProimse;
expect(tileManager.loaded()).toBeFalsy();
});
test('loaded() false when error occurs while source is not loaded', async () => {
const tileManager = createTileManager({
error: 'Error loading source',
loaded() {
return false;
}
});
const errorPromise = tileManager.once('error');
tileManager.onAdd(undefined);
await errorPromise;
expect(tileManager.loaded()).toBeFalsy();
});
test('reloads tiles after a data event where source is updated', () => {
const transform = new MercatorTransform();
transform.resize(511, 511);
transform.setZoom(0);
const expected = [new OverscaledTileID(0, 0, 0, 0, 0).key, new OverscaledTileID(0, 0, 0, 0, 0).key];
expect.assertions(expected.length);
const tileManager = createTileManager();
tileManager._source.loadTile = async (tile) => {
expect(tile.tileID.key).toBe(expected.shift());
tile.state = 'loaded';
};
tileManager.on('data', (e) => {
if (e.dataType === 'source' && e.sourceDataType === 'metadata') {
tileManager.update(transform);
tileManager.getSource().fire(new Event('data', {dataType: 'source', sourceDataType: 'content'}));
}
});
tileManager.onAdd(undefined);
});
test('does not reload errored tiles', () => {
const transform = new MercatorTransform();
transform.resize(511, 511);
transform.setZoom(1);
const tileManager = createTileManager();
tileManager._source.loadTile = async (tile) => {
// this transform will try to load the four tiles at z1 and a single z0 tile
// we only expect _reloadTile to be called with the 'loaded' z0 tile
tile.state = tile.tileID.canonical.z === 1 ? 'errored' : 'loaded';
};
const reloadTileSpy = vi.spyOn(tileManager, '_reloadTile');
tileManager.on('data', (e) => {
if (e.dataType === 'source' && e.sourceDataType === 'metadata') {
tileManager.update(transform);
tileManager.getSource().fire(new Event('data', {dataType: 'source', sourceDataType: 'content'}));
}
});
tileManager.onAdd(undefined);
// we expect the tile manager to have five tiles, but only to have reloaded one
expect(tileManager._inViewTiles.getAllIds()).toHaveLength(5);
expect(reloadTileSpy).toHaveBeenCalledTimes(1);
});
test('does reload errored tiles, if event is source data change', () => {
const transform = new MercatorTransform();
transform.resize(511, 511);
transform.setZoom(1);
const tileManager = createTileManager();
tileManager._source.loadTile = async (tile) => {
// this transform will try to load the four tiles at z1 and a single z0 tile
// we only expect _reloadTile to be called with the 'loaded' z0 tile
tile.state = tile.tileID.canonical.z === 1 ? 'errored' : 'loaded';
};
const reloadTileSpy = vi.spyOn(tileManager, '_reloadTile');
tileManager.on('data', (e) => {
if (e.dataType === 'source' && e.sourceDataType === 'metadata') {
tileManager.update(transform);
tileManager.getSource().fire(new Event('data', {dataType: 'source', sourceDataType: 'content', sourceDataChanged: true}));
}
});
tileManager.onAdd(undefined);
// We expect the tile manager to have five tiles, and for all of them
// to be reloaded
expect(tileManager._inViewTiles.getAllIds()).toHaveLength(5);
expect(reloadTileSpy).toHaveBeenCalledTimes(5);
});
});
describe('TileManager.update', () => {
test('loads no tiles if used is false', async () => {
const transform = new MercatorTransform();
transform.resize(512, 512);
transform.setZoom(0);
const tileManager = createTileManager({}, false);
const dataPromise = waitForEvent(tileManager, 'data', e => e.sourceDataType === 'metadata');
tileManager.onAdd(undefined);
await dataPromise;
tileManager.update(transform);
expect(tileManager.getIds()).toEqual([]);
});
test('loads covering tiles', async () => {
const transform = new MercatorTransform();
transform.resize(511, 511);
transform.setZoom(0);
const tileManager = createTileManager({});
const dataPromise = waitForEvent(tileManager, 'data', e => e.sourceDataType === 'metadata');
tileManager.onAdd(undefined);
await dataPromise;
tileManager.update(transform);
expect(tileManager.getIds()).toEqual([new OverscaledTileID(0, 0, 0, 0, 0).key]);
});
test('adds ideal (covering) tiles only once for zoom level on raster maps', async () => {
const transform = new MercatorTransform();
transform.resize(512, 512);
transform.setZoom(1);
const tileManager = createTileManager({raster: true});
tileManager._source.loadTile = async (tile) => {
tile.state = 'loaded';
};
const addSpy = vi.spyOn(tileManager, '_addTile');
const dataPromise = waitForEvent(tileManager, 'data', e => e.sourceDataType === 'metadata');
tileManager.onAdd(undefined);
await dataPromise;
// on update at zoom 1 there should be 4 ideal tiles added through _addTiles
tileManager.update(transform);
expect(addSpy).toHaveBeenCalledTimes(4);
});
test('bypasses fading logic when raster fading is disabled', async () => {
const map = createMap({
style: {
version: 8,
sources: {rasterSource: {type: 'raster', tiles: [], tileSize: 256}},
layers: [{id: 'rasterLayer', type: 'raster', source: 'rasterSource',
paint: {'raster-fade-duration': 0}
}]
}
});
await map.once('styledata');
const style = map.style;
const tileManager = style.tileManagers['rasterSource'];
tileManager._loadTile = async () => {};
const fakeTile = new Tile(new OverscaledTileID(3, 0, 3, 1, 2), undefined);
fakeTile.resetFadeLogic = vi.fn();
(fakeTile as any).texture = {bind: () => {}, size: [256, 256]};
fakeTile.state = 'loaded';
tileManager._inViewTiles.setTile(fakeTile.tileID.key, fakeTile);
await map.once('render');
map.setZoom(3);
await map.once('render');
expect(fakeTile.resetFadeLogic).not.toHaveBeenCalled();
});
test('respects Source.hasTile method if it is present', async () => {
const transform = new MercatorTransform();
transform.resize(511, 511);
transform.setZoom(1);
const tileManager = createTileManager({
hasTile: (coord) => (coord.canonical.x !== 0)
});
const dataPromise = waitForEvent(tileManager, 'data', e => e.sourceDataType === 'metadata');
tileManager.onAdd(undefined);
await dataPromise;
tileManager.update(transform);
expect(tileManager.getIds().sort()).toEqual([
new OverscaledTileID(1, 0, 1, 1, 0).key,
new OverscaledTileID(1, 0, 1, 1, 1).key
].sort());
});
test('removes unused tiles', async () => {
const transform = new MercatorTransform();
transform.resize(511, 511);
transform.setZoom(0);
const tileManager = createTileManager();
tileManager._source.loadTile = async (tile) => {
tile.state = 'loaded';
};
const dataPromise = waitForEvent(tileManager, 'data', e => e.sourceDataType === 'metadata');
tileManager.onAdd(undefined);
await dataPromise;
tileManager.update(transform);
expect(tileManager.getIds()).toEqual([new OverscaledTileID(0, 0, 0, 0, 0).key]);
transform.setZoom(1);
tileManager.update(transform);
expect(tileManager.getIds()).toEqual([
new OverscaledTileID(1, 0, 1, 1, 1).key,
new OverscaledTileID(1, 0, 1, 0, 1).key,
new OverscaledTileID(1, 0, 1, 1, 0).key,
new OverscaledTileID(1, 0, 1, 0, 0).key
]);
});
test('retains parent tiles for pending children', async () => {
const transform = new MercatorTransform();
(transform as any)._test = 'retains';
transform.resize(511, 511);
transform.setZoom(0);
const tileManager = createTileManager();
tileManager._source.loadTile = async (tile) => {
tile.state = (tile.tileID.key === new OverscaledTileID(0, 0, 0, 0, 0).key) ? 'loaded' : 'loading';
};
const dataPromise = waitForEvent(tileManager, 'data', e => e.sourceDataType === 'metadata');
tileManager.onAdd(undefined);
await dataPromise;
tileManager.update(transform);
expect(tileManager.getIds()).toEqual([new OverscaledTileID(0, 0, 0, 0, 0).key]);
transform.setZoom(1);
tileManager.update(transform);
expect(tileManager.getIds()).toEqual([
new OverscaledTileID(0, 0, 0, 0, 0).key,
new OverscaledTileID(1, 0, 1, 1, 1).key,
new OverscaledTileID(1, 0, 1, 0, 1).key,
new OverscaledTileID(1, 0, 1, 1, 0).key,
new OverscaledTileID(1, 0, 1, 0, 0).key
]);
});
test('retains parent tiles for pending children (wrapped)', async () => {
const transform = new MercatorTransform();
transform.resize(511, 511);
transform.setZoom(0);
transform.setCenter(new LngLat(360, 0));
const tileManager = createTileManager();
tileManager._source.loadTile = async (tile) => {
tile.state = (tile.tileID.key === new OverscaledTileID(0, 1, 0, 0, 0).key) ? 'loaded' : 'loading';
};
const dataPromise = waitForEvent(tileManager, 'data', e => e.sourceDataType === 'metadata');
tileManager.onAdd(undefined);
await dataPromise;
tileManager.update(transform);
expect(tileManager.getIds()).toEqual([new OverscaledTileID(0, 1, 0, 0, 0).key]);
transform.setZoom(1);
tileManager.update(transform);
expect(tileManager.getIds()).toEqual([
new OverscaledTileID(0, 1, 0, 0, 0).key,
new OverscaledTileID(1, 1, 1, 1, 1).key,
new OverscaledTileID(1, 1, 1, 0, 1).key,
new OverscaledTileID(1, 1, 1, 1, 0).key,
new OverscaledTileID(1, 1, 1, 0, 0).key
]);
});
test('retains children tiles for pending parents', () => {
const transform = new GlobeTransform();
transform.resize(511, 511);
transform.setZoom(1);
transform.setCenter(new LngLat(360, 0));
const tileManager = createTileManager();
tileManager._source.loadTile = async (tile) => {
tile.state = (tile.tileID.key === new OverscaledTileID(0, 1, 0, 0, 0).key) ? 'loading' : 'loaded';
};
tileManager.on('data', (e) => {
if (e.sourceDataType === 'metadata') {
tileManager.update(transform);
expect(tileManager.getIds()).toEqual([
new OverscaledTileID(1, 1, 1, 1, 1).key,
new OverscaledTileID(1, 1, 1, 0, 1).key,
new OverscaledTileID(1, 1, 1, 1, 0).key,
new OverscaledTileID(1, 1, 1, 0, 0).key
]);
transform.setZoom(0);
tileManager.update(transform);
expect(tileManager.getIds()).toEqual([
new OverscaledTileID(0, 1, 0, 0, 0).key,
new OverscaledTileID(1, 1, 1, 1, 1).key,
new OverscaledTileID(1, 1, 1, 0, 1).key,
new OverscaledTileID(1, 1, 1, 1, 0).key,
new OverscaledTileID(1, 1, 1, 0, 0).key
]);
}
});
tileManager.onAdd(undefined);
});
test('retains overscaled loaded children', async () => {
const transform = new MercatorTransform();
transform.resize(511, 511);
transform.setZoom(16);
// use slightly offset center so that sort order is better defined
transform.setCenter(new LngLat(-0.001, 0.001));
const tileManager = createTileManager({reparseOverscaled: true});
tileManager._source.loadTile = async (tile) => {
tile.state = tile.tileID.overscaledZ === 16 ? 'loaded' : 'loading';
};
const dataPromise = waitForEvent(tileManager, 'data', e => e.sourceDataType === 'metadata');
tileManager.onAdd(undefined);
await dataPromise;
tileManager.update(transform);
expect(tileManager.getRenderableIds()).toEqual([
new OverscaledTileID(16, 0, 14, 8192, 8192).key,
new OverscaledTileID(16, 0, 14, 8191, 8192).key,
new OverscaledTileID(16, 0, 14, 8192, 8191).key,
new OverscaledTileID(16, 0, 14, 8191, 8191).key
]);
transform.setZoom(15);
tileManager.update(transform);
expect(tileManager.getRenderableIds()).toEqual([
new OverscaledTileID(16, 0, 14, 8192, 8192).key,
new OverscaledTileID(16, 0, 14, 8191, 8192).key,
new OverscaledTileID(16, 0, 14, 8192, 8191).key,
new OverscaledTileID(16, 0, 14, 8191, 8191).key
]);
});
test('reassigns tiles for large jumps in longitude', async () => {
const transform = new MercatorTransform();
transform.resize(511, 511);
transform.setZoom(0);
const tileManager = createTileManager({});
const dataPromise = waitForEvent(tileManager, 'data', e => e.sourceDataType === 'metadata');
tileManager.onAdd(undefined);
await dataPromise;
transform.setCenter(new LngLat(360, 0));
const tileID = new OverscaledTileID(0, 1, 0, 0, 0);
tileManager.update(transform);
expect(tileManager.getIds()).toEqual([tileID.key]);
const tile = tileManager.getTile(tileID);
transform.setCenter(new LngLat(0, 0));
const wrappedTileID = new OverscaledTileID(0, 0, 0, 0, 0);
tileManager.update(transform);
expect(tileManager.getIds()).toEqual([wrappedTileID.key]);
expect(tileManager.getTile(wrappedTileID)).toBe(tile);
});
test('retains fading children and applies fading logic when zooming out', async () => {
const transform = new MercatorTransform();
transform.resize(1024, 1024);
transform.setZoom(10);
const tileManager = createTileManager({raster: true});
const loadedTiles: Record<string, Tile> = {};
tileManager._source.loadTile = async (tile) => {
loadedTiles[tile.tileID.key] = tile;
tile.state = 'loaded';
};
tileManager.on('data', (e) => {
if (e.dataType === 'source' && e.sourceDataType === 'metadata') {
tileManager.update(transform);
}
});
tileManager.setRasterFadeDuration(300);
tileManager.onAdd(undefined);
// get default zoom ideal tiles at zoom specified above
await sleep(0);
// ideal tiles will become fading children when zooming out
const children: Tile[] = Object.values(loadedTiles);
// zoom out 1 level - ideal tiles (new children) should fade out
transform.setZoom(9);
tileManager.update(transform);
await sleep(0);
// ensure that the loaded child was retained and fading logic was applied
for (const child of children) {
expect(loadedTiles).toHaveProperty(child.tileID.key);
expect(child.fadingRole).toEqual(FadingRoles.Base);
expect(child.fadingDirection).toEqual(FadingDirections.Departing);
expect(child.fadingParentID).toBeInstanceOf(OverscaledTileID);
}
});
test('retains fading grandchildren and applies fading logic when zooming out', async () => {
const transform = new MercatorTransform();
transform.resize(512, 512);
transform.setZoom(10);
const tileManager = createTileManager({raster: true});
const loadedTiles: Record<string, Tile> = {};
tileManager._source.loadTile = async (tile) => {
loadedTiles[tile.tileID.key] = tile;
tile.state = 'loaded';
};
tileManager.on('data', (e) => {
if (e.dataType === 'source' && e.sourceDataType === 'metadata') {
tileManager.update(transform);
}
});
tileManager.setRasterFadeDuration(300);
tileManager.onAdd(undefined);
// get default zoom ideal tiles at zoom specified above
await sleep(0);
// ideal tiles will become fading grandchildren when zooming out
const grandChildren: Tile[] = Object.values(loadedTiles);
// zoom out 2 levels - ideal tiles (new grandchildren) should fade out
transform.setZoom(8);
tileManager.update(transform);
await sleep(0);
// ensure that the loaded grandchild was retained and fading logic was applied
for (const grandChild of grandChildren) {
expect(loadedTiles).toHaveProperty(grandChild.tileID.key);
expect(grandChild.fadingRole).toEqual(FadingRoles.Base);
expect(grandChild.fadingDirection).toEqual(FadingDirections.Departing);
expect(grandChild.fadingParentID).toBeInstanceOf(OverscaledTileID);
}
});
test('retains fading parent and applies fading logic when zooming in', async () => {
const transform = new MercatorTransform();
transform.resize(512, 512);
transform.setZoom(10);
const tileManager = createTileManager({raster: true});
const loadedTiles: Record<string, Tile> = {};
tileManager._source.loadTile = async (tile) => {
loadedTiles[tile.tileID.key] = tile;
tile.state = 'loaded';
};
tileManager.on('data', (e) => {
if (e.dataType === 'source' && e.sourceDataType === 'metadata') {
tileManager.update(transform);
}
});
tileManager.setRasterFadeDuration(300);
tileManager.onAdd(undefined);
// get default zoom ideal tiles at zoom specified above
await sleep(0);
// ideal tiles will become fading parent when zooming in
const parents: Tile[] = Object.values(loadedTiles);
const parentKeys = new Set(parents.map(p => p.tileID.key));
// zoom in 1 level - ideal tiles (new parent) should fade out
transform.setZoom(11);
tileManager.update(transform);
await sleep(0);
// ensure that the loaded parents were retained and fading logic was applied
for (const parent of parents) {
expect(loadedTiles).toHaveProperty(parent.tileID.key);
expect(parent.fadingRole).toEqual(FadingRoles.Parent);
expect(parent.fadingDirection).toEqual(FadingDirections.Departing);
}
// check incoming tiles
const incoming = Object.values(loadedTiles).filter(tile => !parentKeys.has(tile.tileID.key));
for (const tile of incoming) {
expect(tile.fadingRole).toEqual(FadingRoles.Base);
expect(tile.fadingDirection).toEqual(FadingDirections.Incoming);
expect(tile.fadingParentID).toBeInstanceOf(OverscaledTileID);
}
});
test('retains fading grandparent and applies fading logic when zooming in', async () => {
const transform = new MercatorTransform();
transform.resize(512, 512);
transform.setZoom(10);
const tileManager = createTileManager({raster: true});
const loadedTiles: Record<string, Tile> = {};
tileManager._source.loadTile = async (tile) => {
loadedTiles[tile.tileID.key] = tile;