Files
CodePilot/src/hooks/useAssistantTrigger.ts
T
7418andClaude Opus 4.6 e2a0f49843 fix: CAS lock for assistant trigger, LIKE escape, provider options race
Assistant trigger CAS (P1):
- hook-triggered route: added expectedOwner param for compare-and-swap —
  rejects if current owner doesn't match, closing the race where two tabs
  both clear then both claim the lock
- useAssistantTrigger: clear sends expectedOwner (stale session), set sends
  expectedOwner: null; non-2xx responses now bail instead of falling through
- Server-side completion (chat/route.ts): only clears lock if owner matches
  current sessionId, preventing completed sessions from wiping active locks
- Compensation branch: clear now passes expectedOwner to avoid bypassing CAS

Image-gen LIKE escape (P2):
- db.ts: escape backslashes before % and _ since ESCAPE '\' makes \ the
  escape char — prevents Windows paths / escaped JSON from corrupting the
  LIKE pattern and silently falling back to prompt-prefix matching

Provider options fetch race (P2):
- page.tsx + ChatView.tsx: provider options fetch now uses AbortController
  with cleanup on dependency change — prevents stale slow responses from
  overwriting the current provider's thinking/context_1m state

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-12 21:29:10 +08:00

299 lines
12 KiB
TypeScript

