From 85bd8a8058d2a95240e12a19e7d22274b85e6637 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Almeida?= Date: Sun, 17 May 2026 11:00:53 +0100 Subject: [PATCH] feat(web): add data-testid attributes to SSH settings UI Sweep stable test ids across the SSH connection and sessions cards so the incoming Playwright suite can hold steady against refactors. Splits the formerly monolithic ssh-settings.tsx into three files to stay within the per-file/per-function size limits: - ssh-connection-card.tsx (form + test-then-trust flow) - ssh-sessions-card.tsx (active-sessions table) - ssh-settings.tsx (barrel re-export so existing imports keep working) Test ids cover: card roots, every input, identity-source select + options, test/save buttons, connection badge (with data-status), error text, test-result panel (with data-success), per-step rows (with data-success), observed/pinned fingerprint, fingerprint-change warning, trust checkbox, sessions table + per-row cells, empty state, refresh button, session status badge. --- .../settings/ssh-connection-card.tsx | 597 ++++++++++++++++++ .../components/settings/ssh-sessions-card.tsx | 161 +++++ apps/web/components/settings/ssh-settings.tsx | 582 +---------------- 3 files changed, 765 insertions(+), 575 deletions(-) create mode 100644 apps/web/components/settings/ssh-connection-card.tsx create mode 100644 apps/web/components/settings/ssh-sessions-card.tsx diff --git a/apps/web/components/settings/ssh-connection-card.tsx b/apps/web/components/settings/ssh-connection-card.tsx new file mode 100644 index 0000000000..ffcd583a6f --- /dev/null +++ b/apps/web/components/settings/ssh-connection-card.tsx @@ -0,0 +1,597 @@ +"use client"; + +import { useCallback, useMemo, useState } from "react"; +import { Badge } from "@kandev/ui/badge"; +import { Button } from "@kandev/ui/button"; +import { Card, CardContent, CardDescription, CardHeader, CardTitle } from "@kandev/ui/card"; +import { Input } from "@kandev/ui/input"; +import { Label } from "@kandev/ui/label"; +import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from "@kandev/ui/select"; +import { + IconCheck, + IconLoader2, + IconShieldLock, + IconTerminal2, + IconTestPipe, + IconX, +} from "@tabler/icons-react"; +import { testSSHConnection } from "@/lib/api/domains/ssh-api"; +import type { + SSHIdentitySource, + SSHTestRequest, + SSHTestResult, + SSHTestStep, +} from "@/lib/types/http-ssh"; + +// SSHExecutorConfig is the shape we persist into executor.Config on save. +// The host_fingerprint is set only after a successful Test Connection has +// completed and the user has ticked "Trust this host". +export interface SSHExecutorConfig { + name: string; + host_alias?: string; + host?: string; + port?: number; + user?: string; + identity_source: SSHIdentitySource; + identity_file?: string; + proxy_jump?: string; + host_fingerprint?: string; +} + +export interface SSHConnectionCardProps { + initial?: Partial; + // Called when the user clicks Save after a successful test+trust. The + // returned config carries the freshly pinned fingerprint. + onSave: (config: SSHExecutorConfig) => Promise | void; + // Existing running sessions for this executor. Triggers the + // "this won't affect existing sessions" warning on save. + runningSessionCount?: number; +} + +interface SSHConnectionState { + form: SSHExecutorConfig; + testing: boolean; + saving: boolean; + result: SSHTestResult | null; + trust: boolean; + error: string | null; +} + +const SSH_FORM_DEFAULTS: SSHExecutorConfig = { + name: "", + host_alias: "", + host: "", + port: 22, + user: "", + identity_source: "agent", + identity_file: "", + proxy_jump: "", + host_fingerprint: undefined, +}; + +function initialState(initial?: Partial): SSHConnectionState { + return { + form: { ...SSH_FORM_DEFAULTS, ...(initial ?? {}) }, + testing: false, + saving: false, + result: null, + trust: false, + error: null, + }; +} + +function useSSHConnection(props: SSHConnectionCardProps) { + const [state, setState] = useState(() => initialState(props.initial)); + const { form, testing, saving, result, trust, error } = state; + + const update = useCallback( + (key: K, value: SSHExecutorConfig[K]) => { + setState((prev) => ({ + ...prev, + form: { ...prev.form, [key]: value }, + result: null, + trust: false, + error: null, + })); + }, + [], + ); + + const setTrust = useCallback((v: boolean) => setState((prev) => ({ ...prev, trust: v })), []); + + const canTest = useMemo(() => { + if (testing) return false; + if (form.name.trim() === "") return false; + if ((form.host ?? "").trim() === "" && (form.host_alias ?? "").trim() === "") return false; + return true; + }, [form, testing]); + + const handleTest = useCallback(async () => { + setState((prev) => ({ ...prev, testing: true, result: null, error: null })); + try { + const req: SSHTestRequest = { + name: form.name, + host_alias: form.host_alias || undefined, + host: form.host || undefined, + port: form.port || undefined, + user: form.user || undefined, + identity_source: form.identity_source, + identity_file: form.identity_file || undefined, + proxy_jump: form.proxy_jump || undefined, + }; + const res = await testSSHConnection(req); + setState((prev) => ({ ...prev, result: res, testing: false })); + } catch (e) { + const msg = e instanceof Error ? e.message : "Failed to reach backend"; + setState((prev) => ({ ...prev, error: msg, testing: false })); + } + }, [form]); + + const canSave = !!result?.success && !!result.fingerprint && trust && !saving; + + const confirmRunningSessions = useCallback( + () => + props.runningSessionCount + ? window.confirm( + `This executor has ${props.runningSessionCount} running session(s). ` + + `They will keep running on the current host. Only new sessions started ` + + `after save will use the updated config. Continue?`, + ) + : true, + [props.runningSessionCount], + ); + + const handleSave = useCallback(async () => { + if (!canSave || !result?.fingerprint) return; + if (!confirmRunningSessions()) return; + setState((prev) => ({ ...prev, saving: true })); + try { + await props.onSave({ ...form, host_fingerprint: result.fingerprint }); + } finally { + setState((prev) => ({ ...prev, saving: false })); + } + }, [canSave, confirmRunningSessions, form, props, result]); + + return { + form, + testing, + saving, + result, + trust, + error, + canTest, + canSave, + update, + setTrust, + handleTest, + handleSave, + }; +} + +export function SSHConnectionCard(props: SSHConnectionCardProps) { + const c = useSSHConnection(props); + return ( + + +
+
+ + + Connection + + + Run an agent on any Linux box you can reach over SSH. linux/amd64 only in v1. + +
+ +
+
+ + + {c.form.host_fingerprint && } + + {c.error && ( +

+ {c.error} +

+ )} + {c.result && ( + + )} +
+
+ ); +} + +type FieldOnChange = ( + key: K, + value: SSHExecutorConfig[K], +) => void; + +function SSHConnectionForm({ + form, + onChange, +}: { + form: SSHExecutorConfig; + onChange: FieldOnChange; +}) { + return ( +
+ onChange("name", v)} + /> + onChange("host_alias", v)} + /> + onChange("host", v)} + /> + onChange("port", parseInt(v, 10) || 22)} + /> + onChange("user", v)} + /> + onChange("identity_source", v)} + /> + {form.identity_source === "file" && ( + onChange("identity_file", v)} + /> + )} + onChange("proxy_jump", v)} + /> +
+ ); +} + +function TextField({ + id, + testId, + label, + hint, + placeholder, + type, + value, + onChange, +}: { + id: string; + testId: string; + label: string; + hint?: string; + placeholder?: string; + type?: string; + value: string; + onChange: (v: string) => void; +}) { + return ( + + onChange(e.target.value)} + /> + + ); +} + +function IdentitySourceField({ + value, + onChange, +}: { + value: SSHIdentitySource; + onChange: (v: SSHIdentitySource) => void; +}) { + return ( + + + + ); +} + +function FieldShell({ + id, + label, + hint, + children, +}: { + id: string; + label: string; + hint?: string; + children: React.ReactNode; +}) { + return ( +
+ + {children} + {hint &&

{hint}

} +
+ ); +} + +function PinnedFingerprintRow({ fingerprint }: { fingerprint: string }) { + return ( +
+ + + Pinned fingerprint:{" "} + + {fingerprint} + + +
+ ); +} + +function SSHConnectionActions({ + testing, + saving, + canTest, + canSave, + onTest, + onSave, +}: { + testing: boolean; + saving: boolean; + canTest: boolean; + canSave: boolean; + onTest: () => void; + onSave: () => void; +}) { + return ( +
+ + +
+ ); +} + +function ConnectionBadge({ fingerprint }: { fingerprint?: string }) { + if (!fingerprint) { + return ( + + Unverified + + ); + } + return ( + + Trusted + + ); +} + +function TestResultDisplay({ + result, + trust, + onTrustChange, + currentlyPinned, +}: { + result: SSHTestResult; + trust: boolean; + onTrustChange: (v: boolean) => void; + currentlyPinned?: string; +}) { + return ( +
+ + {result.steps.map((step: SSHTestStep) => ( + + ))} + {result.error && !result.steps.some((s) => s.error) && ( +

+ {result.error} +

+ )} + {result.success && result.fingerprint && ( + + )} +
+ ); +} + +function TestResultHeader({ success, totalMs }: { success: boolean; totalMs: number }) { + return ( +
+ {success ? ( + + ) : ( + + )} + {success ? "Connection test passed" : "Connection test failed"} + ({totalMs}ms) +
+ ); +} + +function FingerprintTrustBlock({ + fingerprint, + currentlyPinned, + trust, + onTrustChange, +}: { + fingerprint: string; + currentlyPinned?: string; + trust: boolean; + onTrustChange: (v: boolean) => void; +}) { + const fingerprintChanged = !!currentlyPinned && currentlyPinned !== fingerprint; + return ( +
+
+ Host fingerprint observed: + + {fingerprint} + +
+ {fingerprintChanged && ( +

+ Warning: this fingerprint differs from the one currently pinned ( + {currentlyPinned}). Trusting it overwrites the pinned + key. If you didn’t expect a host re-key, stop here. +

+ )} + +
+ ); +} + +function StepRow({ step }: { step: SSHTestStep }) { + const slug = step.name.toLowerCase().replace(/[^a-z0-9]+/g, "-"); + return ( +
+ {step.success ? ( + + ) : ( + + )} +
+
+ {step.name} + ({step.duration_ms}ms) +
+ {step.output && ( +

+ {step.output} +

+ )} + {step.error && ( +

+ {step.error} +

+ )} +
+
+ ); +} diff --git a/apps/web/components/settings/ssh-sessions-card.tsx b/apps/web/components/settings/ssh-sessions-card.tsx new file mode 100644 index 0000000000..b6b736e464 --- /dev/null +++ b/apps/web/components/settings/ssh-sessions-card.tsx @@ -0,0 +1,161 @@ +"use client"; + +import { useCallback, useEffect, useState } from "react"; +import { Badge } from "@kandev/ui/badge"; +import { Button } from "@kandev/ui/button"; +import { Card, CardContent, CardDescription, CardHeader, CardTitle } from "@kandev/ui/card"; +import { Table, TableBody, TableCell, TableHead, TableHeader, TableRow } from "@kandev/ui/table"; +import { IconLoader2 } from "@tabler/icons-react"; +import { listSSHSessions } from "@/lib/api/domains/ssh-api"; +import type { SSHSession } from "@/lib/types/http-ssh"; + +export interface SSHSessionsCardProps { + executorId: string; +} + +const REFRESH_INTERVAL_MS = 90_000; + +export function SSHSessionsCard({ executorId }: SSHSessionsCardProps) { + const [sessions, setSessions] = useState([]); + const [loading, setLoading] = useState(false); + const [error, setError] = useState(null); + + const refresh = useCallback(async () => { + setLoading(true); + setError(null); + try { + const rows = await listSSHSessions(executorId); + setSessions(rows); + } catch (e) { + setError(e instanceof Error ? e.message : "Failed to load sessions"); + } finally { + setLoading(false); + } + }, [executorId]); + + useEffect(() => { + refresh(); + const id = setInterval(refresh, REFRESH_INTERVAL_MS); + return () => clearInterval(id); + }, [refresh]); + + return ( + + +
+
+ Active sessions + + Sessions currently running on this SSH host. Refreshes every 90 seconds. + +
+ +
+
+ + + +
+ ); +} + +function SSHSessionsBody({ + loading, + error, + sessions, +}: { + loading: boolean; + error: string | null; + sessions: SSHSession[]; +}) { + if (error) { + return ( +

+ {error} +

+ ); + } + if (sessions.length === 0 && !loading) { + return ( +

+ No active sessions. +

+ ); + } + if (sessions.length === 0) return null; + return ; +} + +function SSHSessionsTable({ sessions }: { sessions: SSHSession[] }) { + return ( + + + + Task + Session + Host + Remote port + Local fwd + Uptime + Status + + + + {sessions.map((s) => ( + + ))} + +
+ ); +} + +function SSHSessionsRow({ session: s }: { session: SSHSession }) { + return ( + + + {s.task_id.slice(0, 8)} + + + {s.session_id.slice(0, 8)} + + + {s.user ? `${s.user}@${s.host}` : s.host} + + + {s.remote_agentctl_port ?? "—"} + + + {s.local_forward_port ?? "—"} + + + {formatUptime(s.uptime_seconds)} + + + + {s.status} + + + + ); +} + +function formatUptime(s: number): string { + if (s < 60) return `${s}s`; + if (s < 3600) return `${Math.floor(s / 60)}m`; + if (s < 86400) return `${Math.floor(s / 3600)}h`; + return `${Math.floor(s / 86400)}d`; +} diff --git a/apps/web/components/settings/ssh-settings.tsx b/apps/web/components/settings/ssh-settings.tsx index 16be163b33..534683dbb3 100644 --- a/apps/web/components/settings/ssh-settings.tsx +++ b/apps/web/components/settings/ssh-settings.tsx @@ -1,577 +1,9 @@ "use client"; -import { useCallback, useEffect, useMemo, useState } from "react"; -import { Badge } from "@kandev/ui/badge"; -import { Button } from "@kandev/ui/button"; -import { Card, CardContent, CardHeader, CardTitle, CardDescription } from "@kandev/ui/card"; -import { Input } from "@kandev/ui/input"; -import { Label } from "@kandev/ui/label"; -import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from "@kandev/ui/select"; -import { Table, TableBody, TableCell, TableHead, TableHeader, TableRow } from "@kandev/ui/table"; -import { - IconCheck, - IconLoader2, - IconShieldLock, - IconTerminal2, - IconTestPipe, - IconX, -} from "@tabler/icons-react"; -import { testSSHConnection, listSSHSessions } from "@/lib/api/domains/ssh-api"; -import type { - SSHIdentitySource, - SSHSession, - SSHTestRequest, - SSHTestResult, - SSHTestStep, -} from "@/lib/types/http-ssh"; - -// SSHExecutorConfig is the shape we persist into executor.Config on save. -// The host_fingerprint is set only after a successful Test Connection has -// completed and the user has ticked "Trust this host". -export interface SSHExecutorConfig { - name: string; - host_alias?: string; - host?: string; - port?: number; - user?: string; - identity_source: SSHIdentitySource; - identity_file?: string; - proxy_jump?: string; - host_fingerprint?: string; -} - -export interface SSHConnectionCardProps { - initial?: Partial; - // Called when the user clicks Save after a successful test+trust. The - // returned config carries the freshly pinned fingerprint. - onSave: (config: SSHExecutorConfig) => Promise | void; - // Existing running sessions for this executor. Triggers the "this won't - // affect existing sessions" warning on save. - runningSessionCount?: number; -} - -interface SSHConnectionState { - form: SSHExecutorConfig; - testing: boolean; - saving: boolean; - result: SSHTestResult | null; - trust: boolean; - error: string | null; -} - -const SSH_FORM_DEFAULTS: SSHExecutorConfig = { - name: "", - host_alias: "", - host: "", - port: 22, - user: "", - identity_source: "agent", - identity_file: "", - proxy_jump: "", - host_fingerprint: undefined, -}; - -function initialState(initial?: Partial): SSHConnectionState { - return { - form: { ...SSH_FORM_DEFAULTS, ...(initial ?? {}) }, - testing: false, - saving: false, - result: null, - trust: false, - error: null, - }; -} - -function useSSHConnection(props: SSHConnectionCardProps) { - const [state, setState] = useState(() => initialState(props.initial)); - const { form, testing, saving, result, trust, error } = state; - - const update = useCallback( - (key: K, value: SSHExecutorConfig[K]) => { - setState((prev) => ({ - ...prev, - form: { ...prev.form, [key]: value }, - result: null, - trust: false, - error: null, - })); - }, - [], - ); - - const setTrust = useCallback((v: boolean) => setState((prev) => ({ ...prev, trust: v })), []); - - const canTest = useMemo(() => { - if (testing) return false; - if (form.name.trim() === "") return false; - if ((form.host ?? "").trim() === "" && (form.host_alias ?? "").trim() === "") return false; - return true; - }, [form, testing]); - - const handleTest = useCallback(async () => { - setState((prev) => ({ ...prev, testing: true, result: null, error: null })); - try { - const req: SSHTestRequest = { - name: form.name, - host_alias: form.host_alias || undefined, - host: form.host || undefined, - port: form.port || undefined, - user: form.user || undefined, - identity_source: form.identity_source, - identity_file: form.identity_file || undefined, - proxy_jump: form.proxy_jump || undefined, - }; - const res = await testSSHConnection(req); - setState((prev) => ({ ...prev, result: res, testing: false })); - } catch (e) { - const msg = e instanceof Error ? e.message : "Failed to reach backend"; - setState((prev) => ({ ...prev, error: msg, testing: false })); - } - }, [form]); - - const canSave = !!result?.success && !!result.fingerprint && trust && !saving; - - const confirmRunningSessions = useCallback( - () => - props.runningSessionCount - ? window.confirm( - `This executor has ${props.runningSessionCount} running session(s). ` + - `They will keep running on the current host. Only new sessions started ` + - `after save will use the updated config. Continue?`, - ) - : true, - [props.runningSessionCount], - ); - - const handleSave = useCallback(async () => { - if (!canSave || !result?.fingerprint) return; - if (!confirmRunningSessions()) return; - setState((prev) => ({ ...prev, saving: true })); - try { - await props.onSave({ ...form, host_fingerprint: result.fingerprint }); - } finally { - setState((prev) => ({ ...prev, saving: false })); - } - }, [canSave, confirmRunningSessions, form, props, result]); - - return { - form, - testing, - saving, - result, - trust, - error, - canTest, - canSave, - update, - setTrust, - handleTest, - handleSave, - }; -} - -export function SSHConnectionCard(props: SSHConnectionCardProps) { - const c = useSSHConnection(props); - return ( - - -
-
- - - Connection - - - Run an agent on any Linux box you can reach over SSH. linux/amd64 only in v1. - -
- -
-
- - - {c.form.host_fingerprint && } - - {c.error &&

{c.error}

} - {c.result && ( - - )} -
-
- ); -} - -function SSHConnectionForm({ - form, - onChange, -}: { - form: SSHExecutorConfig; - onChange: (key: K, value: SSHExecutorConfig[K]) => void; -}) { - return ( -
- - onChange("name", e.target.value)} - placeholder="My VPS" - /> - - - onChange("host_alias", e.target.value)} - placeholder="prod" - /> - - - onChange("host", e.target.value)} - placeholder="dev.example.com" - /> - - - onChange("port", parseInt(e.target.value, 10) || 22)} - placeholder="22" - /> - - - onChange("user", e.target.value)} - placeholder="ubuntu" - /> - - - - - {form.identity_source === "file" && ( - - onChange("identity_file", e.target.value)} - placeholder="~/.ssh/id_ed25519" - /> - - )} - - onChange("proxy_jump", e.target.value)} - placeholder="bastion.example.com" - /> - -
- ); -} - -function PinnedFingerprintRow({ fingerprint }: { fingerprint: string }) { - return ( -
- - - Pinned fingerprint: {fingerprint} - -
- ); -} - -function SSHConnectionActions({ - testing, - saving, - canTest, - canSave, - onTest, - onSave, -}: { - testing: boolean; - saving: boolean; - canTest: boolean; - canSave: boolean; - onTest: () => void; - onSave: () => void; -}) { - return ( -
- - -
- ); -} - -function ConnectionBadge({ fingerprint }: { fingerprint?: string }) { - if (!fingerprint) return Unverified; - return ( - - Trusted - - ); -} - -function Field({ - id, - label, - hint, - children, -}: { - id: string; - label: string; - hint?: string; - children: React.ReactNode; -}) { - return ( -
- - {children} - {hint &&

{hint}

} -
- ); -} - -function TestResultDisplay({ - result, - trust, - onTrustChange, - currentlyPinned, -}: { - result: SSHTestResult; - trust: boolean; - onTrustChange: (v: boolean) => void; - currentlyPinned?: string; -}) { - const fingerprintChanged = - !!currentlyPinned && !!result.fingerprint && currentlyPinned !== result.fingerprint; - return ( -
-
- {result.success ? ( - - ) : ( - - )} - {result.success ? "Connection test passed" : "Connection test failed"} - ({result.total_duration_ms}ms) -
- {result.steps.map((step: SSHTestStep) => ( - - ))} - {result.error && !result.steps.some((s) => s.error) && ( -

{result.error}

- )} - {result.success && result.fingerprint && ( -
-
- Host fingerprint observed: - {result.fingerprint} -
- {fingerprintChanged && ( -

- Warning: this fingerprint differs from the one currently pinned ( - {currentlyPinned}). Trusting it overwrites the - pinned key. If you didn’t expect a host re-key, stop here. -

- )} - -
- )} -
- ); -} - -function StepRow({ step }: { step: SSHTestStep }) { - return ( -
- {step.success ? ( - - ) : ( - - )} -
-
- {step.name} - ({step.duration_ms}ms) -
- {step.output && ( -

{step.output}

- )} - {step.error &&

{step.error}

} -
-
- ); -} - -export interface SSHSessionsCardProps { - executorId: string; -} - -export function SSHSessionsCard({ executorId }: SSHSessionsCardProps) { - const [sessions, setSessions] = useState([]); - const [loading, setLoading] = useState(false); - const [error, setError] = useState(null); - - const refresh = useCallback(async () => { - setLoading(true); - setError(null); - try { - const rows = await listSSHSessions(executorId); - setSessions(rows); - } catch (e) { - setError(e instanceof Error ? e.message : "Failed to load sessions"); - } finally { - setLoading(false); - } - }, [executorId]); - - useEffect(() => { - refresh(); - const id = setInterval(refresh, 90_000); - return () => clearInterval(id); - }, [refresh]); - - return ( - - -
-
- Active sessions - - Sessions currently running on this SSH host. Refreshes every 90 seconds. - -
- -
-
- - {error &&

{error}

} - {!error && sessions.length === 0 && !loading && ( -

No active sessions.

- )} - {sessions.length > 0 && ( - - - - Task - Session - Host - Remote port - Local fwd - Uptime - Status - - - - {sessions.map((s) => ( - - {s.task_id.slice(0, 8)} - {s.session_id.slice(0, 8)} - - {s.user ? `${s.user}@${s.host}` : s.host} - - - {s.remote_agentctl_port ?? "—"} - - {s.local_forward_port ?? "—"} - {formatUptime(s.uptime_seconds)} - - - {s.status} - - - - ))} - -
- )} -
-
- ); -} - -function formatUptime(s: number): string { - if (s < 60) return `${s}s`; - if (s < 3600) return `${Math.floor(s / 60)}m`; - if (s < 86400) return `${Math.floor(s / 3600)}h`; - return `${Math.floor(s / 86400)}d`; -} +// SSH executor settings UI. The two cards live in their own files so each +// stays under the component size limits; import from here to keep call sites +// short. +export { SSHConnectionCard } from "./ssh-connection-card"; +export type { SSHConnectionCardProps, SSHExecutorConfig } from "./ssh-connection-card"; +export { SSHSessionsCard } from "./ssh-sessions-card"; +export type { SSHSessionsCardProps } from "./ssh-sessions-card";