Files
Netcatty/application/state/settingsStateDefaults.test.ts
T
a03d41ebf5 fix(terminal): migrate saved Shift+Enter newline and honor xterm CSI u (#3775)
* fix(terminal): migrate the saved Shift+Enter newline once

Existing installs kept the pre-#3770 "\\n" default, so Shift+Enter still
submitted in TUI CLIs. Rewrite only that stored value to ESC+CR, and let
xterm's native CSI u own the chord when an app has opted in.

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

* fix(terminal): keep the Shift+Enter migration local

The one-time rewrite of a saved "\n" does not need a sync flag or a
three-way merge. An imported or synced old newline can stay as stored.

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

* fix(terminal): keep native kitty Shift+Enter on broadcast peers

When a target has negotiated xterm kitty keyboard and the custom
protocol setting is off, resolve the broadcast chord as CSI 13;2u
instead of the ESC+CR fallback.

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

---------

Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: 陈大猫 <binaricat@users.noreply.github.com>
2026-10-20 13:53:52 +08:00

292 lines
10 KiB
TypeScript

import test from "node:test";
import assert from "node:assert/strict";
import {
DEFAULT_THEME,
getContrastRatio,
buildAppThemeCssVars,
getHslTokenRelativeLuminance,
resolveReadableForegroundForHsl,
resolveThemeAccentForeground,
migrateIncomingTerminalFontId,
migrateMaterializedAutoCloseOnExitDefault,
migrateMaterializedShiftEnterNewlineDefault,
} from "./settingsStateDefaults.ts";
import { TERMINAL_FONT_AUTO } from "../../infrastructure/config/fonts.ts";
import {
STORAGE_KEY_TERM_AUTO_CLOSE_EXIT_MIGRATED,
STORAGE_KEY_TERM_FONT_FAMILY,
STORAGE_KEY_TERM_SETTINGS,
STORAGE_KEY_TERM_SHIFT_ENTER_NEWLINE_MIGRATED,
} from "../../infrastructure/config/storageKeys.ts";
import type { UiThemeTokens } from "../../infrastructure/config/uiThemes.ts";
function installMemoryLocalStorage(): Map<string, string> {
const store = new Map<string, string>();
(globalThis as { localStorage?: unknown }).localStorage = {
getItem: (k: string) => (store.has(k) ? store.get(k)! : null),
setItem: (k: string, v: string) => void store.set(k, v),
removeItem: (k: string) => void store.delete(k),
clear: () => store.clear(),
};
return store;
}
test("fresh installs follow the operating system color scheme by default", () => {
assert.equal(DEFAULT_THEME, "system");
});
test("migrateIncomingTerminalFontId rewrites deprecated ids to the auto sentinel, not menlo", () => {
// menlo would put Windows/Linux upgrade users back into the #1647 path,
// and a concrete id would leak across OSes via sync; auto resolves per device.
const store = installMemoryLocalStorage();
try {
assert.equal(migrateIncomingTerminalFontId("pingfang-sc"), TERMINAL_FONT_AUTO);
// The rewrite is persisted as the platform-neutral sentinel, never a concrete id.
assert.equal(store.get(STORAGE_KEY_TERM_FONT_FAMILY), TERMINAL_FONT_AUTO);
assert.equal(migrateIncomingTerminalFontId("microsoft-yahei"), TERMINAL_FONT_AUTO);
} finally {
delete (globalThis as { localStorage?: unknown }).localStorage;
}
});
test("migrateIncomingTerminalFontId leaves valid ids and empty values untouched", () => {
assert.equal(migrateIncomingTerminalFontId("jetbrains-mono"), "jetbrains-mono");
assert.equal(migrateIncomingTerminalFontId(TERMINAL_FONT_AUTO), TERMINAL_FONT_AUTO);
assert.equal(migrateIncomingTerminalFontId(""), null);
assert.equal(migrateIncomingTerminalFontId(null), null);
});
test("readable foreground picks white text for dark accent colors", () => {
assert.equal(resolveReadableForegroundForHsl("270 70% 45%"), "0 0% 100%");
});
test("readable foreground picks black text for light accent colors", () => {
assert.equal(resolveReadableForegroundForHsl("48 95% 72%"), "0 0% 0%");
});
test("computed contrast chooses the stronger black or white foreground", () => {
const purpleLuminance = getHslTokenRelativeLuminance("270 70% 45%");
assert.equal(typeof purpleLuminance, "number");
assert.ok(getContrastRatio(1, purpleLuminance as number) > getContrastRatio(0, purpleLuminance as number));
const yellowLuminance = getHslTokenRelativeLuminance("48 95% 72%");
assert.equal(typeof yellowLuminance, "number");
assert.ok(getContrastRatio(0, yellowLuminance as number) > getContrastRatio(1, yellowLuminance as number));
});
test("theme accent foreground uses the computed color for preset accent buttons", () => {
const tokens: UiThemeTokens = {
background: "0 0% 100%",
foreground: "222 47% 12%",
card: "0 0% 100%",
cardForeground: "222 47% 12%",
popover: "0 0% 100%",
popoverForeground: "222 47% 12%",
primary: "270 70% 45%",
primaryForeground: "0 0% 0%",
secondary: "220 12% 95%",
secondaryForeground: "222 47% 12%",
muted: "220 12% 95%",
mutedForeground: "220 10% 45%",
accent: "270 70% 45%",
accentForeground: "0 0% 0%",
destructive: "0 70% 50%",
destructiveForeground: "0 0% 100%",
border: "220 12% 88%",
input: "220 12% 88%",
ring: "270 70% 45%",
};
assert.equal(resolveThemeAccentForeground(tokens, "theme", "48 95% 72%"), "0 0% 100%");
assert.equal(resolveThemeAccentForeground(tokens, "custom", "48 95% 72%"), "0 0% 0%");
});
test("app surface theme vars isolate non-terminal pages from active terminal chrome", () => {
const tokens: UiThemeTokens = {
background: "0 0% 100%",
foreground: "222 47% 12%",
card: "0 0% 100%",
cardForeground: "222 47% 12%",
popover: "0 0% 100%",
popoverForeground: "222 47% 12%",
primary: "270 70% 45%",
primaryForeground: "0 0% 0%",
secondary: "220 12% 95%",
secondaryForeground: "222 47% 12%",
muted: "220 12% 95%",
mutedForeground: "220 10% 45%",
accent: "270 70% 45%",
accentForeground: "0 0% 0%",
destructive: "0 70% 50%",
destructiveForeground: "0 0% 100%",
border: "220 12% 88%",
input: "220 12% 88%",
ring: "270 70% 45%",
};
assert.deepEqual(buildAppThemeCssVars(tokens, "theme", "48 95% 72%"), {
"--background": "0 0% 100%",
"--foreground": "222 47% 12%",
"--card": "0 0% 100%",
"--card-foreground": "222 47% 12%",
"--popover": "0 0% 100%",
"--popover-foreground": "222 47% 12%",
"--primary": "270 70% 45%",
"--primary-foreground": "0 0% 100%",
"--secondary": "220 12% 95%",
"--secondary-foreground": "222 47% 12%",
"--muted": "220 12% 95%",
"--muted-foreground": "220 10% 45%",
"--accent": "270 70% 45%",
"--accent-foreground": "0 0% 100%",
"--destructive": "0 70% 50%",
"--destructive-foreground": "0 0% 100%",
"--border": "220 12% 88%",
"--input": "220 12% 88%",
"--ring": "270 70% 45%",
});
});
test("migrateMaterializedAutoCloseOnExitDefault resets the materialized default-on once", () => {
const store = installMemoryLocalStorage();
try {
store.set(
STORAGE_KEY_TERM_SETTINGS,
JSON.stringify({ scrollback: 3000, autoCloseOnExit: true }),
);
migrateMaterializedAutoCloseOnExitDefault();
const migrated = JSON.parse(store.get(STORAGE_KEY_TERM_SETTINGS)!);
assert.equal(migrated.autoCloseOnExit, false);
// Other saved settings pass through untouched.
assert.equal(migrated.scrollback, 3000);
assert.equal(store.get(STORAGE_KEY_TERM_AUTO_CLOSE_EXIT_MIGRATED), "true");
} finally {
delete (globalThis as { localStorage?: unknown }).localStorage;
}
});
test("migrateMaterializedAutoCloseOnExitDefault runs once and respects later explicit edits", () => {
const store = installMemoryLocalStorage();
try {
store.set(
STORAGE_KEY_TERM_SETTINGS,
JSON.stringify({ autoCloseOnExit: true }),
);
migrateMaterializedAutoCloseOnExitDefault();
assert.equal(
JSON.parse(store.get(STORAGE_KEY_TERM_SETTINGS)!).autoCloseOnExit,
false,
);
// The user re-enables after upgrading: the migration must not undo it again.
store.set(
STORAGE_KEY_TERM_SETTINGS,
JSON.stringify({ autoCloseOnExit: true }),
);
migrateMaterializedAutoCloseOnExitDefault();
assert.equal(
JSON.parse(store.get(STORAGE_KEY_TERM_SETTINGS)!).autoCloseOnExit,
true,
);
} finally {
delete (globalThis as { localStorage?: unknown }).localStorage;
}
});
test("migrateMaterializedAutoCloseOnExitDefault leaves fresh installs and explicit-off alone", () => {
const store = installMemoryLocalStorage();
try {
// Fresh install: no saved settings at all.
migrateMaterializedAutoCloseOnExitDefault();
assert.equal(store.has(STORAGE_KEY_TERM_SETTINGS), false);
assert.equal(store.get(STORAGE_KEY_TERM_AUTO_CLOSE_EXIT_MIGRATED), "true");
// Explicit-off (or any settings blob without the key) is never rewritten.
delete (globalThis as { localStorage?: unknown }).localStorage;
const store2 = installMemoryLocalStorage();
store2.set(
STORAGE_KEY_TERM_SETTINGS,
JSON.stringify({ scrollback: 500 }),
);
migrateMaterializedAutoCloseOnExitDefault();
assert.deepEqual(JSON.parse(store2.get(STORAGE_KEY_TERM_SETTINGS)!), {
scrollback: 500,
});
} finally {
delete (globalThis as { localStorage?: unknown }).localStorage;
}
});
test("migrateMaterializedShiftEnterNewlineDefault rewrites the old default once", () => {
const store = installMemoryLocalStorage();
try {
store.set(
STORAGE_KEY_TERM_SETTINGS,
JSON.stringify({ scrollback: 3000, shiftEnterNewlineText: "\\n" }),
);
migrateMaterializedShiftEnterNewlineDefault();
const migrated = JSON.parse(store.get(STORAGE_KEY_TERM_SETTINGS)!);
assert.equal(migrated.shiftEnterNewlineText, "\\e\\r");
assert.equal(migrated.scrollback, 3000);
assert.equal(store.get(STORAGE_KEY_TERM_SHIFT_ENTER_NEWLINE_MIGRATED), "true");
store.set(
STORAGE_KEY_TERM_SETTINGS,
JSON.stringify({ scrollback: 3000, shiftEnterNewlineText: "\\n" }),
);
migrateMaterializedShiftEnterNewlineDefault();
assert.equal(
JSON.parse(store.get(STORAGE_KEY_TERM_SETTINGS)!).shiftEnterNewlineText,
"\\n",
);
} finally {
delete (globalThis as { localStorage?: unknown }).localStorage;
}
});
test("migrateMaterializedShiftEnterNewlineDefault rewrites a raw stored newline", () => {
const store = installMemoryLocalStorage();
try {
store.set(
STORAGE_KEY_TERM_SETTINGS,
JSON.stringify({ shiftEnterNewlineText: "\n" }),
);
migrateMaterializedShiftEnterNewlineDefault();
assert.equal(
JSON.parse(store.get(STORAGE_KEY_TERM_SETTINGS)!).shiftEnterNewlineText,
"\\e\\r",
);
} finally {
delete (globalThis as { localStorage?: unknown }).localStorage;
}
});
test("migrateMaterializedShiftEnterNewlineDefault keeps custom Shift+Enter text", () => {
const store = installMemoryLocalStorage();
try {
store.set(
STORAGE_KEY_TERM_SETTINGS,
JSON.stringify({ shiftEnterNewlineText: "\\r", scrollback: 1000 }),
);
migrateMaterializedShiftEnterNewlineDefault();
assert.deepEqual(JSON.parse(store.get(STORAGE_KEY_TERM_SETTINGS)!), {
shiftEnterNewlineText: "\\r",
scrollback: 1000,
});
assert.equal(store.get(STORAGE_KEY_TERM_SHIFT_ENTER_NEWLINE_MIGRATED), "true");
} finally {
delete (globalThis as { localStorage?: unknown }).localStorage;
}
});
test("migrateMaterializedShiftEnterNewlineDefault leaves a fresh install without a settings blob", () => {
const store = installMemoryLocalStorage();
try {
migrateMaterializedShiftEnterNewlineDefault();
assert.equal(store.has(STORAGE_KEY_TERM_SETTINGS), false);
assert.equal(store.get(STORAGE_KEY_TERM_SHIFT_ENTER_NEWLINE_MIGRATED), "true");
} finally {
delete (globalThis as { localStorage?: unknown }).localStorage;
}
});