mirror of
https://github.com/bilawalsidhu/gods-eye-view.git
synced 2026-11-16 08:12:24 +00:00
Report model load failures to model sets, and bound the tracked model's retries again
The renderer contract gains an optional event on model draw sets,
`on('loadFailed', (id, message) => ...)`, beside `ready`: a model's url
failed to load, once per failed load. The item stays in the set drawing
what it drew before; removing it and adding it again tries at once. A
renderer that cannot tell a failure may never fire it.
The Cesium draw port fires it once Cesium is done with the frame it
raised the error in, and not for a load that was superseded or whose item
went. The stub fails urls under `stub-fail:`, telling each load once. A
conformance check (`draw.models.loadFailed`) runs on both, with a model
url the dev server does not serve for Cesium.
The flights and military layers use it in place of rewriting every
unloaded model every 5 s. A fleet model whose load failed is removed and
added again 5 s later. The tracked model gets back its per-selection
budget: a failed load is let go and tried again 1.5 s later, and after
three failures the contact stays 2D until another is selected, as
before the models moved onto the draw port. A good load retires the
budget, and a model that loads after all is kept.
This commit is contained in:
1 parent
396e7f0deb
commit
5370feb825
23 files changed
+536
-58
No files matched your search
@@ -267,7 +267,10 @@ export function createCesiumDraw({
|
||||
function makeSet(kind, spec, build) {
|
||||
if (sets.has(spec.id)) throw new Error(`a set with id ${spec.id} is live`);
|
||||
const items = new Map();
|
||||
const listeners = { ready: listenerList(report) };
|
||||
const listeners = {
|
||||
ready: listenerList(report),
|
||||
loadFailed: listenerList(report),
|
||||
};
|
||||
const record = {
|
||||
kind,
|
||||
spec,
|
||||
|
||||
@@ -4052,6 +4052,59 @@ test('a model load superseded or failed settles once', async () => {
|
||||
}
|
||||
});
|
||||
|
||||
test('a failed model load fires loadFailed once, after the frame, with why', async () => {
|
||||
const { loads, restore } = fakeModelLoads();
|
||||
try {
|
||||
const scene = fakeScene();
|
||||
const part = createCesiumDraw({
|
||||
scene,
|
||||
report: (error) => assert.fail(error),
|
||||
});
|
||||
const set = part.port.models({ id: 'm' });
|
||||
const failed = [];
|
||||
set.on('loadFailed', (id, message) => failed.push([id, message]));
|
||||
const item = (id, url) => ({
|
||||
id,
|
||||
pos: { lon: 0, lat: 0 },
|
||||
url,
|
||||
orientation: { heading: 0, pitch: 0, roll: 0 },
|
||||
});
|
||||
// A load that rejects (the glTF did not fetch).
|
||||
set.set([item('a', 'a.glb'), item('b', 'b.glb')]);
|
||||
loads[0].reject(new Error('404 for a.glb'));
|
||||
await settle();
|
||||
assert.deepEqual(failed, [['a', '404 for a.glb']]);
|
||||
// One that fails in its update: told after that update, not inside it.
|
||||
loads[1].resolve();
|
||||
await settle();
|
||||
loads[1].model.errorEvent.raiseEvent(new Error('bad texture'));
|
||||
assert.equal(failed.length, 1, 'not inside the model update');
|
||||
await settle();
|
||||
assert.deepEqual(failed[1], ['b', 'bad texture']);
|
||||
// A listener may change the set: removing and adding again loads at once.
|
||||
set.remove(['a']);
|
||||
set.upsert([item('a', 'a.glb')]);
|
||||
assert.equal(loads.length, 3, 'added again, loaded again');
|
||||
// A load superseded before it fails is not told.
|
||||
set.upsert([item('a', 'c.glb')]);
|
||||
loads[2].reject(new Error('late'));
|
||||
await settle();
|
||||
assert.equal(failed.length, 2, 'a superseded load does not fire');
|
||||
// Nor one whose item went before the failure was told.
|
||||
loads[3].reject('plain reason');
|
||||
set.remove(['a']);
|
||||
await settle();
|
||||
assert.equal(failed.length, 2, 'an item gone does not fire');
|
||||
set.upsert([item('d', 'd.glb')]);
|
||||
loads[4].reject({});
|
||||
await settle();
|
||||
assert.deepEqual(failed[2], ['d', 'the model did not load']);
|
||||
set.dispose();
|
||||
} finally {
|
||||
restore();
|
||||
}
|
||||
});
|
||||
|
||||
test('a failed model load is tried again on a later update, after a wait', async () => {
|
||||
const { loads, restore } = fakeModelLoads();
|
||||
const realNow = Date.now;
|
||||
|
||||
@@ -15,8 +15,9 @@
|
||||
* measures `minPixelSize`), `scaleByDistance`, `fadeByDistance` (the tint's
|
||||
* alpha) and the set's `horizonCull`.
|
||||
*
|
||||
* A failed load is tried again when its item is next updated, once
|
||||
* `MODEL_RETRY_MS` has passed.
|
||||
* A failed load fires `loadFailed` (after the frame Cesium reported it in,
|
||||
* so a listener may change the set), and is tried again when its item is
|
||||
* next updated, once `MODEL_RETRY_MS` has passed.
|
||||
*
|
||||
* `shading: 'thermal'` draws the model unlit and white-hot (its texture
|
||||
* left out), then tinted as asked: a hot target, as the thermal views draw
|
||||
@@ -116,6 +117,13 @@ const tintKey = (tint) =>
|
||||
? tint
|
||||
: tint.join(',');
|
||||
|
||||
/** Why a load failed, as `loadFailed` reports it. */
|
||||
function failureMessage(error) {
|
||||
if (error instanceof Error && error.message) return error.message;
|
||||
const text = error === undefined || error === null ? '' : String(error);
|
||||
return text && text !== '[object Object]' ? text : 'the model did not load';
|
||||
}
|
||||
|
||||
/** Whether an item needs the per-frame pass. */
|
||||
const needsFrame = (item, spec) =>
|
||||
item.maxPixelSize > 0 ||
|
||||
@@ -183,8 +191,11 @@ export function createModelSets({
|
||||
// A load counts until it is ready, fails or is superseded; once.
|
||||
host.loading += 1;
|
||||
let settled = false;
|
||||
const item = entry.item;
|
||||
const current = () =>
|
||||
entry.token === token && record.host === host && !host.isDestroyed();
|
||||
const settleLoad = () => settle(false);
|
||||
const settle = (failed) => {
|
||||
const settle = (failed, error) => {
|
||||
if (settled) return;
|
||||
settled = true;
|
||||
if (entry.settleLoad === settleLoad) entry.settleLoad = null;
|
||||
@@ -193,13 +204,17 @@ export function createModelSets({
|
||||
entry.failed = true;
|
||||
entry.failedAt = Date.now();
|
||||
host.failed += 1;
|
||||
// Told once Cesium is done with the frame it raised this in; not
|
||||
// when the item has moved on to another load meanwhile.
|
||||
const message = failureMessage(error);
|
||||
queueMicrotask(() => {
|
||||
if (current() && entry.failed)
|
||||
record.listeners.loadFailed.fire(item.id, message);
|
||||
});
|
||||
}
|
||||
requestRender();
|
||||
};
|
||||
entry.settleLoad = settleLoad;
|
||||
const item = entry.item;
|
||||
const current = () =>
|
||||
entry.token === token && record.host === host && !host.isDestroyed();
|
||||
Cesium.Model.fromGltfAsync({
|
||||
url: item.url,
|
||||
modelMatrix: matrixOf(entry, new Cesium.Matrix4()),
|
||||
@@ -241,7 +256,7 @@ export function createModelSets({
|
||||
});
|
||||
// A failed load is let go (Cesium would keep drawing frames for
|
||||
// it); the failure stays for `whenSettled` until the item changes.
|
||||
model.errorEvent.addEventListener(() => {
|
||||
model.errorEvent.addEventListener((error) => {
|
||||
if (current() && entry.next === model) {
|
||||
entry.next = null;
|
||||
// Cesium raises this inside the model's update: removing it
|
||||
@@ -251,11 +266,11 @@ export function createModelSets({
|
||||
host.remove(model);
|
||||
});
|
||||
}
|
||||
settle(true);
|
||||
settle(true, error);
|
||||
});
|
||||
requestRender();
|
||||
},
|
||||
() => settle(true),
|
||||
(error) => settle(true, error),
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
@@ -45,6 +45,7 @@ export const CESIUM_CHECKS = new Set([
|
||||
'draw.lines.segments',
|
||||
'draw.ids',
|
||||
'draw.models',
|
||||
'draw.models.loadFailed',
|
||||
'draw.models.tint',
|
||||
'draw.models.update',
|
||||
'draw.motion',
|
||||
@@ -113,11 +114,16 @@ function nextFrame() {
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {{name?: string, model?: string}} [options] `model`: a glTF URL
|
||||
* for the model checks.
|
||||
* @param {{name?: string, model?: string, missingModel?: string}} [options]
|
||||
* `model`: a glTF URL for the model checks; `missingModel`: one that
|
||||
* fails to load, for the failure check.
|
||||
* @returns {import('../conformance/index.js').ConformanceHarness}
|
||||
*/
|
||||
export function createCesiumHarness({ name = 'cesium', model } = {}) {
|
||||
export function createCesiumHarness({
|
||||
name = 'cesium',
|
||||
model,
|
||||
missingModel,
|
||||
} = {}) {
|
||||
return {
|
||||
name,
|
||||
async create({ viewport, capabilities }) {
|
||||
@@ -157,6 +163,6 @@ export function createCesiumHarness({ name = 'cesium', model } = {}) {
|
||||
toEcef,
|
||||
tolerance: DEFAULT_TOLERANCE,
|
||||
flightPaths: 'endpoints',
|
||||
...(model ? { assets: { model } } : {}),
|
||||
...(model ? { assets: { model, missingModel } } : {}),
|
||||
};
|
||||
}
|
||||
Reference in new issue
Block a user