inspector/core/mcp/state/resourceSubscriptionsState.ts
cliffhall 19a6df7ad3 SDK v2 migration (behavior-neutral, versionNegotiation: 'legacy') (#1624)
Migrate all three clients + core + test-servers from
@modelcontextprotocol/sdk@1.29 to SDK v2 (2.0.0-beta.4), keeping behavior
identical against legacy (2025-11-25) servers. Foundation for the SDK V2 +
New Spec stack.

Packages
- Split @modelcontextprotocol/sdk -> @modelcontextprotocol/client (Client,
  transports, OAuth, error taxonomy, protocol types) + core (Zod schemas);
  stdio -> client/stdio, Ajv -> client/validators/ajv. Test-servers ->
  @modelcontextprotocol/server (+ server-legacy/sse). Deterministic import
  rewrite (schemas -> core, everything else -> client); the codemod misroutes
  client code to /server so it was not used for path routing.
- new Client(..., { versionNegotiation: { mode: 'legacy' } }) — nothing
  2026-era goes on the wire.

Runtime (core/mcp/inspectorClient.ts)
- Error taxonomy: McpError -> ProtocolError, ErrorCode -> ProtocolErrorCode;
  RequestTimeout -> SdkError/SdkErrorCode.
- Handlers take method strings; task methods (tasks/*, notifications/tasks/*)
  use the 3-arg custom form (excluded from v2's spec-method set).
- Legacy tasks kept working (per project requirement): requestor tasks re-
  implemented over raw client.request + explicit deprecated schemas;
  experimental.tasks.callToolStream replaced by a local pollTaskToolCall
  async generator (with _progressHandlers revival so task-execution progress
  still reaches the caller). Receiver (server-initiated) tasks: the v2 Client
  validates a sampling/elicit handler result and rejects the legacy { task }
  response with -32602 — installReceiverTaskResponseBypass swaps the wrapped
  entry in the private _requestHandlers map for the task-augmented branch so
  { task } reaches the wire (fixes server-initiated sampling-via-task).
- Pagination: list verbs use raw client.request({method}, List*ResultSchema)
  for single-page behavior (v2's client.listX() auto-aggregate all pages).

Web / auth / apps
- Rename local JsonSchemaType -> InspectorFormSchema + add toFormSchema()
  structural narrowing at the SDK-schema -> form boundary.
- ext-apps still peers on SDK v1: one compat boundary with documented casts
  (remove when ext-apps#702 lands a v2 peer).
- OAuth provider saveClientInformation reconciled with v2's
  OAuthClientInformationContext; InvalidClientMetadataError re-homed as a
  local class (server-legacy/auth is not browser-safe).
- vitest.shared.mts dedupes @modelcontextprotocol/client+core to one copy so
  vi.mock intercepts the SUT's import.

Accepted v2 behavior changes (per #1624 / spec §9.2): unknown-tool call
rejects with -32602; cancellation is stream-abort (no guaranteed
notifications/cancelled frame); output-schema strictness restored via the
Inspector's own Ajv check on the default path.

npm run ci green: validate (web 3087 / cli 212 / tui 274 / launcher 5),
coverage (>=90 per-file, all clients), smoke (launcher/cli/web), storybook
(410).

Closes #1624

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-15 10:44:24 -04:00

150 lines
5.5 KiB
TypeScript

/**
* ResourceSubscriptionsState: tracks the live resource-subscription list the
* Resources screen renders. Subscribes to the InspectorClient's
* `resourceSubscriptionsChange` (URI list) and `resourceUpdated` events,
* resolves each URI against the optional `ManagedResourcesState` so subscriptions
* carry the server-supplied Resource (name/title), and stamps `lastUpdated`
* when a `notifications/resources/updated` arrives for a tracked URI.
*
* When no resource is found in the managed list (e.g. a template-expanded URI
* the user subscribed to before the resources list refreshed), a synthetic
* Resource `{ uri, name: uri }` is used — mirroring the fallback pattern in
* ResourcesScreen. If the server later removes a previously-listed resource
* while the user is still subscribed, the tile regresses to that synthetic
* form: the managed list is the source of truth, so displaying a stale name
* for a server-removed resource is intentionally avoided.
*/
import type { InspectorClientProtocol } from "../inspectorClientProtocol.js";
import type { InspectorClientEventMap } from "../inspectorClientEventTarget.js";
import type {
ManagedResourcesState,
ManagedResourcesStateEventMap,
} from "./managedResourcesState.js";
import type { InspectorResourceSubscription } from "../types.js";
import { isTerminalStatus } from "../types.js";
import type { Resource } from "@modelcontextprotocol/client";
import {
TypedEventTarget,
type TypedEventGeneric,
} from "../typedEventTarget.js";
export interface ResourceSubscriptionsStateEventMap {
subscriptionsChange: InspectorResourceSubscription[];
}
/**
* State manager that mirrors `InspectorClient.subscribedResources` as a list of
* `InspectorResourceSubscription` objects keyed by URI, preserving each
* subscription's `lastUpdated` across re-derivations.
*/
export class ResourceSubscriptionsState extends TypedEventTarget<ResourceSubscriptionsStateEventMap> {
private subscribedUris: string[] = [];
private lastUpdatedByUri: Map<string, Date> = new Map();
private subscriptions: InspectorResourceSubscription[] = [];
private client: InspectorClientProtocol | null = null;
private resourcesState: ManagedResourcesState | null = null;
private unsubscribe: (() => void) | null = null;
constructor(
client: InspectorClientProtocol,
resourcesState: ManagedResourcesState | null = null,
) {
super();
this.client = client;
this.resourcesState = resourcesState;
const onSubscriptionsChange = (
event: TypedEventGeneric<
InspectorClientEventMap,
"resourceSubscriptionsChange"
>,
): void => {
this.subscribedUris = event.detail;
// Drop lastUpdated entries for URIs no longer subscribed
const active = new Set(event.detail);
for (const uri of this.lastUpdatedByUri.keys()) {
if (!active.has(uri)) this.lastUpdatedByUri.delete(uri);
}
this.rebuild();
};
const onResourceUpdated = (
event: TypedEventGeneric<InspectorClientEventMap, "resourceUpdated">,
): void => {
const { uri } = event.detail;
// Belt-and-braces: the client's dispatch site is already guarded by
// subscribedResources.has(uri), so this re-check should be redundant.
// It stays correct if a future change ever decouples dispatch from
// subscription state.
if (!this.subscribedUris.includes(uri)) return;
this.lastUpdatedByUri.set(uri, new Date());
this.rebuild();
};
const onStatusChange = (): void => {
if (isTerminalStatus(this.client?.getStatus())) {
this.subscribedUris = [];
this.lastUpdatedByUri.clear();
this.subscriptions = [];
this.dispatchTypedEvent("subscriptionsChange", this.getSubscriptions());
}
};
const onResourcesChange = (
_event: TypedEventGeneric<
ManagedResourcesStateEventMap,
"resourcesChange"
>,
): void => {
// Re-resolve Resource references in case names/titles changed server-side.
if (this.subscribedUris.length > 0) this.rebuild();
};
client.addEventListener(
"resourceSubscriptionsChange",
onSubscriptionsChange,
);
client.addEventListener("resourceUpdated", onResourceUpdated);
client.addEventListener("statusChange", onStatusChange);
resourcesState?.addEventListener("resourcesChange", onResourcesChange);
this.unsubscribe = () => {
this.client?.removeEventListener(
"resourceSubscriptionsChange",
onSubscriptionsChange,
);
this.client?.removeEventListener("resourceUpdated", onResourceUpdated);
this.client?.removeEventListener("statusChange", onStatusChange);
this.resourcesState?.removeEventListener(
"resourcesChange",
onResourcesChange,
);
this.client = null;
this.resourcesState = null;
};
}
getSubscriptions(): InspectorResourceSubscription[] {
return [...this.subscriptions];
}
private rebuild(): void {
const resources = this.resourcesState?.getResources() ?? [];
const byUri = new Map(resources.map((r) => [r.uri, r]));
this.subscriptions = this.subscribedUris.map((uri) => {
const resource: Resource = byUri.get(uri) ?? { uri, name: uri };
const lastUpdated = this.lastUpdatedByUri.get(uri);
return lastUpdated ? { resource, lastUpdated } : { resource };
});
this.dispatchTypedEvent("subscriptionsChange", this.getSubscriptions());
}
destroy(): void {
this.unsubscribe?.();
this.unsubscribe = null;
this.subscribedUris = [];
this.lastUpdatedByUri.clear();
this.subscriptions = [];
}
}