inspector/core/mcp/state/managedRequestorTasksState.ts
Cliff Hall dc31c28102
fix(core): make "error" the canonical terminal status on a mid-session crash (#1490) (#1493)
* fix(core): make "error" the canonical terminal status on a mid-session crash (#1490)

On a real mid-session transport crash many SDK transports fire BOTH
`onclose` and `onerror` in a transport-dependent order. The `onclose`
guard (`if status !== "disconnected"`) let a trailing `onclose`
downgrade a crash's `"error"` status back to `"disconnected"`, so the
persistent terminal status differed by ordering:

- onerror-then-onclose → "disconnected"
- onclose-then-onerror → "error"

`onclose` now treats `"error"` as terminal (only `"connected"`/
`"connecting"` → `"disconnected"`), so `"error"` is the canonical resting
status in both orderings. It still emits the `disconnect` event exactly
once so session-teardown consumers fire identically either way.

Because the state managers gated list/message/subscription/task teardown
on `getStatus() === "disconnected"`, holding the status at `"error"`
would have left them stale in the onerror-first ordering — swapping one
ordering-dependence for another. Introduce `isTerminalStatus()`
(disconnected || error) and key every teardown guard off it so they
clear identically regardless of crash ordering.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* fix(core): single disconnect event when explicitly disconnecting from "error" (#1490 re-review)

Addresses the non-blocking observation from the PR review: explicitly
calling disconnect() from a held-"error" status could fire the
`disconnect` event twice. close() can trigger the transport's onclose
synchronously; onclose (holding status at "error") fired `disconnect`,
then disconnect()'s own guard saw status still != "disconnected" and
fired it again — a timing-dependence on whether the SDK closes sync.

Add a `disconnecting` ownership flag: onclose defers its status set +
`disconnect` event to disconnect() while it is set, so the
explicit-disconnect path emits exactly one `disconnect` regardless of
sync/async close. Crash-path onclose (flag unset) is unchanged.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* test(core): deterministically pin the sync-close disconnect double-fire (#1490 re-review)

The real-stdio test asserts the single-disconnect invariant but may not
exercise the sync-close branch (the one that double-fired) if the SDK
stdio transport closes asynchronously. Add a test that overrides the SDK
client's close() to invoke the transport's onclose synchronously,
forcing the exact timing the `disconnecting` flag guards. Verified it
asserts 2 (fails) without the flag and 1 (passes) with it.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-15 10:15:29 -04:00

190 lines
6.9 KiB
TypeScript

/**
* ManagedRequestorTasksState: holds full requestor task list, syncs on
* tasksListChanged. Subscribes to taskStatusChange (server) and
* requestorTaskUpdated (client) to merge per-task updates.
*
* Ported from v1.5/main. v2 substitutes `InspectorClientProtocol` for the
* concrete `InspectorClient` since the runtime class is not yet ported.
*/
import type { InspectorClientProtocol } from "../inspectorClientProtocol.js";
import type { Task } from "@modelcontextprotocol/sdk/types.js";
import { isTerminalStatus } from "../types.js";
import type { InspectorClientEventMap } from "../inspectorClientEventTarget.js";
import {
TypedEventTarget,
type TypedEventGeneric,
} from "../typedEventTarget.js";
import { mergeTaskIntoList } from "./mergeTaskIntoList.js";
const MAX_PAGES = 100;
// Terminal task states — a task in one of these can no longer change, so
// "Clear Completed" targets exactly these.
const TERMINAL_STATUSES: ReadonlySet<Task["status"]> = new Set([
"completed",
"failed",
"cancelled",
]);
export interface ManagedRequestorTasksStateEventMap {
tasksChange: Task[];
}
/**
* State manager that keeps the full requestor task list in sync with the
* server. Subscribes to connect, tasksListChanged, statusChange,
* taskStatusChange (server), requestorTaskUpdated (client), and taskCancelled.
*/
export class ManagedRequestorTasksState extends TypedEventTarget<ManagedRequestorTasksStateEventMap> {
private tasks: Task[] = [];
private client: InspectorClientProtocol | null = null;
private unsubscribe: (() => void) | null = null;
// Task ids the user dismissed via clearCompleted(). Sticky for the session:
// these are filtered out of refresh() results and ignored by the live-merge
// handlers so a late status update (or a server that still lists the task)
// can't resurrect a cleared task. Reset on disconnect / destroy.
private dismissedTaskIds = new Set<string>();
constructor(client: InspectorClientProtocol) {
super();
this.client = client;
const onConnect = (): void => {
void this.refresh();
};
const onTasksListChanged = (): void => {
void this.refresh();
};
const onStatusChange = (): void => {
if (isTerminalStatus(this.client?.getStatus())) {
this.tasks = [];
this.dismissedTaskIds.clear();
this.dispatchTypedEvent("tasksChange", []);
}
};
const onTaskStatusChange = (
e: TypedEventGeneric<InspectorClientEventMap, "taskStatusChange">,
): void => {
const { taskId, task } = e.detail;
if (this.dismissedTaskIds.has(taskId)) return;
this.tasks = mergeTaskIntoList(this.tasks, taskId, task);
this.dispatchTypedEvent("tasksChange", this.tasks);
};
const onRequestorTaskUpdated = (
e: TypedEventGeneric<InspectorClientEventMap, "requestorTaskUpdated">,
): void => {
const { taskId, task } = e.detail;
if (this.dismissedTaskIds.has(taskId)) return;
this.tasks = mergeTaskIntoList(this.tasks, taskId, task);
this.dispatchTypedEvent("tasksChange", this.tasks);
};
const onTaskCancelled = (
e: TypedEventGeneric<InspectorClientEventMap, "taskCancelled">,
): void => {
const { taskId } = e.detail;
if (this.dismissedTaskIds.has(taskId)) return;
const idx = this.tasks.findIndex((t) => t.taskId === taskId);
if (idx >= 0) {
const next = [...this.tasks];
const prev = next[idx]!;
next[idx] = { ...prev, status: "cancelled" as const };
this.tasks = next;
this.dispatchTypedEvent("tasksChange", this.tasks);
}
};
this.client.addEventListener("connect", onConnect);
this.client.addEventListener("tasksListChanged", onTasksListChanged);
this.client.addEventListener("statusChange", onStatusChange);
this.client.addEventListener("taskStatusChange", onTaskStatusChange);
this.client.addEventListener(
"requestorTaskUpdated",
onRequestorTaskUpdated,
);
this.client.addEventListener("taskCancelled", onTaskCancelled);
this.unsubscribe = () => {
if (this.client) {
this.client.removeEventListener("connect", onConnect);
this.client.removeEventListener("tasksListChanged", onTasksListChanged);
this.client.removeEventListener("statusChange", onStatusChange);
this.client.removeEventListener("taskStatusChange", onTaskStatusChange);
this.client.removeEventListener(
"requestorTaskUpdated",
onRequestorTaskUpdated,
);
this.client.removeEventListener("taskCancelled", onTaskCancelled);
}
this.client = null;
};
}
getTasks(): Task[] {
return [...this.tasks];
}
async refresh(): Promise<Task[]> {
const client = this.client;
if (!client || client.getStatus() !== "connected") {
return this.getTasks();
}
// Gate on the server's `tasks` capability — calling tasks/list against a
// server that doesn't advertise it returns -32601 "Method not found",
// which then surfaces in the console for every connect against any
// server that doesn't implement task tracking. Empty list is the right
// semantics for "this server doesn't support tasks."
if (!client.getCapabilities()?.tasks) {
this.tasks = [];
this.dispatchTypedEvent("tasksChange", this.tasks);
return this.getTasks();
}
this.tasks = [];
let cursor: string | undefined;
let pageCount = 0;
do {
const result = await client.listRequestorTasks(cursor);
// Filter out tasks the user dismissed via clearCompleted() so a server
// that still lists them (or an in-flight refresh) can't resurrect them.
const page = result.tasks.filter(
(t) => !this.dismissedTaskIds.has(t.taskId),
);
this.tasks = cursor ? [...this.tasks, ...page] : page;
cursor = result.nextCursor;
pageCount++;
if (pageCount >= MAX_PAGES) {
throw new Error(
`Maximum pagination limit (${MAX_PAGES} pages) reached while listing requestor tasks`,
);
}
} while (cursor);
this.dispatchTypedEvent("tasksChange", this.tasks);
return this.getTasks();
}
/**
* Drop terminal-state tasks (completed / failed / cancelled) from the list.
* Their ids are remembered in `dismissedTaskIds` so they stay gone for the
* rest of the session — a subsequent refresh() or live update won't bring
* them back. No-op (and no event) when there's nothing terminal to clear.
*/
clearCompleted(): void {
const remaining: Task[] = [];
let dismissedAny = false;
for (const task of this.tasks) {
if (TERMINAL_STATUSES.has(task.status)) {
this.dismissedTaskIds.add(task.taskId);
dismissedAny = true;
} else {
remaining.push(task);
}
}
if (!dismissedAny) return;
this.tasks = remaining;
this.dispatchTypedEvent("tasksChange", this.tasks);
}
destroy(): void {
this.unsubscribe?.();
this.unsubscribe = null;
this.tasks = [];
this.dismissedTaskIds.clear();
}
}