-
Notifications
You must be signed in to change notification settings - Fork 89
feat(update): in-place updates on Windows, macOS and Linux #358
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
ec27142
feat(update): in-place updates on Windows, macOS and Linux
EtienneLescot 8408220
fix(update): distinguish a failed download from a failed check
EtienneLescot e3f061b
fix(update): apply the updater settings on every call
EtienneLescot 42c9587
chore(nix): refresh npmDepsHash for electron-updater
EtienneLescot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,158 @@ | ||
| import { beforeEach, describe, expect, it, vi } from "vitest"; | ||
| import { | ||
| blockedFromInstalling, | ||
| checkForSelfUpdate, | ||
| downloadSelfUpdate, | ||
| type InstallReadiness, | ||
| installSelfUpdate, | ||
| } from "./auto-updater"; | ||
|
|
||
| const mocks = vi.hoisted(() => ({ | ||
| // Deliberately initialised to electron-updater's DEFAULTS, so a test asserting they are | ||
| // false proves our configuration ran rather than reading a value that was never touched. | ||
| autoUpdater: { | ||
| autoDownload: true, | ||
| autoInstallOnAppQuit: true, | ||
| logger: {} as unknown, | ||
| checkForUpdates: vi.fn(), | ||
| downloadUpdate: vi.fn(), | ||
| quitAndInstall: vi.fn(), | ||
| }, | ||
| app: { isPackaged: true, getVersion: vi.fn(() => "1.9.2") }, | ||
| })); | ||
|
|
||
| vi.mock("electron", () => ({ app: mocks.app })); | ||
| vi.mock("electron-updater", () => ({ autoUpdater: mocks.autoUpdater })); | ||
|
|
||
| function state(overrides: Partial<InstallReadiness> = {}): InstallReadiness { | ||
| return { recording: false, inApplicationsFolder: true, platform: "linux", ...overrides }; | ||
| } | ||
|
|
||
| describe("blockedFromInstalling", () => { | ||
| it("allows an install when nothing is in the way", () => { | ||
| for (const platform of ["win32", "darwin", "linux"] as const) { | ||
| expect(blockedFromInstalling(state({ platform }))).toBeNull(); | ||
| } | ||
| }); | ||
|
|
||
| // Quitting mid-recording loses the take. On Windows it is worse than losing it: the capture | ||
| // helpers spawn from inside the install directory, and NSIS cannot overwrite a running .exe. | ||
| it("refuses while a recording is in progress, on every platform", () => { | ||
| for (const platform of ["win32", "darwin", "linux"] as const) { | ||
| expect(blockedFromInstalling(state({ platform, recording: true }))).toBe("recording"); | ||
| } | ||
| }); | ||
|
|
||
| // App Translocation: a quarantined app runs from a read-only image where Squirrel cannot | ||
| // replace the bundle. Pinned per-platform because CI is Linux-only and an unpinned branch | ||
| // would be green here and wrong on the one platform it applies to. | ||
| it("refuses a macOS install running outside /Applications", () => { | ||
| expect(blockedFromInstalling(state({ platform: "darwin", inApplicationsFolder: false }))).toBe( | ||
| "not-in-applications", | ||
| ); | ||
| }); | ||
|
|
||
| it("does not apply the Applications-folder rule off macOS", () => { | ||
| for (const platform of ["win32", "linux"] as const) { | ||
| expect(blockedFromInstalling(state({ platform, inApplicationsFolder: false }))).toBeNull(); | ||
| } | ||
| }); | ||
|
|
||
| it("reports the recording veto first when both apply", () => { | ||
| expect( | ||
| blockedFromInstalling( | ||
| state({ platform: "darwin", recording: true, inApplicationsFolder: false }), | ||
| ), | ||
| ).toBe("recording"); | ||
| }); | ||
| }); | ||
|
|
||
| describe("self-update flow", () => { | ||
| beforeEach(() => { | ||
| mocks.app.isPackaged = true; | ||
| // Back to electron-updater's DEFAULTS before every test, so "these are false" can only | ||
| // pass because this test's call configured them — not because an earlier test did. | ||
| mocks.autoUpdater.autoDownload = true; | ||
| mocks.autoUpdater.autoInstallOnAppQuit = true; | ||
| mocks.autoUpdater.checkForUpdates.mockReset(); | ||
| mocks.autoUpdater.downloadUpdate.mockReset(); | ||
| mocks.autoUpdater.quitAndInstall.mockReset(); | ||
| }); | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
|
|
||
| it("never touches the updater on a channel a package manager owns", async () => { | ||
| for (const channel of ["store", "flatpak", "snap", "nix"] as const) { | ||
| await expect(checkForSelfUpdate(channel)).resolves.toEqual({ kind: "unsupported" }); | ||
| } | ||
| expect(mocks.autoUpdater.checkForUpdates).not.toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| it("refuses to self-update an unpacked build", async () => { | ||
| mocks.app.isPackaged = false; | ||
| await expect(checkForSelfUpdate("nsis")).resolves.toEqual({ kind: "unsupported" }); | ||
| expect(mocks.autoUpdater.checkForUpdates).not.toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| // These three settings are the difference between an update and a lost recording, and each | ||
| // looks like harmless boilerplate to delete. `window-all-closed` quits this app and the HUD | ||
| // is a window, so the stock autoInstallOnAppQuit would fire a ~243 MB installer when the | ||
| // user merely closed the HUD. | ||
| it("disables auto-download and install-on-quit before doing anything", async () => { | ||
| // Asserted INSIDE the mock: checking after the call would still pass if the settings | ||
| // were applied late, and "late" is the whole failure — a check that starts downloading | ||
| // before autoDownload is turned off has already pulled ~243 MB the user never asked for. | ||
| const settingsWhenChecked: Array<boolean> = []; | ||
| mocks.autoUpdater.checkForUpdates.mockImplementation(() => { | ||
| settingsWhenChecked.push( | ||
| mocks.autoUpdater.autoDownload, | ||
| mocks.autoUpdater.autoInstallOnAppQuit, | ||
| ); | ||
| return Promise.resolve({ updateInfo: { version: "1.9.2" } }); | ||
| }); | ||
|
|
||
| await checkForSelfUpdate("nsis"); | ||
|
|
||
| expect(settingsWhenChecked).toEqual([false, false]); | ||
| }); | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
|
|
||
| it("reports current when the feed offers the running version", async () => { | ||
| mocks.autoUpdater.checkForUpdates.mockResolvedValue({ updateInfo: { version: "1.9.2" } }); | ||
| await expect(checkForSelfUpdate("appimage")).resolves.toEqual({ kind: "current" }); | ||
| }); | ||
|
|
||
| it("reports current when no feed resolves, rather than claiming an update", async () => { | ||
| mocks.autoUpdater.checkForUpdates.mockResolvedValue(null); | ||
| await expect(checkForSelfUpdate("deb")).resolves.toEqual({ kind: "current" }); | ||
| }); | ||
|
|
||
| it("surfaces an available version", async () => { | ||
| mocks.autoUpdater.checkForUpdates.mockResolvedValue({ updateInfo: { version: "1.10.0" } }); | ||
| await expect(checkForSelfUpdate("dmg")).resolves.toEqual({ | ||
| kind: "downloaded", | ||
| version: "1.10.0", | ||
| }); | ||
| }); | ||
|
|
||
| // A release published before the update feeds existed has no latest*.yml. That must degrade | ||
| // to the release-page fallback, not throw into main-process-errors, which re-throws. | ||
| it("reports a missing or broken feed as failed instead of throwing", async () => { | ||
| mocks.autoUpdater.checkForUpdates.mockRejectedValue(new Error("404 latest.yml")); | ||
| const result = await checkForSelfUpdate("nsis"); | ||
| expect(result.kind).toBe("failed"); | ||
| expect(result).toMatchObject({ error: { message: "404 latest.yml" } }); | ||
| }); | ||
|
|
||
| it("reports a failed download instead of throwing", async () => { | ||
| mocks.autoUpdater.downloadUpdate.mockRejectedValue(new Error("connection reset")); | ||
| const result = await downloadSelfUpdate(); | ||
| expect(result.kind).toBe("failed"); | ||
| expect(result).toMatchObject({ error: { message: "connection reset" } }); | ||
| }); | ||
|
|
||
| // isSilent=false so a per-machine Windows install can show its UAC prompt — a silent upgrade | ||
| // of a Program Files install hits elevation and, if dismissed, quits having done nothing. | ||
| // isForceRunAfter=true so the app comes back. | ||
| it("hands over to the installer non-silently and relaunches", async () => { | ||
| await installSelfUpdate(); | ||
| expect(mocks.autoUpdater.quitAndInstall).toHaveBeenCalledWith(false, true); | ||
| }); | ||
| }); | ||
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.