feat: Game Redirect Sync

lang/en.json

@@ -34,6 +34,8 @@
     "enablePlaytimeTrackingExtremeDesc": "Allow tracking last played date, total playtime and play count for Extreme games.",
     "enableTagFilterIndex": "Tag Filter Index",
     "enableTagFilterIndexDesc": "Enable use of the Tag Filter Index to speed up lots of queries",
+    "enableVerboseLogging": "Verbose Logging",
+    "enableVerboseLoggingDesc": "Enables verbose logging for external libraries.",
     "clearPlaytimeTracking": "Clear Playtime Data",
     "clearPlaytimeTrackingDesc": "Clears last played, total playtime and play count for every game. Irreversible.",
     "clearData": "Clear Data",

package.json

@@ -32,7 +32,7 @@
     "@fortawesome/fontawesome-svg-core": "1.2.36",
     "@fortawesome/free-solid-svg-icons": "5.15.4",
     "@fortawesome/react-fontawesome": "0.1.18",
-    "@fparchive/flashpoint-archive": "0.5.0",
+    "@fparchive/flashpoint-archive": "0.6.2",
     "@types/react-virtualized": "^9.21.21",
     "axios": "1.3.4",
     "connected-react-router": "6.9.2",

src/back/index.ts

@@ -33,7 +33,7 @@ import {
   CURATIONS_FOLDER_WORKING, CURATION_META_FILENAMES
 } from '@shared/constants';
 import axios from 'axios';
-import { FlashpointArchive, parseUserSearchInput } from '@fparchive/flashpoint-archive';
+import { FlashpointArchive, enableDebug, parseUserSearchInput } from '@fparchive/flashpoint-archive';
 import { Game, GameData, Playlist, PlaylistGame } from 'flashpoint-launcher';
 import { Tail } from 'tail';
 import { ConfigFile } from './ConfigFile';
@@ -686,6 +686,10 @@ async function initialize() {
     // Non-fatal, don't quit.
   }
 
