Skip to content

Commit 8647975

Browse files
committed
fix(desktop): block recovery until installer termination is confirmed
1 parent 5309f26 commit 8647975

4 files changed

Lines changed: 118 additions & 32 deletions

File tree

‎apps/desktop/src/electron/ElectronUpdater.test.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,13 @@ describe("ElectronUpdater install handoff", () => {
217217
fiber.pollUnsafe(),
218218
"a missing exit event cannot block cleanup forever",
219219
);
220+
const result = fiber.pollUnsafe();
221+
assert.equal(result?._tag, "Failure");
222+
if (result?._tag === "Failure") {
223+
const error = ElectronUpdater.findUnconfirmedInstallerCleanup(result.cause);
224+
assert.equal(error?.terminationConfirmed, false);
225+
assert.include(error?.message ?? "", "recovery");
226+
}
220227
}
221228
yield* Fiber.join(stopping!);
222229
assert.equal(child.stdout.destroy.mock.calls.length, 1);

‎apps/desktop/src/electron/ElectronUpdater.ts‎

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import * as Context from "effect/Context";
2+
import * as Cause from "effect/Cause";
23
import * as Effect from "effect/Effect";
34
import * as Layer from "effect/Layer";
45
import * as Schema from "effect/Schema";
@@ -51,14 +52,30 @@ export class ElectronUpdaterQuitAndInstallError extends Schema.TaggedError<Elect
5152
isSilent: Schema.Boolean,
5253
isForceRunAfter: Schema.Boolean,
5354
stage: Schema.optionalKey(Schema.Literals(["validation", "handoff", "shutdown"])),
55+
terminationConfirmed: Schema.optionalKey(Schema.Boolean),
5456
cause: Schema.Defect(),
5557
},
5658
) {
5759
override get message(): string {
60+
if (this.terminationConfirmed === false)
61+
return "External update installer termination is unconfirmed. Manual recovery is required.";
5862
return `Electron updater failed to quit and install the update on channel ${this.channel ?? "default"} (silent: ${this.isSilent}, force run after: ${this.isForceRunAfter}).`;
5963
}
6064
}
6165