import { useCallback, useEffect, useRef } from 'react';
import type { Message, FileAttachment } from '@/types';
import { getLocalDateString } from '@/lib/utils';
import { startStream } from '@/lib/stream-session-manager';
// ── localStorage heartbeat for cross-tab liveness detection ──
// The session that owns the onboarding lock writes {sessionId, ts} every 10s.
// Other sessions check this to decide if the owner tab is still alive.
// The heartbeat is scoped: isOwnerAlive(hookTriggeredSessionId) only returns
// true if the heartbeat's sessionId matches, so a stale heartbeat from a
// completed session can't masquerade as a different session's owner.
const HEARTBEAT_KEY = 'codepilot:onboarding-heartbeat';
const HEARTBEAT_INTERVAL = 10_000; // write every 10s
const HEARTBEAT_STALE_MS = 30_000; // consider dead after 30s without update
/** Remove the heartbeat key only if it still belongs to the given session. */
function removeHeartbeatIfOwned(sessionId: string): void {
try {
const raw = localStorage.getItem(HEARTBEAT_KEY);
if (!raw) return;
const { sid } = JSON.parse(raw) as { sid: string };
if (sid === sessionId) {
localStorage.removeItem(HEARTBEAT_KEY);
}
} catch { /* ignore */ }
}
function startHeartbeat(sessionId: string): () => void {
if (typeof window === 'undefined') return () => {};
const write = () => {
try {
localStorage.setItem(HEARTBEAT_KEY, JSON.stringify({ sid: sessionId, ts: Date.now() }));
} catch { /* ignore */ }
};
write();
const id = setInterval(write, HEARTBEAT_INTERVAL);
return () => {
clearInterval(id);
removeHeartbeatIfOwned(sessionId);
};
}
/** Stop the heartbeat externally (called when onboarding/check-in completes). */
export function clearOnboardingHeartbeat(sessionId?: string): void {
if (typeof window === 'undefined') return;
if (sessionId) {
removeHeartbeatIfOwned(sessionId);
} else {
// Legacy fallback: unconditional remove (only when caller doesn't know sessionId)
try { localStorage.removeItem(HEARTBEAT_KEY); } catch { /* ignore */ }
}
}
/**
* Check if the tab owning the given sessionId is still alive.
* Returns false if the heartbeat is stale, missing, or belongs to a different session.
*/
function isOwnerAlive(expectedSessionId: string): boolean {
if (typeof window === 'undefined') return false;
try {
const raw = localStorage.getItem(HEARTBEAT_KEY);
if (!raw) return false;
const { sid, ts } = JSON.parse(raw) as { sid: string; ts: number };
if (sid !== expectedSessionId) return false;
return Date.now() - ts < HEARTBEAT_STALE_MS;
} catch {
return false;
}
}
interface UseAssistantTriggerOpts {
sessionId: string;
workingDirectory?: string;
isStreaming: boolean;
mode: string;
currentModel: string;
currentProviderId: string;
initialMessages: Message[];
handleModeChange: (mode: string) => void;
buildThinkingConfig: () => { type: string } | undefined;
sendMessageRef: React.MutableRefObject<((content: string, files?: FileAttachment[]) => Promise<void>) | undefined>;
initMetaRef: React.MutableRefObject<{ tools?: unknown; slash_commands?: unknown; skills?: unknown } | null>;
}
export function useAssistantTrigger({
sessionId,
workingDirectory,
isStreaming,
mode,
currentModel,
currentProviderId,
initialMessages,
handleModeChange,
buildThinkingConfig,
sendMessageRef,
initMetaRef,
}: UseAssistantTriggerOpts): () => void {
const assistantTriggerFiredRef = useRef(false);
const stopHeartbeatRef = useRef<(() => void) | null>(null);
// Clean up heartbeat on unmount (tab close, navigation away)
useEffect(() => {
return () => {
stopHeartbeatRef.current?.();
stopHeartbeatRef.current = null;
};
}, []);
// Stop heartbeat when the triggered stream finishes (onboarding/check-in completed or errored).
// assistantTriggerFiredRef means WE started the stream; !isStreaming means it's done.
useEffect(() => {
if (assistantTriggerFiredRef.current && !isStreaming && stopHeartbeatRef.current) {
stopHeartbeatRef.current();
stopHeartbeatRef.current = null;
}
}, [isStreaming]);
const checkAssistantTrigger = useCallback(async () => {
// Don't trigger if already streaming or already triggered in this mount
if (isStreaming || assistantTriggerFiredRef.current) return;
try {
const res = await fetch('/api/settings/workspace');
if (!res.ok) return;
const data = await res.json();
if (!data.path) return;
// Check if this session's working directory matches workspace path
if (workingDirectory !== data.path) return;
const state = data.state;
if (!state) return;
// Guard against duplicate triggers across sessions:
// 1. If ANOTHER session owns the lock, check if its tab is still alive via
// localStorage heartbeat. No fixed timeout — the heartbeat stops immediately
// when the tab closes/crashes, and we detect it within 30s.
// 2. If THIS session already triggered and has messages, don't re-trigger.
if (state.hookTriggeredSessionId && state.hookTriggeredSessionId !== sessionId) {
if (isOwnerAlive(state.hookTriggeredSessionId)) {
return; // Owning tab is still open, don't interfere
}
// Owner tab is gone — atomically clear the stale lock (CAS: only if owner
// is still the stale session we observed). If another tab already swapped
// in, the server returns owner_mismatch and we bail out.
try {
const clearRes = await fetch('/api/workspace/hook-triggered', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
sessionId: '__clear__',
expectedOwner: state.hookTriggeredSessionId,
}),
});
if (clearRes.ok) {
const clearData = await clearRes.json();
if (!clearData.success) return; // Another tab won the race
} else {
return;
}
} catch {
return; // Can't clear, err on the safe side
}
}
if (state.hookTriggeredSessionId === sessionId && initialMessages.length > 0) return;
const today = getLocalDateString();
const needsOnboarding = !state.onboardingComplete;
const needsCheckIn = state.onboardingComplete && state.lastCheckInDate !== today;
if (!needsOnboarding && !needsCheckIn) return;
// ── Compensation: check if a past message already contains a completion fence ──
// This handles the case where the server-side detection also missed (e.g. crash/restart)
// and the frontend is about to re-trigger onboarding unnecessarily.
if (needsOnboarding && initialMessages.length > 0) {
try {
const { extractCompletion } = await import('@/lib/onboarding-completion');
// Scan assistant messages from newest to oldest for an unprocessed completion
for (let i = initialMessages.length - 1; i >= 0; i--) {
const msg = initialMessages[i];
if (msg.role !== 'assistant') continue;
const completion = extractCompletion(msg.content);
if (completion?.type === 'onboarding') {
console.log('[useAssistantTrigger] Found unprocessed onboarding completion in message history, compensating...');
const resp = await fetch('/api/workspace/onboarding', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ answers: completion.answers, sessionId }),
});
if (resp.ok) {
await fetch('/api/workspace/hook-triggered', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
sessionId: '__clear__',
expectedOwner: state.hookTriggeredSessionId || null,
}),
}).catch(() => {});
console.log('[useAssistantTrigger] Onboarding compensation succeeded, skipping re-trigger');
return; // Don't re-trigger onboarding
}
break; // Found fence but processing failed — fall through to re-trigger
}
}
} catch (e) {
console.error('[useAssistantTrigger] Onboarding compensation check failed:', e);
}
}
// For daily check-in, only trigger in the most recent session for this workspace.
// This prevents older sessions from hijacking the check-in when reopened.
if (needsCheckIn) {
const latestRes = await fetch(`/api/workspace/latest-session?workingDirectory=${encodeURIComponent(data.path)}`);
if (latestRes.ok) {
const { sessionId: latestSessionId } = await latestRes.json();
if (latestSessionId && latestSessionId !== sessionId) return;
}
}
// Mark fired so we don't re-trigger on focus/re-render
assistantTriggerFiredRef.current = true;
// Start heartbeat BEFORE marking persistent state — so the heartbeat is
// already running when other tabs check liveness.
stopHeartbeatRef.current?.();
stopHeartbeatRef.current = startHeartbeat(sessionId);
// Mark in persistent state to prevent duplicate triggers across page reloads.
// CAS: only set owner if currently unowned (null). If another tab set itself
// as owner between our clear and this call, the server rejects and we bail.
try {
const setRes = await fetch('/api/workspace/hook-triggered', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ sessionId, expectedOwner: null }),
});
// Bail on any non-2xx (including 500) or CAS rejection — never
// proceed to startStream without a confirmed lock.
if (!setRes.ok) {
assistantTriggerFiredRef.current = false;
stopHeartbeatRef.current?.();
stopHeartbeatRef.current = null;
return;
}
const setData = await setRes.json();
if (!setData.success) {
// Lost race — another tab claimed ownership
assistantTriggerFiredRef.current = false;
stopHeartbeatRef.current?.();
stopHeartbeatRef.current = null;
return;
}
} catch {
// Network error — bail out
assistantTriggerFiredRef.current = false;
stopHeartbeatRef.current?.();
stopHeartbeatRef.current = null;
return;
}
// Use autoTrigger: the message is invisible (no user bubble, no title update)
const triggerMsg = needsOnboarding
? '请开始助理引导设置。'
: '请开始每日问询。';
startStream({
sessionId,
content: triggerMsg,
mode,
model: currentModel,
providerId: currentProviderId,
autoTrigger: true,
thinking: buildThinkingConfig(),
onModeChanged: (sdkMode) => {
const uiMode = sdkMode === 'plan' ? 'plan' : 'code';
handleModeChange(uiMode);
},
sendMessageFn: (retryContent: string, retryFiles?: FileAttachment[]) => {
sendMessageRef.current?.(retryContent, retryFiles);
},
onInitMeta: (meta) => {
initMetaRef.current = meta;
console.log('[useAssistantTrigger] SDK init meta received:', meta);
},
});
} catch (e) {
console.error('[useAssistantTrigger] Assistant auto-trigger failed:', e);
}
}, [sessionId, workingDirectory, isStreaming, mode, currentModel, currentProviderId, handleModeChange, buildThinkingConfig, initialMessages, sendMessageRef, initMetaRef]);
// Fire with a small delay to let the session fully initialize
useEffect(() => {
const timer = setTimeout(checkAssistantTrigger, 500);
return () => clearTimeout(timer);
}, [checkAssistantTrigger]);
return checkAssistantTrigger;
}