Files
Netcatty/domain/snippetScript.ts
T
陈大猫andCursor 6b9b71ac8a feat(scripts): terminal script automation, recording, and side panel (#1763)
* feat(scripts): add terminal script automation, recording, and side panel

Introduce nct script runtime in the main process with terminal-side recording,
execution overlay, Monaco editor, connect-script queues, and scripts side panel
integration. Fix recording to wire scriptRecorderRef into xterm, use waitForPrompt
for root/user shells, and save recorded scripts through the global editor dialog.

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

* fix(scripts): address Bugbot review findings for recording and side panel

Refresh script run state in side panel memo, guard toolbar recording against
multi-session conflicts, reset connect scripts on reconnect, resolve focused
session via getActiveTerminalSessionId, and avoid wiping host edit form when
snippets list updates.

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

* fix(scripts): prevent pending script re-run and improve workspace run feedback

Track one-shot pendingScript execution separately from onConnect queue so
reconnects do not replay Run-now scripts. Fall back to focused session when
running on all tabs outside a workspace, and toast when every tab is still
connecting.

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

* fix(scripts): consume connect-script window once and filter serial hosts

Mark the onConnect script evaluation as consumed even when the queue is
empty so later snippet/host edits do not rerun automation mid-session.
Restore serial-host filtering in SelectHostPanel confirm handler.

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

* fix(scripts): grace period before giving up on connect-script queue

Only mark onConnect automation as consumed after scripts run or a short
post-connect grace window expires, so late-loading snippets still trigger
while mid-session Vault edits do not.

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

* fix(scripts): gate connect-script consumption on vault hydration

Replace the grace timer with vault-init and unresolved host script binding
checks so late-loading snippets still run onConnect automation while
mid-session edits stay suppressed. Clear pending script run state on
disconnect so reconnect retries workspace pending scripts.

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

* fix(scripts): honor run targets and retry failed connect automation

Route QuickScriptEditorDialog Run through onRunSnippet for multi-host
workspaces. Defer connect/pending script completion markers until each
script succeeds and retry the queue after failures.

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

* fix(scripts): stabilize pending runs and global connect queue sync

Keep pending script run state across reconnects, run onConnect scripts
before one-shot workspace pending scripts, and strip per-host queue entries
when an onConnect script targets all hosts.

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

* fix(scripts): defer host queue snippet sync and guard connect runs

Persist snippet target links only when the host panel is saved, block
duplicate connect-script scheduling while a batch is running, and require
runnable hosts before showing Run in the snippets editor footer.

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

* fix(scripts): retry connect failures and surface output-trigger errors

Use a retry tick in connect-script effect deps, toast automation failures
from output triggers, and require runnable hosts before QuickScript Run.

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

* fix(scripts): track id-less pending runs and re-arm output triggers

Remember anonymous pendingScript objects after first run and allow
onOutput triggers to fire again when new terminal output arrives.

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

* fix(scripts): unblock paused connect runs and pass session meta

Resolve waitForScriptRun on pause, run workspace scripts per session
with hostname context, defer output-trigger arming until runs start, and
add noRunnableHosts i18n for QuickScript Run.

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

* fix(scripts): serialize output triggers and defer empty connect finalize

Fire at most one onOutput trigger per scan while a run is active, and
only finalize an empty connect queue after vault snippets are loaded.

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

* fix(scripts): guard output launch race and script run waits

Block overlapping onOutput launches, timeout stuck waitForScriptRun
promises, and disable vault Run when no connectable targets exist.

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

* fix(scripts): match output triggers on new chunks only

Scan onOutput patterns against recent terminal output instead of buffer
length dedupe, and restore overflow-visible on SelectHostPanel new-host flow.

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

* fix(scripts): await sequential workspace runs and output launch

Wait for each tab script to finish in sequential workspace mode, and hold
output-trigger launch guard until the session run becomes active.

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

* fix(scripts): wait through pause and hold output trigger until done

Keep connect and sequential workspace queues blocked until scripts
complete or fail, and retain output-trigger guard until the launched run
finishes.

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

* fix(scripts): harden output trigger wait helpers

Add explicit timeouts to output-trigger wait helpers and stop rescanning
the buffer after script completion to avoid sticky-match rerun loops.

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

* fix(scripts): allow empty connect queue and match output in new chunks

Treat an empty connectScriptIds array as an explicit cleared queue instead
of re-migrating from snippet targets, and only fire onOutput triggers when
the latest terminal output contains the pattern.

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

* fix(scripts): require fresh output overlap for onOutput triggers

Only fire output-matched scripts when the regex match extends into the
latest terminal chunk, preventing reruns from stale buffer text.

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

* fix(scripts): promote manual scripts added to host connect queue

Diff connect queue changes from raw connectScriptIds so saving a host
updates manual scripts to onConnect when they are newly queued.

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

* fix(scripts): dedupe output triggers by match position

Track the buffer end offset of each output trigger match and ignore
stale re-scans, with a longer wait for run registration before retry.

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

* fix(scripts): record output trigger matches only after run starts

Propagate automation launch failures to output triggers and commit match
dedupe only once the session run is registered as active.

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

* fix(scripts): address Codex review on wait cursor and sensitive codegen

Track scan offset so waitFor/waitForAny only match output after the previous wait, and emit sendLine after sensitive prompt in recorded scripts.

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

* fix(scripts): harden onOutput triggers against PTY echo and local input

Filter server output before pattern matching so onOutput fires only after
Enter on real stdout, not on keystroke/paste echo, OSC/SGR sequences, or
alternate-screen apps. Add dev diagnostics and scope triggers to the active
session when no explicit host targets are configured.

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

* chore(scripts): remove onOutput trigger debug logging

Drop temporary diagnostics module and console traces now that PTY echo
filtering is verified; keep the production trigger pipeline unchanged.

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

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-06-28 23:48:12 +08:00

178 lines
7.0 KiB
TypeScript

import type { Snippet, SnippetKind } from './models';
export function getSnippetKind(snippet: Pick<Snippet, 'kind'>): SnippetKind {
return snippet.kind === 'script' ? 'script' : 'snippet';
}
export function isScriptSnippet(snippet: Pick<Snippet, 'kind'>): boolean {
return getSnippetKind(snippet) === 'script';
}
/** Common interactive shell prompts (root uses #, regular user uses $). */
export const DEFAULT_SHELL_PROMPT_PATTERNS = ['# ', '$ ', '~# ', '~$ ', '% '];
/** Default wait after each recorded command — matches waitForPrompt in generated scripts. */
export const DEFAULT_RECORDING_PROMPT_TIMEOUT_MS = 30000;
/** Regex matching a shell prompt on the last line (~# / ~$ / user@host:path#). */
export const SHELL_PROMPT_END_REGEX = /(?:~[#$]\s*|[@][^\n]{0,120}[:][^\n]{0,120}[#$%]\s*)$/m;
/** Minimal smoke script for verifying manual run and onOutput triggers. */
export const SCRIPT_SMOKE_TEST = `// === Smoke test ===
// Manual: trigger=manual, pick a target host, click "Run now"
// onOutput: trigger=onOutput, pattern=NETCATTY_SMOKE, save, connect to target host, then run: echo NETCATTY_SMOKE
//
await nct.screen.waitForPrompt(30000);
await nct.screen.sendLine('echo netcatty-smoke-ok');
nct.log('Smoke test passed');
await nct.dialog.alert('Netcatty script smoke test OK');
`;
/** Full integration test for onConnect / manual run; dialog API enabled by default. */
export const SCRIPT_INTEGRATION_TEST = `// Netcatty Integration Test — onConnect / manual full API exercise
// Trigger: onConnect or Run now | Permission: Auto or Confirm (dialogs need non-Observer)
const CONFIG = {
SAMPLE_COUNT: 8,
SAMPLE_INTERVAL_MS: 2000,
PROMPT_TIMEOUT_MS: 60000,
STEP_TIMEOUT_MS: 20000,
RUN_DIALOGS: true,
RUN_SESSION_LOG: false,
RUN_SCREEN_CLEAR: false,
};
async function main() {
const tag = \`nc-it-\${Date.now().toString(36)}\`;
nct.log('=== Netcatty Integration Test START ===');
nct.log(\`tag=\${tag} nct.version=\${nct.version}\`);
nct.log(\`session: host=\${nct.session.hostname} user=\${nct.session.username} connected=\${nct.session.connected}\`);
if (!nct.session.connected) {
throw new Error('Session not connected');
}
nct.log('[1/12] waitForPrompt');
await nct.screen.waitForPrompt(CONFIG.PROMPT_TIMEOUT_MS);
nct.log('[2/12] sendLine + waitFor literal');
await nct.screen.sendLine(\`echo "\${tag}_BOOTSTRAP_OK"\`);
await nct.screen.waitFor(\`\${tag}_BOOTSTRAP_OK\`, CONFIG.STEP_TIMEOUT_MS);
nct.log('[3/12] waitForAny');
await nct.screen.sendLine('echo ANY_CHECK && uname -s');
await nct.screen.waitForAny(['ANY_CHECK', /Linux/], CONFIG.STEP_TIMEOUT_MS);
nct.log('[4/12] getText / rows / cols / currentRow');
const text = await nct.screen.getText();
const lineCount = text.split('\\n').filter(Boolean).length;
nct.log(\`captured \${lineCount} lines, rows=\${nct.screen.rows} cols=\${nct.screen.cols} cursorRow=\${nct.screen.currentRow}\`);
nct.log('[5/12] send raw + Enter');
await nct.screen.send(\`echo -n "\${tag}_RAW"\`);
await nct.screen.sendLine('');
await nct.screen.waitFor(\`\${tag}_RAW\`, CONFIG.STEP_TIMEOUT_MS);
nct.log('[6/12] waitFor regex');
await nct.screen.sendLine(\`echo BUILD_ID=\${tag}\`);
await nct.screen.waitFor(new RegExp(\`BUILD_ID=\${tag}\`), CONFIG.STEP_TIMEOUT_MS);
nct.log('[7/12] session.sleep / nct.sleep');
await nct.session.sleep(800);
await nct.sleep(800);
nct.log('[8/12] progress loop health sampling');
nct.progress.start('Health sampling', CONFIG.SAMPLE_COUNT);
for (let i = 1; i <= CONFIG.SAMPLE_COUNT; i += 1) {
const cmd = [
\`echo "== Sample \${i}/\${CONFIG.SAMPLE_COUNT} =="\`,
'date',
'uptime',
"free -h | awk 'NR==2{print $1,$2,$3,$4,$7}'",
"df -h / | awk 'NR==2{print $1,$2,$3,$5,$6}'",
\`echo "\${tag}_SAMPLE_\${i}_DONE"\`,
].join(' && ');
await nct.screen.sendLine(cmd);
await nct.screen.waitFor(new RegExp(\`\${tag}_SAMPLE_\${i}_DONE\`), CONFIG.STEP_TIMEOUT_MS);
await nct.screen.waitForPrompt(CONFIG.PROMPT_TIMEOUT_MS);
nct.progress.step(\`sample \${i}/\${CONFIG.SAMPLE_COUNT}\`);
nct.log(\`sample \${i}/\${CONFIG.SAMPLE_COUNT} ok\`);
if (i < CONFIG.SAMPLE_COUNT) {
await nct.session.sleep(CONFIG.SAMPLE_INTERVAL_MS);
}
}
nct.progress.done();
nct.log('[9/12] nested loop activity mode');
const checks = ['whoami', 'id -u', 'pwd', 'echo $SHELL'];
for (const check of checks) {
await nct.screen.sendLine(check);
await nct.screen.waitForPrompt(CONFIG.PROMPT_TIMEOUT_MS);
}
if (CONFIG.RUN_SESSION_LOG) {
nct.log('[10/12] startLog / stopLog');
await nct.session.startLog(\`./netcatty-it-\${tag}.log\`);
await nct.screen.sendLine(\`echo "\${tag}_LOGGED"\`);
await nct.screen.waitFor(\`\${tag}_LOGGED\`, CONFIG.STEP_TIMEOUT_MS);
await nct.session.stopLog();
} else {
nct.log('[10/12] startLog/stopLog skipped');
}
if (CONFIG.RUN_SCREEN_CLEAR) {
nct.log('[11/12] screen.clear');
await nct.screen.clear();
await nct.session.sleep(500);
await nct.screen.waitForPrompt(CONFIG.PROMPT_TIMEOUT_MS);
} else {
nct.log('[11/12] screen.clear skipped');
}
if (CONFIG.RUN_DIALOGS) {
nct.log('[12/12] dialog confirm / prompt / alert');
const go = await nct.dialog.confirm(\`Integration test \${tag} finished OK. Continue to prompt/alert?\`);
nct.log(\`confirm => \${go}\`);
if (go) {
const note = await nct.dialog.prompt('Optional note:', 'all-good');
nct.log(\`prompt => \${note}\`);
await nct.dialog.alert(\`Done. note=\${note}\`);
} else {
nct.log('confirm declined — skipping prompt/alert');
}
} else {
nct.log('[12/12] dialog skipped');
}
await nct.screen.sendLine(\`echo "=== \${tag} ALL_PASSED ==="\`);
await nct.screen.waitFor(\`\${tag} ALL_PASSED\`, CONFIG.STEP_TIMEOUT_MS);
nct.log('=== Netcatty Integration Test PASSED ===');
}
await main();
`;
export const DEFAULT_SCRIPT_TEMPLATE = `// Netcatty automation script - async JS in the active terminal session
//
// nct.screen.waitForPrompt(ms?) wait for shell prompt (# root / $ user)
// nct.screen.waitFor(pattern, ms?) wait for output (string or /regex/, default 30s)
// nct.screen.waitForAny([patterns], ms?) wait until any pattern matches
// nct.screen.sendLine(cmd) type command + Enter; send(text) raw keys only
// nct.screen.getText(start?, end?) | clear()
// nct.session.sleep(ms) | startLog(path) | stopLog() | disconnect()
// nct.dialog.confirm(msg)->bool | prompt(msg, def?)->string | alert(msg)
// nct.progress.start(label, total) opt-in determinate progress for loops
// nct.progress.step(detail?) | set(n, detail?) | done()
// nct.log(msg) run log panel. Type "nct." in editor for autocomplete snippets.
//
await nct.screen.waitForPrompt(30000);
await nct.screen.sendLine('echo hello');
nct.log('Done');
`;
const SCRIPT_WRITE_PATTERN = /nct\.screen\.(send(?:Line)?|clear)\s*\(|nct\.session\.(disconnect|startLog)\s*\(/;
export function scriptContainsWriteOperations(content: string): boolean {
return SCRIPT_WRITE_PATTERN.test(String(content || ''));
}