[General] Restructure/Cleanup of runLegendaryOrGogdlCommand (#1415)

* Restructured runLegendaryOrGogCommand
- removed unessecary functions and logs
- cleanup unessecary code

* Review suggestions and cleanup

Author: Nocccer

electron/gog/games.ts

@@ -40,7 +40,7 @@ import {
 } from '../launcher'
 import { addShortcuts, removeShortcuts } from '../shortcuts'
 import setup from './setup'
-import { getGogdlCommand, runGogdlCommand } from './library'
+import { runGogdlCommand } from './library'
 
 function verifyProgress(stderr: string): boolean {
   const text = stderr.split('\n').at(-1)
@@ -96,12 +96,9 @@ class GOGGame extends Game {
   }
 
   public async import(path: string): Promise<ExecResult> {
-    const commandParts = ['import', path]
-    const command = getGogdlCommand(commandParts)
-
-    logInfo([`Importing ${this.appName} with:`, command], LogPrefix.Gog)
-
-    const res = await runGogdlCommand(commandParts)
+    const res = await runGogdlCommand(['import', path], {
+      logMessagePrefix: `Importing ${this.appName}`
+    })
 
     if (res.error) {
       logError(
@@ -138,7 +135,7 @@ class GOGGame extends Game {
           `Progress for ${this.appName}:`,
           `${percent}%/${bytes}MiB/${eta}`.trim()
         ],
-        LogPrefix.Backend
+        LogPrefix.Gog
       )
 
       this.window.webContents.send('setGameStatus', {
@@ -185,17 +182,15 @@ class GOGGame extends Game {
       `--lang=${installLanguage}`,
       ...workers
     ]
-    const command = getGogdlCommand(commandParts)
-
-    logInfo([`Installing ${this.appName} with:`, command], LogPrefix.Gog)
 
     const onOutput = (data: string) => {
       this.onInstallOrUpdateOutput('installing', data)
     }
 
     const res = await runGogdlCommand(commandParts, {
       logFile: logPath,
-      onOutput
+      onOutput,
+      logMessagePrefix: `Installing ${this.appName}`
     })
 
     if (res.error) {
@@ -270,6 +265,7 @@ class GOGGame extends Game {
   public async removeShortcuts() {
     return removeShortcuts(this.appName, 'gog')
   }
+
   async launch(launchArguments?: string): Promise<LaunchResult> {
     const gameSettings =
       GameConfig.get(this.appName).config ||
@@ -395,14 +391,15 @@ class GOGGame extends Game {
         launcherArgs
       ]
     }
-    const command = getGogdlCommand(commandParts, commandEnv, wrappers)
 
-    logInfo([`Launching ${gameInfo.title}:`, command], LogPrefix.Gog)
-
-    const { error, stderr, stdout } = await runGogdlCommand(commandParts, {
-      env: commandEnv,
-      wrappers
-    })
+    const { error, stderr, stdout, fullCommand } = await runGogdlCommand(
+      commandParts,
+      {
+        env: commandEnv,
+        wrappers,
+        logMessagePrefix: `Launching ${gameInfo.title}`
+      }
+    )
 
     if (error) {
       logError(['Error launching game:', error], LogPrefix.Gog)
@@ -415,7 +412,7 @@ class GOGGame extends Game {
       stdout,
       stderr,
       gameSettings,
-      command
+      command: fullCommand
     }
   }
 
@@ -467,11 +464,11 @@ class GOGGame extends Game {
       '-b=' + gameData.install.buildId,
       ...workers
     ]
-    const command = getGogdlCommand(commandParts)
 
-    logInfo([`Repairing ${this.appName} with:`, command], LogPrefix.Gog)
-
-    const res = await runGogdlCommand(commandParts, { logFile: logPath })
+    const res = await runGogdlCommand(commandParts, {
+      logFile: logPath,
+      logMessagePrefix: `Repairing ${this.appName}`
+    })
 
     if (res.error) {
       logError(
@@ -578,17 +575,15 @@ class GOGGame extends Game {
       `--lang=${gameData.install.language || 'en-US'}`,
       ...workers
     ]
-    const command = getGogdlCommand(commandParts)
-
-    logInfo([`Updating ${this.appName} with:`, command], LogPrefix.Gog)
 
     const onOutput = (data: string) => {
       this.onInstallOrUpdateOutput('updating', data)
     }
 
     const res = await runGogdlCommand(commandParts, {
       logFile: logPath,
-      onOutput
+      onOutput,
+      logMessagePrefix: `Updating ${this.appName}`
     })
 
     // This always has to be done, so we do it before checking for res.error

electron/gog/library.ts

@@ -6,7 +6,8 @@ import {
   InstallInfo,
   InstalledInfo,
   GOGImportData,
-  ExecResult
+  ExecResult,
+  CallRunnerOptions
 } from '../types'
 import { join } from 'node:path'
 import { existsSync, readFileSync } from 'graceful-fs'
@@ -19,10 +20,7 @@ import {
   libraryStore,
   installedGamesStore
 } from './electronStores'
-import {
-  getLegendaryOrGogdlCommand,
-  runLegendaryOrGogdlCommand
-} from '../launcher'
+import { callRunner } from '../launcher'
 
 export class GOGLibrary {
   private static globalInstance: GOGLibrary = null
@@ -169,9 +167,8 @@ export class GOGLibrary {
       '--os',
       installPlatform
     ]
-    const command = getGogdlCommand(commandParts)
 
-    logInfo(['Getting game metadata:', command], LogPrefix.Gog)
+    logInfo('Getting game metadata.', LogPrefix.Gog)
 
     const res = await runGogdlCommand(commandParts)
     if (res.error) {
@@ -625,33 +622,12 @@ export class GOGLibrary {
  */
 export async function runGogdlCommand(
   commandParts: string[],
-  options?: {
-    logFile?: string
-    env?: Record<string, string>
-    wrappers?: string[]
-    onOutput?: (output: string) => void
-  }
+  options?: CallRunnerOptions
 ): Promise<ExecResult> {
   const { dir, bin } = getGOGdlBin()
-  return runLegendaryOrGogdlCommand(
+  return callRunner(
     commandParts,
-    { name: 'GOGDL', logPrefix: LogPrefix.Gog, bin, dir },
+    { name: 'gog', logPrefix: LogPrefix.Gog, bin, dir },
     options
   )
 }
-
-/**
- * Generates a "safe" GOGDL command **for formatting**.
- * Command generated by this function are not meant to be ran directly, use runGogdlCommand for that.
- * A "safe" command does not include the user's token
- * @param commandParts The command to run, e. g. 'update', 'install'...
- * @returns The full command as a string
- */
-export function getGogdlCommand(
-  commandParts: string[],
-  env: Record<string, string> = {},
-  wrappers: string[] = []
-): string {
-  const gogdlPath = join(...Object.values(getGOGdlBin()))
-  return getLegendaryOrGogdlCommand(commandParts, env, wrappers, gogdlPath)
-}

electron/launcher.ts

@@ -34,7 +34,7 @@ import { DXVK } from './tools'
 import setup from './gog/setup'
 import { GOGGame } from 'gog/games'
 import { LegendaryGame } from 'legendary/games'
-import { GameInfo } from './types'
+import { CallRunnerOptions, GameInfo, Runner } from './types'
 import {
   ExecResult,
   GameSettings,
@@ -468,35 +468,40 @@ async function runWineCommand(
     })
 }
 
-async function runLegendaryOrGogdlCommand(
+interface RunnerProps {
+  name: Runner
+  logPrefix: LogPrefix
+  bin: string
+  dir: string
+}
+
+async function callRunner(
   commandParts: string[],
-  runner: {
-    name: 'GOGDL' | 'Legendary'
-    logPrefix: LogPrefix
-    bin: string
-    dir: string
-  },
-  options?: {
-    logFile?: string
-    env?: Record<string, string>
-    wrappers?: string[]
-    onOutput?: (output: string) => void
-  }
+  runner: RunnerProps,
+  options?: CallRunnerOptions
 ): Promise<ExecResult> {
   const fullRunnerPath = join(runner.dir, runner.bin)
   const appName = commandParts[commandParts.findIndex(() => 'launch') + 1]
-  const safeCommand = getLegendaryOrGogdlCommand(
+
+  // Necessary to get rid of possible undefined or null entries, else
+  // TypeError is triggered
+  commandParts = commandParts.filter(Boolean)
+  const safeCommand = getRunnerCallWithoutCredentials(
     commandParts,
     options?.env,
     options?.wrappers,
     fullRunnerPath
   )
-  logDebug(['Running', runner.name, 'command:', safeCommand], runner.logPrefix)
+
+  logInfo(
+    [options?.logMessagePrefix ?? `Running command`, ':', safeCommand],
+    runner.logPrefix
+  )
+
   if (options?.logFile) {
-    logDebug([`Logging to file "${options.logFile}"`], runner.logPrefix)
+    logDebug(`Logging to file "${options?.logFile}"`, runner.logPrefix)
   }
 
-  commandParts = commandParts.filter((n) => n)
   if (existsSync(options?.logFile)) {
     writeFileSync(options.logFile, '')
   }
@@ -521,28 +526,27 @@ async function runLegendaryOrGogdlCommand(
     const stdout: string[] = []
     const stderr: string[] = []
 
-    if (options?.logFile) {
-      child.stdout.on('data', (data: Buffer) => {
-        appendFileSync(options.logFile, data.toString())
-      })
-      child.stderr.on('data', (data: Buffer) => {
+    child.stdout.on('data', (data: Buffer) => {
+      if (options?.logFile) {
         appendFileSync(options.logFile, data.toString())
-      })
-    }
+      }
 
-    if (options?.onOutput) {
-      child.stdout.on('data', (data: Buffer) => {
-        options.onOutput(data.toString())
-      })
-      child.stderr.on('data', (data: Buffer) => {
+      if (options?.onOutput) {
         options.onOutput(data.toString())
-      })
-    }
+      }
 
-    child.stdout.on('data', (data: Buffer) => {
       stdout.push(data.toString().trim())
     })
+
     child.stderr.on('data', (data: Buffer) => {
+      if (options?.logFile) {
+        appendFileSync(options.logFile, data.toString())
+      }
+
+      if (options?.onOutput) {
+        options.onOutput(data.toString())
+      }
+
       stderr.push(data.toString().trim())
     })
 
@@ -563,6 +567,7 @@ async function runLegendaryOrGogdlCommand(
         stderr: stderr.join('\n')
       })
     })
+
     child.on('error', (error) => {
       rej(error)
     })
@@ -583,22 +588,21 @@ async function runLegendaryOrGogdlCommand(
         !`${error}`.includes('appears to be deleted')
 
       logError(
-        ['Error running', runner.name, 'command', `"${safeCommand}": ${error}`],
+        ['Error running', 'command', `"${safeCommand}": ${error}`],
         runner.logPrefix,
         showDialog
       )
+
       return { stdout: '', stderr: `${error}`, fullCommand: safeCommand, error }
     })
 }
 
-function getLegendaryOrGogdlCommand(
+function getRunnerCallWithoutCredentials(
   commandParts: string[],
   env: Record<string, string> = {},
   wrappers: string[] = [],
   runnerPath: string
 ): string {
-  commandParts = commandParts.filter((n) => n)
-
   // Redact sensitive arguments (SID for Legendary, token for GOGDL)
   for (const sensitiveArg of ['--sid', '--token']) {
     const sensitiveArgIndex = commandParts.indexOf(sensitiveArg)
@@ -636,6 +640,5 @@ export {
   setupWineEnvVars,
   setupWrappers,
   runWineCommand,
-  runLegendaryOrGogdlCommand,
-  getLegendaryOrGogdlCommand
+  callRunner
 }