mirror of
https://github.com/bilawalsidhu/gods-eye-view.git
synced 2026-11-16 16:22:20 +00:00
Scope render demand to each scene attachment
Give each scene its own render governor, owner holds and recent idle requests. Make the Cesium render backend own its request mode directly, so the governor drives engine.render on both engines without a dependency back from Cesium. Route layer requests through their attached engine and capture the attachment's governor for camera motions, orbit, annotations and shell controls. Release retained-layer holds before clearing the outgoing engine, and destroy the governor after scene consumers have detached. Preserve Cesium's owner-keyed holds, pre-install buffering, last-release settling frame and one-shot requests during continuous rendering. Navara keeps the same render policy. There is no intended visible change on either engine. Simultaneous scenes no longer share holds, and an old captured service cannot release a replacement attachment's hold. Cover both rules on fake and headless Cesium engines, including an old orbit ending after reattachment. Viewer-reference lines fall from 910 to 891, Navara-kind checks from 2 to 1, and engine-name lines from 33 to 32. All other coupling counts stay unchanged. Checked in the browser, keyless: qa-perf passes on both engines with the same idle, active and release counts as before (24 checks on Cesium, 22 on Navara).
This commit is contained in:
1 parent
4252ed0798
commit
0459ee6d58
87 files changed
+720
-935
No files matched your search
@@ -6,7 +6,6 @@ import assert from 'node:assert/strict';
|
||||
import { createApplicationTools } from './tools.js';
|
||||
import { createSceneHost } from './sceneHost.js';
|
||||
import { createFakeEngine } from '../globe/testing/fakeEngine.js';
|
||||
import { _resetRenderGovernorForTest } from '../renderGovernor.js';
|
||||
|
||||
test('the debug handle leaves window between engines and comes back the same', async (t) => {
|
||||
const saved = {
|
||||
@@ -32,7 +31,6 @@ test('the debug handle leaves window between engines and comes back the same', a
|
||||
removeEventListener() {},
|
||||
};
|
||||
t.after(() => {
|
||||
_resetRenderGovernorForTest();
|
||||
for (const [name, value] of Object.entries(saved)) {
|
||||
if (value === undefined) delete globalThis[name];
|
||||
else globalThis[name] = value;
|
||||
|
||||
@@ -45,7 +45,9 @@ test('the scene engine defaults to the Cesium engine factory', () => {
|
||||
|
||||
test('the scene constructs the engine with the viewer and returns it beside the viewer', () => {
|
||||
const scene = read('src/app/scene.js');
|
||||
const viewerTeardown = scene.indexOf('uninstallRenderGovernor(viewer);');
|
||||
const viewerTeardown = scene.indexOf(
|
||||
'if (!viewer.isDestroyed()) viewer.destroy();',
|
||||
);
|
||||
const engineAt = scene.indexOf('createSceneEngine(viewer, {');
|
||||
assert.ok(viewerTeardown >= 0 && engineAt >= 0);
|
||||
// Cleanups run last-in first-out: the engine goes before the viewer.
|
||||
|
||||
@@ -8,7 +8,7 @@ export class LayerPresentation {
|
||||
manager,
|
||||
{
|
||||
weatherClock,
|
||||
requestRender = governorRequestRender,
|
||||
requestRender = (reason) => governorRequestRender(reason, manager.engine),
|
||||
invalidateDetection = markDetectionSourcesChanged,
|
||||
} = {},
|
||||
) {
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
import { showOsmCredit, hideOsmCredit } from '../data/dataCredits.js';
|
||||
import { governorRequestRender } from '../renderGovernor.js';
|
||||
import {
|
||||
clearSelectedEntityContextForLayer,
|
||||
registerEntityContext,
|
||||
@@ -24,7 +23,6 @@ export const localGeoJsonServices = Object.freeze({
|
||||
removeEntityContextsForLayer,
|
||||
selectEntityContext,
|
||||
getSelectedEntityContext,
|
||||
governorRequestRender,
|
||||
showOsmCredit,
|
||||
hideOsmCredit,
|
||||
});
|
||||
@@ -1,13 +1,8 @@
|
||||
import test from 'node:test';
|
||||
import assert from 'node:assert/strict';
|
||||
import { MapStackController } from '../mapStackController.js';
|
||||
import {
|
||||
installRenderGovernor,
|
||||
uninstallRenderGovernor,
|
||||
holdContinuousRender,
|
||||
governorRequestRender,
|
||||
getRenderGovernorDiagnostics,
|
||||
} from '../renderGovernor.js';
|
||||
import { createFakeEngine } from '../globe/testing/fakeEngine.js';
|
||||
import { createSceneServices } from '../data/sceneServices.js';
|
||||
|
||||
test('destroy invalidates a pending imagery provider before it can touch the viewer', async () => {
|
||||
let resolveProvider;
|
||||
@@ -35,23 +30,18 @@ test('destroy invalidates a pending imagery provider before it can touch the vie
|
||||
assert.equal(removed, 1);
|
||||
});
|
||||
|
||||
test('uninstall only releases the current viewer and makes later render requests inactive', () => {
|
||||
let renders = 0;
|
||||
const viewer = {
|
||||
scene: {
|
||||
requestRender: () => {
|
||||
renders++;
|
||||
},
|
||||
},
|
||||
};
|
||||
installRenderGovernor(viewer);
|
||||
holdContinuousRender('fixture');
|
||||
uninstallRenderGovernor({});
|
||||
assert.equal(getRenderGovernorDiagnostics().installed, true);
|
||||
uninstallRenderGovernor(viewer);
|
||||
const before = renders;
|
||||
governorRequestRender('late');
|
||||
assert.equal(renders, before);
|
||||
assert.equal(getRenderGovernorDiagnostics().installed, false);
|
||||
assert.deepEqual(getRenderGovernorDiagnostics().holds, []);
|
||||
test('scene teardown makes its later render requests inactive', () => {
|
||||
const engine = createFakeEngine();
|
||||
const services = createSceneServices(engine);
|
||||
const governor = services.render;
|
||||
governor.install();
|
||||
governor.holdContinuousRender('fixture');
|
||||
assert.equal(governor.getRenderGovernorDiagnostics().installed, true);
|
||||
services.destroy();
|
||||
engine.fake.resetCalls();
|
||||
governor.governorRequestRender('late');
|
||||
assert.equal(engine.fake.callsOf('render.request').length, 0);
|
||||
assert.equal(governor.getRenderGovernorDiagnostics().installed, false);
|
||||
assert.deepEqual(governor.getRenderGovernorDiagnostics().holds, []);
|
||||
engine.destroy();
|
||||
});
|
||||
+1
-12
@@ -7,11 +7,6 @@ import { t } from '../i18n/index.js';
|
||||
|
||||
import { DATA_CREDITS, registerDataCredits } from '../data/dataCredits.js';
|
||||
import { createLayerAvailability } from './layers/renderers.js';
|
||||
import {
|
||||
governorRequestRender,
|
||||
installEngineRenderGovernor,
|
||||
uninstallRenderGovernor,
|
||||
} from '../renderGovernor.js';
|
||||
import { createNavaraAnnotationRenderer } from '../annotations/navaraAnnotationRenderer.js';
|
||||
|
||||
/** The Navara globe module, loaded on demand. */
|
||||
@@ -93,12 +88,10 @@ export async function createNavaraScene({
|
||||
});
|
||||
defer(() => globe.destroy());
|
||||
const { engine } = globe;
|
||||
// The tools install the governor on this engine; it goes before the engine.
|
||||
defer(() => uninstallRenderGovernor(engine));
|
||||
signal.throwIfAborted();
|
||||
loaderStatus.textContent = t('Initializing systems...');
|
||||
const mapStackController = new MapController(null, {
|
||||
requestRender: governorRequestRender,
|
||||
requestRender: (reason) => engine.render.request(reason),
|
||||
engine,
|
||||
...mapOptions,
|
||||
cesiumToken,
|
||||
@@ -125,7 +118,6 @@ export async function createNavaraScene({
|
||||
engine,
|
||||
tileset: null,
|
||||
suspend() {
|
||||
uninstallRenderGovernor(engine);
|
||||
engine.camera.cancelFlight();
|
||||
engine.render.setContinuous(false);
|
||||
globe.setRenderLoop(false);
|
||||
@@ -156,9 +148,6 @@ export function navaraToolBackend({ engine }) {
|
||||
// The session's tool on the engine's input and preview.
|
||||
draw: () => ({ engine }),
|
||||
recentImagery: () => ({ engine }),
|
||||
// Holds drive engine.render.setContinuous; requests go to the engine. A
|
||||
// parked engine uninstalls it (createNavaraScene suspend).
|
||||
installGovernor: () => installEngineRenderGovernor(engine),
|
||||
attach({ data, styleManager }, { signal, defer }) {
|
||||
void styleManager.initialRestorePromise?.then(() => {
|
||||
if (!signal.aborted) views.alignDaylightToRestoredView();
|
||||
|
||||
@@ -3,10 +3,7 @@ import assert from 'node:assert/strict';
|
||||
import { createApplicationScene } from './scene.js';
|
||||
import { sceneServicesFor } from '../data/sceneServices.js';
|
||||
import { createFakeEngine } from '../globe/testing/fakeEngine.js';
|
||||
import {
|
||||
installEngineRenderGovernor,
|
||||
isRenderGovernorInstalled,
|
||||
} from '../renderGovernor.js';
|
||||
import { renderGovernorFor } from '../renderGovernor.js';
|
||||
|
||||
// The scene's Navara branch in Node: the globe loader is a seam, so the fake
|
||||
// engine stands in for Navara and nothing Cesium is built.
|
||||
@@ -165,12 +162,15 @@ test('the Navara scene tears down the controller, then the globe', async (t) =>
|
||||
const run = await startScene();
|
||||
// The tools install the governor on the engine (src/app/tools.js); the
|
||||
// scene removes it before the engine goes.
|
||||
installEngineRenderGovernor(run.engine);
|
||||
renderGovernorFor(run.engine).install();
|
||||
const view = globalThis.window;
|
||||
await run.teardown();
|
||||
assert.equal(run.globeDestroyed(), 1);
|
||||
assert.equal(run.engine.isDestroyed(), true);
|
||||
assert.equal(isRenderGovernorInstalled(run.engine), false);
|
||||
assert.equal(
|
||||
renderGovernorFor(run.engine).getRenderGovernorDiagnostics().installed,
|
||||
false,
|
||||
);
|
||||
assert.equal(view.__GOOGLE_MAPS_API_KEY__, undefined);
|
||||
});
|
||||
|
||||
@@ -262,16 +262,21 @@ test('parking or tearing down the Navara scene releases a running camera verb',
|
||||
}
|
||||
});
|
||||
|
||||
test('the application scene owns and releases its pick services', async () => {
|
||||
test('the application scene owns and releases its pick and render services', async () => {
|
||||
const run = await startScene({ googleApiKey: '' });
|
||||
const { engine, services } = run.scene;
|
||||
try {
|
||||
assert.equal(sceneServicesFor(engine), services);
|
||||
services.render.install();
|
||||
services.render.holdContinuousRender('flights');
|
||||
assert.equal(engine.render.isContinuous(), true);
|
||||
services.selection.register('flights', { owns: (id) => id === 'contact' });
|
||||
assert.equal(services.picking.findPickOwner('contact'), 'flights');
|
||||
} finally {
|
||||
await run.teardown();
|
||||
}
|
||||
assert.equal(services.render.getRenderGovernorDiagnostics().installed, false);
|
||||
assert.deepEqual(services.render.getRenderGovernorDiagnostics().holds, []);
|
||||
assert.equal(services.picking.findPickOwner('contact'), null);
|
||||
services.picking.registerPickOwner('late', () => true);
|
||||
assert.equal(services.picking.findPickOwner('contact'), null);
|
||||
|
||||
+1
-7
@@ -11,10 +11,6 @@ import { registerDataCredits } from '../data/dataCredits.js';
|
||||
import { configureCreditKeyboardAccess } from '../creditKeyboard.js';
|
||||
import { MapStackController } from '../mapStackController.js';
|
||||
import { initLogoGaze } from '../logoGaze.js';
|
||||
import {
|
||||
uninstallRenderGovernor,
|
||||
governorRequestRender,
|
||||
} from '../renderGovernor.js';
|
||||
import { describeError } from './errors.js';
|
||||
import { createSceneEngine } from './globeEngine.js';
|
||||
import { onLocaleChange, t } from '../i18n/index.js';
|
||||
@@ -157,7 +153,6 @@ async function createRenderer({
|
||||
creditContainer,
|
||||
});
|
||||
defer(() => {
|
||||
uninstallRenderGovernor(viewer);
|
||||
if (!viewer.isDestroyed()) viewer.destroy();
|
||||
});
|
||||
// The globe engine over this viewer; Google's startup tileset is named
|
||||
@@ -216,7 +211,7 @@ async function createRenderer({
|
||||
loaderStatus.textContent = t('Initializing systems...');
|
||||
|
||||
const mapStackController = new MapController(viewer, {
|
||||
requestRender: governorRequestRender,
|
||||
requestRender: (reason) => engine.render.request(reason),
|
||||
// Map sources reach the scene through the globe engine's maps.
|
||||
engine,
|
||||
...mapOptions,
|
||||
@@ -247,7 +242,6 @@ async function createRenderer({
|
||||
tileset,
|
||||
mapStackController,
|
||||
suspend() {
|
||||
uninstallRenderGovernor(viewer);
|
||||
engine.camera.cancelFlight();
|
||||
releaseCameraVerbs(engine);
|
||||
viewer.useDefaultRenderLoop = false;
|
||||
|
||||
+14
-16
@@ -22,13 +22,7 @@ import {
|
||||
import { KEYHOLE_OUTER_RADIUS } from '../celestialRing.js';
|
||||
import { installGlobeInViewRecovery } from '../globe/cesium/viewer.js';
|
||||
import { installLayerReleaseTrim } from '../sceneCommandRelease.js';
|
||||
import {
|
||||
installRenderGovernor,
|
||||
getRenderGovernorDiagnostics,
|
||||
governorRequestRender,
|
||||
holdContinuousRender,
|
||||
releaseContinuousRender,
|
||||
} from '../renderGovernor.js';
|
||||
import { renderGovernorFor } from '../renderGovernor.js';
|
||||
|
||||
/**
|
||||
* Attach scene tools, rendering listeners and the application debug handle.
|
||||
@@ -148,9 +142,11 @@ export async function createApplicationTools({
|
||||
weatherEffects: controls.weatherEffects ?? null,
|
||||
cockpitCloudEffects: null,
|
||||
voiceCommands: null,
|
||||
getRenderGovernorDiagnostics,
|
||||
getRenderGovernorDiagnostics: () =>
|
||||
renderGovernorFor(debug.engine)?.getRenderGovernorDiagnostics(),
|
||||
surfaceServices: operations.surface,
|
||||
requestRender: governorRequestRender,
|
||||
requestRender: (reason) =>
|
||||
renderGovernorFor(debug.engine)?.governorRequestRender(reason),
|
||||
};
|
||||
defer(() => {
|
||||
if (window.__godsEyeView === debug) delete window.__godsEyeView;
|
||||
@@ -266,6 +262,11 @@ const TOOL_BACKENDS = Object.freeze({
|
||||
/** The Cesium tool backend: the shared tools and its own on the viewer. */
|
||||
function cesiumToolBackend({ engine, tileset }) {
|
||||
const viewer = cesiumViewerOf(engine);
|
||||
const {
|
||||
governorRequestRender,
|
||||
holdContinuousRender,
|
||||
releaseContinuousRender,
|
||||
} = renderGovernorFor(engine);
|
||||
return {
|
||||
viewer,
|
||||
startupChrome: {},
|
||||
@@ -276,10 +277,6 @@ function cesiumToolBackend({ engine, tileset }) {
|
||||
layer.attachTileset(tileset);
|
||||
return { viewer };
|
||||
},
|
||||
// Idle render governor: flips the scene into requestRenderMode whenever
|
||||
// nothing animates per frame. (perf wave 2) A parked viewer uninstalls
|
||||
// it (src/app/scene.js suspend).
|
||||
installGovernor: () => installRenderGovernor(viewer),
|
||||
attach({ dataManager }, { defer }) {
|
||||
// Cesium keeps a turned-off layer's draw commands (and so all its
|
||||
// entities) alive in reused per-pass arrays; trim them after each
|
||||
@@ -336,7 +333,7 @@ function cesiumToolBackend({ engine, tileset }) {
|
||||
* engine kind's backend (TOOL_BACKENDS) says where the shared tools draw:
|
||||
* `board()` and `draw()` give their attachScene arguments (null: not on
|
||||
* this engine), `recentImagery(layer)` the panel's globe,
|
||||
* `installGovernor()` the governor's; `attach(context, attachment)` adds
|
||||
* `attach(context, attachment)` adds
|
||||
* the engine's own tools, `suspend(hidden, controls)` its hidden-tab
|
||||
* handling and `attachViews(context, attachment)` its embedded views. The
|
||||
* shared tools keep their session state across engines. Returns the
|
||||
@@ -358,6 +355,7 @@ async function attachEngineTools(
|
||||
{ signal, defer },
|
||||
) {
|
||||
const { engine, mapStackController } = scene;
|
||||
const governor = scene.services?.render ?? renderGovernorFor(engine);
|
||||
const backend = (await TOOL_BACKENDS[engine.kind]())(scene);
|
||||
// The page session's board, Draw and Import (src/app/sessionTools.js):
|
||||
// an engine switch only takes their drawing off this globe.
|
||||
@@ -412,7 +410,7 @@ async function attachEngineTools(
|
||||
}
|
||||
// Installed AFTER every module above has had its chance to register
|
||||
// pre-install holds.
|
||||
backend.installGovernor();
|
||||
governor.install();
|
||||
backend.attach?.({ data, styleManager, dataManager }, { signal, defer });
|
||||
|
||||
// Install the explicit scope mask used by the DISPLAY controls: a canvas
|
||||
@@ -430,7 +428,7 @@ async function attachEngineTools(
|
||||
backend.suspend?.(hidden, controls);
|
||||
if (!hidden) {
|
||||
data.presentation.flushVisible();
|
||||
governorRequestRender('visibility-restore');
|
||||
governor.governorRequestRender('visibility-restore');
|
||||
}
|
||||
};
|
||||
document.addEventListener('visibilitychange', syncVisibilitySuspension);
|
||||
|
||||
@@ -5,9 +5,8 @@ import { navaraModeNotice } from './navaraMode.js';
|
||||
import { LAYER_MANIFEST, createLayerAvailability } from './layers/renderers.js';
|
||||
import { createFakeEngine } from '../globe/testing/fakeEngine.js';
|
||||
import {
|
||||
_resetRenderGovernorForTest,
|
||||
renderGovernorFor,
|
||||
holdContinuousRender,
|
||||
isRenderGovernorInstalled,
|
||||
releaseContinuousRender,
|
||||
} from '../renderGovernor.js';
|
||||
|
||||
@@ -47,7 +46,6 @@ test('without a viewer the tools run the governor on the engine, show the notice
|
||||
},
|
||||
};
|
||||
t.after(() => {
|
||||
_resetRenderGovernorForTest();
|
||||
for (const [name, value] of Object.entries(saved)) {
|
||||
if (value === undefined) delete globalThis[name];
|
||||
else globalThis[name] = value;
|
||||
@@ -146,10 +144,13 @@ test('without a viewer the tools run the governor on the engine, show the notice
|
||||
'Data layers: Live Flights, Satellites',
|
||||
);
|
||||
// The governor drives the engine's continuous rendering.
|
||||
assert.equal(isRenderGovernorInstalled(engine), true);
|
||||
holdContinuousRender('qa');
|
||||
assert.equal(
|
||||
renderGovernorFor(engine).getRenderGovernorDiagnostics().installed,
|
||||
true,
|
||||
);
|
||||
holdContinuousRender('qa', engine);
|
||||
assert.equal(engine.render.isContinuous(), true);
|
||||
releaseContinuousRender('qa');
|
||||
releaseContinuousRender('qa', engine);
|
||||
assert.equal(engine.render.isContinuous(), false);
|
||||
const debug = window.__godsEyeView;
|
||||
assert.equal(debug.viewer, null);
|
||||
|
||||
Reference in new issue
Block a user