mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-10-04 14:25:08 +00:00
refactor(web): read plugins through a PluginCatalog; only the display runs them (#688)
The web process built its own PluginManager and loaded plugins into itself: store installs and updates loaded or reloaded a web-side copy, and config saves and enable/disable called on_config_change, on_enable and on_disable on it. None of that reached the panel, and /plugins/installed reported runtime state from those copies. - Add PluginCatalog (src/plugin_system/plugin_catalog.py): manifests, directories, display modes, installed version, schema and config reads, with no way to run a plugin. app.py and both blueprints use it; the plugin_manager blueprint attribute is gone. - Remove every lifecycle call from the web routes. Config changes already reach the display through ConfigService (on_config_change) and the enabled-set reconcile. - Health and metrics readers move to api_v3.health_tracker / resource_monitor. /plugins/installed reports loaded/state/error_info as null (the display does not publish them) and enabled by the display's rule. - Store install, update and uninstall answer restart_required when the running display will not pick the change up by itself (display_restart_required). The restart banner follows the flag via window.noteRestartRequired instead of the /config/main URL heuristic; /config/main now sends restart_required: true. - The one remaining in-process import of plugin code (Starlark helper modules, oauth_flow action scripts) goes through _import_plugin_code_in_web_process() until a web-entry contract. - /plugins/installed reports vegas_participation (from #682) from the user's setting or the manifest, with vegas_participation_source; when only the plugin's code decides it, null with source 'runtime', since the web process no longer has plugin instances to ask. - Check & Update All keeps its restart flags when the final list refresh fails, and asks for a restart when an enabled plugin's first request got no answer and the re-sent one found it up to date. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Chuck
+1
-1
@@ -22,7 +22,7 @@ const UNIT = ['unit/test_list_filter.js', 'unit/test_render_cards.js',
|
||||
'unit/test_style_editor_layout_leaf_collision.js',
|
||||
'unit/test_update_all.js', 'unit/test_inline_handler_escaping.js',
|
||||
'unit/test_plugin_action_delegation.js', 'unit/test_file_upload_widget.js',
|
||||
'unit/test_store_registry_fields.js'];
|
||||
'unit/test_store_registry_fields.js', 'unit/test_restart_banner.js'];
|
||||
const DOM = ['dom/test_installed_dom.js', 'dom/test_store_dom.js', 'dom/test_no_double_fetch.js',
|
||||
'dom/test_tools_sections.js'];
|
||||
|
||||
|
||||
@@ -0,0 +1,104 @@
|
||||
// The "restart the display" banner is raised by the server's answer, not by
|
||||
// which URL was called.
|
||||
//
|
||||
// app.js used to show it after any successful POST to /api/v3/config/main and
|
||||
// nothing else. A plugin update, install or uninstall that the running display
|
||||
// cannot pick up live now answers `restart_required: true` (with the banner's
|
||||
// wording in `restart_message`), and so does a main-config save. The htmx
|
||||
// after-request handler and window.noteRestartRequired must both follow the
|
||||
// flag. Runs the shipped app.js in a vm with a minimal fake DOM -- no jsdom and
|
||||
// no server needed, so it runs under test/test_js_unit_suites.py too.
|
||||
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
const vm = require('vm');
|
||||
const V3 = path.resolve(__dirname, '../../../web_interface/static/v3');
|
||||
|
||||
let pass = 0, fail = 0;
|
||||
const ok = (label, cond, extra) => cond
|
||||
? (pass++, console.log(' ok ' + label))
|
||||
: (fail++, console.log(' FAIL ' + label + (extra !== undefined ? ' ' + JSON.stringify(extra) : '')));
|
||||
|
||||
function load() {
|
||||
const handlers = {};
|
||||
const listen = (target) => (type, fn) => { (handlers[target + ':' + type] ||= []).push(fn); };
|
||||
const banner = { style: { display: 'none' } };
|
||||
const text = { dataset: {}, textContent: ' Configuration saved — restart the display to apply the changes ' };
|
||||
const store = {};
|
||||
const document = {
|
||||
body: { addEventListener: listen('body') },
|
||||
addEventListener: listen('document'),
|
||||
getElementById: (id) => ({ 'restart-pending-banner': banner, 'restart-pending-text': text })[id] || null,
|
||||
querySelector: () => null,
|
||||
querySelectorAll: () => [],
|
||||
};
|
||||
const window = {
|
||||
addEventListener: listen('window'),
|
||||
getApp: () => null,
|
||||
};
|
||||
const context = {
|
||||
window, document, console,
|
||||
sessionStorage: {
|
||||
setItem: (k, v) => { store[k] = String(v); },
|
||||
removeItem: (k) => { delete store[k]; },
|
||||
getItem: (k) => (k in store ? store[k] : null),
|
||||
},
|
||||
showNotification: () => {},
|
||||
setTimeout: () => 0,
|
||||
};
|
||||
vm.createContext(context);
|
||||
vm.runInContext(fs.readFileSync(path.join(V3, 'app.js'), 'utf8'), context);
|
||||
const afterRequest = (handlers['body:htmx:afterRequest'] || [])[0];
|
||||
const fire = ({ status = 200, body, path: reqPath = '/api/v3/anything', reportsItself = false }) => {
|
||||
const elt = { closest: () => (reportsItself ? {} : null) };
|
||||
afterRequest({
|
||||
target: { closest: () => null },
|
||||
detail: {
|
||||
xhr: { status, responseText: body === undefined ? '' : (typeof body === 'string' ? body : JSON.stringify(body)) },
|
||||
elt,
|
||||
requestConfig: { verb: 'post', path: reqPath },
|
||||
},
|
||||
});
|
||||
};
|
||||
return { window, banner, text, store, fire, afterRequest };
|
||||
}
|
||||
|
||||
console.log('\nwindow.noteRestartRequired');
|
||||
{
|
||||
const t = load();
|
||||
ok('app.js defines it', typeof t.window.noteRestartRequired === 'function');
|
||||
ok('no flag, no banner', t.window.noteRestartRequired({ status: 'success' }) === false
|
||||
&& t.banner.style.display === 'none');
|
||||
ok('a missing body is ignored', t.window.noteRestartRequired(null) === false);
|
||||
ok('restart_required: false is not a request',
|
||||
t.window.noteRestartRequired({ restart_required: false }) === false && t.banner.style.display === 'none');
|
||||
ok('restart_required: true shows the banner',
|
||||
t.window.noteRestartRequired({ restart_required: true }) === true && t.banner.style.display === 'block');
|
||||
ok('without a message the template wording stays',
|
||||
t.text.textContent === 'Configuration saved — restart the display to apply the changes', t.text.textContent);
|
||||
t.window.noteRestartRequired({ restart_required: true, restart_message: 'Plugin updated — restart the display to run the new version' });
|
||||
ok('restart_message becomes the wording',
|
||||
t.text.textContent === 'Plugin updated — restart the display to run the new version', t.text.textContent);
|
||||
ok('and survives a reload with the flag', t.store['ledmatrix-restart-pending'] === '1'
|
||||
&& t.store['ledmatrix-restart-pending-text'] === 'Plugin updated — restart the display to run the new version');
|
||||
}
|
||||
|
||||
console.log('\nhtmx after-request follows the flag, not the URL');
|
||||
{
|
||||
const t = load();
|
||||
ok('the handler is registered', typeof t.afterRequest === 'function');
|
||||
t.fire({ path: '/api/v3/config/main', body: { status: 'success', message: 'Configuration saved successfully' } });
|
||||
ok('a /config/main answer without the flag raises nothing', t.banner.style.display === 'none');
|
||||
t.fire({ path: '/api/v3/plugins/update', status: 500, body: { status: 'error', restart_required: true } });
|
||||
ok('an error answer never raises it', t.banner.style.display === 'none');
|
||||
t.fire({ path: '/api/v3/whatever', body: '<html>not json' });
|
||||
ok('a non-JSON answer is ignored', t.banner.style.display === 'none');
|
||||
// The main-config forms report their own result (hx-on after-request), so
|
||||
// the flag must be read even when the toast is not this handler's to show.
|
||||
t.fire({ path: '/api/v3/config/main', reportsItself: true,
|
||||
body: { status: 'success', message: 'Configuration saved successfully', restart_required: true } });
|
||||
ok('a flagged answer raises it, even from a form that reports itself', t.banner.style.display === 'block');
|
||||
}
|
||||
|
||||
console.log(`\n${pass} passed, ${fail} failed`);
|
||||
process.exit(fail ? 1 : 0);
|
||||
@@ -229,6 +229,78 @@ const noSleep = { sleep: async () => {} };
|
||||
allNoop.type === 'success' && allNoop.text === '2 already up to date', allNoop);
|
||||
}
|
||||
|
||||
console.log('\nrestart banner: driven by the server\'s restart_required');
|
||||
{
|
||||
const body = (restart_required, restart_message) => ({
|
||||
success: true,
|
||||
result: { status: 'success', data: { update_status: 'updated' }, restart_required, restart_message },
|
||||
});
|
||||
const needed = body(true, 'Plugin updated — restart the display to run the new version');
|
||||
ok('an update the display is running asks for the banner, with its wording',
|
||||
Manager.restartRequest([body(false), needed, body(true, 'second')]) === needed.result);
|
||||
ok('updates the display does not run need no restart',
|
||||
Manager.restartRequest([body(false), body(false)]) === null);
|
||||
ok('a failed request never raises the banner',
|
||||
Manager.restartRequest([{ success: false, error: { restart_required: true } }]) === null);
|
||||
ok('an older server that sends no flag raises nothing',
|
||||
Manager.restartRequest([{ success: true, result: { status: 'success' } }]) === null);
|
||||
ok('no results, no banner', Manager.restartRequest(undefined) === null);
|
||||
|
||||
// The first request's answer was lost; the re-sent one finds nothing to do.
|
||||
const lost = (enabled, update_status = 'up_to_date') => ({
|
||||
pluginId: 'clock', success: true, afterLostAnswer: true, enabled,
|
||||
result: { status: 'success', data: { update_status }, restart_required: false },
|
||||
});
|
||||
const maybe = Manager.restartRequest([body(false), lost(true)]);
|
||||
ok('an enabled plugin up to date after a lost answer may have been updated: banner',
|
||||
maybe && maybe.restart_required === true && /clock/.test(maybe.restart_message), maybe);
|
||||
ok('...but an explicit answer still wins, with its wording',
|
||||
Manager.restartRequest([lost(true), needed]) === needed.result);
|
||||
ok('a disabled one needs no restart (enabling it loads it)',
|
||||
Manager.restartRequest([lost(false)]) === null);
|
||||
ok('nor does one that was not retried',
|
||||
Manager.restartRequest([{ ...lost(true), afterLostAnswer: undefined }]) === null);
|
||||
}
|
||||
|
||||
console.log('\nupdateAll keeps what the banner needs');
|
||||
{
|
||||
// ledmatrix-flights (enabled) loses its first answer, then is up to date.
|
||||
const api = fakeApi({
|
||||
'ledmatrix-flights': (n) => {
|
||||
if (n === 1) throw netErr();
|
||||
return { status: 'success', data: { update_status: 'up_to_date' }, restart_required: false };
|
||||
},
|
||||
});
|
||||
setup(api, { windowList: INSTALLED });
|
||||
const results = await Manager.updateAll(null, noSleep);
|
||||
const flights = results.find(r => r.pluginId === 'ledmatrix-flights');
|
||||
ok('a retried entry is marked, with the plugin\'s enabled flag',
|
||||
flights.afterLostAnswer === true && flights.enabled === true, flights);
|
||||
ok('an entry answered first time is not marked',
|
||||
results.filter(r => r.afterLostAnswer).length === 1, results);
|
||||
ok('...so the run asks for a restart', Manager.restartRequest(results) !== null);
|
||||
}
|
||||
{
|
||||
const answer = { status: 'success', data: { update_status: 'updated' }, restart_required: true };
|
||||
const api = fakeApi({ 'ledmatrix-flights': () => answer });
|
||||
setup(api, { stateList: INSTALLED });
|
||||
window.PluginStateManager.loadInstalledPlugins = async () => { throw new Error('refresh failed'); };
|
||||
const warn = console.warn;
|
||||
console.warn = () => {};
|
||||
let results;
|
||||
try {
|
||||
results = await Manager.updateAll(null, noSleep);
|
||||
} catch (e) {
|
||||
results = e;
|
||||
} finally {
|
||||
console.warn = warn;
|
||||
}
|
||||
ok('a failed list refresh still returns the results',
|
||||
Array.isArray(results) && results.length === EXPECTED.length, String(results));
|
||||
ok('...with the restart flag intact',
|
||||
Array.isArray(results) && Manager.restartRequest(results) === answer);
|
||||
}
|
||||
|
||||
console.log(`\n${pass} passed, ${fail} failed`);
|
||||
process.exit(fail ? 1 : 0);
|
||||
})().catch(e => { console.error(e); process.exit(1); });
|
||||
|
||||
Reference in New Issue
Block a user