66+
const isQuitAndInstallError = Schema.is(ElectronUpdaterQuitAndInstallError);
67+
68+
export const findUnconfirmedInstallerCleanup = (
69+
cause: Cause.Cause<unknown>,
70+
): ElectronUpdaterQuitAndInstallError | undefined => {
71+
for (const reason of cause.reasons) {
72+
const error =
73+
reason._tag === "Die" ? reason.defect : reason._tag === "Fail" ? reason.error : undefined;
74+
if (isQuitAndInstallError(error) && error.terminationConfirmed === false) return error;
75+
}
76+
return undefined;
77+
};
78+
6279
export const ElectronUpdaterError = Schema.Union([
6380
ElectronUpdaterCheckForUpdatesError,
6481
ElectronUpdaterDownloadUpdateError,
@@ -181,13 +198,14 @@ export const make = Effect.gen(function* () {
181198
let closed: Promise<void> | undefined;
182199
let committed = false;
183200
let ownedStage: string | undefined;
184-
const installError = (cause: unknown) =>
201+
const installError = (cause: unknown, terminationConfirmed?: boolean) =>
185202
new ElectronUpdaterQuitAndInstallError({
186203
channel,
187204
isSilent,
188205
isForceRunAfter,
189206
stage,
190207
cause,
208+
...(terminationConfirmed === undefined ? {} : { terminationConfirmed }),
191209
});
192210
return Effect.gen(function* () {
193211
if (installer === undefined) {
@@ -301,7 +319,7 @@ export const make = Effect.gen(function* () {
301319
throw cause;
302320
}
303321
},
304-
catch: installError,
322+
catch: (cause) => installError(cause, false),
305323
});
306324
yield* signalGroup("SIGTERM");
307325
const stopped = yield* Effect.promise(() => closed!).pipe(
@@ -311,7 +329,7 @@ export const make = Effect.gen(function* () {
311329
yield* signalGroup("SIGKILL");
312330
yield* Effect.promise(() => exited!).pipe(
313331
Effect.timeout("5 seconds"),
314-
Effect.mapError(installError),
332+
Effect.mapError((cause) => installError(cause, false)),
315333
);
316334
}
317335
}

‎apps/desktop/src/updates/DesktopUpdateInstall.ts‎

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import * as ElectronUpdater from "../electron/ElectronUpdater.ts";
12
import * as Cause from "effect/Cause";
23
import * as Effect from "effect/Effect";
34
import * as Exit from "effect/Exit";
@@ -39,6 +40,7 @@ export const makeUpdateInstall = Effect.fn("desktop.updates.makeInstall")(functi
3940
const installRunningBackendsRef = yield* Ref.make<
4041
ReadonlyArray<DesktopBackendPool.DesktopBackendInstance>
4142
>([]);
43+
const installCleanupBlockedRef = yield* Ref.make(false);
4244
const resetInstallAction = Effect.all(
4345
[
4446
finishUpdateAction("install"),
@@ -53,6 +55,7 @@ export const makeUpdateInstall = Effect.fn("desktop.updates.makeInstall")(functi
5355
const recoverFailedInstall = Effect.fn("desktop.updates.recoverFailedInstall")(function* (
5456
message: string,
5557
) {
58+
if (yield* Ref.get(installCleanupBlockedRef)) return;
5659
const ownsRecovery = yield* Ref.modify(activeUpdateActionRef, (activeAction) =>
5760
Option.isSome(activeAction) && activeAction.value === "install"
5861
? ([true, Option.some<UpdateAction>("install-recovery")] as const)
@@ -99,6 +102,7 @@ export const makeUpdateInstall = Effect.fn("desktop.updates.makeInstall")(functi
99102
(expectedVersion === undefined || state.downloadedVersion === expectedVersion);
100103
if (
101104
(yield* Ref.get(desktopState.quitting)) ||
105+
(yield* Ref.get(installCleanupBlockedRef)) ||
102106
!(yield* Ref.get(updaterConfiguredRef)) ||
103107
!hasExpectedDownload
104108
) {
@@ -158,6 +162,27 @@ export const makeUpdateInstall = Effect.fn("desktop.updates.makeInstall")(functi
158162
});
159163
return { accepted: true, completed: false, failed: false };
160164
}).pipe(
165+
Effect.catchCause((cause) =>
166+
Effect.gen(function* () {
167+
const error = ElectronUpdater.findUnconfirmedInstallerCleanup(cause);
168+
if (error === undefined) return yield* Effect.failCause(cause);
169+
yield* Ref.set(installCleanupBlockedRef, true);
170+
yield* Ref.set(desktopState.quitting, false);
171+
yield* updateState((current) => ({
172+
...current,
173+
status: "error",
174+
message: error.message,
175+
errorContext: "install",
176+
canRetry: false,
177+
}));
178+
yield* logUpdaterError(error.message, {
179+
errorTag: error._tag,
180+
cause: describeUpdateErrorCause(error.cause),
181+
terminationConfirmed: false,
182+
});
183+
return { accepted: true, completed: false, failed: true };
184+
}).pipe(Effect.uninterruptible),
185+
),
161186
Effect.catchTags({
162187
ElectronUpdaterQuitAndInstallError: Effect.fn("desktop.updates.handleInstallFailure")(
163188
function* (error) {
@@ -173,7 +198,11 @@ export const makeUpdateInstall = Effect.fn("desktop.updates.makeInstall")(functi
173198
},
174199
),
175200
}),
176-
Effect.onInterrupt(() => resetInstallAction),
201+
Effect.onInterrupt(() =>
202+
Ref.get(installCleanupBlockedRef).pipe(
203+
Effect.flatMap((blocked) => (blocked ? Effect.void : resetInstallAction)),
204+
),
205+
),
177206
Effect.catchCause((cause) =>
178207
Effect.gen(function* () {
179208
if (Cause.hasInterruptsOnly(cause)) {

‎apps/desktop/src/updates/DesktopUpdatesInstallFailure.test.ts‎

Lines changed: 60 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -14,35 +14,67 @@ import * as DesktopUpdates from "./DesktopUpdates.ts";
1414
import { flushCallbacks, makeHarness } from "./updatesTestHarness.ts";
1515

1616
describe("DesktopUpdates", () => {
17-
it.effect("keeps windows and restarts backends when quitAndInstall fails", () => {
18-
const harness = makeHarness({
19-
quitAndInstall: Effect.fail(
20-
new ElectronUpdater.ElectronUpdaterQuitAndInstallError({
21-
channel: "latest",
22-
isSilent: true,
23-
isForceRunAfter: true,
24-
cause: new Error("installer refused"),
17+
it.effect.each(["ordinary", "confirmed", "unconfirmed", "mixed", "interrupted"] as const)(
18+
"handles %s installer termination without unsafe recovery",
19+
(mode) => {
20+
const unsafe = !["ordinary", "confirmed"].includes(mode);
21+
const ordinary = new ElectronUpdater.ElectronUpdaterQuitAndInstallError({
22+
channel: "latest",
23+
isSilent: true,
24+
isForceRunAfter: true,
25+
cause: new Error("installer refused"),
26+
});
27+
const error = new ElectronUpdater.ElectronUpdaterQuitAndInstallError({
28+
channel: "latest",
29+
isSilent: true,
30+
isForceRunAfter: true,
31+
terminationConfirmed: !unsafe,
32+
cause: new Error("helper exit unconfirmed"),
33+
});
34+
const failure =
35+
mode === "ordinary"
36+
? Effect.fail(ordinary)
37+
: mode === "confirmed"
38+
? Effect.fail(error)
39+
: mode === "unconfirmed"
40+
? Effect.die(error)
41+
: (mode === "mixed" ? Effect.fail(ordinary) : Effect.interrupt).pipe(
42+
Effect.ensuring(Effect.die(error)),
43+
);
44+
const harness = makeHarness({ quitAndInstall: failure });
45+
return Effect.scoped(
46+
Effect.gen(function* () {
47+
const desktopState = yield* DesktopState.DesktopState;
48+
const updates = yield* DesktopUpdates.DesktopUpdates;
49+
yield* updates.configure;
50+
harness.emit("update-downloaded", { version: "1.2.4" });
51+
yield* flushCallbacks;
52+
const result = yield* updates.install;
53+
assert.isTrue(result.accepted);
54+
assert.isFalse(yield* Ref.get(desktopState.quitting));
55+
assert.deepEqual(
56+
harness.installSteps,
57+
unsafe ? ["quitAndInstall"] : ["quitAndInstall", "startBackend"],
58+
);
59+
assert.equal(harness.updateRestartMarkers.size, unsafe ? 1 : 0);
60+
assert.equal(harness.installRecords.size, unsafe ? 1 : 0);
61+
if (unsafe) {
62+
const state = yield* updates.getState;
63+
assert.equal(state.status, "error");
64+
assert.equal(state.canRetry, false);
65+
assert.include(state.message ?? "", "recovery");
66+
harness.emit("error", new Error("late updater error"));
67+
yield* flushCallbacks;
68+
assert.isFalse((yield* updates.install).accepted);
69+
assert.equal(harness.quitAndInstalls(), 1);
70+
assert.deepEqual(harness.installSteps, ["quitAndInstall"]);
71+
assert.equal(harness.updateRestartMarkers.size, 1);
72+
assert.equal(harness.installRecords.size, 1);
73+
}
2574
}),
26-
),
27-
});
28-
29-
return Effect.scoped(
30-
Effect.gen(function* () {
31-
const desktopState = yield* DesktopState.DesktopState;
32-
const updates = yield* DesktopUpdates.DesktopUpdates;
33-
yield* updates.configure;
34-
harness.emit("update-downloaded", { version: "1.2.4" });
35-
yield* flushCallbacks;
36-
37-
const result = yield* updates.install;
38-
assert.isTrue(result.accepted);
39-
assert.isFalse(yield* Ref.get(desktopState.quitting));
40-
assert.deepEqual(harness.installSteps, ["quitAndInstall", "startBackend"]);
41-
assert.equal(harness.updateRestartMarkers.size, 0);
42-
assert.equal(harness.installRecords.size, 0);
43-
}),
44-
).pipe(Effect.provide(Layer.merge(TestClock.layer(), harness.layer)));
45-
});
75+
).pipe(Effect.provide(Layer.merge(TestClock.layer(), harness.layer)));
76+
},
77+
);
4678

4779
it.effect("keeps the disabled primary stopped when quitAndInstall fails", () => {
4880
const harness = makeHarness({

0 commit comments

Comments
 (0)