fix: Add missing shiftRandomGames() call to rollRandomGames()

refactor: Minimized frequency of preference updates sent

refactor: Let clients apply partial preference updates instead of sending the entire state from back each time

refactor: Little bits of maintenance on older backend code

Author: colin969

src/back/extensions/ApiImplementation.ts

@@ -67,9 +67,9 @@ export function createApiFactory(extId: string, extManifest: IExtensionManifest,
     data: flashpoint.DeepPartial<flashpoint.AppPreferencesData>,
     onError?: (error: string) => void
   ) => {
+    state.socketServer.broadcast(BackOut.UPDATE_PREFERENCES, data);
     overwritePreferenceData(state.preferences, data, onError);
     await PreferencesFile.saveFile(path.join(state.configFolder, PREFERENCES_FILENAME), state.preferences, state);
-    state.socketServer.broadcast(BackOut.UPDATE_PREFERENCES_RESPONSE, state.preferences);
     return state.preferences;
   };
 

src/back/index.ts

@@ -408,7 +408,8 @@ async function prepForInit(initConfig: BackInitArgs): Promise<void> {
       : path.join(process.platform == 'darwin' ? state.configFolder : path.dirname(initConfig.exePath), 'launcher.log'));
 
   const addLog = (entry: flashpoint.ILogEntry): number => { return state.log.push(entry) - 1; };
