Command processing (3/n): Uninstall plugin

Summary:
*Stack summary*: this stack refactors plugin management actions to perform them in a dispatcher rather than in the root reducer (store.tsx) as all of these actions has side effects. To do that, we store requested plugin management actions (install/update/uninstall, star/unstar) in a queue which is then handled by pluginManager dispatcher. This dispatcher then dispatches all required state updates.

*Diff summary*: refactored "uninstall plugin" operation to perform it in pluginManager dispatcher

Reviewed By: mweststrate

Differential Revision: D26166198

fbshipit-source-id: d74a1d690102d9036c6d3d8612d2428f5ecef4e6
This commit is contained in:
Anton Nikolaev
2021-02-16 10:46:11 -08:00
committed by Facebook GitHub Bot
parent 24aed8fd45
commit 01f02b2cab
19 changed files with 336 additions and 170 deletions

View File

@@ -7,27 +7,33 @@
* @format
*/
import {Store} from '../reducers/index';
import {Logger} from '../fb-interfaces/Logger';
import type {Store} from '../reducers/index';
import type {Logger} from '../fb-interfaces/Logger';
import {clearPluginState} from '../reducers/pluginStates';
import {
LoadPluginActionPayload,
pluginCommandsProcessed,
registerInstalledPlugins,
UninstallPluginActionPayload,
} from '../reducers/pluginManager';
import {
getInstalledPlugins,
cleanupOldInstalledPluginVersions,
removePlugins,
ActivatablePluginDetails,
} from 'flipper-plugin-lib';
import {sideEffect} from '../utils/sideEffect';
import {requirePlugin} from './plugins';
import {registerPluginUpdate} from '../reducers/connections';
import {showErrorNotification} from '../utils/notifications';
import type Client from '../Client';
import {unloadModule} from '../utils/electronModuleCache';
import {pluginUninstalled, registerInstalledPlugins} from '../reducers/plugins';
import {defaultEnabledBackgroundPlugins} from '../utils/pluginUtils';
const maxInstalledPluginVersionsToKeep = 2;
function refreshInstalledPlugins(store: Store) {
removePlugins(store.getState().pluginManager.uninstalledPlugins.values())
removePlugins(store.getState().plugins.uninstalledPlugins.values())
.then(() =>
cleanupOldInstalledPluginVersions(maxInstalledPluginVersionsToKeep),
)
@@ -65,6 +71,9 @@ export default (
case 'LOAD_PLUGIN':
loadPlugin(store, command.payload);
break;
case 'UNINSTALL_PLUGIN':
uninstallPlugin(store, command.payload);
break;
default:
console.error('Unexpected plugin command', command);
break;
@@ -95,8 +104,56 @@ function loadPlugin(store: Store, payload: LoadPluginActionPayload) {
);
if (payload.notifyIfFailed) {
showErrorNotification(
`Failed to load plugin "${payload.plugin.title}" v${payload.plugin.version}`,
`Failed to activate plugin "${payload.plugin.title}" v${payload.plugin.version}`,
);
}
}
}
function uninstallPlugin(store: Store, {plugin}: UninstallPluginActionPayload) {
try {
const state = store.getState();
const clients = state.connections.clients;
clients.forEach((client) => {
stopPlugin(client, plugin.id);
});
store.dispatch(clearPluginState({pluginId: plugin.id}));
if (!plugin.details.isBundled) {
unloadPluginModule(plugin.details);
}
store.dispatch(pluginUninstalled(plugin.details));
} catch (err) {
console.error(
`Failed to uninstall plugin ${plugin.title} v${plugin.version}`,
err,
);
showErrorNotification(
`Failed to uninstall plugin "${plugin.title}" v${plugin.version}`,
);
}
}
function stopPlugin(
client: Client,
pluginId: string,
forceInitBackgroundPlugin: boolean = false,
): boolean {
if (
(forceInitBackgroundPlugin ||
!defaultEnabledBackgroundPlugins.includes(pluginId)) &&
client?.isBackgroundPlugin(pluginId)
) {
client.deinitPlugin(pluginId);
}
// stop sandy plugins
client.stopPluginIfNeeded(pluginId);
return true;
}
function unloadPluginModule(plugin: ActivatablePluginDetails) {
if (plugin.isBundled) {
// We cannot unload bundled plugin.
return;
}
unloadModule(plugin.entry);
}