Add layer and map credits through the renderer's credits port

The street-level provider credits, the map source credit, the shared
inline OpenStreetMap and OpenMapTiles credits and the ALPR provider credit
go through the renderer's credits port instead of Cesium's credit display.
Their markup has one link each and is read as the port's plain data; the
ALPR credit is built as plain data, which the port escapes. src/maps/credits.js
and src/layers/streetLevel/credits.js no longer reach Cesium and leave the
allow-list.

findCredits finds the port as findCamera finds the camera: a Cesium viewer
of a caller's own, with no renderer bound, gets a credits port over its
own credit display, so the public entries keep their attribution. A port
built that way is released, not disposed, when a renderer binds later, and
a credit let go after its viewer is destroyed leaves the display alone.

The per-layer data credits and the transit and event credits stay on
Cesium's display: their markup carries several links each, which the
contract's credit cannot hold.
This commit is contained in:
Sameh Khamis committed 2026-11-06 16:32:23 -08:00
1 parent 979e2213b9
commit 765a0db094
26 files changed
+418 -142

No files matched your search

+3 -5
View File
@@ -12,7 +12,7 @@ import {
boxContains,
alprRetryDelayMs,
validateAlprSnapshot,
alprCreditMarkup,
alprCredit,
} from './model.js';
import { createAlprPresentation } from './presentation.js';
import { t, tn, msg } from '../../i18n/index.js';
@@ -44,6 +44,7 @@ export function createAlprCamerasLayer({ source, services } = {}) {
credit: null,
creditTimer: null,
creditPresented: false,
creditOff: null,
enabled: false,
records: [],
recordById: new Map(),
@@ -297,10 +298,7 @@ export function createAlprCamerasLayer({ source, services } = {}) {
if (state.viewer) throw new Error('ALPR layer is already initialized');
state.viewer = viewer;
state.dataSource = new Cesium.CustomDataSource('alpr-cameras');
const creditMarkup = alprCreditMarkup(source.attribution);
state.credit = creditMarkup
? new Cesium.Credit(creditMarkup, true)
: null;
state.credit = alprCredit(source.attribution);
viewer.dataSources.add(state.dataSource);
state.moveEndRemove =
viewer.camera.moveEnd.addEventListener(scheduleLoad);
+7 -15
View File
@@ -31,24 +31,16 @@ export function destinationPointDeg(latDeg, lonDeg, bearingDeg, distanceM) {
};
}
/** Build a linked attribution from plain text and an HTTPS URL only. */
export function alprCreditMarkup(attribution) {
/**
* The on-map credit for the renderer's credits port, from plain text and an
* HTTPS URL only; the port escapes it as it shows it.
* @returns {{text: string, href: string, inline: true}|null}
*/
export function alprCredit(attribution) {
if (!attribution?.text || !attribution?.href) return null;
const href = new URL(attribution.href);
if (href.protocol !== 'https:' || href.username || href.password) {
throw new TypeError('Camera attribution requires a public HTTPS link');
}
const escape = (value) =>
String(value).replace(
/[&<>"']/g,
(char) =>
({
'&': '&amp;',
'<': '&lt;',
'>': '&gt;',
'"': '&quot;',
"'": '&#39;',
})[char],
);
return `<span class="gev-alpr-credit">ALPR: <a href="${escape(href.href)}" target="_blank" rel="noopener">${escape(attribution.text)}</a></span>`;
return { text: `ALPR: ${attribution.text}`, href: href.href, inline: true };
}
+5 -3
View File
@@ -28,6 +28,7 @@ import { entityRecord, readEntityRecord } from '../../data/entityRecords.js';
import { alprMarkers } from './markerState.js';
import { heightsFor } from '../../queries/heights.js';
import { cameraOf } from '../../render/cesium/camera.js';
import { findCredits } from '../../render/rendererOf.js';
export function createAlprPresentation({ state, services, source }) {
const { governorRequestRender } = services.render;
@@ -326,8 +327,8 @@ export function createAlprPresentation({ state, services, source }) {
services.credits?.hideOsmCredit?.(state.viewer, LAYER_ID);
clearTimeout(state.creditTimer);
state.creditTimer = null;
if (state.credit)
state.viewer?.creditDisplay?.removeStaticCredit(state.credit);
state.creditOff?.();
state.creditOff = null;
governorRequestRender('alpr-credit');
}
@@ -342,7 +343,8 @@ export function createAlprPresentation({ state, services, source }) {
}
if (!state.enabled || state.creditPresented || !state.credit) return;
state.creditPresented = true;
state.viewer.creditDisplay?.addStaticCredit(state.credit);
state.creditOff =
findCredits(state.viewer)?.addStatic(state.credit) ?? null;
state.creditTimer = setTimeout(hideOnMapCredit, CREDIT_DISPLAY_MS);
governorRequestRender('alpr-credit');
}
+20 -11
View File
@@ -8,7 +8,7 @@ import {
createOverpassAlprSource,
buildOverpassQuery,
} from './source.js';
import { validateAlprSnapshot, alprCreditMarkup } from './model.js';
import { validateAlprSnapshot, alprCredit } from './model.js';
const box = { south: 30, west: -98, north: 30.1, east: -97.9 };
test('the source rejects invalid and unbounded queries before fetching', async () => {
let calls = 0;
@@ -130,19 +130,28 @@ test('source snapshots reject malformed coordinates and duplicate identities', (
);
});
test('provider attribution escapes markup and rejects executable links', () => {
assert.equal(alprCreditMarkup(null), null);
test('provider attribution is plain text with a public HTTPS link only', () => {
assert.equal(alprCredit(null), null);
assert.throws(
() => alprCreditMarkup({ text: 'test', href: 'javascript:alert(1)' }),
() => alprCredit({ text: 'test', href: 'javascript:alert(1)' }),
/HTTPS/,
);
const html = alprCreditMarkup({
text: '<img onerror=alert(1)>',
href: 'https://example.org/?a=1&b=2',
});
assert.ok(html.includes('&lt;img onerror=alert(1)&gt;'));
assert.ok(html.includes('?a=1&amp;b=2'));
assert.ok(!html.includes('<img'));
assert.throws(
() => alprCredit({ text: 'test', href: 'https://user:[email protected]/' }),
/HTTPS/,
);
assert.deepEqual(
alprCredit({
text: '<img onerror=alert(1)>',
href: 'https://example.org/?a=1&b=2',
}),
{
text: 'ALPR: <img onerror=alert(1)>',
href: 'https://example.org/?a=1&b=2',
inline: true,
},
'left as text: the credits port escapes it',
);
});
test('wide detail view returns zoom guidance before any fetch and can retry a smaller view', async () => {