-  global.log = {
+  // Typescript get supset here despite it working globally elsewhere :(
+  (global as any).log = {
     trace: logFactory(LogLevel.TRACE, state.socketServer, addLog, state.logFile, state.verbose, state.apiEmitters.onLog),
     debug: logFactory(LogLevel.DEBUG, state.socketServer, addLog, state.logFile, state.verbose, state.apiEmitters.onLog),
     info:  logFactory(LogLevel.INFO,  state.socketServer, addLog, state.logFile, state.verbose, state.apiEmitters.onLog),
@@ -564,7 +565,7 @@ async function prepForInit(initConfig: BackInitArgs): Promise<void> {
     // Add event listeners
     state.languageWatcher.on('add', onLangAddOrChange);
     state.languageWatcher.on('change', onLangAddOrChange);
-    state.languageWatcher.on('remove', (filename: string, offsetPath: string) => {
+    state.languageWatcher.on('remove', (filename: string, stats: fs.Stats, offsetPath: string) => {
       state.languageQueue.push(() => {
         const filePath = path.join(state.languageWatcher.getFolder() || '', offsetPath, filename);
         const index = state.languages.findIndex(l => l.filename === filePath);
@@ -773,7 +774,7 @@ async function prepForInit(initConfig: BackInitArgs): Promise<void> {
   // Exit if it failed to open the server
   if (state.socketServer.port < 0) {
     console.log('Back - Failed to open Socket Server, Exiting...');
-    setImmediate(exit);
+    setImmediate(() => exit(state));
     return;
   }
 
@@ -786,10 +787,14 @@ async function prepForInit(initConfig: BackInitArgs): Promise<void> {
   await promiseSleep(3000);
 
   // Respond
-  send({ port: state.socketServer.port, config: state.config, prefs: state.preferences }, () => {
-    console.log('Back - Ready for Init');
-    state.apiEmitters.onDidInit.fire();
-  });
+  if (process.send) {
+    process.send({ port: state.socketServer.port, config: state.config, prefs: state.preferences }, undefined, undefined,
+      () => {
+        console.log('Back - Ready for Init');
+        state.apiEmitters.onDidInit.fire();
+      });
+  }
+
 }
 
 async function onProcessMessage(message: any): Promise<void> {
@@ -1037,7 +1042,7 @@ async function initialize() {
             const msg = formatString(state.languageContainer.dialog.badAntiVirus, output.trim()) as string;
             const client = state.socketServer.clients.clients[state.socketServer.clients.clients.length - 1]; // Latest client
             const func = state.socketServer.showMessageBoxBack(state, client);
-            const dialogId = await func({
+            const dialogId = func({
               message: msg,
               largeMessage: true,
               buttons: [state.languageContainer.dialog.openWiki, state.languageContainer.dialog.openDiscord, state.languageContainer.dialog.doNotShowAgain],

src/back/responses.ts

@@ -529,7 +529,9 @@ export function registerRequestCallbacks(state: BackState, init: () => Promise<v
         state.prefsQueue.push(() => {
           PreferencesFile.saveFile(path.join(state.config.flashpointPath, PREFERENCES_FILENAME), state.preferences, state);
         });
-        state.socketServer.broadcast(BackOut.UPDATE_PREFERENCES_RESPONSE, state.preferences);
+        state.socketServer.broadcast(BackOut.UPDATE_PREFERENCES, {
+          gameDataSources: state.preferences.gameMetadataSources
+        });
       }
 
       updateToast('Updating Search Suggestions...');
@@ -1459,6 +1461,8 @@ export function registerRequestCallbacks(state: BackState, init: () => Promise<v
   });
 
   state.socketServer.register(BackIn.UPDATE_PREFERENCES, async (event, data) => {
+    state.socketServer.broadcastExcept(event.client, BackOut.UPDATE_PREFERENCES, data);
+
     if ((data.currentLanguage  !== undefined && data.currentLanguage  !== state.preferences.currentLanguage) ||
         (data.fallbackLanguage !== undefined && data.fallbackLanguage !== state.preferences.fallbackLanguage)) {
       state.languageContainer = createContainer(
@@ -1474,8 +1478,6 @@ export function registerRequestCallbacks(state: BackState, init: () => Promise<v
     state.prefsQueue.push(() => {
       PreferencesFile.saveFile(path.join(state.config.flashpointPath, PREFERENCES_FILENAME), state.preferences, state);
     });
-
-    // TODO: Broadcast to all other users
   });
 
   state.socketServer.register(BackIn.SERVICE_ACTION, async (event, action, id) => {

src/back/util/misc.ts

@@ -17,7 +17,6 @@ import { AdditionalApp, Game, IBackProcessInfo, IService, LangContainer, LangFil
 import * as fs from 'fs-extra';
 import * as path from 'node:path';
 import * as os from 'os';
-import * as kill from 'tree-kill';
 import { promisify } from 'util';
 import { uuid } from './uuid';
 
@@ -189,15 +188,6 @@ export async function exit(state: BackState, beforeProcessExit?: () => void | Pr
       state.socketServer.close()
       .catch(e => { console.error(e); });
 
-      await new Promise<void>((resolve, reject) => {
-        kill(process.pid, (error) => {
-          if (error) {
-            reject(error);
-          } else {
-            resolve();
-          }
-        });
-      });
       // Kill the parent process.
       process.kill(process.pid);
       process.exit(0);

src/renderer/components/HomePageComponents.tsx

@@ -2,7 +2,7 @@ import { createSelector } from '@reduxjs/toolkit';
 import { useView } from '@renderer/hooks/search';
 import { useAppDispatch, useAppSelector } from '@renderer/hooks/useAppSelector';
 import { useLocalization } from '@renderer/hooks/useLocalization';
-import { addRandomGames, RANDOM_GAME_ROW_COUNT, setMainState } from '@renderer/store/main/slice';
+import { addRandomGames, RANDOM_GAME_ROW_COUNT, setMainState, shiftRandomGames } from '@renderer/store/main/slice';
 import { forceSearch, GENERAL_VIEW_ID, selectGame, setSearchText } from '@renderer/store/search/slice';
 import { findGameDragEventDataGrid, getExtremeIconURL, getPlatformIconURL, joinLibraryRoute } from '@renderer/Util';
 import { idToGame } from '@renderer/util/async';
@@ -335,6 +335,8 @@ export function HomePageComponentRandomGames(props: HomePageComponentProps) {
         dispatch(addRandomGames(data));
       });
     }
+    // Cycle row of games
+    dispatch(shiftRandomGames());
   };
 
   const onSelectGame = async (gameId?: string) => {

src/renderer/components/app.tsx

@@ -12,7 +12,7 @@ import { performFpfssAction, 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, removeExtension, removeGameSidebarComponent, removeService, setExtConfigValue, setExtOrderablesFromCallback, setMainState, setUnrecoverableError, setUpdateInfo, updateDialog, updateDialogField, updateMetadataSource, updateSystemThemeCss, updateThemeCss } from '@renderer/store/main/slice';
-import { setExtState, setPreferences, updatePreferences } from '@renderer/store/preferences/slice';
+import { setExtState, setPreferences, updatePreferences, updatePreferencesWithoutSend } 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';
 import { setTagCategories } from '@renderer/store/tagCategories/slice';
@@ -737,6 +737,10 @@ function registerWebsocketListeners(dispatch: AppDispatch) {
     }));
   });
 
+  window.Shared.back.register(BackOut.UPDATE_PREFERENCES, (event, data) => {
+    dispatch(updatePreferencesWithoutSend(data));
+  });
+
   window.Shared.back.register(BackOut.UPDATE_PREFERENCES_RESPONSE, (event, data) => {
     dispatch(setPreferences(data));
   });

src/renderer/store/preferences/slice.ts

@@ -46,6 +46,9 @@ const prefsSlice = createSlice({
     setPreferences(state: AppPreferencesData, { payload }: PayloadAction<AppPreferencesData>) {
       return payload;
     },
+    updatePreferencesWithoutSend(state: AppPreferencesData, { payload }: PayloadAction<DeepPartial<AppPreferencesData>>) {
+      overwritePreferenceData(state, payload);
+    },
     updatePreferences(state: AppPreferencesData, { payload }: PayloadAction<DeepPartial<AppPreferencesData>>) {
       overwritePreferenceData(state, payload);
     },
@@ -175,6 +178,7 @@ export const { actions: preferencesActions } = prefsSlice;
 export const {
   setPreferences,
   updatePreferences,
+  updatePreferencesWithoutSend,
   setHomePageBoxOpen,
   setUseStoredViews,
   setUseCustomViews,

src/shared/back/types.ts

@@ -54,7 +54,7 @@ import { UnrecoverableError } from 'flashpoint-launcher-renderer';
 import { UpdateOptions } from 'react-toastify';
 import { LogLevel } from '../Log/interface';
 import { Theme } from '../ThemeFile';
-import { ExecMapping, GamePropSuggestions, ProcessAction } from '../interfaces';
+import { DeepPartial, ExecMapping, GamePropSuggestions, ProcessAction } from '../interfaces';
 
 export enum BackIn {
   UNKNOWN = 1000,
@@ -243,6 +243,7 @@ export enum BackOut {
   OPEN_EXTERNAL,
   LOCALE_UPDATE,
   GET_MAIN_INIT_DATA,
+  UPDATE_PREFERENCES,
   UPDATE_PREFERENCES_RESPONSE,
   SET_EXT_CONFIG_VALUE,
   IMAGE_CHANGE,
@@ -518,6 +519,7 @@ export type BackOutTemplate = SocketTemplate<BackOut, {
   [BackOut.OPEN_EXTERNAL]: (url: string, options?: OpenExternalOptions) => void;
   [BackOut.LOCALE_UPDATE]: (data: string) => void;
   [BackOut.GET_MAIN_INIT_DATA]: () => void;
+  [BackOut.UPDATE_PREFERENCES]: (data: DeepPartial<AppPreferencesData>) => void;
   [BackOut.UPDATE_PREFERENCES_RESPONSE]: (data: AppPreferencesData) => void;
   [BackOut.SET_EXT_CONFIG_VALUE]: (key: string, value: any) => void;
   [BackOut.IMAGE_CHANGE]: (folder: string, id: string) => void;