Skip to content

[backport v2.14.1] Guard against unhandled exceptions when using waitFor() #17086

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rak-phillip merged 2 commits into from
Apr 3, 2026
Merged

[backport v2.14.1] Guard against unhandled exceptions when using waitFor() #17086

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3ab62a3
Always reject regardless of message passed to `waitFor()`
rak-phillip Mar 26, 2026
d556fac
Guard against unhandled exceptions using `waitFor()`
rak-phillip Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 29 additions & 4 deletions shell/plugins/steve/subscribe.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,11 +131,17 @@ const isWaitingForDestroy = (storeName, store) => {
};

const waitForSettingsSchema = (storeName, store) => {
return waitFor(() => isWaitingForDestroy(storeName, store) || !!store.getters['management/byId'](SCHEMA, MANAGEMENT.SETTING));
return waitFor(
() => isWaitingForDestroy(storeName, store) || !!store.getters['management/byId'](SCHEMA, MANAGEMENT.SETTING),
'management settings schema to be available'
);
};

const waitForSettings = (storeName, store) => {
return waitFor(() => isWaitingForDestroy(storeName, store) || !!store.getters['management/byId'](MANAGEMENT.SETTING, SETTING.UI_PERFORMANCE));
return waitFor(
() => isWaitingForDestroy(storeName, store) || !!store.getters['management/byId'](MANAGEMENT.SETTING, SETTING.UI_PERFORMANCE),
'UI performance settings to be available'
);
};

const isAdvancedWorker = (ctx) => {
Expand Down Expand Up @@ -195,8 +201,20 @@ export async function createWorker(store, ctx) {
};
}

await waitForSettingsSchema(storeName, store);
await waitForSettings(storeName, store);
try {
await waitForSettingsSchema(storeName, store);
await waitForSettings(storeName, store);
} catch (e) {
// Clean up the mock worker and abort so callers are not permanently blocked.
if (store.$workers[storeName]?.destroy) {
store.$workers[storeName].destroy();
} else {
delete store.$workers[storeName];
}

return;
}

if (store.$workers[storeName].waitingForDestroy()) {
store.$workers[storeName].destroy();

Expand Down Expand Up @@ -382,6 +400,13 @@ const sharedActions = {
if (!this.$workers[getters.storeName]) {
await createWorker(this, ctx);
}

// createWorker cleans up and returns early when schema/settings are unavailable.
// Guard against calling postMessage on a non-existent worker.
if (!this.$workers[getters.storeName]) {
return;
}

const options = { parseJSON: false };
const csrf = rootGetters['cookies/get']({ key: CSRF, options });

Expand Down
6 changes: 1 addition & 5 deletions shell/utils/async.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,7 @@ export const waitFor = (testFn: Function, msg = '', timeoutMs = 3000000, interva
gatedLog('Wait for', msg, 'timed out');
clearInterval(interval);
clearTimeout(timeout);
if (msg) {
reject(new Error(`Failed waiting for: ${ msg }`));
} else {
throw new Error(`waitFor timed out after ${ timeoutMs / 1000 } seconds`);
}
reject(new Error(msg ? `Failed waiting for: ${ msg }` : `waitFor timed out after ${ timeoutMs / 1000 } seconds`));
}, timeoutMs);
const interval = setInterval(() => {
if ( testFn() ) {
Expand Down
Loading