mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-10-04 22:35:08 +00:00
fix(web-ui): Plugin Manager - enable aliased installs, Update All, on-demand modes, long installs, categories, GitHub-URL install (#746)
* fix(web-ui): Update All sends the live installed list and redraws the grid updateAll() preferred PluginStateManager.installedPlugins over window.installedPlugins. Only updateAll's own end-of-run refresh ever fills PluginStateManager, so from the second run on it sent the first run's plugins: one uninstalled since failed with "plugin not found" and one installed since was never updated. That refresh also only replaced window.installedPlugins, so the installed cards and the Updates badge kept offering "Update to vX" for what had just been updated. Read window.installedPlugins, the list plugins_manager.js republishes after every install, uninstall and refresh, keeping PluginStateManager as the fallback for a page without it, and refresh through pluginManager.loadInstalledPlugins(true), which redraws the grid. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(web-ui): list each plugin's display modes in /plugins/installed The on-demand modal fills its Display Mode select from plugin.display_modes, but /plugins/installed never sent the field. Every plugin offered one option, its own id, under "This plugin exposes a single display mode"; the display resolved that id to the plugin's first mode, so a multi-mode plugin could only be started, or pinned, there. Add display_modes to each entry, read from the plugin catalog (get_plugin_display_modes), the same declared list /display/modes and on-demand/start use, keeping only strings. Single-mode plugins still get one option and the same hint. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(web-ui): enable a store install by its installed id, and not on reinstall The store's Install button enabled the new plugin by the registry id it installed. Weather, Music, Stocks and Leaderboard install under the id their manifests declare (weather -> ledmatrix-weather); the plugin list, the config section and /plugins/toggle know only that id, so the toggle answered 404 "Plugin not found" and the plugin stayed disabled behind "installed, but enabling it failed". The same button on an installed plugin (Reinstall) enabled it too, switching a plugin the user had turned off back on. POST /plugins/install now names the installed plugin: plugin_id in the direct answer and in the queued operation's result, read from the installed manifest found the way the store's update and uninstall find it (_find_plugin_path: id, aliases, plugin_path name), else the requested id. The client reloads the list, then enables that id; from an answer without it, the installed entry the store entry matches (findInstalledStorePlugin, which isStorePluginInstalled now uses). A reinstall, decided by the same match that labelled the button, reloads the list and leaves the enabled state alone. test/js/plugins_manager_sandbox.js runs the whole of plugins_manager.js in a vm context against a fake DOM and API, for suites that drive its real flows. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(web-ui): wait for long store installs; on timeout reload, not fail pollOperationStatus gave a queued install 60 polls, a second apart, then reported "Install operation timed out" as an error and stopped. The server allows the plugin's dependency install 300 s on its own (install_requirements_file in store_install.py), after a download that fetches the plugin a file at a time, so installs that went on to succeed were reported as failed, never enabled, and left out of the installed list until the page was reloaded. Give installs INSTALL_POLL_MAX_ATTEMPTS (600, ten minutes). When even that runs out, reload the installed list and the store badges and warn that the install may still be running; nothing is enabled without the operation's answer. Uninstall keeps the default. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(web-ui): build the store's category filter from the store's plugins The #plugin-category select listed seven fixed categories while the registry uses about twenty (productivity, utility, transit, finance, ...), so roughly a third of the store could not be filtered to, and "Financial" missed the plugin filed under "finance". The template now ships only "All Categories"; syncStoreCategoryOptions, run by applyStoreFiltersAndSort, adds one option per category the cached store plugins have (case folded, as the filter compares), keeps the current choice, and rebuilds only when the set changes or the partial was swapped in afresh -- the way the Starlark section builds its own. The test sandbox gains window.addEventListener (initPluginsPage needs it) and quiets the script's "element not found" warnings. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * fix(web-ui): one handler for the GitHub-URL Install button #install-plugin-from-url had an inline onclick calling window.handleGitHubPluginInstall, and attachInstallButtonHandler also gave it a click listener that installs, so both ran on every click (and on Enter, which clicks it). The inline handler threw a ReferenceError -- it called isGithubUrl, which is local to the plugin-manager IIFE, from outside it -- so only the listener's request went out; correcting that scope alone would have sent every install twice. Remove the inline onclick and the window.handleGitHubPluginInstall it called, which nothing else uses. The listener, which already sent the only request, is unchanged. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Chuck
@@ -0,0 +1,93 @@
|
||||
// Plugin Manager > Install from GitHub > Install Single Plugin: one click,
|
||||
// one request, no errors.
|
||||
//
|
||||
// The Install button carried an inline onclick calling
|
||||
// window.handleGitHubPluginInstall, and attachInstallButtonHandler also gave
|
||||
// it a click listener that installs. Both ran on every click. The inline one
|
||||
// threw a ReferenceError (it called isGithubUrl, which lives inside the
|
||||
// plugin-manager IIFE, from outside it), so only the listener's request went
|
||||
// out -- and fixing that scope alone would have sent every install twice.
|
||||
// The button now has the listener only.
|
||||
//
|
||||
// Runs the whole of plugins_manager.js in the sandbox, with the button as
|
||||
// partials/plugins.html ships it.
|
||||
|
||||
const { create, templateAttributes } = require('../plugins_manager_sandbox');
|
||||
|
||||
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).slice(0, 400) : '')));
|
||||
|
||||
const URL = 'https://github.com/someone/ledmatrix-demo';
|
||||
|
||||
function route(method, url) {
|
||||
if (method === 'POST' && url === '/api/v3/plugins/install-from-url') {
|
||||
return { json: { status: 'success', message: 'Plugin demo installed successfully', plugin_id: 'demo' } };
|
||||
}
|
||||
if (url.startsWith('/api/v3/plugins/installed')) return { json: { status: 'success', data: { plugins: [] } } };
|
||||
return { json: { status: 'success' } };
|
||||
}
|
||||
|
||||
function page() {
|
||||
const sb = create({ route });
|
||||
const button = templateAttributes('install-plugin-from-url');
|
||||
sb.el('install-plugin-from-url', button.tag, button.attrs);
|
||||
sb.el('github-plugin-url', 'input');
|
||||
sb.el('github-plugin-status');
|
||||
sb.el('plugin-branch-input', 'input');
|
||||
return sb;
|
||||
}
|
||||
|
||||
const installs = sb => sb.requests.filter(r => r.url === '/api/v3/plugins/install-from-url');
|
||||
|
||||
(async () => {
|
||||
console.log('\nthe template');
|
||||
{
|
||||
const { attrs } = templateAttributes('install-plugin-from-url');
|
||||
ok('the Install button has no inline onclick', !('onclick' in attrs), attrs.onclick);
|
||||
}
|
||||
|
||||
console.log('\na click');
|
||||
{
|
||||
const sb = page();
|
||||
sb.window.attachInstallButtonHandler();
|
||||
// htmx:afterSettle runs it again on every swap; that must not add a handler.
|
||||
sb.window.attachInstallButtonHandler();
|
||||
sb.el('github-plugin-url').value = URL;
|
||||
sb.window.document.getElementById('install-plugin-from-url').click();
|
||||
await sb.settle();
|
||||
ok('raises no error', sb.errors.length === 0, sb.errors.map(String));
|
||||
ok('sends exactly one install request', installs(sb).length === 1, installs(sb));
|
||||
ok('for the URL typed', installs(sb)[0] && installs(sb)[0].body.repo_url === URL, installs(sb));
|
||||
ok('and reports the result', /Successfully installed: demo/.test(sb.el('github-plugin-status').innerHTML),
|
||||
sb.el('github-plugin-status').innerHTML);
|
||||
}
|
||||
|
||||
console.log('\nEnter in the URL field');
|
||||
{
|
||||
const sb = page();
|
||||
sb.window.attachInstallButtonHandler();
|
||||
const input = sb.el('github-plugin-url');
|
||||
input.value = URL;
|
||||
input.dispatch('keypress', { key: 'Enter' });
|
||||
await sb.settle();
|
||||
ok('raises no error', sb.errors.length === 0, sb.errors.map(String));
|
||||
ok('sends exactly one install request', installs(sb).length === 1, installs(sb));
|
||||
}
|
||||
|
||||
console.log('\na URL that is not GitHub');
|
||||
{
|
||||
const sb = page();
|
||||
sb.window.attachInstallButtonHandler();
|
||||
sb.el('github-plugin-url').value = 'https://example.com/x';
|
||||
sb.window.document.getElementById('install-plugin-from-url').click();
|
||||
await sb.settle();
|
||||
ok('is refused without a request or an error',
|
||||
installs(sb).length === 0 && sb.errors.length === 0 && /valid GitHub URL/.test(sb.el('github-plugin-status').innerHTML),
|
||||
{ errors: sb.errors.map(String), status: sb.el('github-plugin-status').innerHTML });
|
||||
}
|
||||
|
||||
console.log(`\n${pass} passed, ${fail} failed`);
|
||||
process.exit(fail ? 1 : 0);
|
||||
})().catch(e => { console.error(e); process.exit(1); });
|
||||
@@ -0,0 +1,89 @@
|
||||
// How long the store's Install waits for a queued install, and what it says
|
||||
// when it stops waiting.
|
||||
//
|
||||
// It polled the operation 60 times, a second apart, then reported "Install
|
||||
// operation timed out" as an error and did nothing else. The server is
|
||||
// allowed far longer: the plugin's dependency install alone may take 300 s
|
||||
// (install_requirements_file in src/plugin_system/store_install.py), after
|
||||
// a download that fetches the plugin one file at a time. So an install that
|
||||
// went on to succeed was reported as failed, never enabled, and missing from
|
||||
// the installed list until the page was reloaded.
|
||||
//
|
||||
// Runs the whole of plugins_manager.js in the sandbox; its timers ignore
|
||||
// their delays, so each poll here stands for one second on a real page.
|
||||
|
||||
const { create } = require('../plugins_manager_sandbox');
|
||||
|
||||
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).slice(0, 400) : '')));
|
||||
|
||||
// The server's dependency-install timeout, in polls (one a second).
|
||||
const DEPENDENCY_INSTALL_TIMEOUT_POLLS = 300;
|
||||
|
||||
function server(completesAfterPolls) {
|
||||
const state = { polls: 0, installed: [] };
|
||||
state.route = (method, url, body) => {
|
||||
if (url.startsWith('/api/v3/plugins/installed')) {
|
||||
return { json: { status: 'success', data: { plugins: state.installed.map(p => ({ ...p })) } } };
|
||||
}
|
||||
if (method === 'POST' && url === '/api/v3/plugins/install') {
|
||||
return { json: { status: 'success', message: 'queued', data: { operation_id: 'op-1' } } };
|
||||
}
|
||||
if (url === '/api/v3/plugins/operation/op-1') {
|
||||
state.polls++;
|
||||
if (completesAfterPolls === null || state.polls < completesAfterPolls) {
|
||||
return { json: { status: 'success', data: { status: 'running' } } };
|
||||
}
|
||||
state.installed = [{ id: 'clock-simple', name: 'Clock', enabled: false }];
|
||||
return { json: { status: 'success', data: { status: 'completed',
|
||||
result: { success: true, message: 'installed', plugin_id: 'clock-simple' } } } };
|
||||
}
|
||||
if (method === 'POST' && url === '/api/v3/plugins/toggle') {
|
||||
return { json: { status: 'success', message: 'enabled' } };
|
||||
}
|
||||
return { json: { status: 'success' } };
|
||||
};
|
||||
return state;
|
||||
}
|
||||
|
||||
(async () => {
|
||||
console.log('\nan install that takes longer than a minute');
|
||||
{
|
||||
// 200 s: well inside what the server allows.
|
||||
const srv = server(200);
|
||||
const sb = create({ route: srv.route });
|
||||
sb.window.installPlugin('clock-simple');
|
||||
await sb.until(() => sb.toasts.some(t => /installed and enabled|enabling it failed|timed out|still/i.test(t.message)),
|
||||
'the install to finish');
|
||||
await sb.settle();
|
||||
ok('is waited for until it completes', srv.polls === 200, srv.polls);
|
||||
ok('is not reported as an error', !sb.toasts.some(t => t.type === 'error'), sb.toasts);
|
||||
ok('and is enabled', sb.requests.some(r => r.url === '/api/v3/plugins/toggle' && r.body.plugin_id === 'clock-simple'),
|
||||
sb.requests.filter(r => r.method === 'POST'));
|
||||
}
|
||||
|
||||
console.log('\nan install that never reports back');
|
||||
{
|
||||
const srv = server(null);
|
||||
const sb = create({ route: srv.route });
|
||||
sb.window.installPlugin('clock-simple');
|
||||
await sb.until(() => sb.toasts.length >= 3, 'the poller to give up');
|
||||
await sb.settle();
|
||||
ok(`is polled for at least the ${DEPENDENCY_INSTALL_TIMEOUT_POLLS} s dependency-install timeout`,
|
||||
srv.polls >= DEPENDENCY_INSTALL_TIMEOUT_POLLS, srv.polls);
|
||||
ok('...but not forever', srv.polls <= 1200, srv.polls);
|
||||
const lastPoll = sb.requests.map(r => r.url).lastIndexOf('/api/v3/plugins/operation/op-1');
|
||||
ok('then the installed list is reloaded, to show what actually happened',
|
||||
sb.requests.slice(lastPoll + 1).some(r => r.url === '/api/v3/plugins/installed'),
|
||||
sb.requests.slice(lastPoll + 1).map(r => r.url));
|
||||
const last = sb.toasts[sb.toasts.length - 1];
|
||||
ok('it says the install may still be running, as a warning, not a failure',
|
||||
last && last.type === 'warning' && !/fail|timed out/i.test(last.message), sb.toasts);
|
||||
ok('nothing is enabled on a guess', !sb.requests.some(r => r.url === '/api/v3/plugins/toggle'));
|
||||
}
|
||||
|
||||
console.log(`\n${pass} passed, ${fail} failed`);
|
||||
process.exit(fail ? 1 : 0);
|
||||
})().catch(e => { console.error(e); process.exit(1); });
|
||||
@@ -0,0 +1,105 @@
|
||||
// The Plugin Store's category filter offers the categories its plugins have.
|
||||
//
|
||||
// The template listed seven fixed categories. The registry uses about
|
||||
// twenty (productivity, utility, transit, finance, ...), so roughly a third
|
||||
// of the store could not be filtered to at all, and "Financial" missed the
|
||||
// plugin filed under "finance". The options are now built from the store's
|
||||
// plugins, as the Starlark section builds its own; the template ships only
|
||||
// "All Categories".
|
||||
//
|
||||
// Runs the whole of plugins_manager.js in the sandbox.
|
||||
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
const { create, templateAttributes } = require('../plugins_manager_sandbox');
|
||||
|
||||
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).slice(0, 400) : '')));
|
||||
|
||||
const STORE = [
|
||||
{ id: 'nfl', name: 'NFL', category: 'sports' },
|
||||
{ id: 'nba', name: 'NBA', category: 'Sports' },
|
||||
{ id: 'todo', name: 'Todo', category: 'productivity' },
|
||||
{ id: 'stocks', name: 'Stocks', category: 'finance' },
|
||||
{ id: 'crypto', name: 'Crypto', category: 'financial' },
|
||||
{ id: 'bus', name: 'Bus', category: 'transit' },
|
||||
{ id: 'mystery', name: 'Mystery' },
|
||||
];
|
||||
|
||||
function route(method, url) {
|
||||
if (url.startsWith('/api/v3/plugins/store/list')) return { json: { status: 'success', data: { plugins: STORE } } };
|
||||
if (url.startsWith('/api/v3/plugins/installed')) return { json: { status: 'success', data: { plugins: [] } } };
|
||||
if (url.startsWith('/api/v3/plugins/store/github-status')) {
|
||||
return { json: { status: 'success', data: { token_status: 'valid', authenticated: true, rate_limit: 5000 } } };
|
||||
}
|
||||
if (url.startsWith('/api/v3/plugins/saved-repositories')) {
|
||||
return { json: { status: 'success', data: { repositories: [] } } };
|
||||
}
|
||||
if (url.startsWith('/api/v3/display/on-demand/status')) {
|
||||
return { json: { status: 'success', data: { state: {}, service: {} } } };
|
||||
}
|
||||
return { json: { status: 'success' } };
|
||||
}
|
||||
|
||||
const options = sel => sel.children.map(o => o.value);
|
||||
const cardIds = sb => [...sb.el('plugin-store-grid').innerHTML.matchAll(/<h4[^>]*>([^<]*)<\/h4>/g)].map(m => m[1]);
|
||||
|
||||
(async () => {
|
||||
console.log('\nthe template');
|
||||
{
|
||||
const html = fs.readFileSync(path.resolve(__dirname,
|
||||
'../../../web_interface/templates/v3/partials/plugins.html'), 'utf8');
|
||||
const start = html.indexOf('<select id="plugin-category"');
|
||||
const block = html.slice(start, html.indexOf('</select>', start));
|
||||
const shipped = [...block.matchAll(/<option value="([^"]*)"/g)].map(m => m[1]);
|
||||
ok('ships only "All Categories"', JSON.stringify(shipped) === JSON.stringify(['']), shipped);
|
||||
}
|
||||
|
||||
const sb = create({ route });
|
||||
const attrs = templateAttributes('plugin-category').attrs;
|
||||
const select = sb.el('plugin-category', 'select', attrs);
|
||||
sb.el('plugin-store-grid');
|
||||
sb.el('installed-plugins-grid');
|
||||
sb.window.initPluginsPage();
|
||||
await sb.until(() => sb.requests.some(r => r.url.startsWith('/api/v3/plugins/store/list')), 'the store list');
|
||||
await sb.settle();
|
||||
|
||||
console.log('\noptions come from the store\'s plugins');
|
||||
ok('"All Categories" is still the first choice', /<option value="">All Categories<\/option>/.test(select.innerHTML),
|
||||
select.innerHTML);
|
||||
ok('every category a plugin has is offered once, whatever its case',
|
||||
JSON.stringify(options(select)) === JSON.stringify(['finance', 'financial', 'productivity', 'sports', 'transit']),
|
||||
options(select));
|
||||
ok('labels are capitalised',
|
||||
(select.children.find(o => o.value === 'productivity') || {}).textContent === 'Productivity');
|
||||
|
||||
console.log('\nchoosing one filters to it');
|
||||
select.value = 'productivity';
|
||||
select.dispatch('change');
|
||||
ok('productivity shows its plugin', JSON.stringify(cardIds(sb)) === JSON.stringify(['Todo']), cardIds(sb));
|
||||
select.value = 'finance';
|
||||
select.dispatch('change');
|
||||
ok('finance is not lost to "financial"', JSON.stringify(cardIds(sb)) === JSON.stringify(['Stocks']), cardIds(sb));
|
||||
select.value = 'sports';
|
||||
select.dispatch('change');
|
||||
ok('one option covers both spellings of sports',
|
||||
JSON.stringify(cardIds(sb).sort()) === JSON.stringify(['NBA', 'NFL']), cardIds(sb));
|
||||
|
||||
console.log('\nthe partial is swapped back in (tab switch)');
|
||||
{
|
||||
// A fresh <select> from the template, the store list still cached.
|
||||
const fresh = new sb.FakeElement('plugin-category', 'select', attrs);
|
||||
select.parentNode.replaceChild(fresh, select);
|
||||
sb.window.searchPluginStore(false);
|
||||
await sb.settle();
|
||||
ok('the new select is filled from the cache',
|
||||
JSON.stringify(options(fresh)) === JSON.stringify(['finance', 'financial', 'productivity', 'sports', 'transit']),
|
||||
options(fresh));
|
||||
ok('keeping the chosen category', fresh.value === 'sports', fresh.value);
|
||||
}
|
||||
|
||||
console.log(`\n${pass} passed, ${fail} failed`);
|
||||
process.exit(fail ? 1 : 0);
|
||||
})().catch(e => { console.error(e); process.exit(1); });
|
||||
@@ -0,0 +1,138 @@
|
||||
// The store's Install button: which plugin it enables afterwards, and when.
|
||||
//
|
||||
// 1. Weather, Music, Stocks and Leaderboard are registry entries (`weather`)
|
||||
// whose manifests declare another id (`ledmatrix-weather`). The plugin
|
||||
// list, its config section and /plugins/toggle know them by that id, but
|
||||
// the button enabled the registry id: /plugins/toggle answered 404
|
||||
// "Plugin not found" and the plugin stayed disabled behind "installed,
|
||||
// but enabling it failed". It now enables the id the install answer
|
||||
// names (`plugin_id`), or, from an answer without one, the installed
|
||||
// entry the store entry matches (its id, plugin_path name or aliases).
|
||||
//
|
||||
// 2. Reinstall (the same button on an installed plugin) enabled it too, so
|
||||
// reinstalling a plugin the user had switched off switched it back on.
|
||||
// Only a fresh install enables.
|
||||
//
|
||||
// Runs the whole of plugins_manager.js in the sandbox against a fake API.
|
||||
|
||||
const { create } = require('../plugins_manager_sandbox');
|
||||
|
||||
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).slice(0, 400) : '')));
|
||||
|
||||
const STORE = [
|
||||
{ id: 'weather', name: 'Weather', category: 'weather', plugin_path: 'plugins/ledmatrix-weather',
|
||||
aliases: ['ledmatrix-weather'] },
|
||||
{ id: 'clock-simple', name: 'Clock', category: 'time', plugin_path: 'plugins/clock-simple', aliases: [] },
|
||||
];
|
||||
|
||||
// A server with one install in flight. `queue` false answers the install
|
||||
// directly; `names` false leaves plugin_id out of the answer (an older
|
||||
// server); `installsAs` is the id the installed manifest declares.
|
||||
function server({ installed = [], queue = true, names = true, installsAs }) {
|
||||
const state = { installed: installed.map(p => ({ ...p })), polls: 0 };
|
||||
const done = (id) => {
|
||||
if (!state.installed.some(p => p.id === installsAs)) {
|
||||
state.installed.push({ id: installsAs, name: id, enabled: false });
|
||||
}
|
||||
const result = { success: true, message: `Plugin ${id} installed successfully`, restart_required: false };
|
||||
if (names) result.plugin_id = installsAs;
|
||||
return result;
|
||||
};
|
||||
state.route = (method, url, body) => {
|
||||
if (url.startsWith('/api/v3/plugins/store/list')) {
|
||||
return { json: { status: 'success', data: { plugins: STORE } } };
|
||||
}
|
||||
if (url.startsWith('/api/v3/plugins/installed')) {
|
||||
return { json: { status: 'success', data: { plugins: state.installed.map(p => ({ ...p })) } } };
|
||||
}
|
||||
if (method === 'POST' && url === '/api/v3/plugins/install') {
|
||||
if (queue) return { json: { status: 'success', message: 'queued', data: { operation_id: 'op-1' } } };
|
||||
return { json: { status: 'success', message: 'Plugin installed successfully', ...done(body.plugin_id) } };
|
||||
}
|
||||
if (url === '/api/v3/plugins/operation/op-1') {
|
||||
state.polls++;
|
||||
if (state.polls < 3) return { json: { status: 'success', data: { status: 'running' } } };
|
||||
return { json: { status: 'success', data: { status: 'completed', result: done('weather') } } };
|
||||
}
|
||||
if (method === 'POST' && url === '/api/v3/plugins/toggle') {
|
||||
const plugin = state.installed.find(p => p.id === body.plugin_id);
|
||||
if (!plugin) return { status: 404, json: { status: 'error', message: 'Plugin not found' } };
|
||||
plugin.enabled = body.enabled;
|
||||
return { json: { status: 'success', message: `Plugin ${body.plugin_id} enabled successfully` } };
|
||||
}
|
||||
return { json: { status: 'success' } };
|
||||
};
|
||||
return state;
|
||||
}
|
||||
|
||||
async function install(pluginId, opts) {
|
||||
const srv = server(opts);
|
||||
const sb = create({ route: srv.route });
|
||||
sb.window.searchPluginStore();
|
||||
await sb.until(() => sb.requests.some(r => r.url.startsWith('/api/v3/plugins/store/list')), 'store list');
|
||||
await sb.window.pluginManager.loadInstalledPlugins(true);
|
||||
await sb.settle();
|
||||
sb.requests.length = 0;
|
||||
sb.toasts.length = 0;
|
||||
sb.window.installPlugin(pluginId);
|
||||
await sb.until(() => sb.toasts.some(t => /installed and enabled|enabling it failed|reinstalled/.test(t.message)),
|
||||
'the install to finish');
|
||||
await sb.settle();
|
||||
const toggles = sb.requests.filter(r => r.url === '/api/v3/plugins/toggle').map(r => r.body);
|
||||
return { sb, srv, toggles };
|
||||
}
|
||||
|
||||
(async () => {
|
||||
console.log('\n1. a fresh install enables the id the plugin was installed as');
|
||||
{
|
||||
const { srv, toggles, sb } = await install('weather', { installsAs: 'ledmatrix-weather' });
|
||||
ok('enables ledmatrix-weather, not the registry id',
|
||||
JSON.stringify(toggles) === JSON.stringify([{ plugin_id: 'ledmatrix-weather', enabled: true }]), toggles);
|
||||
ok('...which the server enabled', srv.installed.find(p => p.id === 'ledmatrix-weather').enabled === true, srv.installed);
|
||||
ok('says so', sb.toasts.some(t => t.type === 'success' && /installed and enabled/.test(t.message)), sb.toasts);
|
||||
ok('no "Plugin not found"', !sb.toasts.some(t => /not found|failed/.test(t.message)), sb.toasts);
|
||||
const lastList = sb.requests.map(r => r.url).lastIndexOf('/api/v3/plugins/installed');
|
||||
const toggleAt = sb.requests.findIndex(r => r.url === '/api/v3/plugins/toggle');
|
||||
ok('the installed list is reloaded before enabling, so the new card is there to update',
|
||||
lastList >= 0 && lastList < toggleAt, sb.requests.map(r => r.method + ' ' + r.url));
|
||||
}
|
||||
{
|
||||
const { toggles } = await install('weather', { installsAs: 'ledmatrix-weather', names: false });
|
||||
ok('an answer without plugin_id: the installed entry the store entry matches (its alias)',
|
||||
JSON.stringify(toggles) === JSON.stringify([{ plugin_id: 'ledmatrix-weather', enabled: true }]), toggles);
|
||||
}
|
||||
{
|
||||
const { toggles } = await install('weather', { installsAs: 'ledmatrix-weather', queue: false });
|
||||
ok('without the operation queue, from the direct answer',
|
||||
JSON.stringify(toggles) === JSON.stringify([{ plugin_id: 'ledmatrix-weather', enabled: true }]), toggles);
|
||||
}
|
||||
{
|
||||
const { toggles } = await install('clock-simple', { installsAs: 'clock-simple', names: false });
|
||||
ok('a plugin installed under its registry id is enabled by that id',
|
||||
JSON.stringify(toggles) === JSON.stringify([{ plugin_id: 'clock-simple', enabled: true }]), toggles);
|
||||
}
|
||||
|
||||
console.log('\n2. a reinstall leaves the plugin as the user had it');
|
||||
{
|
||||
const { srv, toggles, sb } = await install('weather', {
|
||||
installsAs: 'ledmatrix-weather', installed: [{ id: 'ledmatrix-weather', name: 'Weather', enabled: false }],
|
||||
});
|
||||
ok('sends no toggle', toggles.length === 0, toggles);
|
||||
ok('the plugin stays disabled', srv.installed.find(p => p.id === 'ledmatrix-weather').enabled === false);
|
||||
ok('says it was reinstalled', sb.toasts.some(t => t.type === 'success' && /reinstalled/.test(t.message)), sb.toasts);
|
||||
ok('and reloads the list',
|
||||
sb.requests.some(r => r.url === '/api/v3/plugins/installed'), sb.requests.map(r => r.url));
|
||||
}
|
||||
{
|
||||
const { toggles } = await install('weather', {
|
||||
installsAs: 'ledmatrix-weather', installed: [{ id: 'ledmatrix-weather', name: 'Weather', enabled: true }],
|
||||
});
|
||||
ok('an enabled plugin is not toggled either', toggles.length === 0, toggles);
|
||||
}
|
||||
|
||||
console.log(`\n${pass} passed, ${fail} failed`);
|
||||
process.exit(fail ? 1 : 0);
|
||||
})().catch(e => { console.error(e); process.exit(1); });
|
||||
@@ -52,7 +52,8 @@ global.installedPlugins = [];
|
||||
// eslint-disable-next-line no-eval
|
||||
eval([
|
||||
'function escapeHtml(text) {', 'function escapeAttribute(text) {', 'function jsStringAttr(value) {',
|
||||
'function isStorePluginInstalled(pluginIdOrPlugin) {', 'function renderPluginStore(plugins) {',
|
||||
'function isStorePluginInstalled(pluginIdOrPlugin) {',
|
||||
'function findInstalledStorePlugin(pluginIdOrPlugin) {', 'function renderPluginStore(plugins) {',
|
||||
].map(extract).join('\n') + '\nglobal.renderPluginStore = renderPluginStore;'
|
||||
+ '\nglobal.isStorePluginInstalled = isStorePluginInstalled;');
|
||||
|
||||
|
||||
@@ -52,7 +52,7 @@ function fakeApi(behaviour = {}) {
|
||||
};
|
||||
}
|
||||
|
||||
function setup(api, { stateList, windowList } = {}) {
|
||||
function setup(api, { stateList, windowList, pluginManager } = {}) {
|
||||
global.window = {
|
||||
PluginAPI: api,
|
||||
installedPlugins: windowList,
|
||||
@@ -60,6 +60,7 @@ function setup(api, { stateList, windowList } = {}) {
|
||||
installedPlugins: stateList,
|
||||
loadInstalledPlugins: async () => stateList,
|
||||
},
|
||||
pluginManager,
|
||||
};
|
||||
}
|
||||
|
||||
@@ -92,12 +93,68 @@ const noSleep = { sleep: async () => {} };
|
||||
ok('progress total counts only what is sent',
|
||||
progress.length === EXPECTED.length && progress.every(([, n]) => n === EXPECTED.length), progress);
|
||||
}
|
||||
{
|
||||
// A page without the plugin manager has no window.installedPlugins.
|
||||
const api = fakeApi();
|
||||
setup(api, { stateList: INSTALLED });
|
||||
await Manager.updateAll(null, noSleep);
|
||||
ok('the PluginStateManager list (no live list) is filtered the same way',
|
||||
JSON.stringify(api.calls) === JSON.stringify(EXPECTED), api.calls);
|
||||
}
|
||||
|
||||
console.log('\na second run sends the live list, not the first run\'s snapshot');
|
||||
{
|
||||
// Run 1 leaves PluginStateManager holding a, b, c. Then c is uninstalled
|
||||
// and d installed: plugins_manager.js publishes that only as
|
||||
// window.installedPlugins. Run 2 used to send a, b, c -- c failed as
|
||||
// "plugin not found" and d, which had an update waiting, was skipped.
|
||||
const api = fakeApi({
|
||||
c: () => { throw { error_code: 'PLUGIN_UPDATE_FAILED', message: 'Plugin update failed: plugin not found' }; },
|
||||
});
|
||||
const stale = [{ id: 'a' }, { id: 'b' }, { id: 'c' }];
|
||||
setup(api, { stateList: stale, windowList: [{ id: 'a' }, { id: 'b' }, { id: 'd' }] });
|
||||
const results = await Manager.updateAll(null, noSleep);
|
||||
ok('sends exactly what is installed now',
|
||||
JSON.stringify(api.calls) === JSON.stringify(['a', 'b', 'd']), api.calls);
|
||||
ok('...so nothing fails over an uninstalled plugin', results.every(r => r.success), results);
|
||||
}
|
||||
{
|
||||
const api = fakeApi();
|
||||
setup(api, { stateList: INSTALLED, windowList: [] });
|
||||
const results = await Manager.updateAll(null, noSleep);
|
||||
ok('an empty live list means nothing is installed: nothing is sent',
|
||||
api.calls.length === 0 && results.length === 0, api.calls);
|
||||
}
|
||||
|
||||
console.log('\nthe end-of-run refresh redraws the installed grid');
|
||||
{
|
||||
// PluginStateManager's refresh replaced window.installedPlugins and
|
||||
// nothing else: the cards kept "Update to vX" and the Updates badge
|
||||
// kept its count. The plugin manager's load renders the grid.
|
||||
const loads = [];
|
||||
let stateLoads = 0;
|
||||
const pluginManager = { loadInstalledPlugins: async (force) => { loads.push(force); } };
|
||||
setup(fakeApi(), { stateList: INSTALLED, windowList: INSTALLED, pluginManager });
|
||||
window.PluginStateManager.loadInstalledPlugins = async () => { stateLoads++; };
|
||||
await Manager.updateAll(null, noSleep);
|
||||
ok('the PluginStateManager list is filtered the same way',
|
||||
JSON.stringify(api.calls) === JSON.stringify(EXPECTED), api.calls);
|
||||
ok('reloads through the plugin manager once, forced past its caches',
|
||||
JSON.stringify(loads) === JSON.stringify([true]), loads);
|
||||
ok('...instead of PluginStateManager', stateLoads === 0, stateLoads);
|
||||
}
|
||||
{
|
||||
const pluginManager = { loadInstalledPlugins: async () => { throw new Error('offline'); } };
|
||||
const answer = { status: 'success', data: { update_status: 'updated' }, restart_required: true };
|
||||
setup(fakeApi({ 'ledmatrix-flights': () => answer }), { windowList: INSTALLED, pluginManager });
|
||||
const warn = console.warn;
|
||||
console.warn = () => {};
|
||||
let results;
|
||||
try {
|
||||
results = await Manager.updateAll(null, noSleep);
|
||||
} finally {
|
||||
console.warn = warn;
|
||||
}
|
||||
ok('a failed plugin-manager reload still returns the results with their restart flag',
|
||||
Array.isArray(results) && Manager.restartRequest(results) === answer);
|
||||
}
|
||||
{
|
||||
const api = fakeApi();
|
||||
|
||||
Reference in New Issue
Block a user