[UI] Show winetricks progress output and Sync-Saves output via React Dialog (#1730)

* First poc

* Improved sending output to frontend

* Don't set winetricksRunning false dialog backdrop

* CSS tweaks in winetricks dialog log

* Scroll always to bottom

* lint fix

* AutoScroll on/off for winetricks log

* review suggestions

* review suggestions (2)

* Add new ProgressDialog component

* Make use of ProgressDialog for Sync-Saves

* Add margin

Co-authored-by: Ariel Juodziukynas <arieljuod@gmail.com>

Author: Nocccer

electron/main.ts

@@ -627,7 +627,7 @@ ipcMain.handle(
 
     switch (tool) {
       case 'winetricks':
-        Winetricks.run(wineVersion, winePrefix)
+        await Winetricks.run(wineVersion, winePrefix, event)
         break
       case 'winecfg':
         game.runWineCommand('winecfg')

electron/tools.ts

@@ -205,39 +205,88 @@ export const Winetricks = {
         logWarning('Error Downloading Winetricks', LogPrefix.Backend)
       })
   },
-  run: async (wineVersion: WineInstallation, baseWinePrefix: string) => {
-    const winetricks = `${heroicToolsPath}/winetricks`
+  run: async (
+    wineVersion: WineInstallation,
+    baseWinePrefix: string,
+    event: Electron.IpcMainInvokeEvent
+  ) => {
+    return new Promise<void>((resolve) => {
+      const winetricks = `${heroicToolsPath}/winetricks`
 
-    const { winePrefix, wineBin } = getWineFromProton(
-      wineVersion,
-      baseWinePrefix
-    )
+      const { winePrefix, wineBin } = getWineFromProton(
+        wineVersion,
+        baseWinePrefix
+      )
 
-    const winepath = dirname(wineBin)
+      const winepath = dirname(wineBin)
 
-    const envs = {
-      ...process.env,
-      WINEPREFIX: winePrefix,
-      PATH: `${winepath}:${process.env.PATH}`
-    }
+      const envs = {
+        ...process.env,
+        WINEPREFIX: winePrefix,
+        PATH: `${winepath}:${process.env.PATH}`
+      }
 
-    logInfo(
-      `Running WINEPREFIX='${winePrefix}' PATH='${winepath}':$PATH ${winetricks} -q`,
-      LogPrefix.WineTricks
-    )
+      const executeMessages = [] as string[]
+      let progressUpdated = false
+      const appendMessage = (message: string) => {
+        // Don't store more than 100 messages, to not
+        // fill the storage and make render still fast
+        if (executeMessages.length > 100) {
+          executeMessages.shift()
+        }
+        executeMessages.push(message)
+        progressUpdated = true
+      }
+      const sendProgress = setInterval(() => {
+        if (progressUpdated) {
+          event.sender.send('progressOfWinetricks', executeMessages)
+          progressUpdated = false
+        }
+      }, 1000)
+
+      logInfo(
+        `Running WINEPREFIX='${winePrefix}' PATH='${winepath}':$PATH ${winetricks} -q`,
+        LogPrefix.WineTricks
+      )
 
-    const child = spawn(winetricks, ['-q'], { env: envs })
+      const child = spawn(winetricks, ['-q'], { env: envs })
 
-    child.stdout.on('data', (data: Buffer) => {
-      logInfo(data.toString(), LogPrefix.WineTricks)
-    })
+      child.stdout.setEncoding('utf8')
+      child.stdout.on('data', (data: string) => {
+        logInfo(data, LogPrefix.WineTricks)
+        appendMessage(data)
+      })
 
-    child.stderr.on('data', (data: Buffer) => {
-      logError(data.toString(), LogPrefix.WineTricks)
-    })
+      child.stderr.setEncoding('utf8')
+      child.stderr.on('data', (data: string) => {
+        logError(data, LogPrefix.WineTricks)
+        appendMessage(data)
+      })
 
-    child.on('error', (error) => {
-      logError(`Winetricks throwed Error: ${error}`, LogPrefix.WineTricks)
+      child.on('error', (error) => {
+        logError(`Winetricks threw Error: ${error}`, LogPrefix.WineTricks)
+        showErrorBoxModalAuto(
+          i18next.t('box.error.winetricks.title', 'Winetricks error'),
+          i18next.t('box.error.winetricks.message', {
+            defaultValue:
+              'Winetricks returned the following error during execution:{{newLine}}{{error}}',
+            newLine: '\n',
+            error: `${error}`
+          })
+        )
+        clearInterval(sendProgress)
+        resolve()
+      })
+
+      child.on('exit', () => {
+        clearInterval(sendProgress)
+        resolve()
+      })
+
+      child.on('close', () => {
+        clearInterval(sendProgress)
+        resolve()
+      })
     })
   }
 }

public/locales/bg/translation.json

@@ -75,6 +75,10 @@
             "wine-not-found": {
                 "message": "Няма избрана версия на Wine. Проверете настройките на играта!",
                 "title": "Wine не е намерен"
+            },
+            "winetricks": {
+                "message": "Winetricks returned the following error during execution:{{newLine}}{{error}}",
+                "title": "Winetricks error"
             }
         },
         "info": {
@@ -372,6 +376,7 @@
         "win": "Уиндоус"
     },
     "Plugins": "Добавки",
+    "progress": "Progress",
     "Projects": "Проекти",
     "Recent": "Играно наскоро",
     "search": "Търсене на игри",

public/locales/ca/translation.json

@@ -75,6 +75,10 @@
             "wine-not-found": {
                 "message": "No s'ha seleccionat cap versió del Wine. Comprova la configuració del joc.",
                 "title": "No s'ha trobat el Wine"
+            },
+            "winetricks": {
+                "message": "Winetricks returned the following error during execution:{{newLine}}{{error}}",
+                "title": "Winetricks error"
             }
         },
         "info": {
@@ -372,6 +376,7 @@
         "win": "Windows"
     },
     "Plugins": "Extensions",
+    "progress": "Progress",
     "Projects": "Projectes",
     "Recent": "Jugats fa poc",
     "search": "Cerca jocs",

public/locales/cs/translation.json

@@ -75,6 +75,10 @@
             "wine-not-found": {
                 "message": "Není vybrána žádná verze Wine. Zkontrolujte nastavení hry!",
                 "title": "Wine nenalezen"
+            },
+            "winetricks": {
+                "message": "Winetricks returned the following error during execution:{{newLine}}{{error}}",
+                "title": "Winetricks error"
             }
         },
         "info": {
@@ -372,6 +376,7 @@
         "win": "Windows"
     },
     "Plugins": "Plugins",
