[FEAT] Improve and Fix Auto-Update on Windows and macOS (#1217)

flavioislima · web-flow · commit 3bbff39f2669 · 2025-02-27T17:56:29.000Z
* [FEAT] Add retry for auto updates

* chore: comments

* test only: revert after test

* chore: lowered version for testing

* i18n: updated error message

* feat: improve update logic and error messages

* feat: increase maximum update attempts and improve error handling logic

* feat: For test only: disable update code signature verification on windows

* chore: move updater to its own folder and create utils file

* fix: pr comments and test settings

* feat: add tracking for client update download start event

* fix: remove redundant name field from electron-builder configuration

---------

Co-authored-by: Flavio F Lima &lt;flavioislima@users.noreply.github.com&gt;
diff --git a/public/locales/en/translation.json b/public/locales/en/translation.json
@@ -88,8 +88,25 @@
                 "title": "Ubisoft Connect"
             },
             "update": {
-                "message": "Something went wrong with the update! Please manually uninstall and reinstall HyperPlay.",
-                "title": "Update Error"
+                "addressUnreachable": "Address unreachable. Please check your internet connection.",
+                "body": "Something went wrong with the update after multiple attempts! Please check the error message below or reinstall HyperPlay. error: {{error}}",
+                "certAuthorityInvalid": "Certificate authority invalid. Please check your system time and date or open a ticket with HyperPlay support.",
+                "certDateInvalid": "Certificate date invalid. Please check your system time and date or open a ticket with HyperPlay support.",
+                "connectionAborted": "Connection aborted. Please check your internet connection.",
+                "connectionClosed": "Connection closed. Please check your internet connection.",
+                "connectionRefused": "Connection refused. Please check your internet connection.",
+                "connectionReset": "Connection reset. Please check your internet connection.",
+                "connectionTimedOut": "Connection timed out. Please check your internet connection.",
+                "emptyResponse": "Empty response. Please check your internet connection.",
+                "failed": "Download Failed. Please check your internet connection.",
+                "http2ServerRefusedStream": "HTTP2 server refused stream. Please check your internet connection.",
+                "internetDisconnected": "Internet disconnected. Please check your internet connection.",
+                "message": "Error Updating",
+                "nameNotResolved": "Name not resolved. Please check your internet connection.",
+                "networkAccessDenied": "Network access denied. Please check your internet connection.",
+                "networkChanged": "Network changed. Please check your internet connection.",
+                "proxyConnectionFailed": "Proxy connection failed. Please check your proxy settings.",
+                "sslProtocolError": "SSL protocol error. Please check your system time and date or open a ticket with HyperPlay support."
             },
             "winetricks": {
                 "message": "Winetricks returned the following error during execution:{{newLine}}{{error}}",
diff --git a/src/backend/main.ts b/src/backend/main.ts
@@ -151,7 +151,7 @@ import {
   checkWineBeforeLaunch,
   runWineCommandOnGame
 } from './utils/compatibility_layers'
-import { isClientUpdating } from 'backend/updater'
+import { isClientUpdating } from 'backend/updater/updater'
 
 /*
  * INSERT OTHER IPC HANDLERS HERE
diff --git a/src/backend/metrics/types.ts b/src/backend/metrics/types.ts
@@ -399,6 +399,15 @@ export interface ClientUpdateNotified {
   sensitiveProperties?: never
 }
 
+export interface ClientUpdateDownloading {
+  event: 'Downloading Client Update'
+  properties: {
+    currentVersion: string
+    newVersion: string
+  }
+  sensitiveProperties?: never
+}
+
 export interface ClientUpdateError {
   event: 'Client Update Error'
   properties: {
@@ -460,6 +469,7 @@ export type PossibleMetricPayloads =
   | RewardClaimSuccess
   | RewardClaimError
   | ClientUpdateNotified
+  | ClientUpdateDownloading
   | ClientUpdateError
   | ClientUpdateDownloaded
   | PatchingStarted
diff --git a/src/backend/updater/updater.ts b/src/backend/updater/updater.ts
@@ -1,16 +1,16 @@
-import { dialog, shell } from 'electron'
+import { app, dialog, shell } from 'electron'
 import { autoUpdater } from 'electron-updater'
 import { t } from 'i18next'
 
-import { configStore, icon, isLinux } from './constants'
-import { logError, logInfo, LogPrefix } from './logger/logger'
-import { isOnline } from './online_monitor'
+import { configStore, icon, isLinux } from '../constants'
+import { logError, logInfo, LogPrefix } from '../logger/logger'
 import { captureException } from '@sentry/electron'
-import { getFileSize } from './utils'
+import { getFileSize } from '../utils'
 import { ClientUpdateStatuses } from '@hyperplay/utils'
-import { trackEvent } from './metrics/metrics'
-// to test auto update on windows locally make sure you added the option "verifyUpdateCodeSignature": false
-// under build.win in package.json and also change the app version to an old one there
+import { trackEvent } from '../metrics/metrics'
+import { getErrorMessage, removeCachedUpdatesFolder } from './utils'
+// to test auto update on windows locally make sure you added the option verifyUpdateCodeSignature: false
+// under build.win in electron-builder.yml and also change the app version to an old one there
 
 const appSettings = configStore.get_nodefault('settings')
 const shouldCheckForUpdates = appSettings?.checkForUpdatesOnStartup === true
@@ -21,17 +21,35 @@ autoUpdater.autoInstallOnAppQuit = true
 
 let isAppUpdating = false
 let hasUpdated = false
+let hasReportedDownloadStart = false
 
-// check for updates every hour
-const checkUpdateInterval = 1 * 60 * 60 * 1000
-setInterval(() => {
-  if (isOnline() && shouldCheckForUpdates) {
-    autoUpdater.checkForUpdates()
+let updateAttempts = 0
+const MAX_UPDATE_ATTEMPTS = 10
+// check for updates every 3 hours
+const checkUpdateInterval = 3 * 1000 * 60 * 60
+
+setInterval(async () => {
+  if (shouldCheckForUpdates && !hasUpdated && !isAppUpdating) {
+    logInfo('Checking for client updates...', LogPrefix.AutoUpdater)
+    await autoUpdater.checkForUpdates()
   }
 }, checkUpdateInterval)
 
 autoUpdater.on('update-available', async (info) => {
-  if (!isOnline() || !shouldCheckForUpdates) {
+  if (isAppUpdating && hasUpdated) {
+    logInfo(
+      'New update available, but user has already updated the app',
+      LogPrefix.AutoUpdater
+    )
+    return
+  }
+
+  if (!shouldCheckForUpdates) {
+    logInfo(
+      'New update available, but user has disabled auto updates',
+      LogPrefix.AutoUpdater
+    )
+
     return
   }
   newVersion = info.version
@@ -56,6 +74,19 @@ autoUpdater.on('update-available', async (info) => {
 // log download progress
 autoUpdater.on('download-progress', (progress) => {
   isAppUpdating = true
+
+  // Track download start only once
+  if (!hasReportedDownloadStart) {
+    trackEvent({
+      event: 'Downloading Client Update',
+      properties: {
+        currentVersion: autoUpdater.currentVersion.version,
+        newVersion
+      }
+    })
+    hasReportedDownloadStart = true
+  }
+
   logInfo(
     'Downloading HyperPlay update...' +
       `Download speed: ${progress.bytesPerSecond}, ` +
@@ -68,7 +99,10 @@ autoUpdater.on('download-progress', (progress) => {
 })
 
 autoUpdater.on('update-downloaded', async () => {
-  logInfo('App update is downloaded')
+  logInfo('The App update was downloaded', LogPrefix.AutoUpdater)
+  hasUpdated = true
+  isAppUpdating = false
+  hasReportedDownloadStart = false // Reset for potential future updates
 
   trackEvent({
     event: 'Client Update Downloaded',
@@ -91,16 +125,38 @@ autoUpdater.on('update-downloaded', async () => {
   if (response === 1) {
     return autoUpdater.quitAndInstall()
   }
-  hasUpdated = true
+  logInfo('User chose not to update the app for now.', LogPrefix.AutoUpdater)
 })
 
 autoUpdater.on('error', async (error) => {
-  if (!isOnline()) {
+  isAppUpdating = false
+  const isNewVersion = newVersion !== app.getVersion()
+
+  // To avoid false positives, we should not show the error dialog if the app has already updated successfully
+  if (hasUpdated || !isNewVersion) {
     return
   }
 
-  isAppUpdating = false
-  logError(`Error updating HyperPlay: ${error.message}`, LogPrefix.AutoUpdater)
+  const errorMessage = getErrorMessage(error.message)
+  logError(`Error updating HyperPlay: ${errorMessage}`, LogPrefix.AutoUpdater)
+
+  // will remove cached updates when it fails to avoid corrupted updates
+  if (updateAttempts > 3) {
+    await removeCachedUpdatesFolder()
+  }
+
+  updateAttempts++
+
+  if (updateAttempts < MAX_UPDATE_ATTEMPTS) {
+    logInfo(
+      `Retrying update attempt ${updateAttempts + 1}/${MAX_UPDATE_ATTEMPTS}`,
+      LogPrefix.AutoUpdater
+    )
+    setTimeout(() => {
+      autoUpdater.checkForUpdates()
+    }, 6000)
+    return
+  }
 
   trackEvent({
     event: 'Client Update Error',
@@ -115,17 +171,19 @@ autoUpdater.on('error', async (error) => {
     tags: {
       event: 'Client Update Error',
       currentVersion: autoUpdater.currentVersion.version,
-      newVersion
+      newVersion,
+      totalAttempts: MAX_UPDATE_ATTEMPTS
     }
   })
 
+  updateAttempts = 0
+
   const { response } = await dialog.showMessageBox({
-    title: t('box.error.update.title', 'Error Updating'),
+    title: t('box.error.update.message', 'Error Updating'),
     message: t(
-      'box.error.update.message',
-      `Something went wrong with the update after multiple attempts! Please manually uninstall and reinstall HyperPlay. error: ${JSON.stringify(
-        error
-      )}`
+      'box.error.update.body',
+      `Something went wrong with the update after multiple attempts! Please check the error message below or reinstall HyperPlay. error: {{error}}`,
+      { error: errorMessage }
     ),
     type: 'error',
     buttons: [t('button.cancel', 'Cancel'), t('button.download', 'Download')]
diff --git a/src/backend/updater/utils.ts b/src/backend/updater/utils.ts
@@ -0,0 +1,122 @@
+import { isMac } from 'backend/constants'
+import { logError, LogPrefix } from 'backend/logger/logger'
+import { rm } from 'fs/promises'
+import { t } from 'i18next'
+import { homedir } from 'os'
+import { join } from 'path'
+
+export async function removeCachedUpdatesFolder() {
+  // remove hyperplay-updates folder from cache directory
+  // on macOS: /Users/<username>/Library/Caches/hyperplay-updates
+  // on Windows: C:\Users\<username>\AppData\Local\hyperplay-updates
+  const macOSPath = join(homedir(), 'Library', 'Caches', 'hyperplay-updates')
+  const windowsPath = join(homedir(), 'AppData', 'Local', 'hyperplay-updates')
+
+  try {
+    await rm(isMac ? macOSPath : windowsPath, { recursive: true })
+  } catch (error) {
+    logError(
+      `Error removing cached updates folder: ${error}`,
+      LogPrefix.AutoUpdater
+    )
+  }
+}
+
+const commonDownloadErrors: Record<string, () => string> = {
+  ERR_NETWORK_CHANGED: () =>
+    t(
+      'box.error.update.networkChanged',
+      'Network changed. Please check your internet connection.'
+    ),
+  ERR_INTERNET_DISCONNECTED: () =>
+    t(
+      'box.error.update.internetDisconnected',
+      'Internet disconnected. Please check your internet connection.'
+    ),
+  ERR_CONNECTION_RESET: () =>
+    t(
+      'box.error.update.connectionReset',
+      'Connection reset. Please check your internet connection.'
+    ),
+  ERR_CONNECTION_CLOSED: () =>
+    t(
+      'box.error.update.connectionClosed',
+      'Connection closed. Please check your internet connection.'
+    ),
+  ERR_CONNECTION_TIMED_OUT: () =>
+    t(
+      'box.error.update.connectionTimedOut',
+      'Connection timed out. Please check your internet connection.'
+    ),
+  ERR_NAME_NOT_RESOLVED: () =>
+    t(
+      'box.error.update.nameNotResolved',
+      'Name not resolved. Please check your internet connection.'
+    ),
+  ERR_CONNECTION_REFUSED: () =>
+    t(
+      'box.error.update.connectionRefused',
+      'Connection refused. Please check your internet connection.'
+    ),
+  ERR_SSL_PROTOCOL_ERROR: () =>
+    t(
+      'box.error.update.sslProtocolError',
+      'SSL protocol error. Please check your system time and date or open a ticket with HyperPlay support.'
+    ),
+  ERR_CERT_AUTHORITY_INVALID: () =>
+    t(
+      'box.error.update.certAuthorityInvalid',
+      'Certificate authority invalid. Please check your system time and date or open a ticket with HyperPlay support.'
+    ),
+  ERR_NETWORK_ACCESS_DENIED: () =>
+    t(
+      'box.error.update.networkAccessDenied',
+      'Network access denied. Please check your internet connection.'
+    ),
+  ERR_PROXY_CONNECTION_FAILED: () =>
+    t(
+      'box.error.update.proxyConnectionFailed',
+      'Proxy connection failed. Please check your proxy settings.'
+    ),
+  ERR_CONNECTION_ABORTED: () =>
+    t(
+      'box.error.update.connectionAborted',
+      'Connection aborted. Please check your internet connection.'
+    ),
+  ERR_ADDRESS_UNREACHABLE: () =>
+    t(
+      'box.error.update.addressUnreachable',
+      'Address unreachable. Please check your internet connection.'
+    ),
+  ERR_CERT_DATE_INVALID: () =>
+    t(
+      'box.error.update.certDateInvalid',
+      'Certificate date invalid. Please check your system time and date or open a ticket with HyperPlay support.'
+    ),
+  ERR_HTTP2_SERVER_REFUSED_STREAM: () =>
+    t(
+      'box.error.update.http2ServerRefusedStream',
+      'HTTP2 server refused stream. Please check your internet connection.'
+    ),
+  ERR_EMPTY_RESPONSE: () =>
+    t(
+      'box.error.update.emptyResponse',
+      'Empty response. Please check your internet connection.'
+    ),
+  ERR_FAILED: () =>
+    t(
+      'box.error.update.failed',
+      'Download Failed. Please check your internet connection.'
+    )
+}
+
+export function getErrorMessage(error: string): string {
+  const trimmedError = error.replace('net::', '').trim()
+  if (
+    Object.prototype.hasOwnProperty.call(commonDownloadErrors, trimmedError)
+  ) {
+    return commonDownloadErrors[trimmedError]()
+  } else {
+    return error
+  }
+}
