Files
Netcatty/application/state/resolveTerminalSessionExitIntent.test.ts
T
11c90b45ec feat(terminal): disable auto-close-on-exit by default (#3619)
* feat(terminal): disable auto-close-on-exit by default

Remote graceful channel closes (VPN half-close, server-side idle kick) can be reported as a clean exit with code 0, so with auto-close enabled the tab gets destroyed exactly when the user needs it kept - bypassing the SSH auto-reconnect loop, which intentionally skips exited events.

Keep tabs on exit by default; users who want close-on-exit can enable it in Settings > Terminal > Behavior. Attach-mode close behavior is unchanged.

* fix(terminal): keep session tabs when the auto-close setting is unavailable

The resolver's own default and the TerminalLayer call-site fallback still
treated a missing terminal setting as auto-close enabled. Remote graceful
channel closes (a jump host reaping an idle session) are reported as a
clean exit, so before the settings store had loaded, those closes silently
deleted the session tab and its scrollback. This completes the opt-in
default introduced above: only an explicit autoCloseOnExit true closes tabs.

* fix(terminal): migrate the materialized auto-close-on-exit default once

Builds before the default flip shipped autoCloseOnExit: true as the
default and materialized it into netcatty_term_settings_v1 on any
settings write, so most upgraders carry a value they never chose and
the new default-off never reaches them: bastion and idle-harvesting
servers reporting clean exits keep silently deleting their tabs.

Reset that materialized true exactly once behind a marker key before
the settings blob is first ingested, then persist the marker so every
later stored value is treated as the user's own choice. The cost is
documented: a user who deliberately enabled auto-close before this
release must re-enable it once.

* fix(terminal): keep synced legacy auto-close from coming back

A device that already wrote the one-shot migration marker was accepting
a pre-migration cloud or backup payload with autoCloseOnExit true.
Unversioned true is rewritten to false. Payloads that record the
migration still sync an explicit opt-in, including across a three-way
merge that would otherwise glue the local marker onto a legacy true.

Co-authored-by: 陈大猫 <binaricat@users.noreply.github.com>

---------

Co-authored-by: xu <tbqyomnnnbltzxy2t@aliyun.com>
Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: 陈大猫 <binaricat@users.noreply.github.com>
2026-10-13 17:11:15 +08:00

163 lines
4.8 KiB
TypeScript

import test from "node:test";
import assert from "node:assert/strict";
import {
formatSessionClosedExitMessage,
resolveTerminalSessionExitIntent,
shouldCloseTerminalPopupOnExit,
shouldRevealTerminalPopupOnExit,
} from "./resolveTerminalSessionExitIntent.ts";
test("backend exited events close the session tab only when auto-close is enabled", () => {
assert.deepEqual(
resolveTerminalSessionExitIntent({ reason: "exited", exitCode: 0 }, true),
{ kind: "closeSession" },
);
});
test("omitted auto-close setting keeps the session tab on a clean exit", () => {
// The fallback for callers that have not loaded the terminal setting yet:
// keep the tab so a jump host / bastion reaping a session (a clean exit)
// never silently deletes the user's scrollback.
assert.deepEqual(
resolveTerminalSessionExitIntent({ reason: "exited", exitCode: 0 }),
{ kind: "markDisconnected" },
);
});
test("disabled auto-close keeps the session tab after a clean exit", () => {
assert.deepEqual(
resolveTerminalSessionExitIntent({ reason: "exited", exitCode: 0 }, false),
{ kind: "markDisconnected" },
);
});
test("non-zero backend exits keep the tab and mark it disconnected", () => {
assert.deepEqual(
resolveTerminalSessionExitIntent({ reason: "exited", exitCode: 1 }),
{ kind: "markDisconnected" },
);
});
test("backend exits without a confirmed clean exit code keep the tab", () => {
assert.deepEqual(
resolveTerminalSessionExitIntent({ reason: "exited" }),
{ kind: "markDisconnected" },
);
});
test("backend timeout events keep the tab and mark it disconnected", () => {
assert.deepEqual(
resolveTerminalSessionExitIntent({ reason: "timeout", error: "idle timeout" }),
{ kind: "markDisconnected" },
);
});
test("backend error events keep the tab and mark it disconnected", () => {
assert.deepEqual(
resolveTerminalSessionExitIntent({ reason: "error", error: "connection reset" }),
{ kind: "markDisconnected" },
);
});
test("backend closed events keep the tab and mark it disconnected", () => {
assert.deepEqual(
resolveTerminalSessionExitIntent({ reason: "closed", exitCode: 0 }),
{ kind: "markDisconnected" },
);
});
test("terminal popup only auto-closes after clean command exit", () => {
assert.equal(shouldCloseTerminalPopupOnExit({ reason: "exited", exitCode: 0 }), true);
assert.equal(shouldCloseTerminalPopupOnExit({ reason: "exited", exitCode: 1 }), false);
assert.equal(shouldCloseTerminalPopupOnExit({ reason: "error", error: "connection reset" }), false);
assert.equal(shouldCloseTerminalPopupOnExit({ reason: "closed", exitCode: 0 }), false);
});
test("disabled auto-close keeps command and attached terminal popups open", () => {
assert.equal(
shouldCloseTerminalPopupOnExit(
{ reason: "exited", exitCode: 0 },
{ autoCloseOnExit: false },
),
false,
);
assert.equal(
shouldCloseTerminalPopupOnExit(
{ reason: "closed", exitCode: 0 },
{ autoCloseOnExit: false, isAttachMode: true },
),
false,
);
});
test("disabled auto-close reveals every command popup exit instead of reporting startup failure", () => {
assert.equal(
shouldRevealTerminalPopupOnExit(
{ reason: "exited", exitCode: 0 },
{ autoCloseOnExit: false },
),
true,
);
assert.equal(
shouldRevealTerminalPopupOnExit(
{ reason: "exited", exitCode: 1 },
{ autoCloseOnExit: false },
),
true,
);
assert.equal(
shouldRevealTerminalPopupOnExit(
{ reason: "exited" },
{ autoCloseOnExit: false },
),
true,
);
assert.equal(
shouldRevealTerminalPopupOnExit(
{ reason: "exited", exitCode: 0 },
{ autoCloseOnExit: false, isAttachMode: true },
),
false,
);
});
test("attached terminal popups keep their existing auto-close behavior by default", () => {
assert.equal(
shouldCloseTerminalPopupOnExit(
{ reason: "closed", exitCode: 0 },
{ isAttachMode: true },
),
true,
);
});
test("exit messages show the reported code for a real remote exit", () => {
assert.equal(
formatSessionClosedExitMessage({ reason: "exited", exitCode: 0 }),
"\r\n[session closed (code 0)]",
);
assert.equal(
formatSessionClosedExitMessage({ reason: "exited", exitCode: 127 }),
"\r\n[session closed (code 127)]",
);
});
test("a channel closed without exit-status or exit-signal must not render as code 0", () => {
assert.equal(
formatSessionClosedExitMessage({
reason: "closed",
remoteClosedWithoutExitStatus: true,
}),
"\r\n[session closed by remote (no exit status)]",
);
});
test("exit messages without a reported code stay plain instead of showing a sentinel", () => {
assert.equal(
formatSessionClosedExitMessage({ reason: "closed" }),
"\r\n[session closed]",
);
assert.equal(formatSessionClosedExitMessage({}), "\r\n[session closed]");
});