feat: Uninstall extensions

fix: Make sure requiring ext module for unload also uses webpack bypass

fix: Flipped incorrect unload and load in SET_EXTENSION_ENABLED

fix: Only show menu seperator when there are extension context buttons present

Author: colin969

extensions/core-manager/src/commands.ts

@@ -1 +1,2 @@
 export const DownloadExtCommand = 'core-manager.download-extension';
+export const UninstallExtCommand = 'core-manager.uninstall-extension';

extensions/core-manager/src/components/ExtensionSubsection.tsx

@@ -3,7 +3,7 @@ import { useAppSelector } from 'flashpoint-launcher-renderer-ext/hooks';
 import { getExtensionFileURL, runCommand, setExtensionEnabled } from 'flashpoint-launcher-renderer-ext/utils';
 import { useEffect, useState } from 'react';
 import { List, RowComponentProps, useDynamicRowHeight } from 'react-window';
-import { DownloadExtCommand } from '../commands';
+import { DownloadExtCommand, UninstallExtCommand } from '../commands';
 import { loadExtIndexUrl, ManagerExtensionInfo } from '../extensionLoader';
 
 export type ExtensionRowProps = {
@@ -14,6 +14,7 @@ export type ExtensionRowProps = {
 export function ExtensionSubsection() {
   const [availableExtensions, setAvailableExtensions] = useState<ManagerExtensionInfo[]>([]);
   const installedExtensions = useAppSelector(state => state.main.extensions);
+  console.log(installedExtensions);
   const disabledExtensions = useAppSelector(state => state.preferences.disabledExtensions);
 
   useEffect(() => {
@@ -66,7 +67,7 @@ export function ExtensionSubsection() {
 }
 
 export function ExtensionRow({ items, disabledExtensions, index, style }: RowComponentProps<ExtensionRowProps>) {
-  const { id, title, description, installed, newestVersion, iconUrl, getDownloadUrl, } = items[index];
+  const { id, title, description, installed, newestVersion, iconUrl, getDownloadUrl } = items[index];
   const [busy, setBusy] = useState(false);
   const canInstall = getDownloadUrl !== undefined;
   const enabled = !disabledExtensions.includes(id);
@@ -97,7 +98,16 @@ export function ExtensionRow({ items, disabledExtensions, index, style }: RowCom
         { !busy ? (
           <>
             { installed && (
-              <SimpleButton value={'Remove'}/>
+              <SimpleButton value={'Remove'} onClick={() => {
+                setBusy(true);
+                runCommand(UninstallExtCommand, id)
+                .catch((error) => {
+                  const errorString =  `Failed to uninstall extension: ${error}`;
+                  alert(errorString);
+                  log.error('Manager', errorString);
+                })
+                .finally(() => setBusy(false));
+              }}/>
             )}
             { canInstall && (
               <SimpleButton value={'Install'} onClick={() => {

extensions/core-manager/src/extension.ts

@@ -1,9 +1,9 @@
 import axios from 'axios';
-import { commands, Disposable, ExtensionContext, installExtension, log, registerDisposable } from 'flashpoint-launcher';
+import { commands, Disposable, ExtensionContext, installExtension, log, registerDisposable, uninstallExtension } from 'flashpoint-launcher';
 import fs from 'node:fs';
 import os from 'node:os';
 import path from 'node:path';
-import { DownloadExtCommand } from './commands';
+import { DownloadExtCommand, UninstallExtCommand } from './commands';
 
 export async function activate(context: ExtensionContext): Promise<void> {
   const register = (disp: Disposable) => {
@@ -32,4 +32,12 @@ export async function activate(context: ExtensionContext): Promise<void> {
       await installExtension(tempFilepath);
     })
   );
+
+  register(
+    commands.registerCommand(UninstallExtCommand, async (extId: string) => {
+      log.info('Uninstalling Extension ' + extId);
+
+      await uninstallExtension(extId);
+    })
+  );
 }

src/back/extensions/ApiImplementation.ts

@@ -5,7 +5,7 @@ import { loadCurationIndexImage } from '@back/curate/parse';
 import { duplicateCuration, genCurationWarnings, makeCurationFromGame, refreshCurationContent } from '@back/curate/util';
 import { saveCuration } from '@back/curate/write';
 import { downloadGameData } from '@back/download';
-import { installExtension as installExtensionUtil, unzipFile as unzipFileUtil } from '@back/extensions/util';
+import { installExtension as installExtensionUtil, uninstallExtension as uninstallExtensionUtil, unzipFile as unzipFileUtil } from '@back/extensions/util';
 import { genContentTree } from '@back/rust';
 import { BackState, StatusState } from '@back/types';
 import { awaitDialog } from '@back/util/dialog';
@@ -96,6 +96,10 @@ export function createApiFactory(extId: string, extManifest: IExtensionManifest,
     return installExtensionUtil(state, filePath);
   };
 
+  const uninstallExtension = (extId: string) => {
+    return uninstallExtensionUtil(state, extId);
+  };
+
   const registerDataProvider = (provider: flashpoint.GameDataProvider): void => {
     console.log(`Registered ${provider.id}`);
     state.registry.dataSources.set(provider.id, provider);
@@ -686,6 +690,7 @@ export function createApiFactory(extId: string, extManifest: IExtensionManifest,
     getExtensionFileURL: getExtensionFileURL,
     unzipFile,
     installExtension,
+    uninstallExtension,
     getExtConfigValue: getExtConfigValue,
     setExtConfigValue: setExtConfigValue,
     onExtConfigChange: state.apiEmitters.ext.onExtConfigChange.extEvent(extManifest.displayName || extManifest.name),

src/back/extensions/ExtensionService.ts

@@ -162,6 +162,7 @@ export class ExtensionService {
         subscriptions: extData.subscriptions
       };
       if (entryPath) {
+        console.log('loading ' + entryPath);
         const extModule: ExtensionModule = this.require(entryPath);
         if (!extModule.activate) {
           throw new Error('No "activate" export found in extension module!');
@@ -203,6 +204,18 @@ export class ExtensionService {
     }
   }
 
+  public async removeExtension(id: string): Promise<void> {
+    await this.unloadExtension(id);
+    if (this.installedExtensionsReady.isOpen()) {
+      const extIdx = this._extensions.findIndex(e => e.id == id);
+      if (extIdx > -1) {
+        this._extensions.splice(extIdx);
+      } else {
+        log.error('Extensions', `Attempted removal of extension ${id}, but no extension with this ID found`);
+      }
+    }
+  }
+
   private async _unloadExtension(ext: IExtension): Promise<void> {
     const extData = this._extensionData[ext.id];
 
@@ -214,7 +227,7 @@ export class ExtensionService {
     const entryPath = getExtensionEntry(ext);
     if (entryPath) {
       try {
-        const extModule: ExtensionModule = await import(entryPath);
+        const extModule: ExtensionModule = this.require(entryPath);
         if (extModule.deactivate) {
           try {
             await extModule.deactivate.apply(global);

src/back/extensions/util.ts

@@ -5,6 +5,7 @@ import { IExtension } from '@shared/extensions/interfaces';
 import { fixSlashes } from '@shared/Util';
 import { parseVariableString } from '@shared/utils/VariableString';
 import { ZipExtractOptions } from 'flashpoint-launcher';
+import * as fs from 'fs-extra';
 import { extractFull } from 'node-7z';
 import * as path from 'node:path';
 
@@ -31,6 +32,16 @@ export async function parseAppVar(extId: string, appPath: string, launchCommand:
   });
 }
 
+export async function uninstallExtension(state: BackState, extId: string) {
+  console.log('finding ' + extId);
+  const ext = await state.extensionsService.getExtension(extId);
+  if (ext) {
+    await state.extensionsService.removeExtension(extId);
+    await fs.remove(ext.extensionPath);
+  }
+  state.socketServer.broadcast(BackOut.REMOVED_EXTENSION, extId);
+}
+
 export async function installExtension(state: BackState, filePath: string) {
   const extensionsPath = path.join(state.config.flashpointPath, state.preferences.extensionsPath);
 

src/back/responses.ts

@@ -1445,11 +1445,11 @@ export function registerRequestCallbacks(state: BackState, init: () => Promise<v
       if (newState) {
         // Enable ext
         state.preferences.disabledExtensions = state.preferences.disabledExtensions.filter(c => c !== extId);
-        await state.extensionsService.unloadExtension(extId);
+        await state.extensionsService.loadExtension(extId);
       } else {
         // Disable ext
         state.preferences.disabledExtensions.push(extId);
-        await state.extensionsService.loadExtension(extId);
+        await state.extensionsService.unloadExtension(extId);
       }
       state.prefsQueue.push(() => {
         PreferencesFile.saveFile(path.join(state.config.flashpointPath, PREFERENCES_FILENAME), state.preferences, state);

src/renderer/components/app.tsx

@@ -9,7 +9,7 @@ import { setDownloaderState, updateDownloaderStatus, updateDownloaderTask, updat
 import { setFpfssUser } from '@renderer/store/fpfss/slice';
 import { pushHistory } from '@renderer/store/history/slice';
 import { addLogEntries, setEntries } from '@renderer/store/logs/slice';
-import { addCustomRoute, addGameSidebarComponent, addLoaded, addNewExtension, cancelDialog, changeService, createDialog, openDynamicPage, removeCustomRoute, removeGameSidebarComponent, removeService, setExtOrderablesFromCallback, setMainState, setUnrecoverableError, setUpdateInfo, updateDialog, updateDialogField, updateMetadataSource } from '@renderer/store/main/slice';
+import { addCustomRoute, addGameSidebarComponent, addLoaded, addNewExtension, cancelDialog, changeService, createDialog, openDynamicPage, removeCustomRoute, removeExtension, removeGameSidebarComponent, removeService, setExtOrderablesFromCallback, setMainState, setUnrecoverableError, setUpdateInfo, updateDialog, updateDialogField, updateMetadataSource } from '@renderer/store/main/slice';
 import { setExtState, setPreferences, updatePreferences } from '@renderer/store/preferences/slice';
 import { addData, createViews, GENERAL_VIEW_ID, resetDropdownData, updateGame } from '@renderer/store/search/slice';
 import store, { AppDispatch, RootState } from '@renderer/store/store';
@@ -958,6 +958,10 @@ function registerWebsocketListeners(dispatch: AppDispatch) {
     }));
   });
 
+  window.Shared.back.register(BackOut.REMOVED_EXTENSION, async (event, extId) => {
+    dispatch(removeExtension(extId));
+  });
+
   window.Shared.back.register(BackOut.ADDED_EXTENSION, async (event, ext) => {
     dispatch(addNewExtension(ext));
   });

src/renderer/context/MenuContext.tsx

@@ -43,7 +43,7 @@ export function MenuProvider({ children }: MenuContextProps) {
   const htdocsFolderPath = useAppSelector(state => state.preferences.htdocsFolderPath);
   const dataPacksFolderPath = useAppSelector(state => state.preferences.dataPacksFolderPath);
   const imageFolderPath = useAppSelector(state => state.preferences.imageFolderPath);
-  const extContextButtons = useAppSelector(state => state.main.contextButtons);
+  const extContextButtonContribs = useAppSelector(state => state.main.contextButtons);
   const scale = useAppSelector(state => state.preferences.scaleValues.menuItem);
   const menuItemHeight = Math.floor(calcScale(menuDefHeight, scale));
   const navigate = useNavigate();
@@ -211,16 +211,17 @@ export function MenuProvider({ children }: MenuContextProps) {
               });
             });
           }
-        }, ...fpfssButtons, { type: 'separator' }
+        }, ...fpfssButtons
       ];
       contextButtons = contextButtons.concat(editingButtons);
     }
 
     // Add extension contexts
-    for (const contribution of extContextButtons) {
+    const extContextButtons: MenuItemType[] = [];
+    for (const contribution of extContextButtonContribs) {
       for (const contextButton of contribution.value) {
         if (contextButton.context === 'game') {
-          contextButtons.push({
+          extContextButtons.push({
             type: 'button',
             label: contextButton.name,
             onClick: () => {
@@ -237,6 +238,10 @@ export function MenuProvider({ children }: MenuContextProps) {
       }
     }
 
+    if (extContextButtons.length > 0) {
+      contextButtons.push({ type: 'separator' });
+      return contextButtons.concat(extContextButtons);
+    }
     return contextButtons;
   };
 

src/renderer/store/main/middleware.ts

@@ -3,7 +3,7 @@ import { startAppListening } from '@renderer/store/listenerMiddleware';
 import { BackIn } from '@shared/back/types';
 import { selectGame, selectPlaylist } from '../search/slice';
 import store from '../store';
-import { removePlaylistGame, RemovePlaylistGameAction, resolveDialog, ResolveDialogActionData } from './slice';
+import { addNewExtension, removeExtension, removePlaylistGame, RemovePlaylistGameAction, resolveDialog, ResolveDialogActionData, setMainState } from './slice';
 
 export function addMainMiddleware() {
   // Send dialog state to event handlers after reducer has finished
@@ -19,6 +19,17 @@ export function addMainMiddleware() {
     }
   });
 
+  startAppListening({
+    matcher: isAnyOf(removeExtension, addNewExtension),
+    effect: async () => {
+      // Refetch extension contributions
+      window.Shared.back.request(BackIn.GET_RENDERER_EXTENSION_INFO)
+      .then((data) => {
+        store.dispatch(setMainState(data));
+      });
+    }
+  });
+
   startAppListening({
     matcher: isAnyOf(removePlaylistGame),
     effect: async (action: PayloadAction<RemovePlaylistGameAction>, listenerApi) => {