inspector/core/mcp/state/managedRequestorTasksState.ts

/**
 * 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/client";
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>();
  // Task ids the user cancelled via the Cancel Task control. Cancellation is a
  // deliberate terminal decision, so it is sticky: a status update that arrives
  // afterwards — e.g. a server that completes the task anyway (cancellation is
  // cooperative) or the in-flight tool call resolving with a result — must not
  // flip a cancelled task back to "completed". Reset on disconnect / destroy.
  private cancelledTaskIds = 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.cancelledTaskIds.clear();
        this.dispatchTypedEvent("tasksChange", []);
      }
    };
    // A status update is ignored when the task was dismissed (clearCompleted)
    // or when the user cancelled it and the update isn't itself "cancelled" —
    // the deliberate cancel wins over a late completed/working update.
    const shouldIgnoreUpdate = (
      taskId: string,
      status: Task["status"],
    ): boolean =>
      this.dismissedTaskIds.has(taskId) ||
      (this.cancelledTaskIds.has(taskId) && status !== "cancelled");
    const onTaskStatusChange = (
      e: TypedEventGeneric<InspectorClientEventMap, "taskStatusChange">,
    ): void => {
      const { taskId, task } = e.detail;
      if (shouldIgnoreUpdate(taskId, task.status)) 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 (shouldIgnoreUpdate(taskId, task.status)) 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;
      // Remember the cancel so a later status update can't un-cancel it.
      this.cancelledTaskIds.add(taskId);
      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();
    }
    // Modern era (SEP-2663): the `io.modelcontextprotocol/tasks` extension has
    // NO `tasks/list` — task handles are durable and client-held, arriving via
    // task-augmented tool calls (server-directed `CreateTaskResult`) or
    // unsolicited handles. "Refresh" therefore re-polls the tasks already known
    // to this store via `tasks/get`; a task the server has since dropped (TTL)
    // simply keeps its last-seen state. Gate on the extension being negotiated.
    if (client.isTasksExtensionNegotiated()) {
      return this.refreshModern(client);
    }
    // Legacy era: 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.
      // For a user-cancelled task, keep it but pin its status to "cancelled":
      // cancellation is cooperative, so a server that completes and re-lists it
      // as "completed" must not un-stick the cancel on a manual Refresh — same
      // guarantee the live-merge handlers give via `cancelledTaskIds`.
      const page = result.tasks
        .filter((t) => !this.dismissedTaskIds.has(t.taskId))
        .map((t) =>
          this.cancelledTaskIds.has(t.taskId)
            ? { ...t, status: "cancelled" as const }
            : t,
        );
      // `=== undefined`, not truthiness, on both the append test and the loop
      // condition: a cursor is opaque and `""` is a legal value (#2220). Under
      // a truthiness check an empty `nextCursor` ended the walk after page one
      // AND made the next page replace the list rather than extend it — the
      // user-visible task list silently stopping at four rows against a
      // conforming server.
      this.tasks = cursor === undefined ? page : [...this.tasks, ...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 !== undefined);
    this.dispatchTypedEvent("tasksChange", this.tasks);
    return this.getTasks();
  }

  /**
   * Modern refresh: re-poll each currently-known (non-dismissed) task via
   * `getRequestorTask` (`tasks/get`). Each poll dispatches `requestorTaskUpdated`,
   * which the live-merge handler folds back into `this.tasks` — so the list
   * updates in place. A poll that errors (e.g. the task expired and the server
   * returns "unknown taskId") is swallowed so one dead handle can't abort the
   * whole refresh. No known tasks ⇒ a no-op refresh (the correct "no server
   * list" semantics).
   */
  private async refreshModern(
    client: InspectorClientProtocol,
  ): Promise<Task[]> {
    const ids = this.tasks
      .map((t) => t.taskId)
      .filter((id) => !this.dismissedTaskIds.has(id));
    for (const id of ids) {
      try {
        await client.getRequestorTask(id);
      } catch {
        // Ignore a single failed poll (expired / unknown task); keep the rest.
      }
    }
    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();
    this.cancelledTaskIds.clear();
  }
}