Merge pull request #1543 from Byrd-IT/byrdit/cctv-visible-only-fetch

perf(cctv): fetch the active camera's pictures only while they can be seen
This commit is contained in:
German Khokhlov authored and GitHub committed 2026-11-20 19:42:08 +04:00
commit 41c792208e
24 files changed
+934 -51

No files matched your search

@@ -0,0 +1,4 @@
- Stop fetching the active CCTV camera's pictures when nobody can see them. The
monitor plane skips its 10 s still while it is off screen or below the
horizon, and the still preview waits for a visible tab and an open panel or
Context camera card (on phones, the open Cameras or Context sheet) (Byrd-IT, #1543).
+10
View File
@@ -2087,6 +2087,16 @@ already shows, so the list cannot pick that camera: FOCUS does, and so does
NEAREST when that camera is the nearest. Closing the list without a choice
keeps automatic selection.
The active camera's pictures follow what can be seen. The monitor plane skips
its 10 s still while the renderer reports it off screen or below the horizon,
and fetches on the first refresh tick after it is back. Activating or
calibrating a camera bypasses visibility and the usual refresh interval, but
still waits for an in-flight request and the provider's minimum interval.
The panel's still and live video run only while the tab is visible and the
panel is open (on phones, the Cameras sheet). The still also loads while
Context shows the camera's card (on phones, the Context sheet) or its bigger
view is open.
Traffic owns its rendered-surface observer only while enabled, removes it on disable/destroy, and rebuilds no cached heights on frames where the surface identity is unchanged. Its dots and heat-lines are two renderer draw sets, it animates on the frame port's preRender, and it follows the camera through the camera port at its own 5% threshold rather than the shared `percentageChanged` ledger. The surface identity is the globe port's `surfaceVersion()` and tile readiness its `isSettled('surface')`, so the layer no longer reaches Cesium. Heat-lines are always asked for draped: where the Cesium renderer cannot drape (no depth textures) its draw port draws them (and every other draped line) over the surface, in their colour where the surface hides them and hidden past the horizon, recolouring a line in place when only its colour changes, rather than the layer dropping them.
Traffic and bikeshare expose factories through `./layers/traffic` and
+7
View File
@@ -81,6 +81,13 @@ optional:
target's east-north-up frame, or the identity. `setView` keeps that frame
while it places a world pose. A share link's follow offset is
re-expressed in it, satellites included.
- `camera.visiblePoints(points, horizonMarginM)` (capability `pointVisibility`)
is whether any of the points may be on screen: `false` only when their
bounding sphere is outside the view or all of them are below the horizon
of the WGS84 ellipsoid shrunk by `horizonMarginM` metres; `null` when it
cannot tell (not a 3D scene, an empty point set, or a non-finite point or
camera vector), and callers count that as visible. Supply a finite,
nonnegative margin smaller than the shortest WGS84 radius.
- `globe.surfaceVersion()` (capability `surfaceIdentity`) is a number that
changes whenever what surface heights answer against changes (base,
terrain or photoreal route swapped, the globe shown or hidden) and never
+3
View File
@@ -1103,6 +1103,7 @@
"src/ui/cctv.js",
"src/ui/cctvBindings.js",
"src/ui/cctvCalibration.js",
"src/ui/mobileSheets.js",
"src/ui/cctvControls.js",
"src/ui/cctvFrames.js",
"src/ui/cctvVideo.js",
@@ -1343,6 +1344,7 @@
"src/data/distanceFormat.js",
"src/i18n/marker.js",
"src/ui/mobileShell.js",
"src/ui/mobileSheets.js",
"src/exclusiveSurfaces.js",
"src/ui/placeNames.js",
"src/hudLayouts.js",
@@ -4795,6 +4797,7 @@
"src/ui/applicationShell.js",
"src/ui/railEdgeScroll.js",
"src/ui/mobileShell.js",
"src/ui/mobileSheets.js",
"src/ui/localePicker.js",
"src/ui/cyberSonarControls.js",
"src/ui/locationNavigation.js",
+24
View File
@@ -1,3 +1,4 @@
import { findCamera } from '../../render/rendererOf.js';
import {
FRAME_SIGNATURE_W,
FRAME_SIGNATURE_H,
@@ -41,6 +42,11 @@ export function fitToProjection(sourceW, sourceH) {
};
}
const PLANE_POINTS = ['mount', 'tl', 'tr', 'br', 'bl'];
const _scratchPoints = [];
// Keep the occluding surface below common negative geoid undulations.
const HORIZON_MARGIN_M = 200;
export function createFrames({ state: layerState, services, parts, source }) {
/**
* FNV-1a over the RGB channels of a downsampled frame. Pure (takes the raw
@@ -236,6 +242,22 @@ export function createFrames({ state: layerState, services, parts, source }) {
ctx.fillText(status.slice(0, 58), 46, h - 42);
}
/**
* Whether a camera's monitor plane may be on screen; what cannot be judged counts as visible.
* @param {Object} record - Camera record.
* @returns {boolean}
*/
function projectionInView(record) {
const camera = findCamera(layerState._viewer);
if (typeof camera?.visiblePoints !== 'function') return true;
const placed = record.frustumPositions;
if (!placed) return true;
const points = _scratchPoints;
points.length = 0;
for (const key of PLANE_POINTS) points.push(placed[key]);
return camera.visiblePoints(points, HORIZON_MARGIN_M) !== false;
}
/**
* Triggers a new frame fetch for an image-mode projection if the refresh
* interval has elapsed. Active cameras refresh more frequently than idle ones.
@@ -269,6 +291,8 @@ export function createFrames({ state: layerState, services, parts, source }) {
// bypass a provider's explicit minimum between image requests.
if (sourceRefreshMs > 0 && sinceLastRefresh < sourceRefreshMs) return;
if (!force && sinceLastRefresh < refreshMs) return;
// Skip before stamping lastImageRefreshAt, so the first tick back in view fetches.
if (!force && !projectionInView(record)) return;
runtime.lastImageRefreshAt = now;
const frameUrl = frameUrlFor(record.camera, refreshMs);
+108
View File
@@ -3,6 +3,7 @@
// 1920x1080 projection canvas, instead of being stretched to fill it.
import { test } from 'node:test';
import assert from 'node:assert/strict';
import { bindRenderer } from '../../render/rendererOf.js';
import { createFrames, fitToProjection } from './frames.js';
import {
FRAME_SIGNATURE_W,
@@ -170,3 +171,110 @@ test('a failed pixel signature redraws rather than assuming equal content', () =
assert.deepEqual(load(640, 480).at(-1), ['drawImage', 240, 0, 1440, 1080]);
assert.equal(runtime.canvasStamp, 2);
});
const MOUNT = { x: 0, y: 0, z: 0 };
function planeRecord() {
return {
camera: { id: 'plane' },
position: MOUNT,
frustumPositions: {
mount: MOUNT,
capCenter: { x: 1, y: 0, z: 0 },
tl: { x: 1, y: -1, z: 1 },
tr: { x: 1, y: 1, z: 1 },
br: { x: 1, y: 1, z: -1 },
bl: { x: 1, y: -1, z: -1 },
},
projection: {
mode: 'image',
image: {},
imageLoading: false,
imageReady: false,
lastImageRefreshAt: 0,
},
};
}
function framesFor(viewer) {
const state = {
_viewer: viewer,
_healthById: new Map(),
_activeCameraId: 'plane',
};
return createFrames({
state,
services: {},
parts: {
model: {
safeNumber: (value, fallback) =>
Number.isFinite(Number(value)) ? Number(value) : fallback,
},
},
source: { getFrameUrl: () => '/api/cctv/frame?id=plane' },
});
}
function framesWithCamera(t, camera) {
const host = {};
t.after(bindRenderer(host, { camera }));
return framesFor(host);
}
test('a plane the renderer may show fetches its picture', (t) => {
const visiblePoints = t.mock.fn(() => true);
const frames = framesWithCamera(t, { visiblePoints });
const record = planeRecord();
frames.refreshProjectionImage(record);
assert.match(
record.projection.image.src,
/^\/api\/cctv\/frame\?id=plane&projTs=/,
);
assert.equal(record.projection.imageLoading, true);
assert.equal(visiblePoints.mock.callCount(), 1);
const [points, margin] = visiblePoints.mock.calls[0].arguments;
const { mount, tl, tr, br, bl } = record.frustumPositions;
assert.deepEqual(points, [mount, tl, tr, br, bl]);
assert.equal(points[0], mount);
assert.equal(margin, 200);
});
test('a plane the renderer cannot show is not fetched, but a forced refresh is', (t) => {
const frames = framesWithCamera(t, { visiblePoints: () => false });
const record = planeRecord();
frames.refreshProjectionImage(record);
assert.equal(record.projection.image.src, undefined);
assert.equal(record.projection.lastImageRefreshAt, 0);
frames.refreshProjectionImage(record, true);
assert.match(record.projection.image.src, /projTs=/);
});
test('a skipped refresh does not use up the interval', (t) => {
let visible = false;
const frames = framesWithCamera(t, { visiblePoints: () => visible });
const record = planeRecord();
frames.refreshProjectionImage(record);
assert.equal(record.projection.image.src, undefined);
visible = true;
frames.refreshProjectionImage(record);
assert.match(record.projection.image.src, /projTs=/);
});
test('what cannot be judged counts as visible', (t) => {
for (const frames of [
framesWithCamera(t, { visiblePoints: () => null }),
framesWithCamera(t, { pose: () => ({}) }),
framesFor(null),
]) {
const record = planeRecord();
frames.refreshProjectionImage(record);
assert.match(record.projection.image.src, /projTs=/);
}
const noGeometry = planeRecord();
delete noGeometry.frustumPositions;
const visiblePoints = t.mock.fn(() => false);
framesWithCamera(t, { visiblePoints }).refreshProjectionImage(noGeometry);
assert.equal(visiblePoints.mock.callCount(), 0);
assert.match(noGeometry.projection.image.src, /projTs=/);
});
+56
View File
@@ -86,6 +86,62 @@ function sameMatrix(array, matrix) {
return true;
}
const finiteVector = (v) =>
!!v && Number.isFinite(v.x) && Number.isFinite(v.y) && Number.isFinite(v.z);
/** Conservative globe/frustum visibility; null means unknown. */
export function createPointsVisibility(scene, camera) {
const visibilitySphere = new Cesium.BoundingSphere();
let visibilityMargin = null;
let visibilityEllipsoid = null;
let visibilityOccluder = null;
return function visiblePoints(points, marginM) {
const eye = camera.positionWC;
const direction = camera.directionWC;
const up = camera.upWC;
if (
scene.mode !== Cesium.SceneMode.SCENE3D ||
!points?.length ||
!finiteVector(eye) ||
!finiteVector(direction) ||
!finiteVector(up) ||
!points.every(finiteVector)
)
return null;
if (visibilityMargin !== marginM) {
const radii = Cesium.Ellipsoid.WGS84.radii;
visibilityMargin = marginM;
visibilityEllipsoid = new Cesium.Ellipsoid(
radii.x - marginM,
radii.y - marginM,
radii.z - marginM,
);
visibilityOccluder = new Cesium.EllipsoidalOccluder(visibilityEllipsoid);
}
const inverse = visibilityEllipsoid.oneOverRadii;
// Inside the ellipsoid Cesium's occluder hides nearby points; judge by the frustum alone.
const outside =
Math.hypot(eye.x * inverse.x, eye.y * inverse.y, eye.z * inverse.z) >= 1;
if (outside) {
visibilityOccluder.cameraPosition = eye;
let visible = false;
for (const p of points) {
if (visibilityOccluder.isPointVisible(p)) {
visible = true;
break;
}
}
if (!visible) return false;
}
const culling = camera.frustum.computeCullingVolume(eye, direction, up);
return (
culling.computeVisibility(
Cesium.BoundingSphere.fromPoints(points, visibilitySphere),
) !== Cesium.Intersect.OUTSIDE
);
};
}
/**
* @param {{scene: object, camera: object, report: (error: unknown) => void,
* widget?: object, capabilities?: ReadonlySet<string>,
+142 -1
View File
@@ -19,7 +19,7 @@ import {
headlessCamera,
withVirtualClock,
} from './cameraGoldens.js';
import { createCesiumCamera } from './camera.js';
import { createCesiumCamera, createPointsVisibility } from './camera.js';
import { createCesiumPorts } from './ports.js';
import { bindRenderer, cameraOf } from '../rendererOf.js';
@@ -337,6 +337,147 @@ test('the camera port gives the clock its own tick back as it goes', () => {
}
});
test('visiblePoints is there only with its capability, and unknown outside 3D', (t) => {
const { scene } = headlessCamera();
for (const name of ['preUpdate', 'postUpdate', 'preRender', 'postRender'])
scene[name] = new Cesium.Event();
scene.primitives = { add() {}, remove() {} };
scene.requestRender = () => {};
const viewer = { scene, clock: { currentTime: Cesium.JulianDate.now() } };
const without = createCesiumPorts(viewer, { capabilities: new Set() });
assert.equal(without.camera.visiblePoints, undefined);
without.dispose();
const ports = createCesiumPorts(viewer, {
capabilities: new Set(['pointVisibility']),
});
t.after(() => ports.dispose());
const points = [Cesium.Cartesian3.fromDegrees(0, 0, 10)];
for (const mode of [
Cesium.SceneMode.SCENE2D,
Cesium.SceneMode.COLUMBUS_VIEW,
Cesium.SceneMode.MORPHING,
undefined,
]) {
scene.mode = mode;
assert.equal(ports.camera.visiblePoints(points, 200), null);
}
scene.mode = Cesium.SceneMode.SCENE3D;
assert.equal(typeof ports.camera.visiblePoints(points, 200), 'boolean');
});
const point = (lon, lat, altitude = 20) =>
Cesium.Cartesian3.fromDegrees(lon, lat, altitude);
const down = Cesium.Cartesian3.negate(
Cesium.Cartesian3.UNIT_X,
new Cesium.Cartesian3(),
);
const up = Cesium.Cartesian3.UNIT_Z;
const frustum = new Cesium.PerspectiveFrustum({
fov: Cesium.Math.toRadians(60),
aspectRatio: 16 / 9,
near: 1,
// Cesium's default far plane, as the app uses.
far: 5e8,
});
function visibility(position, direction, up) {
const visiblePoints = createPointsVisibility(
{ mode: Cesium.SceneMode.SCENE3D },
{ positionWC: position, directionWC: direction, upWC: up, frustum },
);
return (points) => visiblePoints(points, 200);
}
function directionTo(position, target) {
return Cesium.Cartesian3.normalize(
Cesium.Cartesian3.subtract(target, position, new Cesium.Cartesian3()),
new Cesium.Cartesian3(),
);
}
function assertInFrustum(points, position, direction) {
const culling = frustum.computeCullingVolume(position, direction, up);
assert.notEqual(
culling.computeVisibility(Cesium.BoundingSphere.fromPoints(points)),
Cesium.Intersect.OUTSIDE,
);
}
test('a plane in front of the camera is visible', () => {
assert.equal(visibility(point(0, 0, 30000), down, up)([point(0, 0)]), true);
});
test('a plane behind the camera is outside the frustum', () => {
assert.equal(
visibility(point(0, 0, 30000), Cesium.Cartesian3.UNIT_X, up)([point(0, 0)]),
false,
);
});
test('a corner can be in view when the mount and centre are outside', () => {
const visible = visibility(point(0, 0, 30000), down, up);
const mount = point(0.3, 0);
const points = [
mount,
point(0.1, 0.0001),
point(0.3, 0.0001),
point(0.3, -0.0001),
point(0.1, -0.0001),
];
assert.equal(visible(points), true);
assert.equal(visible([mount]), false);
assert.equal(visible([point(0.2, 0)]), false);
});
test('a nearby plane below the ellipsoid is visible to low and high viewers', () => {
const cap = point(0.00054, 0, -18);
const points = [point(0, 0, -18), cap];
for (const altitude of [4, 1200]) {
const position = point(0.00135, 0, altitude);
const direction = directionTo(position, cap);
assertInFrustum(points, position, direction);
assert.equal(visibility(position, direction, up)(points), true);
}
});
test('the horizon rejects a negative-height plane on the far side', () => {
const mount = point(0, 0, -18);
const points = [mount, point(0.00054, 0, -18)];
for (const altitude of [4, 30000, 2e7]) {
const position = point(180, 0, altitude);
const direction = directionTo(position, mount);
assertInFrustum(points, position, direction);
assert.equal(visibility(position, direction, up)(points), false);
}
});
test('a low viewer can see a plane beyond the WGS84 horizon', () => {
const mount = point(0, 0, 1);
const position = point(0.2, 0, 4);
assert.equal(
visibility(position, directionTo(position, mount), up)([mount]),
true,
);
});
test('deep viewers do not lose nearby planes to the horizon test', () => {
const mount = point(0, 0, -350);
const position = point(0.00135, 0, -300);
assert.equal(
visibility(position, directionTo(position, mount), up)([mount]),
true,
);
});
test('a non-finite camera direction leaves visibility unknown', () => {
const visible = visibility(
point(0, 0, 30000),
new Cesium.Cartesian3(NaN, 0, 0),
up,
);
assert.equal(visible([point(0, 0)]), null);
});
test('setFov holds the vertical angle across resizes, and waits for a first one', () => {
const { scene, camera } = headlessCamera();
scene.postUpdate = new Cesium.Event();
@@ -321,6 +321,8 @@ test('the application’s Cesium renderer runs the controller around its preUpda
const renderer = await plugin.create({ container: {} });
assert.equal(scene.screenSpaceCameraController.enableInputs, false);
assert.equal(typeof renderer.camera.native.setPose, 'function');
assert.equal(renderer.capabilities.has('pointVisibility'), true);
assert.equal(renderer.camera.visiblePoints([], 200), null);
renderer.frame.on('preUpdate', () => order.push('preUpdate'));
scene.preUpdate.raise(scene, Cesium.JulianDate.fromDate(new Date(5000)));
assert.deepEqual(order, [['before', 5000], 'preUpdate', 'after']);
+4 -1
View File
@@ -13,7 +13,7 @@
* absent, never stubbed.
*/
import * as Cesium from 'cesium';
import { createCesiumCamera } from './camera.js';
import { createCesiumCamera, createPointsVisibility } from './camera.js';
import { createControlledCamera } from './controlledCamera.js';
import { listenerList, toCartesian, uncaught } from './common.js';
import { createCesiumCredits } from './credits.js';
@@ -84,6 +84,7 @@ export function cesiumCapabilities(scene, only) {
// Raster shells; other field kinds are refused.
'fields',
'followFrame',
'pointVisibility',
// Cesium's AUTODETECT tracking frame (`follow.js`).
'followAutodetect',
'cameraChangeThreshold',
@@ -488,6 +489,8 @@ export function createCesiumPorts(
: {}),
});
const cameraPort = cameraPart.port;
if (capabilities.has('pointVisibility'))
cameraPort.visiblePoints = createPointsVisibility(scene, camera);
measureCameraChanged = cameraPart.measureChanged ?? null;
const effectsPart = createCesiumEffects(scene, {
capabilities,
+1
View File
@@ -12,6 +12,7 @@ import { createNativeClick } from './nativeClick.js';
test('capabilities follow what the scene supports', () => {
const effects = [
'followFrame',
'pointVisibility',
'followAutodetect',
'cameraChangeThreshold',
'columns',
+9
View File
@@ -234,6 +234,15 @@ export type CameraEvent =
'changed' | 'moveStart' | 'moveEnd' | 'followChanged' | 'flightEnd';
export interface CameraPort {
/**
* Whether any of the ECEF points may be on screen: false only when their
* bounding sphere is outside the view or all of them are below the horizon
* of WGS84 shrunk by `horizonMarginM` metres; null when it cannot tell
* (not a 3D scene, an empty point set, or a non-finite point or camera
* vector), which callers treat as visible. Supply a finite, nonnegative
* margin smaller than the shortest WGS84 radius.
*/
visiblePoints?(points: Ecef[], horizonMarginM: number): boolean | null;
pose(): CameraPose;
/**
* Place the eye. A position with a `{direction, up}` orientation is placed
+2
View File
@@ -183,6 +183,8 @@ export type Capability =
| 'pickPosition'
/** Points tested against the frame's depth (`query.occlusionTest`). */
| 'occlusionTest'
/** Conservative camera visibility of a point set (`camera.visiblePoints`). */
| 'pointVisibility'
/** Outward user zooms that keep the Earth framed (`controls.keepEarthFramed`). */
| 'keepEarthFramed'
/** Height sampling against tiles and terrain. */
+2
View File
@@ -50,6 +50,7 @@ export const CAPABILITIES = Object.freeze([
'followFrame',
'cameraChangeThreshold',
'occlusionTest',
'pointVisibility',
'keepEarthFramed',
]);
@@ -209,6 +210,7 @@ export const PORTS = deepFreeze({
'matrices',
),
['followFrame', 'followFrame'],
['visiblePoints', 'pointVisibility'],
['controls.keepEarthFramed', 'keepEarthFramed'],
]),
query: Object.fromEntries([
+2
View File
@@ -262,6 +262,8 @@ export function createStubRenderer(options = {}) {
camera.setViewRectangle(viewRectangle);
if (capabilities.has('followFrame'))
camera.port.followFrame = camera.eyeFrame;
if (capabilities.has('pointVisibility'))
camera.port.visiblePoints = () => null;
camera.port.setView({
destination: { lon: -97.7431, lat: 30.2672, height: 15000000 },
});
+9
View File
@@ -40,6 +40,15 @@ test('the stub passes the conformance suite', async () => {
]);
});
test('point visibility capability is optional and the stub reports unknown', () => {
const without = createStubRenderer({ capabilities: [] });
const withVisibility = createStubRenderer({
capabilities: ['pointVisibility'],
});
assert.equal(without.camera.visiblePoints, undefined);
assert.equal(withVisibility.camera.visiblePoints([], 200), null);
});
test('a frame runs the contract’s steps in order', () => {
const r = createStubRenderer();
r.frame.requestRender('test');
+16 -1
View File
@@ -1,3 +1,5 @@
import { watch } from 'vue';
import { MOBILE_SHEET_ATTR } from './mobileSheets.js';
import {
EMPTY_CCTV_FRAME,
_clearCctvFrame,
@@ -73,7 +75,10 @@ export class CctvControls {
if (state) this._renderCctvState(state);
if (this._cctvChip) this._publishCctvChip({});
});
if (this._cctvVideo && typeof MutationObserver !== 'undefined') {
if (
(this._cctvVideo || this._cctvFrame) &&
typeof MutationObserver !== 'undefined'
) {
this._videoVisibilityObserver = new MutationObserver(() =>
this._renderCctvState(this._cctvState),
);
@@ -82,6 +87,15 @@ export class CctvControls {
attributes: true,
attributeFilter: ['class', 'hidden'],
});
// On phones the panel is on screen only while the Cameras sheet is open.
this._videoVisibilityObserver.observe(document.body, {
attributes: true,
attributeFilter: ['class', MOBILE_SHEET_ATTR],
});
this._offPreviewCards = watch(
() => this.store.previewCards,
() => this._renderCctvState(this._cctvState),
);
this.listen(document, 'visibilitychange', () =>
this._renderCctvState(this._cctvState),
);
@@ -154,6 +168,7 @@ export class CctvControls {
this._quebecCctvOverlay?.dispose();
this._cctvVideoSurface?.stop();
this._videoVisibilityObserver?.disconnect();
this._offPreviewCards?.();
this._actionGeneration++;
this.listeners.abort();
this._cctvUnsubscribe?.();
+152 -11
View File
@@ -20,7 +20,7 @@ const BUTTONS = {
_cctvProjectionBtn: 'cctv-projection-btn',
};
function panel(t) {
function panel(t, { video = false } = {}) {
document.body.replaceChildren();
const host = document.body.appendChild(document.createElement('div'));
const pinia = createPinia();
@@ -32,6 +32,7 @@ function panel(t) {
document.getElementById(id),
]),
);
if (video) elements._cctvVideo = document.getElementById('cctv-video');
const controls = new CctvControls({
elements: {
...elements,
@@ -377,17 +378,10 @@ test('a second edit of the same chip gets a fresh input', async (t) => {
});
test('the frame preview renders each step of a camera frame request', async (t) => {
const prior = globalThis.Image;
const requests = [];
globalThis.Image = class {
constructor() {
requests.push(this);
}
};
t.after(() => {
globalThis.Image = prior;
});
const requests = mockImages(t);
const { controls, byId } = panel(t);
// The preview loads while the panel is open; the panel starts collapsed.
byId('cctv-panel').classList.remove('collapsed');
const frame = byId('cctv-frame');
const wrap = byId('cctv-frame-wrap');
const badge = byId('cctv-source-badge');
@@ -606,3 +600,150 @@ test('the meta line of a disabled layer does not describe its last camera', () =
);
assert.match(presentCctvPanel(activeState, true).meta, /^Austin · HDG /);
});
const settle = () => new Promise((resolve) => setTimeout(resolve, 0));
function mockImages(t) {
const prior = globalThis.Image;
const requests = [];
globalThis.Image = class {
constructor() {
requests.push(this);
}
};
t.after(() => {
globalThis.Image = prior;
});
return requests;
}
const stillState = (frameUrl, id = 'a') => ({
enabled: true,
count: 2,
cameraIndex: [camera, { ...camera, id: 'b' }],
activeCameraId: id,
activeCamera: { ...camera, id, frameUrl, sourceKind: 'snapshot' },
});
test('the still preview is fetched only while the tab and the panel are shown', async (t) => {
const requests = mockImages(t);
const hidden = Object.getOwnPropertyDescriptor(document, 'hidden');
let tabHidden = false;
Object.defineProperty(document, 'hidden', {
configurable: true,
get: () => tabHidden,
});
t.after(() => {
if (hidden) Object.defineProperty(document, 'hidden', hidden);
else delete document.hidden;
});
const { controls, byId } = panel(t);
assert.equal(controls._cctvVideo, undefined);
const panelElement = byId('cctv-panel');
const state = stillState;
// Collapsed panel: nothing is requested, however often the state arrives.
assert.equal(panelElement.classList.contains('collapsed'), true);
controls._renderCctvState(state('a1.jpg'));
controls._renderCctvState(state('a2.jpg'));
assert.equal(requests.length, 0, 'collapsed panel');
// Opening it resumes through the class observer, with no manual render.
panelElement.classList.remove('collapsed');
await settle();
assert.equal(requests.length, 1, 'expanded panel');
assert.equal(requests[0].src, 'a2.jpg');
requests[0].onload();
// A background tab: refreshed URLs are not requested.
tabHidden = true;
document.dispatchEvent(new Event('visibilitychange'));
controls._renderCctvState(state('a3.jpg'));
assert.equal(requests.length, 1, 'hidden tab');
// Back in the tab: visibilitychange alone fetches the current URL.
tabHidden = false;
document.dispatchEvent(new Event('visibilitychange'));
assert.equal(requests.length, 2, 'visible tab');
assert.equal(requests[1].src, 'a3.jpg');
});
test('the still preview waits for the Cameras sheet on phones', async (t) => {
const requests = mockImages(t);
t.after(() => {
document.body.classList.remove('mobile-shell');
document.body.removeAttribute('data-mobile-sheet');
});
const { controls, byId } = panel(t);
byId('cctv-panel').classList.remove('collapsed');
document.body.classList.add('mobile-shell');
document.body.setAttribute('data-mobile-sheet', 'layers');
controls._renderCctvState(stillState('a1.jpg'));
assert.equal(requests.length, 0, 'another sheet is open');
document.body.removeAttribute('data-mobile-sheet');
controls._renderCctvState(stillState('a1.jpg'));
assert.equal(requests.length, 0, 'no sheet is open');
document.body.setAttribute('data-mobile-sheet', 'cameras');
await settle();
assert.equal(requests.length, 1, 'Cameras sheet opened');
assert.equal(requests[0].src, 'a1.jpg');
// Off a phone the sheet attribute means nothing.
requests[0].onload();
document.body.classList.remove('mobile-shell');
document.body.setAttribute('data-mobile-sheet', 'layers');
controls._renderCctvState(stillState('a2.jpg'));
assert.equal(requests.length, 2, 'desktop ignores the sheet');
});
test('a camera picked while the panel is collapsed shows its own still on expanding', async (t) => {
const requests = mockImages(t);
const { controls, byId } = panel(t);
const panelElement = byId('cctv-panel');
panelElement.classList.remove('collapsed');
controls._renderCctvState(stillState('a1.jpg'));
assert.equal(requests.length, 1);
assert.equal(requests[0].src, 'a1.jpg');
panelElement.classList.add('collapsed');
await settle();
controls._renderCctvState(stillState('b1.jpg', 'b'));
assert.equal(requests.length, 1);
requests[0].onload();
panelElement.classList.remove('collapsed');
await settle();
await nextTick();
assert.equal(requests.length, 2);
assert.equal(requests[1].src, 'b1.jpg');
assert.equal(byId('cctv-frame').dataset.cameraId, 'b');
assert.notEqual(byId('cctv-frame').getAttribute('src'), 'a1.jpg');
});
test('leaving the Cameras sheet stops the live video and coming back starts it again', async (t) => {
const { controls, byId } = panel(t, { video: true });
byId('cctv-panel').classList.remove('collapsed');
document.body.classList.add('mobile-shell');
document.body.setAttribute('data-mobile-sheet', 'cameras');
t.after(() => {
document.body.classList.remove('mobile-shell');
document.body.removeAttribute('data-mobile-sheet');
});
controls._renderCctvState({
enabled: true,
count: 1,
cameraIndex: [camera],
activeCameraId: 'a',
activeCamera: { ...camera, isVideo: true },
});
const first = controls._cctvVideoSurface;
assert.ok(first);
const stop = t.mock.method(first, 'stop');
document.body.setAttribute('data-mobile-sheet', 'layers');
await settle();
assert.equal(stop.mock.callCount(), 1);
assert.equal(controls._cctvVideoSurface, null);
document.body.setAttribute('data-mobile-sheet', 'cameras');
await settle();
assert.ok(controls._cctvVideoSurface);
assert.notEqual(controls._cctvVideoSurface, first);
});
+28 -4
View File
@@ -8,6 +8,15 @@ import {
import { createCctvVideoSurface } from './cctvVideo.js';
import { presentCctvCalibration } from './cctvCalibration.js';
import { roundHeadingDegrees } from '../data/headingDegrees.js';
import {
MOBILE_SHELL_CLASS,
MOBILE_SHEET_ATTR,
sheetForPanelId,
} from './mobileSheets.js';
const CAMERAS_SHEET = sheetForPanelId('cctv-panel');
const CONTEXT_SHEET = sheetForPanelId('global-context-panel');
export function _calBadgeLabel(badge) {
switch (badge) {
case 'calibrated':
@@ -279,11 +288,25 @@ export function _renderCctvState(state) {
const liveIntent =
enabled && !!activeCamera?.isVideo && !activeCamera?.browserMediaUrl;
this.store.setLive(liveIntent);
// A background tab, a collapsed panel or a closed phone sheet shows no
// picture; the observers and visibilitychange render again on showing.
const body = globalThis.document?.body;
const phone = body?.classList.contains(MOBILE_SHELL_CLASS);
const sheet = body?.getAttribute(MOBILE_SHEET_ATTR);
const tabShown = !!body && !document.hidden;
const panelShown =
tabShown &&
!this._cctvPanel?.classList.contains('collapsed') &&
(!phone || sheet === CAMERAS_SHEET);
// Context's camera card shows the same still.
const cardShown =
tabShown &&
this.store.previewCards > 0 &&
(!phone || sheet === CONTEXT_SHEET);
// Its bigger view is a popup over the map, shown on any phone sheet.
const popupShown = tabShown && this.store.previewPopups > 0;
if (this._cctvVideo) {
const visible =
liveIntent &&
!document.hidden &&
!this._cctvPanel?.classList.contains('collapsed');
const visible = liveIntent && panelShown;
if (!visible || this._cctvVideoCameraId !== activeId) {
this._cctvVideoSurface?.stop();
this._cctvVideoSurface = null;
@@ -308,6 +331,7 @@ export function _renderCctvState(state) {
// immediate so navigation never waits on the prior camera's request.
if (
nextSrc &&
(panelShown || cardShown || popupShown) &&
(cameraChanged || (!frameLoading && this._frame.currentSrc !== nextSrc))
) {
this._queueCctvFrame(nextSrc, nextCameraId, cameraChanged);
+281
View File
@@ -0,0 +1,281 @@
import '../testSupport/registerDom.mjs';
import assert from 'node:assert/strict';
import test from 'node:test';
import { createPinia } from 'pinia';
import { createApp, nextTick } from 'vue';
import { CctvControls } from './cctvControls.js';
import { useCctvStore } from './stores/cctv.js';
import CctvPanel from './views/panels/CctvPanel.vue';
import CctvPreview from './views/panels/CctvPreview.vue';
const settle = () => new Promise((r) => setTimeout(r, 0));
const camera = {
id: 'a',
city: 'Austin',
name: 'Congress Ave',
headingDeg: 91.6,
fovDeg: 60,
rangeM: 120.4,
sourceLabel: 'Configured Source',
calBadge: 'curated',
};
const stillState = (frameUrl, id = 'a') => ({
enabled: true,
count: 2,
cameraIndex: [camera, { ...camera, id: 'b' }],
activeCameraId: id,
activeCamera: { ...camera, id, frameUrl, sourceKind: 'snapshot' },
});
function fixture(t, { card = true } = {}) {
document.body.replaceChildren();
const host = document.body.appendChild(document.createElement('div'));
const cardHost = document.body.appendChild(document.createElement('div'));
const pinia = createPinia();
const app = createApp(CctvPanel).use(pinia);
app.mount(host);
let preview;
function mountCard() {
preview = createApp(CctvPreview, { cameraId: 'a' }).use(pinia);
preview.mount(cardHost);
}
function unmountCard() {
preview?.unmount();
preview = null;
}
if (card) mountCard();
const store = useCctvStore(pinia);
const controls = new CctvControls({
elements: {
_cctvPanel: document.getElementById('cctv-panel'),
_cctvFrame: document.getElementById('cctv-frame'),
_cctvFrameWrap: document.getElementById('cctv-frame-wrap'),
},
cctv: {},
actions: {
isEnabled: () => true,
setPanelCollapsed() {},
syncViewport() {},
},
store,
});
t.after(() => {
controls.destroy();
app.unmount();
preview?.unmount();
});
return {
controls,
cardHost,
mountCard,
unmountCard,
store,
panelEl: document.getElementById('cctv-panel'),
};
}
function mockImages(t) {
const prior = globalThis.Image;
const requests = [];
globalThis.Image = class {
constructor() {
requests.push(this);
}
};
t.after(() => {
globalThis.Image = prior;
});
return requests;
}
test('desktop: the Context card keeps refreshing while the accordion folds CCTV', async (t) => {
const requests = mockImages(t);
const { controls, cardHost, panelEl } = fixture(t);
panelEl.classList.remove('collapsed');
controls._renderCctvState(stillState('a1.jpg'));
assert.equal(requests.length, 1);
requests[0].onload();
await settle();
await nextTick();
assert.equal(cardHost.querySelector('img')?.getAttribute('src'), 'a1.jpg');
// Context opens: the desktop accordion folds CCTV (class collapsed).
panelEl.classList.add('collapsed');
await settle();
controls._renderCctvState(stillState('a2.jpg'));
assert.equal(requests.length, 2);
assert.equal(requests[1].src, 'a2.jpg');
requests[1].onload();
controls._renderCctvState(stillState('a3.jpg'));
assert.equal(requests.length, 3);
assert.equal(requests[2].src, 'a3.jpg');
requests[2].onload();
await settle();
await nextTick();
assert.equal(cardHost.querySelector('img')?.getAttribute('src'), 'a3.jpg');
});
test('phone: a camera picked with the Context sheet open gets its still', async (t) => {
const requests = mockImages(t);
t.after(() => {
document.body.classList.remove('mobile-shell');
document.body.removeAttribute('data-mobile-sheet');
});
const { controls, cardHost, panelEl } = fixture(t);
document.body.classList.add('mobile-shell');
document.body.setAttribute('data-mobile-sheet', 'context');
panelEl.classList.remove('collapsed');
controls._renderCctvState(stillState('a1.jpg'));
controls._renderCctvState(stillState('a2.jpg'));
await settle();
await nextTick();
assert.equal(
requests.length,
1,
'the Context card on the Context sheet requests the still',
);
assert.equal(requests[0].src, 'a1.jpg');
requests.at(-1).onload();
await settle();
await nextTick();
assert.ok(
cardHost.querySelector('.cctv-preview__expand'),
'the card shows a frame, not Acquiring frame…',
);
});
test('phone: the card on a closed Context sheet waits', async (t) => {
const requests = mockImages(t);
const { controls, panelEl } = fixture(t);
panelEl.classList.add('collapsed');
document.body.classList.add('mobile-shell');
document.body.setAttribute('data-mobile-sheet', 'layers');
t.after(() => {
document.body.classList.remove('mobile-shell');
document.body.removeAttribute('data-mobile-sheet');
});
controls._renderCctvState(stillState('a1.jpg'));
assert.equal(requests.length, 0);
document.body.setAttribute('data-mobile-sheet', 'context');
await settle();
assert.equal(requests.length, 1);
assert.equal(requests[0].src, 'a1.jpg');
});
test('phone: the bigger view keeps refreshing after the layout turns phone, and stops once closed', async (t) => {
const requests = mockImages(t);
t.after(() => {
document.body.classList.remove('mobile-shell');
document.body.removeAttribute('data-mobile-sheet');
});
const { controls, cardHost, panelEl } = fixture(t);
panelEl.classList.add('collapsed');
controls._renderCctvState(stillState('a1.jpg'));
assert.equal(requests.length, 1);
requests[0].onload();
await settle();
await nextTick();
cardHost.querySelector('.cctv-preview__expand').click();
await settle();
await nextTick();
const popup = document.body.querySelector('.cctv-popup');
assert.ok(popup);
assert.equal(popup.querySelector('img').getAttribute('src'), 'a1.jpg');
document.body.classList.add('mobile-shell');
await settle();
controls._renderCctvState(stillState('a2.jpg'));
await settle();
await nextTick();
assert.ok(document.body.contains(popup));
assert.equal(requests.length, 2);
assert.equal(requests[1].src, 'a2.jpg');
requests[1].onload();
await settle();
await nextTick();
assert.equal(popup.querySelector('img').getAttribute('src'), 'a2.jpg');
popup.querySelector('.cctv-popup__close').click();
await settle();
await nextTick();
assert.equal(document.body.querySelector('.cctv-popup'), null);
controls._renderCctvState(stillState('a3.jpg'));
await settle();
assert.equal(requests.length, 2);
});
test('desktop: a card that mounts asks for the still', async (t) => {
const requests = mockImages(t);
const { controls, panelEl, mountCard } = fixture(t, { card: false });
panelEl.classList.add('collapsed');
controls._renderCctvState(stillState('a1.jpg'));
await settle();
assert.equal(requests.length, 0);
mountCard();
await settle();
await nextTick();
assert.equal(requests.length, 1);
assert.equal(requests[0].src, 'a1.jpg');
});
test('desktop: a card that unmounts stops the still, and a remount resumes it', async (t) => {
const requests = mockImages(t);
const { controls, panelEl, mountCard, unmountCard, store } = fixture(t);
panelEl.classList.add('collapsed');
controls._renderCctvState(stillState('a1.jpg'));
assert.equal(requests.length, 1);
requests[0].onload();
await settle();
await nextTick();
unmountCard();
await settle();
await nextTick();
assert.equal(store.previewCards, 0);
controls._renderCctvState(stillState('a2.jpg'));
await settle();
assert.equal(requests.length, 1);
mountCard();
await settle();
await nextTick();
assert.equal(requests.length, 2);
assert.equal(requests[1].src, 'a2.jpg');
});
test('desktop: the bigger view is released when the card unmounts, also in the tick it closes', async (t) => {
const requests = mockImages(t);
const { controls, cardHost, panelEl, mountCard, unmountCard, store } =
fixture(t);
panelEl.classList.add('collapsed');
controls._renderCctvState(stillState('a1.jpg'));
requests[0].onload();
await settle();
await nextTick();
const openPopup = async () => {
cardHost.querySelector('.cctv-preview__expand').click();
await nextTick();
assert.equal(store.previewPopups, 1);
};
await openPopup();
unmountCard();
await nextTick();
assert.equal(document.body.querySelector('.cctv-popup'), null);
assert.equal(store.previewPopups, 0);
mountCard();
await nextTick();
await openPopup();
// Closed and unmounted before the watcher runs, as when one Escape closes
// the phone's Context sheet and the popup.
document.body.querySelector('.cctv-popup__close').click();
unmountCard();
await settle();
await nextTick();
assert.equal(store.previewPopups, 0);
assert.equal(store.previewCards, 0);
const before = requests.length;
controls._renderCctvState(stillState('a3.jpg'));
await settle();
assert.equal(requests.length, before);
});
+26
View File
@@ -0,0 +1,26 @@
export const MOBILE_SHELL_CLASS = 'mobile-shell';
export const MOBILE_SHEET_ATTR = 'data-mobile-sheet';
/**
* Panels each sheet expands. A sheet also shows its rail's other panels
* collapsed (Scenes under Layers), per styles/mobile-shell.css.
*/
export const MOBILE_SHEET_PANELS = Object.freeze({
layers: Object.freeze(['data-panel']),
cameras: Object.freeze(['cctv-panel', 'street-level-panel']),
context: Object.freeze(['global-context-panel']),
missions: Object.freeze(['space-missions-panel']),
search: Object.freeze(['location-bar']),
more: Object.freeze(['control-panel', 'pp-toggles']),
});
/**
* @param {string} panelId
* @returns {string|null} The sheet that presents `panelId`.
*/
export function sheetForPanelId(panelId) {
for (const [sheet, ids] of Object.entries(MOBILE_SHEET_PANELS)) {
if (ids.includes(panelId)) return sheet;
}
return null;
}
+13 -27
View File
@@ -18,23 +18,20 @@ import {
readPanelState,
} from './rail/panelState.js';
import {
MOBILE_SHELL_CLASS,
MOBILE_SHEET_ATTR,
MOBILE_SHEET_PANELS,
} from './mobileSheets.js';
export {
MOBILE_SHELL_CLASS,
MOBILE_SHEET_ATTR,
MOBILE_SHEET_PANELS,
sheetForPanelId,
} from './mobileSheets.js';
export const MOBILE_SHELL_MEDIA_QUERY = '(max-width: 720px)';
export const MOBILE_SHELL_CLASS = 'mobile-shell';
export const MOBILE_SHEET_ATTR = 'data-mobile-sheet';
/**
* Panels each sheet expands. A sheet also shows its rail's other panels
* collapsed (Scenes under Layers), per styles/mobile-shell.css.
*/
export const MOBILE_SHEET_PANELS = Object.freeze({
layers: Object.freeze(['data-panel']),
cameras: Object.freeze(['cctv-panel', 'street-level-panel']),
context: Object.freeze(['global-context-panel']),
missions: Object.freeze(['space-missions-panel']),
search: Object.freeze(['location-bar']),
more: Object.freeze(['control-panel', 'pp-toggles']),
});
export const MOBILE_TABS = Object.freeze([
Object.freeze({ sheet: 'layers', label: msg('Layers'), icon: 'layers' }),
Object.freeze({ sheet: 'cameras', label: msg('Cameras'), icon: 'videocam' }),
@@ -64,17 +61,6 @@ const BORROWED_PANELS = Object.freeze([
const BORROW_OPTIONS = Object.freeze({ persist: false, syncShare: false });
/**
* @param {string} panelId
* @returns {string|null} The sheet that presents `panelId`.
*/
export function sheetForPanelId(panelId) {
for (const [sheet, ids] of Object.entries(MOBILE_SHEET_PANELS)) {
if (ids.includes(panelId)) return sheet;
}
return null;
}
/**
* The sheet after a tab press: the same tab closes its sheet, another opens.
* @param {string|null} current
+18
View File
@@ -20,6 +20,10 @@ export const useCctvStore = defineStore('gev-cctv', () => {
/** The preview: requested and shown frame, loading and error state. */
const frame = shallowRef(null);
/** Number of camera cards outside the panel showing its preview, including Context's card. */
const previewCards = shallowRef(0);
/** Number of open bigger views of a camera card (popups over the map). */
const previewPopups = shallowRef(0);
/** Whether the live video surface replaces the still frame. */
const live = shallowRef(false);
/** `{label, state}` for the source badge; null until first synced. */
@@ -49,6 +53,16 @@ export const useCctvStore = defineStore('gev-cctv', () => {
frame.value = markRaw(next);
}
/** @param {boolean} shown */
function showPreviewCard(shown) {
previewCards.value = Math.max(0, previewCards.value + (shown ? 1 : -1));
}
/** @param {boolean} shown */
function showPreviewPopup(shown) {
previewPopups.value = Math.max(0, previewPopups.value + (shown ? 1 : -1));
}
/** @param {boolean} on */
function setLive(on) {
live.value = Boolean(on);
@@ -73,6 +87,8 @@ export const useCctvStore = defineStore('gev-cctv', () => {
view,
calEdit,
frame,
previewCards,
previewPopups,
live,
sourceBadge,
summary,
@@ -80,6 +96,8 @@ export const useCctvStore = defineStore('gev-cctv', () => {
publish,
setCalEdit,
setFrame,
showPreviewCard,
showPreviewPopup,
setLive,
setSourceBadge,
setSummary,
+15 -6
View File
@@ -1,5 +1,5 @@
<script setup>
import { computed, onBeforeUnmount, ref, watch } from 'vue';
import { computed, onBeforeUnmount, onMounted, ref, watch } from 'vue';
import { storeToRefs } from 'pinia';
import { t } from '../../../i18n/index.js';
import { useCctvStore } from '../../stores/cctv.js';
@@ -16,7 +16,8 @@ const props = defineProps({
cameraId: { type: String, default: '' },
});
const { view, frame, sourceBadge } = storeToRefs(useCctvStore());
const cctv = useCctvStore();
const { view, frame, sourceBadge } = storeToRefs(cctv);
const chrome = usePanelChromeStore();
const { panels } = storeToRefs(chrome);
@@ -53,11 +54,19 @@ const big = ref(false);
const onKey = (e) => {
if (e.key === 'Escape') big.value = false;
};
watch(big, (open) => {
if (open) document.addEventListener('keydown', onKey);
else document.removeEventListener('keydown', onKey);
// The cleanup also runs when the card unmounts, even if `big` turned false in
// the same tick and the watcher never saw it.
watch(big, (open, _, onCleanup) => {
if (!open) return;
cctv.showPreviewPopup(true);
document.addEventListener('keydown', onKey);
onCleanup(() => {
cctv.showPreviewPopup(false);
document.removeEventListener('keydown', onKey);
});
});
onBeforeUnmount(() => document.removeEventListener('keydown', onKey));
onMounted(() => cctv.showPreviewCard(true));
onBeforeUnmount(() => cctv.showPreviewCard(false));
function openPanel() {
if (panels.value['cctv-panel']?.collapsed !== false) chrome.act('toggle', 'cctv-panel');