Skip to content

Commit dd9c2f8

Browse files
fix(desktop): installing an update closes SSH port forwards before relaunch (#35018)
1 parent d6ac53e commit dd9c2f8

6 files changed

Lines changed: 45 additions & 17 deletions

File tree

‎apps/desktop/src/main.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,6 @@ const layerDesktopApplication = Layer.mergeAll(
214214
DesktopApplicationMenu.layer,
215215
DesktopLinuxUrlHandler.layer,
216216
DesktopCliCommand.layer,
217-
layerDesktopSsh,
218217
).pipe(
219218
Layer.provideMerge(layerDesktopSnapShot),
220219
Layer.provideMerge(
@@ -224,6 +223,8 @@ const layerDesktopApplication = Layer.mergeAll(
224223
Layer.provide(DesktopManagedPolicy.layer),
225224
),
226225
),
226+
// Updates closes the same tunnels the SSH IPC opens before quitAndInstall.
227+
Layer.provideMerge(layerDesktopSsh),
227228
Layer.provideMerge(layerDesktopWslBackend),
228229
Layer.provideMerge(layerDesktopLocalEnvironmentAuth),
229230
);

‎apps/desktop/src/ssh/DesktopSshEnvironment.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ export class DesktopSshEnvironment extends Context.Service<
6464
readonly disconnectEnvironment: (
6565
target: DesktopSshEnvironmentTarget,
6666
) => Effect.Effect<void, DesktopSshEnvironmentOperationError>;
67+
readonly closeAllTunnels: Effect.Effect<void>;
6768
}
6869
>()("@t3tools/desktop/ssh/DesktopSshEnvironment") {}
6970