+    "progress": "Progress",
     "Projects": "Projekty",
     "Recent": "Recently Played",
     "search": "Vyhledat hry",

public/locales/de/translation.json

@@ -75,6 +75,10 @@
             "wine-not-found": {
                 "message": "Keine Wine Version ausgewählt. Überprüfe die Spieleinstellungen!",
                 "title": "Wine nicht gefunden"
+            },
+            "winetricks": {
+                "message": "Winetricks returned the following error during execution:{{newLine}}{{error}}",
+                "title": "Winetricks error"
             }
         },
         "info": {
@@ -372,6 +376,7 @@
         "win": "Windows"
     },
     "Plugins": "Plugins",
+    "progress": "Progress",
     "Projects": "Projekte",
     "Recent": "Zuletzt gespielte Spiele",
     "search": "Suche nach Spielen",

public/locales/el/translation.json

@@ -75,6 +75,10 @@
             "wine-not-found": {
                 "message": "Δεν επιλέχθηκε έκδοση Wine. Ελέγξτε τις ρυθμίσεις παιχνιδιού!",
                 "title": "Το Wine δεν βρέθηκε"
+            },
+            "winetricks": {
+                "message": "Winetricks returned the following error during execution:{{newLine}}{{error}}",
+                "title": "Winetricks error"
             }
         },
         "info": {
@@ -372,6 +376,7 @@
         "win": "Windows"
     },
     "Plugins": "Plugins",
+    "progress": "Progress",
     "Projects": "Πρότζεκτ",
     "Recent": "Παίχτηκε Πρόσφατα",
     "search": "Αναζήτηση για Παιχνίδια",

public/locales/en/translation.json

@@ -75,6 +75,10 @@
             "wine-not-found": {
                 "message": "No Wine Version Selected. Check Game Settings!",
                 "title": "Wine Not Found"
+            },
+            "winetricks": {
+                "message": "Winetricks returned the following error during execution:{{newLine}}{{error}}",
+                "title": "Winetricks error"
             }
         },
         "info": {
@@ -372,6 +376,7 @@
         "win": "Windows"
     },
     "Plugins": "Plugins",
+    "progress": "Progress",
     "Projects": "Projects",
     "Recent": "Played Recently",
     "search": "Search for Games",

public/locales/es/translation.json

@@ -75,6 +75,10 @@
             "wine-not-found": {
                 "message": "No se ha seleccionado la versión de Wine. ¡Comprueba la configuración del juego!",
                 "title": "No se ha encontrado Wine"
+            },
+            "winetricks": {
+                "message": "Winetricks returned the following error during execution:{{newLine}}{{error}}",
+                "title": "Winetricks error"
             }
         },
         "info": {
@@ -372,6 +376,7 @@
         "win": "Windows"
     },
     "Plugins": "Plugins",
+    "progress": "Progress",
     "Projects": "Proyectos",
     "Recent": "Jugado recientemente",
     "search": "Buscar juegos",

public/locales/et/translation.json

@@ -75,6 +75,10 @@
             "wine-not-found": {
                 "message": "Wine'i versiooni pole valitud. Kontrolli mängu seadeid!",
                 "title": "Wine'i ei leitud"
+            },
+            "winetricks": {
+                "message": "Winetricks returned the following error during execution:{{newLine}}{{error}}",
+                "title": "Winetricks error"
             }
         },
         "info": {
@@ -372,6 +376,7 @@
         "win": "Windows"
     },
     "Plugins": "Pluginad",
+    "progress": "Progress",
     "Projects": "Projektid",
     "Recent": "Hiljuti mängitud",
     "search": "Otsi mänge",