Files
Netcatty/components/scripts/QuickScriptEditorDialog.tsx
T
陈大猫 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

269 lines
8.8 KiB
TypeScript

import React, { useCallback, useEffect, useMemo, useState } from 'react';
import type { Host, Snippet } from '@/domain/models';
import {
DEFAULT_SCRIPT_TEMPLATE,
isScriptSnippet,
} from '@/domain/snippetScript.ts';
import {
getRunnableHostsForSnippet,
} from '@/domain/snippetTargets.ts';
import {
removeHostConnectScript,
syncHostsForSnippetTargetChange,
} from '@/domain/hostConnectScripts.ts';
import { ScriptEditorModal } from '@/components/scripts/ScriptEditorModal';
import { toast } from '@/components/ui/toast';
import { useI18n } from '@/application/i18n/I18nProvider';
export interface QuickScriptEditorDialogProps {
snippets: Snippet[];
packages: string[];
hosts: Host[];
customGroups?: string[];
onCreateSnippet: (snippet: Snippet) => void;
onUpdateSnippet: (snippet: Snippet) => void;
onCreatePackage?: (packagePath: string) => void;
onUpdateHosts?: (hosts: Host[]) => void;
onRunSnippet?: (snippet: Snippet, targetHosts: Host[]) => void;
}
function createBlankScript(): Partial<Snippet> {
return {
label: '',
command: DEFAULT_SCRIPT_TEMPLATE,
package: '',
targets: [],
kind: 'script',
language: 'javascript',
trigger: 'manual',
};
}
export const QuickScriptEditorDialog: React.FC<QuickScriptEditorDialogProps> = ({
snippets,
packages,
hosts,
customGroups = [],
onCreateSnippet,
onUpdateSnippet,
onCreatePackage,
onUpdateHosts,
onRunSnippet,
}) => {
const { t } = useI18n();
const [open, setOpen] = useState(false);
const [editingSnippet, setEditingSnippet] = useState<Partial<Snippet>>(createBlankScript);
const [targetSelection, setTargetSelection] = useState<string[]>([]);
useEffect(() => {
const handler = () => {
setEditingSnippet(createBlankScript());
setTargetSelection([]);
setOpen(true);
};
window.addEventListener('netcatty:scripts:add', handler);
return () => window.removeEventListener('netcatty:scripts:add', handler);
}, []);
useEffect(() => {
const handler = (event: Event) => {
const snippet = (event as CustomEvent<{ snippet?: Snippet }>).detail?.snippet;
if (!snippet || !isScriptSnippet(snippet)) return;
setEditingSnippet(snippet);
setTargetSelection(snippet.targetsAllHosts ? [] : (snippet.targets ?? []));
setOpen(true);
};
window.addEventListener('netcatty:snippets:edit', handler);
return () => window.removeEventListener('netcatty:snippets:edit', handler);
}, []);
useEffect(() => {
const handler = (event: Event) => {
const detail = (event as CustomEvent<{
name: string;
packagePath: string;
code: string;
editAfterSave: boolean;
}>).detail;
if (!detail?.code?.trim()) return;
const packagePath = detail.packagePath?.trim() ?? '';
if (packagePath && !packages.includes(packagePath)) {
onCreatePackage?.(packagePath);
}
const snippet: Snippet = {
id: crypto.randomUUID(),
label: detail.name?.trim() || 'Recorded script',
command: detail.code,
package: packagePath,
targets: [],
kind: 'script',
language: 'javascript',
trigger: 'manual',
};
onCreateSnippet(snippet);
toast.success(t('scripts.recording.savedNamed', { name: snippet.label }));
window.dispatchEvent(new CustomEvent('netcatty:scripts:saved', {
detail: { snippetId: snippet.id, packagePath },
}));
if (detail.editAfterSave) {
setEditingSnippet(snippet);
setTargetSelection([]);
setOpen(true);
}
};
window.addEventListener('netcatty:scripts:save-recorded', handler);
return () => window.removeEventListener('netcatty:scripts:save-recorded', handler);
}, [onCreatePackage, onCreateSnippet, packages, t]);
const hostById = useMemo(
() => new Map(hosts.map((host) => [host.id, host])),
[hosts],
);
const targetHosts = useMemo(
() => targetSelection.map((id) => hostById.get(id)).filter(Boolean) as Host[],
[hostById, targetSelection],
);
const runnableSnippet = useMemo(() => ({
...(editingSnippet as Snippet),
targets: editingSnippet.targetsAllHosts ? [] : targetSelection,
targetsAllHosts: editingSnippet.targetsAllHosts || undefined,
}), [editingSnippet, targetSelection]);
const runTargets = useMemo(
() => getRunnableHostsForSnippet(runnableSnippet, hosts),
[hosts, runnableSnippet],
);
const canRun = Boolean(editingSnippet.command?.trim()) && runTargets.length > 0;
const syncHostsAfterSave = useCallback((savedSnippet: Snippet, nextSnippets: Snippet[]) => {
if (!onUpdateHosts || !savedSnippet.id) return;
const original = snippets.find((item) => item.id === savedSnippet.id);
const prevTargetIds = original?.targetsAllHosts ? [] : (original?.targets ?? []);
let nextHosts = hosts;
if (isScriptSnippet(savedSnippet) && savedSnippet.trigger === 'onConnect') {
nextHosts = syncHostsForSnippetTargetChange(hosts, savedSnippet, prevTargetIds, nextSnippets);
} else if (original && isScriptSnippet(original) && original.trigger === 'onConnect') {
nextHosts = hosts.map((item) => removeHostConnectScript(item, savedSnippet.id!, nextSnippets));
}
const changed = nextHosts.length !== hosts.length
|| nextHosts.some((host, index) => host !== hosts[index]);
if (changed) {
onUpdateHosts(nextHosts);
}
}, [hosts, onUpdateHosts, snippets]);
const buildSavedSnippet = useCallback((): Snippet | null => {
if (!editingSnippet.label?.trim() || !editingSnippet.command?.trim()) return null;
const packagePath = editingSnippet.package?.trim() ?? '';
if (packagePath && !packages.includes(packagePath)) {
onCreatePackage?.(packagePath);
}
return {
id: editingSnippet.id || crypto.randomUUID(),
label: editingSnippet.label.trim(),
command: editingSnippet.command,
tags: editingSnippet.tags ?? [],
package: packagePath,
targets: editingSnippet.targetsAllHosts ? [] : targetSelection,
targetsAllHosts: editingSnippet.targetsAllHosts || undefined,
kind: 'script',
language: editingSnippet.language ?? 'javascript',
description: editingSnippet.description,
trigger: editingSnippet.trigger ?? 'manual',
triggerPattern: editingSnippet.triggerPattern,
order: editingSnippet.order,
};
}, [editingSnippet, onCreatePackage, packages, targetSelection]);
const persistSnippet = useCallback((): Snippet | null => {
const savedSnippet = buildSavedSnippet();
if (!savedSnippet) return null;
const nextSnippets = snippets.some((item) => item.id === savedSnippet.id)
? snippets.map((item) => (item.id === savedSnippet.id ? savedSnippet : item))
: [...snippets, savedSnippet];
if (snippets.some((item) => item.id === savedSnippet.id)) {
onUpdateSnippet(savedSnippet);
} else {
onCreateSnippet(savedSnippet);
}
syncHostsAfterSave(savedSnippet, nextSnippets);
return savedSnippet;
}, [buildSavedSnippet, onCreateSnippet, onUpdateSnippet, snippets, syncHostsAfterSave]);
const handleSave = useCallback(() => {
if (!persistSnippet()) return;
setOpen(false);
}, [persistSnippet]);
const handleRun = useCallback(() => {
const savedSnippet = persistSnippet();
if (!savedSnippet) return;
const targets = getRunnableHostsForSnippet(savedSnippet, hosts);
if (targets.length === 0) {
toast.error(t('scripts.actions.noRunnableHosts'));
return;
}
if (onRunSnippet) {
onRunSnippet(savedSnippet, targets);
} else {
window.dispatchEvent(new CustomEvent('netcatty:scripts:run-now', {
detail: { snippet: savedSnippet },
}));
}
setOpen(false);
}, [hosts, onRunSnippet, persistSnippet, t]);
const handleSelectHost = useCallback((host: Host) => {
setTargetSelection((prev) => (
prev.includes(host.id)
? prev.filter((id) => id !== host.id)
: [...prev, host.id]
));
}, []);
const handleTargetsAllHostsChange = useCallback((checked: boolean) => {
if (checked) {
setTargetSelection([]);
setEditingSnippet((prev) => ({
...prev,
targetsAllHosts: true,
targets: [],
}));
return;
}
setEditingSnippet((prev) => ({
...prev,
targetsAllHosts: undefined,
}));
}, []);
return (
<ScriptEditorModal
open={open}
onClose={() => setOpen(false)}
snippet={editingSnippet as Snippet}
onChange={setEditingSnippet}
onSave={handleSave}
canRun={canRun}
onRun={canRun ? handleRun : undefined}
targetHosts={targetHosts}
hosts={hosts}
customGroups={customGroups}
selectedHostIds={targetSelection}
onSelectHost={handleSelectHost}
targetsAllHosts={Boolean(editingSnippet.targetsAllHosts)}
onTargetsAllHostsChange={handleTargetsAllHostsChange}
/>
);
};