[FEAT] Improve and Fix Auto-Update on Windows and macOS #1217
+235
−28
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
flavioislima
requested review from
jiyuu-jin,
BrettCleary,
eliobricenov,
biliesilva and
ry-animal
ry-animal
approved these changes
Jan 22, 2025
jiyuu-jin
approved these changes
Jan 22, 2025
eliobricenov
approved these changes
Jan 22, 2025
BrettCleary
approved these changes
Jan 22, 2025
flavioislima
added
PR: Ready-For-Test
flavioislima
force-pushed
the
feat/retry_auto_update
branch
from
4929a43 to
995f8d7
Compare
ry-animal
approved these changes
Jan 22, 2025
nyghtstalker
approved these changes
Jan 29, 2025
…desktop-client into feat/retry_auto_update
…client into feat/retry_auto_update
flavioislima
changed the title
flavioislima
requested review from
BrettCleary,
nyghtstalker,
biliesilva and
ry-animal
flavioislima
added
PR: Ready-For-Review
flavioislima
commented
Feb 21, 2025
flavioislima
added
PR: Ready-For-Test
nyghtstalker
approved these changes
Feb 25, 2025
There was a problem hiding this comment.
Windows
- After using the artifact I confirmed that after interrupting the update by disconnecting the internet it will have ten attempts and then give this error. Once the internet is restored it will attempt again after three hours and update as normal.
Mac
- After using the release draft created I confirmed that when the user selects YES to restarting after the update the client will relaunch with the update applied. If NO is selected then no update is applied.
BrettCleary
approved these changes
Feb 26, 2025
| 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 |
There was a problem hiding this comment.
if this app setting is false, HyperPlay will never update?
There was a problem hiding this comment.
Yes, it will never check for updates on Startup. This is an old setting.
…desktop-client into feat/retry_auto_update
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes several changes aimed at improving the update process, error handling, and code organization. The most important changes include adding detailed error messages for update failures, renaming and restructuring files for better organization, and implementing a mechanism to retry updates and clear cached updates.
It should also fix all the false positives on the tracking mechanism that was sending error messages even if the app was on last version and not updating but only reaching the servers (more info on the ticket)
Improvements to error handling:
public/locales/en/translation.json: Added detailed error messages for various update failure scenarios to provide better guidance to users.src/backend/updater/utils.ts: Implemented a function to remove cached updates folder and defined common download errors with corresponding messages.Enhancements to update process:
src/backend/updater/updater.ts: Introduced retry logic for update attempts, limited to a maximum of 10 retries, and added logging for each retry attempt. [1] [2] [3]Code organization and restructuring:
src/backend/updater/updater.ts: Renamed and moved the file fromsrc/backend/updater.tstosrc/backend/updater/updater.tsfor better organization.src/backend/main.ts: Updated import path forisClientUpdatingto reflect the new file structure.Configuration changes:
electron-builder.yml: AddedverifyUpdateCodeSignature: falseunder thewinsection to facilitate local testing of updates on Windows.HOW TO TEST
https://app.qase.io/project/HC?case=567&suite=175
https://app.qase.io/project/HC?case=568&suite=175
https://app.qase.io/project/HC?case=570&suite=175
Use the following Checklist if you have changed something on the Backend or Frontend: