[UI/UX] Improve error handling on BE and FE (#1363)

* wip: show error message if no games found

* feat: add Error components

* i18n: updated keys

* chore: typo

* fix: check

* feat: show error message on gamepage

* chore: added more checks

* feat: added more messages and error handlers

* chore: change invalid path message

* feat: add context menu to Settings

* fix: steam runtime setting not updating

* fix: type conversion on logger

* feat: add showdialog param to logger

* fix: wrong type coertions

* chore: log level adjustments

* fix: epic webview login not working

* fix: logged in status not changing

* feat: handle other login errors

* chore: refactor login FE a bit

* feat: deal with memory cache failure on install

* fix: error handler error

* chore: pr comments

* chore: pr comments 2

* chore: function naming

* feat: refactor and deal with deleted folders

* feat: gog forceUninstall

* fix: use legendary uninstall command

* chore: pr comments

* fix: imports and tests

* feat: check if gog game folder exists

* i18n: updated keys

* feat: get runtimes from steam libraries

* i18n: updated keys

Author: flavioislima

electron/config.ts

@@ -57,7 +57,15 @@ abstract class GlobalConfig {
     // Config file exists, detect its version.
     else {
       // Check version field in the config.
-      version = JSON.parse(readFileSync(heroicConfigPath, 'utf-8'))['version']
+      try {
+        version = JSON.parse(readFileSync(heroicConfigPath, 'utf-8'))['version']
+      } catch (error) {
+        logError(
+          `Config file is corrupted, please check ${heroicConfigPath}`,
+          LogPrefix.Backend
+        )
+        version = 'v0'
+      }
       // Legacy config file without a version field, it's a v0 config.
       if (!version) {
         version = 'v0'
@@ -411,12 +419,23 @@ class GlobalConfigV0 extends GlobalConfig {
       return this.getFactoryDefaults()
     }
 
-    let settings = JSON.parse(readFileSync(heroicConfigPath, 'utf-8'))
-    settings = {
-      ...(await this.getFactoryDefaults()),
-      ...settings.defaultSettings
-    } as AppSettings
-    return settings
+    try {
+      let settings = JSON.parse(readFileSync(heroicConfigPath, 'utf-8'))
+      settings = {
+        ...(await this.getFactoryDefaults()),
+        ...settings.defaultSettings
+      } as AppSettings
+      return settings
+    } catch (error) {
+      logError(
+        `Config file is corrupted, please check ${heroicConfigPath}`,
+        LogPrefix.Backend
+      )
+      const settings = {
+        ...(await this.getFactoryDefaults())
+      }
+      return settings
+    }
   }
 
   public async getCustomWinePaths(): Promise<Set<WineInstallation>> {

electron/game_config.ts

@@ -49,7 +49,15 @@ abstract class GameConfig {
     // Config file exists, detect its version.
     else {
       // Check version field in the config.
-      version = JSON.parse(readFileSync(path, 'utf-8'))['version']
+      try {
+        version = JSON.parse(readFileSync(path, 'utf-8'))['version']
+      } catch (error) {
+        logError(
+          `Config file is corrupted, please check ${path}`,
+          LogPrefix.Backend
+        )
+        version = 'v0'
+      }
       // Legacy config file without a version field, it's a v0 config.
       if (!version) {
         version = 'v0'
@@ -189,13 +197,23 @@ class GameConfigV0 extends GameConfig {
     if (!existsSync(this.path)) {
       return { ...GlobalConfig.get().config } as GameSettings
     }
-    const settings = JSON.parse(readFileSync(this.path, 'utf-8'))
-    // Take defaults, then overwrite if explicitly set values exist.
-    // The settings defined work as overrides.
-    return {
-      ...GlobalConfig.get().config,
-      ...settings[this.appName]
-    } as GameSettings
+    try {
+      const settings = JSON.parse(readFileSync(this.path, 'utf-8'))
+      // Take defaults, then overwrite if explicitly set values exist.
+      // The settings defined work as overrides.
+      return {
+        ...GlobalConfig.get().config,
+        ...settings[this.appName]
+      } as GameSettings
+    } catch (error) {
+      logError(
+        `Config file is corrupted, please check ${this.path}`,
+        LogPrefix.Backend
+      )
+      return {
+        ...GlobalConfig.get().config
+      }
+    }
   }
 
   public async resetToDefaults() {

electron/games.ts

@@ -35,6 +35,7 @@ abstract class Game {
   abstract moveInstall(newInstallPath: string): Promise<string>
   abstract repair(): Promise<ExecResult>
   abstract stop(): Promise<void>
+  abstract forceUninstall(): Promise<void>
   abstract syncSaves(arg: string, path: string): Promise<ExecResult>
   abstract uninstall(): Promise<ExecResult>
   abstract update(): Promise<{ status: 'done' | 'error' }>

electron/gog/electronStores.ts

@@ -11,8 +11,13 @@ const configStore = new Store({
 
 const apiInfoCache = new Store({
   cwd: 'gog_store',
-  name: 'api_info_cache'
+  name: 'api_info_cache',
+  clearInvalidConfig: true
+})
+const libraryStore = new Store({
+  cwd: 'gog_store',
+  name: 'library',
+  clearInvalidConfig: true
 })
-const libraryStore = new Store({ cwd: 'gog_store', name: 'library' })
 
 export { configStore, installedGamesStore, apiInfoCache, libraryStore }

electron/gog/games.ts

@@ -15,8 +15,7 @@ import {
   InstallArgs,
   LaunchResult,
   GOGLoginData,
-  InstalledInfo,
-  InstallProgress
+  InstalledInfo
 } from 'types'
 import { existsSync, rmSync } from 'graceful-fs'
 import {
@@ -28,7 +27,7 @@ import {
 } from '../constants'
 import { configStore, installedGamesStore } from '../gog/electronStores'
 import { logError, logInfo, LogPrefix, logWarning } from '../logger/logger'
-import { execAsync, getFileSize, getSteamRuntime } from '../utils'
+import { errorHandler, execAsync, getFileSize, getSteamRuntime } from '../utils'
 import { GOGUser } from './user'
 import {
   launchCleanup,
@@ -109,8 +108,15 @@ class GOGGame extends Game {
         LogPrefix.Gog
       )
     }
-    await GOGLibrary.get().importGame(JSON.parse(res.stdout), path)
-    return res
+    try {
+      await GOGLibrary.get().importGame(JSON.parse(res.stdout), path)
+      return res
+    } catch (error) {
+      logError(
+        ['Failed to import', `${this.appName}:`, res.error],
+        LogPrefix.Gog
+      )
+    }
   }
 
   public onInstallOrUpdateOutput(
@@ -224,7 +230,7 @@ class GOGGame extends Game {
       buildId: isLinuxNative ? '' : installInfo.game.buildId
     }
     const array: Array<InstalledInfo> =
-      (installedGamesStore.get('installed') as Array<InstalledInfo>) || []
+      (installedGamesStore.get('installed', []) as Array<InstalledInfo>) || []
     array.push(installedData)
     installedGamesStore.set('installed', array)
     GOGLibrary.get().refreshInstalled()
@@ -251,6 +257,14 @@ class GOGGame extends Game {
       (await GameConfig.get(this.appName).getSettings())
     const gameInfo = GOGLibrary.get().getGameInfo(this.appName)
 
+    if (!existsSync(gameInfo.install.install_path)) {
+      errorHandler({
+        error: 'appears to be deleted',
+        runner: 'gog',
+        appName: gameInfo.app_name
+      })
+    }
+
     const {
       success: launchPrepSuccess,
       failureReason: launchPrepFailReason,
@@ -513,7 +527,7 @@ class GOGGame extends Game {
           res.stderr = stderr
         })
         .catch((error) => {
-          res.error = error
+          res.error = `${error}`
         })
     } else {
       rmSync(object.install_path, { recursive: true })
@@ -611,7 +625,7 @@ class GOGGame extends Game {
     if (GOGUser.isTokenExpired()) {
       await GOGUser.refreshToken()
     }
-    const credentials = configStore.get('credentials') as GOGLoginData
+    const credentials = configStore.get('credentials', {}) as GOGLoginData
 
     const installPlatform = gameData.install.platform
     const logPath = join(heroicGamesConfigPath, this.appName + '.log')
@@ -643,6 +657,17 @@ class GOGGame extends Game {
 
     return runWineCommand(await this.getSettings(), command, altWineBin, wait)
   }
+
+  async forceUninstall(): Promise<void> {
+    const installed = installedGamesStore.get(
+      'installed',
+      []
+    ) as Array<InstalledInfo>
+    const newInstalled = installed.filter((g) => g.appName !== this.appName)
+    installedGamesStore.set('installed', newInstalled)
+    const mainWindow = BrowserWindow.getFocusedWindow()
+    mainWindow.webContents.send('refreshLibrary', 'gog')
+  }
 }
 
 export { GOGGame }

electron/gog/library.ts

@@ -86,7 +86,7 @@ export class GOGLibrary {
     }
 
     const gamesObjects: GameInfo[] = []
-    const gamesArray = libraryStore.get('games') as GameInfo[]
+    const gamesArray = libraryStore.get('games', []) as GameInfo[]
     for (const game of gameApiArray as GOGGameInfo[]) {
       let unifiedObject = gamesArray
         ? gamesArray.find((value) => value.app_name === String(game.id))
@@ -182,7 +182,7 @@ export class GOGLibrary {
     }
 
     const gogInfo = JSON.parse(res.stdout)
-    const libraryArray = libraryStore.get('games') as GameInfo[]
+    const libraryArray = libraryStore.get('games', []) as GameInfo[]
     const gameObjectIndex = libraryArray.findIndex(
       (value) => value.app_name === appName
     )
@@ -219,7 +219,7 @@ export class GOGLibrary {
    */
   public refreshInstalled() {
     const installedArray =
-      (installedGamesStore.get('installed') as Array<InstalledInfo>) || []
+      (installedGamesStore.get('installed', []) as Array<InstalledInfo>) || []
     this.installedGames.clear()
     installedArray.forEach((value) => {
       this.installedGames.set(value.appName, value)
@@ -230,7 +230,7 @@ export class GOGLibrary {
     const cachedGameData = this.library.get(appName)
 
     const installedArray =
-      (installedGamesStore.get('installed') as Array<InstalledInfo>) || []
+      (installedGamesStore.get('installed', []) as Array<InstalledInfo>) || []
 
     const gameIndex = installedArray.findIndex(
       (value) => value.appName === appName
@@ -488,18 +488,25 @@ export class GOGLibrary {
       logInfo(`Loading playTask data from ${infoFilePath}`, LogPrefix.Backend)
       const fileData = readFileSync(infoFilePath, { encoding: 'utf-8' })
 
-      const jsonData = JSON.parse(fileData)
-      const playTasks = jsonData.playTasks
+      try {
+        const jsonData = JSON.parse(fileData)
+        const playTasks = jsonData.playTasks
 
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      const primary = playTasks.find((value: any) => value?.isPrimary)
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const primary = playTasks.find((value: any) => value?.isPrimary)
 
-      const workingDir = primary?.workingDir
+        const workingDir = primary?.workingDir
 
-      if (workingDir) {
-        return join(workingDir, primary.path)
+        if (workingDir) {
+          return join(workingDir, primary.path)
+        }
+        return primary.path
+      } catch (error) {
+        logError(
+          `Error reading ${fileData}, could not complete operation`,
+          LogPrefix.Gog
+        )
       }
-      return primary.path
     }
 
     return ''

electron/gog/user.ts

@@ -2,6 +2,7 @@ import axios from 'axios'
 import { logError, logInfo, LogPrefix, logWarning } from '../logger/logger'
 import { GOGLoginData } from '../types'
 import { configStore, libraryStore } from '../gog/electronStores'
+import { errorHandler } from '../utils'
 
 const gogAuthenticateUrl =
   'https://auth.gog.com/token?client_id=46899977096215655&client_secret=9d85c43b1482497dbbce61f6e4aa173a433796eeae2ca8c5f6129f2dc4de46d9&grant_type=authorization_code&redirect_uri=https%3A%2F%2Fembed.gog.com%2Fon_login_success%3Forigin%3Dclient&code='
@@ -72,14 +73,17 @@ export class GOGUser {
       return this.refreshToken()
     }
 
-    return configStore.get('credentials') as GOGLoginData
+    return configStore.get('credentials', {}) as GOGLoginData
   }
 
   /**
    * Refreshes token and returns new credentials
    */
   public static async refreshToken(): Promise<GOGLoginData | null> {
-    const user: GOGLoginData = configStore.get('credentials') as GOGLoginData
+    const user: GOGLoginData = configStore.get(
+      'credentials',
+      {}
+    ) as GOGLoginData
     logInfo('Refreshing access_token', LogPrefix.Gog)
     if (user) {
       const response = await axios
@@ -103,12 +107,19 @@ export class GOGUser {
       return data
     } else {
       logError('No credentials, auth required', LogPrefix.Gog)
+      errorHandler({
+        error: 'No credentials',
+        runner: 'GOG'
+      })
       return null
     }
   }
 
   public static isTokenExpired() {
-    const user: GOGLoginData = configStore.get('credentials') as GOGLoginData
+    const user: GOGLoginData = configStore.get(
+      'credentials',
+      null
+    ) as GOGLoginData
     if (!user) {
       return true
     }