Skip to content

Commit a05e8fd

Browse files
Mnigosmaria-rcks
andauthored
fix(web): Add Environment dialog reopens on Remote link instead of a stale SSH selection (#26160)
Co-authored-by: maria-rcks <[email protected]>
1 parent 01b026f commit a05e8fd

2 files changed

Lines changed: 166 additions & 16 deletions

File tree

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
import { Atom, AsyncResult } from "effect/reactivity";
2+
import * as Cause from "effect/Cause";
3+
import type { AtomCommandResult } from "@t3tools/client-runtime/state/runtime";
4+
import { useState } from "react";
5+
import { page, userEvent } from "vite-plus/test/browser";
6+
import { describe, expect, it, vi } from "vite-plus/test";
7+
8+
import { render, stubGlobal } from "../../../test/render";
9+
import { AppAtomRegistryProvider } from "../../rpc/atomRegistry";
10+
11+
const mocks = vi.hoisted(() => ({
12+
connectSshEnvironment: vi.fn<() => Promise<AtomCommandResult<void, Error>>>(async () =>
13+
AsyncResult.success(undefined),
14+
),
15+
refresh: () => {},
16+
}));
17+
18+
vi.mock(import("../../state/use-atom-command"), async (original) => ({
19+
...(await original()),
20+
useAtomCommand: ((command: unknown) => command) as never,
21+
}));
22+
vi.mock(import("~/connection/onboarding"), async (original) => ({
23+
...(await original()),
24+
connectSshEnvironment: mocks.connectSshEnvironment as never,
25+
}));
26+
vi.mock(import("~/state/query"), async (original) => ({
27+
...(await original()),
28+
useEnvironmentQuery: (() => ({
29+
data: [],
30+
isPending: false,
31+
error: null,
32+
refresh: mocks.refresh,
33+
})) as never,
34+
}));
35+
vi.mock(import("~/state/environments"), async (original) => ({
36+
...(await original()),
37+
useRelayEnvironmentDiscovery: (() => ({ environments: new Map() })) as never,
38+
}));
39+
vi.mock(import("~/state/server"), async (original) => ({
40+
...(await original()),
41+
primaryServerKeybindingsAtom: Atom.make([]) as never,
42+
}));
43+
44+
import { AddEnvironmentDialog } from "./AddEnvironmentDialog";
45+
46+
function Owner() {
47+
const [open, setOpen] = useState(false);
48+
const [error, setError] = useState<string | null>(null);
49+
return (
50+
<AppAtomRegistryProvider>
51+
<AddEnvironmentDialog
52+
open={open}
53+
routeTarget={null}
54+
error={error}
55+
savedEnvironments={[]}
56+
onOpenChange={setOpen}
57+
onErrorChange={setError}
58+
/>
59+
</AppAtomRegistryProvider>
60+
);
61+
}
62+
63+
function setup() {
64+
mocks.connectSshEnvironment.mockClear();
65+
return stubGlobal("desktopBridge", {});
66+
}
67+
68+
const remoteCard = () => page.getByRole("button", { name: /Remote link/ });
69+
const sshCard = () => page.getByRole("button", { name: /^SSH/ });
70+
71+
async function openDialogOnSsh() {
72+
await userEvent.click(page.getByRole("button", { name: "Add environment" }));
73+
await userEvent.click(sshCard());
74+
await expect.element(sshCard()).toHaveAttribute("aria-pressed", "true");
75+
}
76+
77+
async function expectDefaultModeAfterReopen() {
78+
await expect.element(page.getByRole("dialog")).not.toBeInTheDocument();
79+
await userEvent.click(page.getByRole("button", { name: "Add environment" }));
80+
await expect.element(remoteCard()).toHaveAttribute("aria-pressed", "true");
81+
await expect.element(sshCard()).toHaveAttribute("aria-pressed", "false");
82+
await expect.element(page.getByPlaceholder("backend.example.com")).toBeInTheDocument();
83+
}
84+
85+
describe("AddEnvironmentDialog", () => {
86+
it("reopens on Remote link after adding an SSH environment", async () => {
87+
using _bridge = setup();
88+
await using _screen = await render(<Owner />);
89+
90+
await openDialogOnSsh();
91+
await userEvent.type(page.getByPlaceholder("Search hosts or type devbox"), "devbox");
92+
await userEvent.click(
93+
page.getByRole("dialog").getByRole("button", { name: "Add environment" }),
94+
);
95+
expect(mocks.connectSshEnvironment).toHaveBeenCalledOnce();
96+
97+
await expectDefaultModeAfterReopen();
98+
});
99+
100+
it("clears the form after dismissing it on SSH", async () => {
101+
using _bridge = setup();
102+
await using _screen = await render(<Owner />);
103+
104+
await openDialogOnSsh();
105+
await userEvent.click(remoteCard());
106+
await userEvent.type(page.getByPlaceholder("backend.example.com"), "devbox.example.com");
107+
await userEvent.type(page.getByPlaceholder("PAIRCODE"), "PAIRCODE");
108+
await userEvent.click(sshCard());
109+
await userEvent.type(page.getByPlaceholder("Search hosts or type devbox"), "devbox");
110+
await userEvent.type(page.getByPlaceholder("root"), "maria");
111+
await userEvent.type(page.getByPlaceholder("22"), "2222");
112+
await userEvent.keyboard("{Escape}");
113+
114+
await expectDefaultModeAfterReopen();
115+
await expect.element(page.getByPlaceholder("backend.example.com")).toHaveValue("");
116+
await expect.element(page.getByPlaceholder("PAIRCODE")).toHaveValue("");
117+
await userEvent.click(sshCard());
118+
await expect.element(page.getByPlaceholder("Search hosts or type devbox")).toHaveValue("");
119+
await expect.element(page.getByPlaceholder("root")).toHaveValue("");
120+
await expect.element(page.getByPlaceholder("22")).toHaveValue("");
121+
122+
let finishConnection!: (result: AtomCommandResult<void, Error>) => void;
123+
const pending = new Promise<AtomCommandResult<void, Error>>((resolve) => {
124+
finishConnection = resolve;
125+
});
126+
mocks.connectSshEnvironment.mockImplementationOnce(() => pending);
127+
await userEvent.type(page.getByPlaceholder("Search hosts or type devbox"), "devbox");
128+
await userEvent.click(
129+
page.getByRole("dialog").getByRole("button", { name: "Add environment" }),
130+
);
131+
await userEvent.keyboard("{Escape}");
132+
await expectDefaultModeAfterReopen();
133+
finishConnection(AsyncResult.failure(Cause.fail(new Error("dismissed SSH attempt"))));
134+
await expect
135+
.element(page.getByRole("dialog").getByRole("button", { name: "Add environment" }))
136+
.toBeEnabled();
137+
await expect.element(page.getByText(/dismissed SSH attempt/)).not.toBeInTheDocument();
138+
});
139+
});

‎apps/web/src/components/settings/AddEnvironmentDialog.tsx‎

Lines changed: 27 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ export function AddEnvironmentDialog({
118118
const [sshHostSuggestionsOpen, setSshHostSuggestionsOpen] = useState(false);
119119
const highlightedSshHostRef = useRef<DesktopDiscoveredSshHost | undefined>(undefined);
120120
const [isAddingSavedBackend, setIsAddingSavedBackend] = useState(false);
121+
const savedBackendSessionRef = useRef(0);
121122
const isSshDiscoveryActive = desktopBridge !== undefined && open && savedBackendMode === "ssh";
122123
const desktopSshHosts = useEnvironmentQuery(
123124
isSshDiscoveryActive ? desktopSshHostsStateAtom : null,
@@ -146,7 +147,20 @@ export function AddEnvironmentDialog({
146147
const hasSshHostSuggestionContent =
147148
desktopBridge !== undefined &&
148149
(isLoadingDiscoveredSshHosts || unsavedDiscoveredSshHosts.length > 0);
150+
const handleOpenChange = (nextOpen: boolean) => {
151+
if (!nextOpen) {
152+
savedBackendSessionRef.current += 1;
153+
setSavedBackendMode("remote");
154+
setSavedBackendHost("");
155+
setSavedBackendPairingCode("");
156+
setSavedBackendSshHost("");
157+
setSavedBackendSshUsername("");
158+
setSavedBackendSshPort("");
159+
}
160+
onOpenChange(nextOpen);
161+
};
149162
const connectSavedBackendSshTarget = async (target: DesktopSshEnvironmentTarget) => {
163+
const session = savedBackendSessionRef.current;
150164
setIsAddingSavedBackend(true);
151165
onErrorChange(null);
152166
const result = await connectSshEnvironment({
@@ -155,19 +169,14 @@ export function AddEnvironmentDialog({
155169
...(routeTarget ? { expectedEnvironmentId: routeTarget.environmentId } : {}),
156170
});
157171
if (result._tag === "Failure") {
158-
if (!isAtomCommandInterrupted(result)) {
172+
if (session === savedBackendSessionRef.current && !isAtomCommandInterrupted(result)) {
159173
pipe(squashAtomCommandFailure(result), formatDesktopSshConnectionError, onErrorChange);
160174
}
161175
setIsAddingSavedBackend(false);
162176
return;
163177
}
164178

165-
setSavedBackendHost("");
166-
setSavedBackendPairingCode("");
167-
setSavedBackendSshHost("");
168-
setSavedBackendSshUsername("");
169-
setSavedBackendSshPort("");
170-
onOpenChange(false);
179+
handleOpenChange(false);
171180
toastManager.add({
172181
type: "success",
173182
title: routeTarget ? "Route added" : "Environment connected",
@@ -239,12 +248,7 @@ export function AddEnvironmentDialog({
239248
return;
240249
}
241250

242-
setSavedBackendHost("");
243-
setSavedBackendPairingCode("");
244-
setSavedBackendSshHost("");
245-
setSavedBackendSshUsername("");
246-
setSavedBackendSshPort("");
247-
onOpenChange(false);
251+
handleOpenChange(false);
248252
toastManager.add(
249253
routeTarget
250254
? {
@@ -272,14 +276,21 @@ export function AddEnvironmentDialog({
272276
const handleSelectSshHostSuggestion = async (target: DesktopDiscoveredSshHost) => {
273277
if (isAddingSavedBackend || !desktopBridge) return;
274278

279+
const session = savedBackendSessionRef.current;
275280
setIsAddingSavedBackend(true);
276281
onErrorChange(null);
277282
setSavedBackendSshHost(target.alias);
278283
let resolved: DesktopSshEnvironmentTarget;
279284
try {
280285
resolved = await desktopBridge.resolveSshHost(target.alias);
281286
} catch (error) {
282-
onErrorChange(formatDesktopSshConnectionError(error));
287+
if (session === savedBackendSessionRef.current) {
288+
onErrorChange(formatDesktopSshConnectionError(error));
289+
}
290+
setIsAddingSavedBackend(false);
291+
return;
292+
}
293+
if (session !== savedBackendSessionRef.current) {
283294
setIsAddingSavedBackend(false);
284295
return;
285296
}
@@ -434,7 +445,7 @@ export function AddEnvironmentDialog({
434445
}
435446
return;
436447
}
437-
onOpenChange(false);
448+
handleOpenChange(false);
438449
toastManager.add({
439450
type: "success",
440451
title: "Route added",
@@ -595,7 +606,7 @@ export function AddEnvironmentDialog({
595606
);
596607

597608
return (
598-
<Dialog open={open} onOpenChange={onOpenChange}>
609+
<Dialog open={open} onOpenChange={handleOpenChange}>
599610
<Tooltip>
600611
<TooltipTrigger
601612
render={

0 commit comments

Comments
 (0)