+  if (state.preferences.enableVerboseLogging) {
+    enableDebug();
+  }
+
   const databasePath = path.resolve(state.config.flashpointPath, 'Data', 'flashpoint.sqlite');
   try {
     fpDatabase.loadDatabase(databasePath);

src/back/responses.ts

@@ -49,7 +49,7 @@ import { fpDatabase, loadCurationArchive, onDidUninstallGameData, onWillUninstal
 import { importGames, importPlatforms, importTagCategories, importTags } from './metadataImport';
 import { addPlaylistGame, deletePlaylist, deletePlaylistGame, duplicatePlaylist, filterPlaylists, getPlaylistGame, importPlaylist, savePlaylistGame, updatePlaylist } from './playlist';
 import { copyFolder, genContentTree } from './rust';
-import { getMetaUpdateInfo, syncGames, syncPlatforms, syncTags } from './sync';
+import { getMetaUpdateInfo, syncGames, syncPlatforms, syncRedirects, syncTags } from './sync';
 import { BackState, MetadataRaw, TagsFile } from './types';
 import { pathToBluezip } from './util/Bluezip';
 import { pathTo7zBack } from './util/SevenZip';
@@ -374,6 +374,7 @@ export function registerRequestCallbacks(state: BackState, init: () => Promise<v
         const progress = chunk / chunks;
         state.socketServer.broadcast(BackOut.UPDATE_DIALOG_FIELD_VALUE, dialogId, 'progress', progress * 100);
       });
+      await syncRedirects(source);
       if (sourceIdx !== -1) {
         state.preferences.gameMetadataSources[sourceIdx].games.latestUpdateTime = lastDate.toISOString();
         state.preferences.gameMetadataSources[sourceIdx].games.actualUpdateTime = newDate.toISOString();
@@ -1326,6 +1327,7 @@ export function registerRequestCallbacks(state: BackState, init: () => Promise<v
     // --- GAMES ----
 
     // Collect games
+
     const search = parseUserSearchInput('');
     search.limit = 5000;
     let games = await fpDatabase.searchGames(search);

src/back/sync.ts

@@ -1,4 +1,4 @@
-import { RemoteCategory, RemoteDeletedGamesRes, RemoteGamesRes, RemotePlatform, RemoteTag } from '@fparchive/flashpoint-archive';
+import { GameRedirect, RemoteCategory, RemoteDeletedGamesRes, RemoteGamesRes, RemotePlatform, RemoteTag } from '@fparchive/flashpoint-archive';
 import axios from 'axios';
 import { GameMetadataSource } from 'flashpoint-launcher';
 import { camelCase, transform } from 'lodash';
@@ -132,6 +132,21 @@ export async function syncGames(source: GameMetadataSource, dataPacksFolder: str
   return new Date(lastDate);
 }
 
+export async function syncRedirects(source: GameMetadataSource): Promise<void> {
+  const gamesUrl = `${source.baseUrl}/api/game-redirects`;
+  const res = await axios.get(gamesUrl)
+  .catch((err) => {
+    throw 'Failed to search game redirects';
+  });
+
+  const data = res.data.map((d: any) => { return {
+    sourceId: d.source_id,
+    destId: d.id
+  };}) as any as Array<GameRedirect>;
+  console.log('applying redirects');
+  await fpDatabase.updateApplyRedirects(data);
+}
+
 export async function getMetaUpdateInfo(source: GameMetadataSource, accurate?: boolean, fromScratch?: boolean): Promise<number> {
   // Add 1 second to update time to prevent rounding down errors
   const d = new Date(source.games.latestUpdateTime);

src/renderer/components/pages/ConfigPage.tsx

@@ -287,6 +287,12 @@ export class ConfigPage extends React.Component<ConfigPageProps, ConfigPageState
                     icon='plus' />
                 </div>
               </ConfigBox>
+              {/* Verbose Logging */}
+              <ConfigBoxCheckbox
+                title={strings.enableVerboseLogging}
+                description={strings.enableVerboseLoggingDesc}
+                checked={this.props.preferencesData.enableVerboseLogging}
+                onToggle={this.onVerboseLoggingToggle} />
             </div>
           </div>
 
@@ -806,6 +812,10 @@ export class ConfigPage extends React.Component<ConfigPageProps, ConfigPageState
     updatePreferencesData({ enableTagFilterIndex: isChecked });
   };
 
+  onVerboseLoggingToggle = (isChecked: boolean): void => {
+    updatePreferencesData({ enableVerboseLogging: isChecked });
+  };
+
   onSearchLimitChange = (event: React.ChangeEvent<HTMLSelectElement>): void => {
     updatePreferencesData({ searchLimit: num(event.target.value) });
   };

src/shared/lang.ts

@@ -37,6 +37,8 @@ const langTemplate = {
     'enablePlaytimeTrackingDesc',
     'enableTagFilterIndex',
     'enableTagFilterIndexDesc',
+    'enableVerboseLogging',
+    'enableVerboseLoggingDesc',
     'enablePlaytimeTrackingExtreme',
     'enablePlaytimeTrackingExtremeDesc',
     'clearPlaytimeTracking',

src/shared/preferences/util.ts

@@ -147,6 +147,7 @@ export const defaultPreferencesData: Readonly<AppPreferencesData> = Object.freez
   enablePlaytimeTracking: true,
   enablePlaytimeTrackingExtreme: true,
   enableTagFilterIndex: true,
+  enableVerboseLogging: false,
 });
 
 /**
@@ -221,6 +222,7 @@ export function overwritePreferenceData(
   parser.prop('enablePlaytimeTracking',        v => source.enablePlaytimeTracking        = !!v, true);
   parser.prop('enablePlaytimeTrackingExtreme', v => source.enablePlaytimeTrackingExtreme = !!v, true);
   parser.prop('enableTagFilterIndex',          v => source.enableTagFilterIndex          = !!v, true);
+  parser.prop('enableVerboseLogging',          v => source.enableVerboseLogging          = !!v, true);
 
   // Migrate onDemandBaseUrl from the older FP url
   if (source.onDemandBaseUrl == 'https://infinity.unstable.life/Flashpoint/Data/Images/') {

tests/unit/back/configuration.test.ts

@@ -178,6 +178,7 @@ describe('Configuration Files', () => {
       'enablePlaytimeTracking': false,
       'enablePlaytimeTrackingExtreme': false,
       'enableTagFilterIndex': false,
+      'enableVerboseLogging': true,
     };
     const newData = deepCopy(defaultPreferencesData);
     overwritePreferenceData(newData, data);

typings/flashpoint-launcher.d.ts

@@ -1048,6 +1048,8 @@ declare module 'flashpoint-launcher' {
         enablePlaytimeTrackingExtreme: boolean;
         /** Enable tag filter indexing */
         enableTagFilterIndex: boolean;
+        /** Use verbose logging for the rust library */
+        enableVerboseLogging: boolean;
     };
 
     type GameDataSource = {