fix: Update ext contribs when state changes

refactor:  Remove outdated devScripts contribs

Author: colin969

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

@@ -61,7 +61,7 @@ export function ExtensionSubsection() {
           <ExtensionRow
             ext={ext}
             index={index}
-            disabled={!disabledExtensions.includes(ext.id)}/>
+            disabled={disabledExtensions.includes(ext.id)}/>
         );
       }) : <div>Loading...</div>}
     </div>

src/back/extensions/ApiImplementation.ts

@@ -468,7 +468,7 @@ export function createApiFactory(extId: string, extManifest: IExtensionManifest,
       return [...state.loadedCurations];
     },
     async getCurationTemplates(): Promise<CurationTemplate[]> {
-      const contribs = await state.extensionsService.getContributions('curationTemplates');
+      const contribs = await state.extensionsService.getEnabledContributions('curationTemplates', state.preferences.disabledExtensions);
       return contribs.reduce<CurationTemplate[]>((prev, cur) => prev.concat(cur.value), []);
     },
     getCuration: (folder: string) => {

src/back/extensions/ExtensionService.ts

@@ -97,6 +97,20 @@ export class ExtensionService {
     });
   }
 
+  /**
+   * Returns a list of all extension contributions of a particular type filtered for enabled extensions
+   *
+   * @param key Type of contribution to get
+   * @param disabledExts Array of disabled extension IDs
+   * @returns All of this contribution type from all enabled and loaded extensions
+   */
+  getEnabledContributions<T extends keyof Contributions>(key: T, disabled: string[]): Promise<ExtensionContribution<T>[]> {
+    return this.getContributions(key)
+    .then((contribs) => {
+      return contribs.filter(c => !disabled.includes(c.extId));
+    });
+  }
+
   /** Build a search tree mapping extensions and their paths */
   public async getExtensionPathIndex(): Promise<TernarySearchTree<string, IExtension>> {
     return this.installedExtensionsReady.wait().then(() => {

src/back/extensions/ExtensionsScanner.ts

@@ -1,11 +1,11 @@
 import { EditCurationMeta } from '@shared/curate/OLD_types';
+import { ExtensionType, IExtension } from '@shared/extensions/interfaces';
 import { readJsonFile } from '@shared/Util';
 import * as Coerce from '@shared/utils/Coerce';
 import { IObjectParserProp, ObjectParser } from '@shared/utils/ObjectParser';
+import { AppConfigData, Application, ButtonContext, ContextButton, Contributions, CurationTemplate, ExtConfiguration, ExtConfigurationProp, ExtTheme, IExtensionManifest, ILogoSet, ModuleContribution } from 'flashpoint-launcher';
 import * as fs from 'node:fs';
 import * as path from 'node:path';
-import { ExtensionType, IExtension } from '@shared/extensions/interfaces';
-import { AppConfigData, Application, ButtonContext, ContextButton, Contributions, CurationTemplate, DevScript, ExtConfiguration, ExtConfigurationProp, ExtTheme, IExtensionManifest, ILogoSet, ModuleContribution } from 'flashpoint-launcher';
 
 const { str, num } = Coerce;
 const fsPromises = fs.promises;
@@ -179,7 +179,6 @@ function parseContributions(parser: IObjectParserProp<Contributions>): Contribut
   const contributes: Contributions = {
     logoSets: [],
     themes: [],
-    devScripts: [],
     contextButtons: [],
     applications: [],
     configuration: [],
@@ -189,7 +188,6 @@ function parseContributions(parser: IObjectParserProp<Contributions>): Contribut
   };
   parser.prop('logoSets',          true).array(item => contributes.logoSets.push(parseLogoSet(item)));
   parser.prop('themes',            true).array(item => contributes.themes.push(parseTheme(item)));
-  parser.prop('devScripts',        true).array(item => contributes.devScripts.push(parseDevScript(item)));
   parser.prop('contextButtons',    true).array(item => contributes.contextButtons.push(parseContextButton(item)));
   parser.prop('applications',      true).array(item => contributes.applications.push(parseApplication(item)));
   parser.prop('configuration',     true).array(item => contributes.configuration.push(parseConfiguration(item)));
@@ -222,18 +220,6 @@ function parseTheme(parser: IObjectParserProp<ExtTheme>): ExtTheme {
   return theme;
 }
 
-function parseDevScript(parser: IObjectParserProp<DevScript>): DevScript {
-  const devScript: DevScript = {
-    name: '',
-    description: '',
-    command: ''
-  };
-  parser.prop('name',        v => devScript.name        = str(v));
-  parser.prop('description', v => devScript.description = str(v));
-  parser.prop('command',     v => devScript.command     = str(v));
-  return devScript;
-}
-
 function parseContextButton(parser: IObjectParserProp<ContextButton>): ContextButton {
   const contextButton: ContextButton = {
     context: 'game',

src/back/index.ts

@@ -683,7 +683,7 @@ async function prepForInit(initConfig: BackInitArgs): Promise<void> {
   } catch (error: any) {
     log.error('Launcher', `Error loading default Themes folder\n${error.message}`);
   }
-  const themeContributions = await state.extensionsService.getContributions('themes');
+  const themeContributions = await state.extensionsService.getEnabledContributions('themes', state.preferences.disabledExtensions);
   for (const c of themeContributions) {
     for (const theme of c.value) {
       const ext = await state.extensionsService.getExtension(c.extId);
@@ -1126,7 +1126,7 @@ async function initialize() {
     await state.extensionsService.getExtensions()
     .then(async (exts) => {
       // Set any ext config defaults
-      for (const contrib of (await state.extensionsService.getContributions('configuration'))) {
+      for (const contrib of (await state.extensionsService.getEnabledContributions('configuration', state.preferences.disabledExtensions))) {
         for (const extConfig of contrib.value) {
           for (const key in extConfig.properties) {
             // Value not set, use default
@@ -1185,7 +1185,7 @@ async function initialize() {
       }
 
       // Init Ext Logo Sets
-      await state.extensionsService.getContributions('logoSets')
+      await state.extensionsService.getEnabledContributions('logoSets', state.preferences.disabledExtensions)
       .then(async (logoSetContributions) => {
         for (const c of logoSetContributions) {
           for (const logoSet of c.value) {

src/back/responses.ts

@@ -188,10 +188,9 @@ export function registerRequestCallbacks(state: BackState, init: () => Promise<v
 
   state.socketServer.register(BackIn.GET_RENDERER_EXTENSION_INFO, async () => {
     return {
-      devScripts: await state.extensionsService.getContributions('devScripts'),
-      contextButtons: await state.extensionsService.getContributions('contextButtons'),
-      curationTemplates: await state.extensionsService.getContributions('curationTemplates'),
-      extConfigs: await state.extensionsService.getContributions('configuration'),
+      contextButtons: await state.extensionsService.getEnabledContributions('contextButtons', state.preferences.disabledExtensions),
+      curationTemplates: await state.extensionsService.getEnabledContributions('curationTemplates', state.preferences.disabledExtensions),
+      extConfigs: await state.extensionsService.getEnabledContributions('configuration', state.preferences.disabledExtensions),
       extConfig: state.extConfig,
       extensions: (await state.extensionsService.getExtensions()).map(e => {
         return {
@@ -1439,23 +1438,24 @@ export function registerRequestCallbacks(state: BackState, init: () => Promise<v
     catch (error: any) { log.error('Launcher', error); }
   });
 
-  state.socketServer.register(BackIn.SET_EXTENSION_ENABLED, async (event, extId, newState) => {
+  state.socketServer.register(BackIn.SET_EXTENSION_ENABLED, async (event, extId, enable) => {
     const isEnabled = !state.preferences.disabledExtensions.includes(extId);
-    if (newState !== isEnabled) {
-      if (newState) {
-        // Enable ext
-        state.preferences.disabledExtensions = state.preferences.disabledExtensions.filter(c => c !== extId);
-        await state.extensionsService.loadExtension(extId);
-      } else {
-        // Disable ext
-        state.preferences.disabledExtensions.push(extId);
-        await state.extensionsService.unloadExtension(extId);
-      }
+    if (enable !== isEnabled && enable) {
+      // Enable ext
+      state.preferences.disabledExtensions = state.preferences.disabledExtensions.filter(c => c !== extId);
+      await state.extensionsService.loadExtension(extId);
+      state.prefsQueue.push(() => {
+        PreferencesFile.saveFile(path.join(state.config.flashpointPath, PREFERENCES_FILENAME), state.preferences, state);
+      });
+    } else if (enable !== isEnabled && !enable) {
+      // Disable ext
+      state.preferences.disabledExtensions.push(extId);
+      await state.extensionsService.unloadExtension(extId);
       state.prefsQueue.push(() => {
         PreferencesFile.saveFile(path.join(state.config.flashpointPath, PREFERENCES_FILENAME), state.preferences, state);
       });
     }
-    state.socketServer.broadcast(BackOut.UPDATE_EXTENSION_STATE, extId, newState);
+    state.socketServer.broadcast(BackOut.UPDATE_EXTENSION_STATE, extId, enable);
   });
 
   state.socketServer.register(BackIn.UPDATE_PREFERENCES, async (event, data) => {
@@ -2731,7 +2731,7 @@ async function runCommand(state: BackState, command: string, args: any[] = []):
  * @param state Current back state
  */
 export async function getProviders(state: BackState): Promise<AppProvider[]> {
-  return state.extensionsService.getContributions('applications')
+  return state.extensionsService.getEnabledContributions('applications', state.preferences.disabledExtensions)
   .then(contributions => {
     return contributions.map(c => {
       const apps = c.value;

src/renderer/components/pages/ConfigPage.tsx

@@ -517,13 +517,6 @@ export function ConfigPage() {
 
     const shortContribs = [];
     if (ext.contributes) {
-      if (ext.contributes.devScripts && ext.contributes.devScripts.length > 0) {
-        shortContribs.push(
-          <div key='devScripts'>
-            {`${ext.contributes.devScripts.length} ${strings.extDevScripts}`}
-          </div>
-        );
-      }
       if (ext.contributes.themes && ext.contributes.themes.length > 0) {
         shortContribs.push(
           <div key='themes'>

src/renderer/store/main/slice.ts

@@ -84,8 +84,6 @@ export type MainState = {
   metaEditExporterOpen: boolean;
   /** ID of the game used in the "Meta Edit Popup". */
   metaEditExporterGameId: string;
-  /** Scripts for the Developer Page */
-  devScripts: ExtensionContribution<'devScripts'>[];
   /** Context buttons added by extensions */
   contextButtons: ExtensionContribution<'contextButtons'>[];
   /** Curation Templates added by extensions */
@@ -242,7 +240,6 @@ const initialState: MainState = {
   extensions: [],
   extConfig: {},
   extConfigs: [],
-  devScripts: [],
   contextButtons: [],
   curationTemplates: [],
   services: [],

src/renderer/store/preferences/middleware.ts

@@ -2,10 +2,10 @@ import { isAnyOf, PayloadAction } from '@reduxjs/toolkit';
 import { BackIn } from '@shared/back/types';
 import { debounce } from '@shared/utils/debounce';
 import { startAppListening } from '../listenerMiddleware';
-import store from '../store';
-import { newAppPathOverride, newTagFilterGroup, removeAppPathOverride, removeTagFilterGroup, setHomePageBoxOpen, setLogoSet, setUseCustomViews, setUseStoredViews, toggleExcludedLibrary, toggleNativePlatform, updateAppPathOverride, updatePreferences, updateTagFilterGroup } from './slice';
+import { incrementLogoVersion, setMainState } from '../main/slice';
 import { createViews } from '../search/slice';
-import { incrementLogoVersion } from '../main/slice';
+import store from '../store';
+import { newAppPathOverride, newTagFilterGroup, removeAppPathOverride, removeTagFilterGroup, setExtState, setHomePageBoxOpen, setLogoSet, setUseCustomViews, setUseStoredViews, toggleExcludedLibrary, toggleNativePlatform, updateAppPathOverride, updatePreferences, updateTagFilterGroup } from './slice';
 
 export function addPreferencesMiddleware() {
   startAppListening({
@@ -15,6 +15,17 @@ export function addPreferencesMiddleware() {
     }
   });
 
+  startAppListening({
+    matcher: isAnyOf(setExtState),
+    effect: async () => {
+      // Refetch extension contributions
+      window.Shared.back.request(BackIn.GET_RENDERER_EXTENSION_INFO)
+      .then((data) => {
+        store.dispatch(setMainState(data));
+      });
+    }
+  });
+
   startAppListening({
     matcher: isAnyOf(setUseCustomViews),
     effect: async (action: PayloadAction<boolean>, listenerApi) => {

src/shared/back/types.ts

@@ -645,7 +645,6 @@ export type GetLoggerInitDataResponse = {
 
 export type GetRendererExtDataResponse = {
   extensions: IExtensionDescription[];
-  devScripts: ExtensionContribution<'devScripts'>[];
   contextButtons: ExtensionContribution<'contextButtons'>[];
   curationTemplates: ExtensionContribution<'curationTemplates'>[];
   extConfigs: ExtensionContribution<'configuration'>[];