@@ -156,6 +157,7 @@ export const make = Effect.gen(function* () {
156157
Effect.provideService(SshAuth.SshPasswordPrompt, passwordPrompt),
157158
Effect.provide(runtimeContext),
158159
),
160+
closeAllTunnels: manager.closeAllTunnels,
159161
});
160162
});
161163

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

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -655,7 +655,11 @@ describe("DesktopUpdates", () => {
655655
const result = yield* updates.install;
656656
assert.isTrue(result.accepted);
657657
assert.isFalse(yield* Ref.get(desktopState.quitting));
658-
assert.deepEqual(harness.installSteps, ["quitAndInstall", "startBackend"]);
658+
assert.deepEqual(harness.installSteps, [
659+
"closeSshTunnels",
660+
"quitAndInstall",
661+
"startBackend",
662+
]);
659663
assert.equal(harness.updateRestartMarkers.size, 0);
660664
assert.equal(harness.installRecords.size, 0);
661665
}),
@@ -685,7 +689,7 @@ describe("DesktopUpdates", () => {
685689

686690
const result = yield* updates.install;
687691
assert.equal(result.state.errorContext, "install");
688-
assert.deepEqual(harness.installSteps, ["quitAndInstall"]);
692+
assert.deepEqual(harness.installSteps, ["closeSshTunnels", "quitAndInstall"]);
689693
assert.isFalse((yield* (yield* pool.primary).snapshot).desiredRunning);
690694
}),
691695
).pipe(Effect.provide(Layer.merge(TestClock.layer(), harness.layer)));
@@ -779,7 +783,11 @@ describe("DesktopUpdates", () => {
779783
assert.equal(harness.quitAndInstalls(), 1);
780784
harness.emit("error", new Error("duplicate native installer error"));
781785
yield* flushCallbacks;
782-
assert.deepEqual(harness.installSteps, ["quitAndInstall", "startBackend"]);
786+
assert.deepEqual(harness.installSteps, [
787+
"closeSshTunnels",
788+
"quitAndInstall",
789+
"startBackend",
790+
]);
783791

784792
yield* Deferred.succeed(releaseRecovery, undefined);
785793
const failedResult = yield* Fiber.join(failedInstall);

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

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ import * as ElectronUpdater from "../electron/ElectronUpdater.ts";
3535
import * as ElectronWindow from "../electron/ElectronWindow.ts";
3636
import * as IpcChannels from "../ipc/channels.ts";
3737
import * as DesktopAppSettings from "../settings/DesktopAppSettings.ts";
38+
import * as DesktopSshEnvironment from "../ssh/DesktopSshEnvironment.ts";
3839
import * as DesktopUpdatePolicy from "./DesktopUpdatePolicy.ts";
3940
import {
4041
normalizeDesktopUpdateReleaseNotes,
@@ -369,6 +370,7 @@ function isArm64HostRunningIntelBuild(runtimeInfo: DesktopRuntimeInfo): boolean
369370
export const make = Effect.gen(function* () {
370371
const config = yield* DesktopConfig.DesktopConfig;
371372
const pool = yield* DesktopBackendPool.DesktopBackendPool;
373+
const sshEnvironment = yield* DesktopSshEnvironment.DesktopSshEnvironment;
372374
const desktopState = yield* DesktopState.DesktopState;
373375
const electronUpdater = yield* ElectronUpdater.ElectronUpdater;
374376
const electronWindow = yield* ElectronWindow.ElectronWindow;
@@ -816,17 +818,23 @@ export const make = Effect.gen(function* () {
816818
yield* writeUpdateRestartMarker;
817819
const { downloadedVersion } = yield* Ref.get(updateStateRef);
818820
if (downloadedVersion !== null) yield* writeInstallRecord(downloadedVersion);
819-
// Stop pooled backends before quitAndInstall can outrun their scope finalizers.
821+
// Stop pooled backends and SSH tunnels before quitAndInstall can outrun their scope finalizers.
820822
const instances = yield* pool.list;
821823
// stop clears desiredRunning, so retain the recovery set beforehand.
822824
const runningInstances = yield* Effect.filter(instances, (instance) =>
823825
instance.snapshot.pipe(Effect.map((snapshot) => snapshot.desiredRunning)),
824826
);
825827
yield* Ref.set(installRunningBackendsRef, runningInstances);
826-
yield* Effect.forEach(
827-
instances,
828-
(instance) =>
829-
instance.stop({ timeout: DesktopBackendManager.BACKEND_QUIT_STOP_TIMEOUT }),
828+
yield* Effect.all(
829+
[
830+
Effect.forEach(
831+
instances,
832+
(instance) =>
833+
instance.stop({ timeout: DesktopBackendManager.BACKEND_QUIT_STOP_TIMEOUT }),
834+
{ concurrency: "unbounded" },
835+
),
836+
sshEnvironment.closeAllTunnels,
837+
],
830838
{ concurrency: "unbounded" },
831839
);
832840
yield* electronUpdater.quitAndInstall({

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import * as DesktopEnvironment from "../app/DesktopEnvironment.ts";
1313
import * as ElectronUpdater from "../electron/ElectronUpdater.ts";
1414
import * as ElectronWindow from "../electron/ElectronWindow.ts";
1515
import * as DesktopAppSettings from "../settings/DesktopAppSettings.ts";
16+
import * as DesktopSshEnvironment from "../ssh/DesktopSshEnvironment.ts";
1617
import * as DesktopState from "../app/DesktopState.ts";
1718
import * as DesktopUpdatePolicy from "./DesktopUpdatePolicy.ts";
1819
import * as DesktopUpdates from "./DesktopUpdates.ts";
@@ -136,6 +137,12 @@ export function makeHarness(options: UpdatesHarnessOptions = {}) {
136137
syncAllAppearance: () => Effect.void,
137138
} satisfies ElectronWindow.ElectronWindow["Service"]);
138139

140+
const layerSshEnvironment = Layer.mock(DesktopSshEnvironment.DesktopSshEnvironment, {
141+
closeAllTunnels: Effect.sync(() => {
142+
installSteps.push("closeSshTunnels");
143+
}),
144+
});
145+
139146
let backendDesiredRunning = options.backendDesiredRunning ?? true;
140147
const stubBackendInstance: DesktopBackendPool.DesktopBackendInstance = {
141148
id: DesktopBackendPool.PRIMARY_INSTANCE_ID,
@@ -278,6 +285,7 @@ export function makeHarness(options: UpdatesHarnessOptions = {}) {
278285
Layer.provideMerge(layerUpdater),
279286
Layer.provideMerge(layerWindow),
280287
Layer.provideMerge(layerBackend),
288+
Layer.provideMerge(layerSshEnvironment),
281289
Layer.provideMerge(DesktopState.layer),
282290
Layer.provideMerge(layerSettings),
283291
Layer.provideMerge(

‎packages/ssh/src/tunnel.ts‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,8 @@ export interface SshEnvironmentManagerShape {
164164
readonly disconnectEnvironment: (
165165
target: DesktopSshEnvironmentTarget,
166166
) => Effect.Effect<void, SshEnvironmentEffectError, SshEnvironmentEffectContext>;
167+
/** Closes every tunnel, as the manager's scope finalizer does. */
168+
readonly closeAllTunnels: Effect.Effect<void>;
167169
}
168170

169171
const RemoteLaunchResult = Schema.Struct({
@@ -1521,16 +1523,15 @@ const makeSshEnvironmentManager = Effect.fn("ssh/tunnel.SshEnvironmentManager.ma
15211523
});
15221524
});
15231525

1524-
yield* Scope.addFinalizer(
1525-
managerScope,
1526-
Effect.sync(() => [...tunnels.values()]).pipe(
1527-
Effect.flatMap((entries) =>
1528-
Effect.forEach(entries, closeTunnelEntry, { concurrency: "unbounded" }),
1529-
),
1530-
Effect.ignore,
1526+
const closeAllTunnels = Effect.sync(() => [...tunnels.values()]).pipe(
1527+
Effect.flatMap((entries) =>
1528+
Effect.forEach(entries, closeTunnelEntry, { concurrency: "unbounded" }),
15311529
),
1530+
Effect.ignore,
15321531
);
15331532

1533+
yield* Scope.addFinalizer(managerScope, closeAllTunnels);
1534+
15341535
const promptForPassword = Effect.fn("ssh/tunnel.promptForPassword")(function* (
15351536
target: DesktopSshEnvironmentTarget,
15361537
attempt: number,
@@ -1920,7 +1921,7 @@ const makeSshEnvironmentManager = Effect.fn("ssh/tunnel.SshEnvironmentManager.ma
19201921
);
19211922
});
19221923

1923-
return SshEnvironmentManager.of({ ensureEnvironment, disconnectEnvironment });
1924+
return SshEnvironmentManager.of({ ensureEnvironment, disconnectEnvironment, closeAllTunnels });
19241925
});
19251926

19261927
/**

0 commit comments

Comments
 (0)