Drape the open-data map overlays through the renderer's globe port

The sea-mark and ski-piste overlays add an XYZ imagery layer through the
globe port instead of building Cesium layers into a host collection. The
port drapes it on the globe on globe stacks and on the Google 3D tiles,
which the map stack now marks as its base tilesets. The row's hidden
reason reads the map stack's new getDrapeSurface, or the viewer's globe
when there is no map stack, and an overlay enabled before its viewer has
a globe port adds its layer once there is one. The overlays no longer
reach Cesium, so they leave the allow-list.
This commit is contained in:
Sameh Khamis committed 2026-11-06 18:29:40 -08:00
1 parent c67cda5f84
commit b3dfcddcde
6 files changed
+152 -126

No files matched your search

+77 -56
View File
@@ -5,28 +5,29 @@ import {
createOsmOverlayLayer,
createOsmOverlayLayers,
osmOverlayHiddenReason,
osmOverlaySpec,
} from './osmOverlays.js';
import { NO_IMAGERY_HOST } from '../maps/imageryHost.js';
function fakeCollection() {
/** A globe port recording the imagery layers added and removed through it. */
function fakeGlobe() {
const layers = [];
const removed = [];
return {
layers,
removed,
add(layer) {
layers.push(layer);
},
contains(layer) {
return layers.includes(layer);
},
remove(layer, destroy) {
const index = layers.indexOf(layer);
if (index < 0) return false;
layers.splice(index, 1);
removed.push({ layer, destroy });
if (destroy) layer.destroyed = true;
return true;
imagery: {
add(spec) {
const layer = {
spec,
removed: false,
remove() {
layer.removed = true;
layers.splice(layers.indexOf(layer), 1);
},
};
layers.push(layer);
return layer;
},
list: () => layers.slice(),
},
};
}
@@ -34,9 +35,9 @@ function fakeCollection() {
function fakeMapStack() {
const subscribers = new Set();
return {
tileset: null,
getImageryHostTileset() {
return this.tileset;
surface: 'globe',
getDrapeSurface() {
return this.surface;
},
subscribe(fn) {
subscribers.add(fn);
@@ -50,24 +51,15 @@ function fakeMapStack() {
}
function setup(overlay = OSM_OVERLAYS[0]) {
const globe = fakeCollection();
const viewer = {
imageryLayers: globe,
scene: { globe: { show: true }, requestRender() {} },
};
const created = [];
const globe = fakeGlobe();
const viewer = { scene: { globe: { show: true } } };
const layer = createOsmOverlayLayer(overlay, {
createProvider: (descriptor) => ({ descriptor }),
createImageryLayer: (provider) => {
const imagery = { provider, destroyed: false };
created.push(imagery);
return imagery;
},
globeOf: (given) => (given === viewer ? globe : null),
});
const mapStack = fakeMapStack();
layer.init(viewer);
layer.attachMapStackController(mapStack);
return { layer, viewer, globe, created, mapStack };
return { layer, viewer, globe, mapStack };
}
test('OSM_OVERLAYS: the two shipped layers, each with a tile template and credit', () => {
@@ -103,65 +95,94 @@ test('osmOverlayHiddenReason: only when enabled with no imagery host', () => {
assert.equal(osmOverlayHiddenReason(true, 'none'), NO_IMAGERY_HOST);
});
test('a layer owns no imagery until enabled and destroys it on disable', () => {
const { layer, globe, created } = setup(OSM_OVERLAYS[1]);
assert.equal(created.length, 0);
test('a layer owns no imagery until enabled and removes it on disable', () => {
const { layer, globe } = setup(OSM_OVERLAYS[1]);
assert.equal(globe.layers.length, 0);
layer.enable();
assert.equal(globe.layers.length, 1);
assert.equal(globe.layers[0].provider.descriptor.id, 'ski-pistes');
assert.deepEqual(globe.layers[0].spec, osmOverlaySpec(OSM_OVERLAYS[1]));
assert.deepEqual(globe.layers[0].spec, {
kind: 'xyz',
url: 'https://www.opensnowmap.org/pistes/{z}/{x}/{y}.png',
maxLevel: 18,
credit: { text: OSM_OVERLAYS[1].credit },
});
assert.deepEqual(layer.getStats(), { count: 1, error: null });
const [first] = globe.layers;
layer.disable();
assert.equal(globe.layers.length, 0);
assert.equal(created[0].destroyed, true);
assert.equal(first.removed, true);
assert.deepEqual(layer.diagnostics(), { host: 'none', ownedCount: 0 });
assert.deepEqual(layer.getStats(), { count: 0, error: null });
layer.enable();
assert.equal(created.length, 2, 're-enabling creates a fresh imagery layer');
assert.notEqual(globe.layers[0], first, 're-enabling adds a fresh layer');
});
test('the overlay follows a map-stack switch onto the Google 3D tileset and back', () => {
const { layer, viewer, globe, mapStack } = setup();
test('a map-stack switch onto Google 3D keeps the one layer, which the renderer drapes there', () => {
const { layer, globe, mapStack } = setup();
layer.enable();
const [imagery] = globe.layers;
const tileset = { imageryLayers: fakeCollection() };
viewer.scene.globe.show = false;
mapStack.tileset = tileset;
mapStack.surface = 'tileset';
mapStack.emit();
assert.equal(globe.layers.length, 0);
assert.deepEqual(tileset.imageryLayers.layers, [imagery]);
assert.equal(globe.removed[0].destroy, false);
assert.deepEqual(globe.layers, [imagery]);
assert.equal(layer.diagnostics().host, 'tileset');
assert.equal(layer.getStats().error, null);
viewer.scene.globe.show = true;
mapStack.tileset = null;
mapStack.surface = 'globe';
mapStack.emit();
assert.deepEqual(globe.layers, [imagery]);
assert.equal(tileset.imageryLayers.layers.length, 0);
assert.equal(layer.diagnostics().host, 'globe');
});
test('with no surface to drape on the row explains itself, and recovers when one appears', () => {
const { layer, viewer, globe, mapStack } = setup();
viewer.scene.globe.show = false;
const { layer, globe, mapStack } = setup();
mapStack.surface = 'none';
layer.enable();
assert.equal(globe.layers.length, 0);
assert.equal(globe.layers.length, 1, 'kept, drawn when a surface is');
assert.equal(layer.getStats().error, NO_IMAGERY_HOST);
viewer.scene.globe.show = true;
mapStack.surface = 'globe';
mapStack.emit();
assert.equal(globe.layers.length, 1);
assert.equal(layer.getStats().error, null);
});
test('without a map stack, the viewer’s globe decides, polled by the stats', () => {
const globe = fakeGlobe();
const viewer = { scene: { globe: { show: false } } };
const layer = createOsmOverlayLayer(OSM_OVERLAYS[0], {
globeOf: () => globe,
});
layer.init(viewer);
layer.enable();
assert.equal(layer.getStats().error, NO_IMAGERY_HOST);
viewer.scene.globe.show = true;
assert.equal(layer.getStats().error, null);
});
test('destroy removes owned imagery and unsubscribes from the map stack', () => {
const { layer, globe, created, mapStack } = setup();
const { layer, globe, mapStack } = setup();
layer.enable();
const [imagery] = globe.layers;
layer.destroy();
assert.equal(globe.layers.length, 0);
assert.equal(created[0].destroyed, true);
assert.equal(imagery.removed, true);
assert.equal(mapStack.subscribers.size, 0);
});
test('an overlay enabled before its viewer has a globe port adds it once one does', () => {
const globe = fakeGlobe();
let port = null;
const layer = createOsmOverlayLayer(OSM_OVERLAYS[0], { globeOf: () => port });
layer.init({ scene: { globe: { show: true } } });
layer.enable();
assert.equal(layer.diagnostics().ownedCount, 0);
port = globe;
layer.getStats();
assert.equal(globe.layers.length, 1);
layer.getStats();
assert.equal(globe.layers.length, 1, 'added once');
});