inspector/core/mcp/state/resourceSubscriptionsState.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

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/sdk/types.js";
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 = [];
}
}