Files
Netcatty/components/terminal/TerminalView.test.tsx
T
Eric ChanandCursor a859af6c62 feat(terminal): suggest Network Device Mode via a session-header tip (#2566)
* feat(terminal): suggest Network Device Mode via a session-header tip

When a connected host is classified as a network device (auto-detected
vendor banner/os-release, or a manual distro-icon override) but Network
Device Mode is off, show a non-blocking one-line tip at the top of the
session. The user can enable the mode (persisted to the host) or dismiss
it; we only suggest once per host.

Driven by the host's effective distro so it also previews without real
hardware: set a host's device icon to a network vendor and reconnect.

- domain: shouldSuggestNetworkDeviceMode (exact vendor match, once-per-host)
- application/state: networkDeviceModeSuggestion persistence boundary
- TerminalView: header tip + reserve top offset so it never covers output
- i18n: terminal.networkDevice.tip.* for en/zh-CN/zh-TW/ru

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(terminal): gate network device mode tip to plain SSH sessions

Codex review: the suggestion tip used the host's effective distro (incl.
manual icon override), so a Mosh/ET/serial/telnet session with a
network-vendor classification would still offer it and persist a
host-level deviceType:'network'. The Host Details toggle is exposed only
for plain SSH hosts, so this could set a hidden mode that surprises later
SSH reconnects. Add an effectiveProtocol gate to shouldSuggestNetworkDeviceMode
and pass effectiveTerminalProtocol from TerminalView. (#2367)

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(terminal): make network device tip gate effective and popup/multi-pane safe

Addresses Codex re-review on the tip:
- The effectiveProtocol gate was dead: ctx never carried
  effectiveTerminalProtocol, so it was always undefined (unrestricted).
  Derive it from the host via resolveEffectiveTerminalProtocol instead.
- Suppress the tip when host updates are unavailable (detached popup has no
  onUpdateHost) so Enable can't silently no-op; plumb canUpdateHost through ctx.
- Sync dismiss/enable across panes/windows for the same host via an in-process
  subscription in the suggestion persistence module. (#2367)

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(terminal): make network device tip once-per-host, ephemeral- and multi-window-safe

Addresses Codex re-review round 3 on the tip:
- Exclude ephemeral deep-link/quick-connect hosts (isSavedVaultHost): they are
  not in the persisted vault array, so Enable would silently no-op even though
  canUpdateHost is true.
- Track first display separately from user interaction: record "shown" silently
  on first display so simply closing the session no longer re-nags on every
  reconnect, while the showing instance keeps the tip until the user acts.
- Propagate resolve/dismiss across separate BrowserWindows (#/session-window)
  via a native storage-event listener that diffs newly handled host ids.
(#2367)

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(terminal): don't touch localStorage at import; keep network tip clear of speed dial

Addresses Codex re-review round 4:
- P1: networkDeviceModeSuggestion read localStorage at module scope
  (knownHandledIds initializer), which threw ReferenceError under the Node
  test runner and broke `npm test`. Initialize it lazily inside the existing
  browser-only window guard instead.
- P2: when the host info bar is hidden and search is closed the full-width tip
  strip overlapped the compact speed-dial toggle (top-right) and swallowed its
  clicks. Reserve right-side clearance for the toggle via a pure
  resolveNetworkDeviceTipRightInset helper (with unit test).
(#2367)

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(terminal): drop network tip once the host is classified elsewhere

Addresses Codex re-review round 5: while the tip is latched open, enabling
Network Device Mode from Host Details or a synced pane updates the host to
deviceType:'network', but the eligibility effect's early return kept the tip
(and its now-redundant Enable action) visible. Clear the latch whenever
host.deviceType becomes 'network'. (#2367)

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(terminal): persist only the deviceType override, not the effective host

Addresses Codex re-review round 5 (P1): the tip's Enable spread the *effective*
session host (group defaults / proxy profile already materialized) into
onUpdateHost, so mergeTerminalHostUpdate froze every inherited field
(credentials, appearance, proxyConfig) as host-level overrides and later
group/profile changes stopped propagating. Send a sparse
{ id, deviceType: 'network' } update instead. (#2367)

Co-authored-by: Cursor <cursoragent@cursor.com>

* refactor(terminal): move network device tip lifecycle into a state hook; per-host keys

Addresses Codex re-review round 6:
- P1 (architecture): TerminalView no longer imports the persistence API or owns
  the handled-state subscription/eligibility/writes. Extract
  useNetworkDeviceModeSuggestion under application/state; the component consumes
  { visible, enable, dismiss } and keeps only view glue (sparse host update +
  toast), per AGENTS.md's layer boundaries.
- P2 (cross-window clobber): persist one key per host instead of a single shared
  array. localStorage has no atomic read-modify-write, so concurrent appends
  from two windows could drop a marker; independent keys never clobber, and the
  storage event recovers the host id directly from the key.
(#2367)

Co-authored-by: Cursor <cursoragent@cursor.com>

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-07-29 11:11:14 +08:00

323 lines
13 KiB
TypeScript

import test from "node:test";
import assert from "node:assert/strict";
import { readFileSync } from "node:fs";
import {
formatTerminalTitleConnectionAddress,
getLineTimestampToggleHostUpdate,
resolveNetworkDeviceTipRightInset,
resolveTerminalRightInset,
resolveTerminalTopOffsets,
shouldBlockTerminalReconnectForTarget,
shouldReconnectTerminalOnEnterKey,
shouldShowSelectionAIOverlay,
shouldShowLineTimestampToolbarToggle,
} from "./TerminalView.tsx";
test("line timestamp toggle creates a persistent host update", () => {
const host = {
id: "host-1",
label: "Host",
showLineTimestamps: false,
theme: "default",
};
assert.deepEqual(getLineTimestampToggleHostUpdate(host), {
id: "host-1",
showLineTimestamps: true,
});
assert.deepEqual(getLineTimestampToggleHostUpdate({ ...host, showLineTimestamps: true }), {
id: "host-1",
showLineTimestamps: false,
});
});
test("line timestamp toolbar toggle is hidden when timestamps are unavailable", () => {
assert.equal(shouldShowLineTimestampToolbarToggle(false, () => {}), false);
assert.equal(shouldShowLineTimestampToolbarToggle(true, () => {}), true);
assert.equal(shouldShowLineTimestampToolbarToggle(undefined, () => {}), true);
assert.equal(shouldShowLineTimestampToolbarToggle(true, undefined), false);
});
test("selection AI overlay honors the visibility preference", () => {
const overlayPosition = { left: 120, top: 80 };
const addSelection = () => {};
assert.equal(
shouldShowSelectionAIOverlay({
hasSelection: true,
selectionOverlayPosition: overlayPosition,
onAddSelectionToAI: addSelection,
}),
true,
);
assert.equal(
shouldShowSelectionAIOverlay({
hasSelection: true,
selectionOverlayPosition: overlayPosition,
onAddSelectionToAI: addSelection,
showSelectionAIAction: true,
}),
true,
);
assert.equal(
shouldShowSelectionAIOverlay({
hasSelection: true,
selectionOverlayPosition: overlayPosition,
onAddSelectionToAI: addSelection,
showSelectionAIAction: false,
}),
false,
);
});
test("disconnected terminal reconnects on plain Enter when input is not claimed elsewhere", () => {
assert.equal(
shouldReconnectTerminalOnEnterKey({
key: "Enter",
status: "disconnected",
hasRetryHandler: true,
isComposeBarOpen: false,
needsAuth: false,
needsHostKeyVerification: false,
hasBlockingOverlay: false,
}),
true,
);
});
test("terminal enter reconnect ignores active controls and non-disconnected states", () => {
const base = {
key: "Enter",
status: "disconnected" as const,
hasRetryHandler: true,
isComposeBarOpen: false,
needsAuth: false,
needsHostKeyVerification: false,
hasBlockingOverlay: false,
};
assert.equal(shouldReconnectTerminalOnEnterKey({ ...base, status: "connected" }), false);
assert.equal(shouldReconnectTerminalOnEnterKey({ ...base, key: "a" }), false);
assert.equal(shouldReconnectTerminalOnEnterKey({ ...base, hasRetryHandler: false }), false);
// Open search must not globally suppress Enter reconnect / the hint (#2546).
assert.equal(shouldReconnectTerminalOnEnterKey({ ...base }), true);
assert.equal(shouldReconnectTerminalOnEnterKey({ ...base, isComposeBarOpen: true }), false);
assert.equal(shouldReconnectTerminalOnEnterKey({ ...base, needsAuth: true }), false);
assert.equal(shouldReconnectTerminalOnEnterKey({ ...base, needsHostKeyVerification: true }), false);
assert.equal(shouldReconnectTerminalOnEnterKey({ ...base, hasBlockingOverlay: true }), false);
assert.equal(shouldReconnectTerminalOnEnterKey({ ...base, altKey: true }), false);
});
test("terminal enter reconnect ignores interactive controls outside xterm only", () => {
assert.equal(
shouldBlockTerminalReconnectForTarget({
isWithinXterm: false,
hasInteractiveAncestor: true,
}),
true,
);
assert.equal(
shouldBlockTerminalReconnectForTarget({
isWithinXterm: true,
hasInteractiveAncestor: true,
}),
false,
);
assert.equal(
shouldBlockTerminalReconnectForTarget({
isWithinXterm: false,
hasInteractiveAncestor: false,
}),
false,
);
// An open terminal search input is interactive, but disconnected Enter must
// still reconnect rather than find-next (#2546).
assert.equal(
shouldBlockTerminalReconnectForTarget({
isWithinXterm: false,
hasInteractiveAncestor: true,
isTerminalSearchInput: true,
}),
false,
);
});
test("terminal title formats the connection address for remote sessions", () => {
assert.equal(
formatTerminalTitleConnectionAddress({
protocol: "ssh",
username: "root",
hostname: "10.1.2.34",
port: 2222,
}),
"root@10.1.2.34:2222",
);
assert.equal(formatTerminalTitleConnectionAddress({ protocol: "local", hostname: "localhost" }), null);
assert.equal(formatTerminalTitleConnectionAddress({
protocol: "plugin:com.example.transport.connection",
hostname: "com.example.transport.connection",
port: 22,
}), null);
});
test("terminal title row does not render a status dot beside the address", () => {
const source = readFileSync(new URL("./TerminalView.tsx", import.meta.url), "utf8");
const titleStart = source.indexOf("data-terminal-detach-drag-handle");
const titleEnd = source.indexOf("shouldShowLineTimestampToolbarToggle", titleStart);
assert.notEqual(titleStart, -1);
assert.notEqual(titleEnd, -1);
assert.doesNotMatch(source.slice(titleStart, titleEnd), /statusDotTone/);
});
test("terminal title keeps the copy host action beside the address", () => {
const source = readFileSync(new URL("./TerminalView.tsx", import.meta.url), "utf8");
const titleStart = source.indexOf("data-terminal-detach-drag-handle");
const copyAction = source.indexOf('aria-label={t("terminal.statusbar.copyHostname.label")}', titleStart);
const timestampToggle = source.indexOf("shouldShowLineTimestampToolbarToggle", titleStart);
assert.notEqual(titleStart, -1);
assert.notEqual(copyAction, -1);
assert.notEqual(timestampToggle, -1);
assert.ok(copyAction < timestampToggle);
});
test("popup terminals disable line timestamp controls", () => {
const source = readFileSync(new URL("../TerminalPopupPage.tsx", import.meta.url), "utf8");
assert.match(source, /lineTimestampsAvailable=\{false\}/);
});
test("terminal body keeps a slight inset from the surrounding chrome", () => {
const source = readFileSync(new URL("./TerminalView.tsx", import.meta.url), "utf8");
assert.match(source, /const terminalBodyInset = 4/);
assert.match(source, /left: activeLineTimestampGutterWidth \+ terminalBodyInset/);
assert.match(source, /right: terminalRightInset/);
assert.match(source, /bottom: terminalBodyInset/);
assert.match(source, /left=\{terminalBodyInset\}/);
assert.match(source, /bottom=\{terminalBodyInset\}/);
});
test("hidden host information bar gives its vertical space back to the terminal", () => {
assert.deepEqual(
resolveTerminalTopOffsets({ showHostInfoBar: false, isSearchOpen: false }),
{ toolbarOffset: 0, contentTop: "4px" },
);
assert.deepEqual(
resolveTerminalTopOffsets({ showHostInfoBar: true, isSearchOpen: false }),
{ toolbarOffset: 30, contentTop: "34px" },
);
});
test("terminal search keeps enough space when host information is hidden", () => {
assert.deepEqual(
resolveTerminalTopOffsets({ showHostInfoBar: false, isSearchOpen: true }),
{ toolbarOffset: 64, contentTop: "68px" },
);
});
test("network device tip reserves extra top space below the toolbar", () => {
// Tip stacks below the toolbar: content shifts down by the tip height, but
// the toolbar offset itself is unchanged.
assert.deepEqual(
resolveTerminalTopOffsets({ showHostInfoBar: true, isSearchOpen: false, networkDeviceTipHeight: 28 }),
{ toolbarOffset: 30, contentTop: "62px" },
);
assert.deepEqual(
resolveTerminalTopOffsets({ showHostInfoBar: false, isSearchOpen: false, networkDeviceTipHeight: 28 }),
{ toolbarOffset: 0, contentTop: "32px" },
);
});
test("network device tip clears the compact speed-dial toggle only when it is present", () => {
// Speed dial only renders when host info is hidden and search is closed;
// reserve right-side room there so the tip cannot cover its click target.
assert.equal(resolveNetworkDeviceTipRightInset({ showHostInfoBar: false, isSearchOpen: false }), 40);
assert.equal(resolveNetworkDeviceTipRightInset({ showHostInfoBar: true, isSearchOpen: false }), 0);
assert.equal(resolveNetworkDeviceTipRightInset({ showHostInfoBar: false, isSearchOpen: true }), 0);
});
test("hidden host information does not reserve a side gutter for its floating action button", () => {
// Speed-dial overlays the terminal; scrollbar stays at the pane edge.
assert.equal(resolveTerminalRightInset({ showHostInfoBar: false, isSearchOpen: false }), 4);
assert.equal(resolveTerminalRightInset({ showHostInfoBar: true, isSearchOpen: false }), 4);
assert.equal(resolveTerminalRightInset({ showHostInfoBar: false, isSearchOpen: true }), 4);
});
test("hidden host information keeps terminal actions rendered", () => {
const source = readFileSync(new URL("./TerminalView.tsx", import.meta.url), "utf8");
const hostInfoStart = source.indexOf("{showHostInfoBar && <div");
const hostInfoEnd = source.indexOf("</div>}", hostInfoStart);
const copyAction = source.indexOf('aria-label={t("terminal.statusbar.copyHostname.label")}');
const timestampAction = source.indexOf("shouldShowLineTimestampToolbarToggle", copyAction);
const systemAction = source.indexOf('aria-label={t("terminal.layer.system")}', timestampAction);
const actionsStart = source.indexOf('className="flex items-center gap-0.5 flex-shrink-0"');
const controls = source.indexOf("{renderControls({ showClose: inWorkspace })}");
const compactDragHandle = source.indexOf('data-terminal-detach-drag-handle="true"');
assert.notEqual(hostInfoStart, -1);
assert.notEqual(hostInfoEnd, -1);
assert.notEqual(copyAction, -1);
assert.notEqual(timestampAction, -1);
assert.notEqual(systemAction, -1);
assert.notEqual(actionsStart, -1);
assert.notEqual(controls, -1);
assert.notEqual(compactDragHandle, -1);
// Compact drag handle uses GripVertical, not the old radial-dot “chessboard”.
assert.match(source, /GripVertical/);
assert.ok(!source.includes("backgroundSize: '4px 4px'"));
assert.ok(hostInfoStart < hostInfoEnd);
assert.ok(hostInfoEnd < copyAction);
assert.ok(copyAction < timestampAction);
assert.ok(timestampAction < systemAction);
assert.ok(systemAction < actionsStart);
assert.ok(actionsStart < controls);
assert.ok(compactDragHandle < hostInfoStart);
});
test("hidden host information reveals actions without permanently covering terminal content", () => {
const source = readFileSync(new URL("./TerminalView.tsx", import.meta.url), "utf8");
assert.match(source, /aria-label=\{t\("terminal\.toolbar\.showActions"\)\}/);
assert.match(source, /aria-expanded=\{compactActionsOpen\}/);
assert.match(source, /aria-controls=\{`terminal-actions-\$\{sessionId\}`\}/);
assert.match(source, /id=\{`terminal-actions-\$\{sessionId\}`\}/);
assert.match(source, /onClick=\{\(\) => setCompactActionsOpen/);
assert.match(source, /right: terminalRightInset/);
// Compact mode is a circular speed-dial: tray springs left via 0fr→1fr grid
// (must not use .terminal-topbar — container-type collapses content width).
assert.match(source, /flex flex-row-reverse items-center/);
assert.match(source, /rounded-full/);
assert.match(source, /grid-cols-\[1fr\]/);
assert.match(source, /grid-cols-\[0fr\]/);
assert.match(source, /ChevronsLeft/);
assert.match(source, /h-7/);
assert.match(source, /Do NOT use `\.terminal-topbar`|container-type:inline-size|container-type collapses/);
assert.match(source, /document\.addEventListener\("pointerdown", handlePointerDown\)/);
assert.match(source, /closest\('\[data-radix-popper-content-wrapper\]'\)/);
assert.match(source, /event\.key !== "Escape"/);
assert.match(source, /compactActionsButtonRef\.current\?\.focus\(\)/);
});
test("compact action toggle preserves terminal focus like the visible toolbar", () => {
const source = readFileSync(new URL("./TerminalView.tsx", import.meta.url), "utf8");
const overlayStart = source.indexOf('ref={compactActionsRef}');
const toggleStart = source.indexOf('ref={compactActionsButtonRef}', overlayStart);
assert.notEqual(overlayStart, -1);
assert.notEqual(toggleStart, -1);
assert.ok(overlayStart < toggleStart);
assert.match(source.slice(overlayStart, toggleStart), /onMouseDownCapture=\{handleTopOverlayMouseDownCapture\}/);
});
test("terminal theme updates force xterm renderer to repaint immediately", () => {
const source = readFileSync(new URL("./useTerminalEffects.ts", import.meta.url), "utf8");
const schedulerSource = readFileSync(new URL("./terminalThemeScheduler.ts", import.meta.url), "utf8");
assert.match(source, /applyTerminalThemeSync\(term, effectiveTheme\)/);
assert.match(schedulerSource, /term\.options\.theme = \{/);
assert.match(schedulerSource, /forceSyncRenderAfterResize\(term\)/);
});