Files
Netcatty/components/terminal/osc7Setup.test.ts
T
陈大猫 1e939c9b31 [codex] Fix terminal WebGL atlas corruption (#1556)
* fix terminal webgl atlas corruption

* fix osc7 setup shell compatibility
2026-06-22 16:34:28 +08:00

182 lines
6.8 KiB
TypeScript

import test from "node:test";
import assert from "node:assert/strict";
import { execFileSync } from "node:child_process";
import { existsSync, mkdirSync, mkdtempSync, readFileSync, realpathSync, rmSync } from "node:fs";
import { tmpdir } from "node:os";
import { basename, join } from "node:path";
import { OSC7_MARKER, buildOsc7SetupCommand, shouldOfferOsc7SetupAction } from "./osc7Setup";
const runSetup = (env: NodeJS.ProcessEnv) => {
execFileSync("/bin/sh", ["-c", buildOsc7SetupCommand()], {
env: { ...process.env, ZDOTDIR: "", XDG_CONFIG_HOME: "", ...env },
stdio: "pipe",
});
};
const withTempHome = (prefix: string, fn: (home: string) => void) => {
const home = mkdtempSync(join(tmpdir(), prefix));
try {
fn(home);
} finally {
rmSync(home, { recursive: true, force: true });
}
};
const markerCount = (content: string) => content.split(OSC7_MARKER).length - 1;
const existingShells = (paths: string[]) => Array.from(new Set(paths.filter(existsSync)));
const supportedShells = () => existingShells(["/bin/bash", "/bin/zsh", "/usr/bin/zsh", "/opt/homebrew/bin/fish", "/usr/bin/fish"]);
const extractOsc7Path = (output: string) => {
const escape = String.fromCharCode(0x1b);
const bell = String.fromCharCode(0x07);
const payloadStart = output.indexOf(`${escape}]7;`);
assert.notEqual(payloadStart, -1, "expected OSC 7 output");
const payload = output.slice(payloadStart + `${escape}]7;`.length);
const terminators = [payload.indexOf(escape), payload.indexOf(bell)].filter((index) => index >= 0);
const payloadEnd = terminators.length > 0 ? Math.min(...terminators) : payload.length;
const fileUrl = payload.slice(0, payloadEnd);
assert.ok(fileUrl.startsWith("file://"), "expected OSC 7 file URL");
return decodeURIComponent(new URL(fileUrl).pathname);
};
test("shouldOfferOsc7SetupAction only allows remote shell-style sessions", () => {
assert.equal(shouldOfferOsc7SetupAction({ protocol: "ssh" }), true);
assert.equal(shouldOfferOsc7SetupAction({ protocol: "mosh" }), true);
assert.equal(shouldOfferOsc7SetupAction({ protocol: "et" }), true);
assert.equal(shouldOfferOsc7SetupAction({ protocol: "telnet" }), false);
assert.equal(shouldOfferOsc7SetupAction({ protocol: "ssh", isNetworkDevice: true }), false);
assert.equal(shouldOfferOsc7SetupAction({ protocol: "local", isLocalConnection: true }), false);
assert.equal(shouldOfferOsc7SetupAction({ protocol: "serial", isSerialConnection: true }), false);
});
test("buildOsc7SetupCommand configures bash once and prompt loading stays idempotent", () => {
withTempHome("netcatty-osc7-bash-", (home) => {
runSetup({ HOME: home, SHELL: "/bin/bash" });
runSetup({ HOME: home, SHELL: "/bin/bash" });
const bashrcPath = join(home, ".bashrc");
const bashrc = readFileSync(bashrcPath, "utf8");
assert.equal(markerCount(bashrc), 2);
assert.match(bashrc, /PROMPT_COMMAND/);
const output = execFileSync(
"/bin/bash",
[
"-lc",
`PROMPT_COMMAND=existing; source ${JSON.stringify(bashrcPath)}; source ${JSON.stringify(bashrcPath)}; printf '%s' "$PROMPT_COMMAND"`,
],
{ env: { ...process.env, HOME: home } },
).toString("utf8");
assert.equal(output.split("osc7_cwd").length - 1, 1);
});
});
test("buildOsc7SetupCommand honors zsh ZDOTDIR captured from the current shell", (t) => {
const zshPath = existingShells(["/bin/zsh", "/usr/bin/zsh"])[0];
if (!zshPath) {
t.skip("zsh is not installed on this runner");
return;
}
withTempHome("netcatty-osc7-zsh-", (home) => {
const zdotdir = join(home, ".config", "zsh");
runSetup({ HOME: home, SHELL: zshPath, ZDOTDIR: zdotdir });
runSetup({ HOME: home, SHELL: zshPath, ZDOTDIR: zdotdir });
const zshrcPath = join(zdotdir, ".zshrc");
const zshrc = readFileSync(zshrcPath, "utf8");
assert.equal(markerCount(zshrc), 2);
assert.match(zshrc, /precmd_functions/);
assert.equal(existsSync(join(home, ".zshrc")), false);
execFileSync(zshPath, ["-uc", `source ${JSON.stringify(zshrcPath)}; print -r -- "\${precmd_functions[*]}"`], {
env: { ...process.env, HOME: home, ZDOTDIR: zdotdir },
stdio: "pipe",
});
});
});
test("buildOsc7SetupCommand configures fish once with valid fish syntax", () => {
withTempHome("netcatty-osc7-fish-", (home) => {
const fishPath = existingShells(["/opt/homebrew/bin/fish", "/usr/bin/fish"])[0] ?? "/usr/bin/fish";
runSetup({ HOME: home, SHELL: fishPath });
runSetup({ HOME: home, SHELL: fishPath });
const fishConfigPath = join(home, ".config", "fish", "config.fish");
const fishConfig = readFileSync(fishConfigPath, "utf8");
assert.equal(markerCount(fishConfig), 2);
assert.match(fishConfig, /fish_prompt/);
if (existsSync(fishPath)) {
execFileSync(fishPath, ["-n", fishConfigPath], { stdio: "pipe" });
execFileSync(fishPath, ["-c", `source ${JSON.stringify(fishConfigPath)}; functions -q __netcatty_osc7_cwd`], {
env: { ...process.env, HOME: home },
stdio: "pipe",
});
}
});
});
test("buildOsc7SetupCommand can be pasted into supported shells", () => {
const shells = supportedShells();
if (process.env.CI) {
assert.ok(shells.some((shellPath) => basename(shellPath) === "fish"), "CI must exercise fish");
}
for (const shellPath of shells) {
withTempHome(`netcatty-osc7-${basename(shellPath)}-`, (home) => {
const zdotdir = join(home, "zdot");
const xdgConfigHome = join(home, "xdg");
const specialCwd = join(home, "space dir#frag?query%pct");
mkdirSync(specialCwd, { recursive: true });
const output = execFileSync(shellPath, ["-c", buildOsc7SetupCommand()], {
cwd: specialCwd,
env: {
...process.env,
HOME: home,
SHELL: shellPath,
ZDOTDIR: zdotdir,
XDG_CONFIG_HOME: xdgConfigHome,
},
stdio: "pipe",
}).toString("utf8");
const shellName = basename(shellPath);
const configPath = shellName === "bash"
? join(home, ".bashrc")
: shellName === "zsh"
? join(zdotdir, ".zshrc")
: join(xdgConfigHome, "fish", "config.fish");
const config = readFileSync(configPath, "utf8");
assert.equal(markerCount(config), 2, shellPath);
assert.equal(realpathSync(extractOsc7Path(output)), realpathSync(specialCwd), shellPath);
});
}
});
test("buildOsc7SetupCommand runs under strict unset-variable mode", () => {
for (const shellPath of existingShells(["/bin/bash", "/bin/zsh"])) {
withTempHome(`netcatty-osc7-strict-${basename(shellPath)}-`, (home) => {
execFileSync(shellPath, ["-uc", buildOsc7SetupCommand()], {
env: {
...process.env,
HOME: home,
SHELL: shellPath,
ZDOTDIR: undefined,
XDG_CONFIG_HOME: undefined,
},
stdio: "pipe",
});
});
}
});