mirror of
https://github.com/bilawalsidhu/gods-eye-view.git
synced 2026-11-16 16:22:20 +00:00
Keep the render loop marked running after a frame Retry could race
An error Scene catches itself marks Cesium's render loop stopped while the loop's next animation frame is still queued. A Retry, or a tab shown again, before that frame ran started a second loop, and the globe drew every frame twice. The render and resize wrapper now keeps the loop marked running after a call made while it ran; the queued frame stops it if nothing restarted it. This also covers the inline panel's timer frames, so its own guard goes.
This commit is contained in:
1 parent
2448662574
commit
c763c38193
6 files changed
+296
-30
No files matched your search
+4
-17
@@ -103,20 +103,12 @@ export function keepPanelRendering(
|
||||
// Cesium stops its render loop after a render error, and the timer stops
|
||||
// with it; Retry restarts both. Report the error in full: workers report
|
||||
// plain objects, which Cesium prints as [object Object].
|
||||
let drawing = false;
|
||||
const removeErrorListener = viewer.scene?.renderError?.addEventListener(
|
||||
(_scene, error) => {
|
||||
// Cesium marks its loop stopped, but in a frame the timer draws, the
|
||||
// loop's next animation frame is still queued and resumes when frames
|
||||
// do. Restarting the loop now would start a second one beside it, and
|
||||
// the globe would draw twice a frame.
|
||||
if (drawing && viewer.cesiumWidget)
|
||||
viewer.cesiumWidget._renderLoopRunning = true;
|
||||
(_scene, error) =>
|
||||
console.error(
|
||||
"[God's Eye View panel] render error:",
|
||||
describeError(error),
|
||||
);
|
||||
},
|
||||
),
|
||||
);
|
||||
const timer = windowRef.setInterval(() => {
|
||||
if (
|
||||
@@ -125,13 +117,8 @@ export function keepPanelRendering(
|
||||
viewer.isDestroyed?.()
|
||||
)
|
||||
return;
|
||||
drawing = true;
|
||||
try {
|
||||
viewer.resize();
|
||||
viewer.render();
|
||||
} finally {
|
||||
drawing = false;
|
||||
}
|
||||
viewer.resize();
|
||||
viewer.render();
|
||||
}, PANEL_FRAME_MS);
|
||||
return () => {
|
||||
windowRef.clearInterval(timer);
|
||||
|
||||
@@ -0,0 +1,109 @@
|
||||
// Retry in an inline panel after an error Scene catches itself in an
|
||||
// animation frame, when the host stops frames right after it. The loop's next
|
||||
// animation frame is still queued, so Retry must not start a second loop.
|
||||
import test from 'node:test';
|
||||
import assert from 'node:assert/strict';
|
||||
import * as Cesium from 'cesium';
|
||||
import { keepPanelRendering } from './embed.js';
|
||||
import { installRenderFailureNotice } from '../ui/renderFailure.js';
|
||||
|
||||
test('Retry in a panel whose host stopped frames right after an error Scene caught in an animation frame keeps one render loop', () => {
|
||||
const frames = [];
|
||||
let tick = null;
|
||||
let clock = 0;
|
||||
const windowRef = {
|
||||
requestAnimationFrame: () => 1,
|
||||
cancelAnimationFrame() {},
|
||||
setInterval: (fn) => ((tick = fn), 1),
|
||||
clearInterval() {},
|
||||
};
|
||||
const previousRaf = globalThis.requestAnimationFrame;
|
||||
globalThis.requestAnimationFrame = (fn) => frames.push(fn);
|
||||
const previousError = console.error;
|
||||
console.error = () => {};
|
||||
try {
|
||||
let broken = false;
|
||||
let drawn = 0;
|
||||
const scene = {
|
||||
renderError: new Cesium.Event(),
|
||||
preUpdate: new Cesium.Event(),
|
||||
postRender: new Cesium.Event(),
|
||||
requestRender() {},
|
||||
initializeFrame() {},
|
||||
render() {
|
||||
drawn += 1;
|
||||
this.preUpdate.raiseEvent(this);
|
||||
if (broken) this.renderError.raiseEvent(this, new Error('boom'));
|
||||
this.postRender.raiseEvent(this);
|
||||
},
|
||||
};
|
||||
const widget = Object.create(Cesium.CesiumWidget.prototype);
|
||||
Object.assign(widget, {
|
||||
_scene: scene,
|
||||
_clock: { tick() {} },
|
||||
_canRender: true,
|
||||
_useDefaultRenderLoop: false,
|
||||
_renderLoopRunning: false,
|
||||
_showRenderLoopErrors: false,
|
||||
_targetFrameRate: undefined,
|
||||
isDestroyed: () => false,
|
||||
resize() {},
|
||||
});
|
||||
// CesiumWidget's own renderError handler, which marks the loop stopped.
|
||||
scene.renderError.addEventListener(() => {
|
||||
widget._useDefaultRenderLoop = false;
|
||||
widget._renderLoopRunning = false;
|
||||
});
|
||||
const viewer = {
|
||||
scene,
|
||||
cesiumWidget: widget,
|
||||
canvas: { addEventListener() {}, removeEventListener() {} },
|
||||
get useDefaultRenderLoop() {
|
||||
return widget.useDefaultRenderLoop;
|
||||
},
|
||||
set useDefaultRenderLoop(value) {
|
||||
widget.useDefaultRenderLoop = value;
|
||||
},
|
||||
isDestroyed: () => false,
|
||||
render: () => widget.render(),
|
||||
resize: () => widget.resize(),
|
||||
};
|
||||
const store = {
|
||||
renderFailure: null,
|
||||
publishRenderFailure(next) {
|
||||
this.renderFailure = next;
|
||||
},
|
||||
};
|
||||
const uninstall = installRenderFailureNotice(viewer, {
|
||||
store,
|
||||
allowReload: false,
|
||||
locationRef: { href: 'https://gev.example/', reload() {}, assign() {} },
|
||||
logError() {},
|
||||
});
|
||||
const stop = keepPanelRendering(viewer, { windowRef, now: () => clock });
|
||||
viewer.useDefaultRenderLoop = true;
|
||||
// The error comes in an animation frame; Scene catches it, and the loop
|
||||
// still queues its next frame. Then the host stops animation frames.
|
||||
broken = true;
|
||||
for (const render of frames.splice(0)) render(16);
|
||||
assert.equal(store.renderFailure?.reason, 'render-error');
|
||||
assert.equal(frames.length, 1);
|
||||
broken = false;
|
||||
clock = 400;
|
||||
store.renderFailure.retry();
|
||||
clock += 33;
|
||||
tick();
|
||||
assert.equal(store.renderFailure, null);
|
||||
assert.equal(frames.length, 1, 'Retry starts no second loop');
|
||||
// The host resumes frames: the globe draws once a frame.
|
||||
drawn = 0;
|
||||
for (let frame = 1; frame <= 3; frame += 1)
|
||||
for (const render of frames.splice(0)) render(frame * 16);
|
||||
assert.equal(drawn, 3);
|
||||
stop();
|
||||
uninstall();
|
||||
} finally {
|
||||
globalThis.requestAnimationFrame = previousRaf;
|
||||
console.error = previousError;
|
||||
}
|
||||
});
|
||||
Reference in new issue
Block a user