inspector/core/mcp/state/resourceSubscriptionsState.ts
Cliff Hall 373f346e5f
Some checks failed
Run install, format, lint, build, and test on every push / build (push) Has been cancelled
Run install, format, lint, build, and test on every push / publish (push) Has been cancelled
Run install, format, lint, build, and test on every push / publish-github-container-registry (push) Has been cancelled
chore: close quality-gate coverage gaps (#1689) (#1766)
Closes #1689. Typecheck cli/tui src, add a core/ format+lint gate, and gate core/json + core/client coverage. See PR #1766 for the full review history.
2026-07-24 17:20:12 -04:00

194 lines
7 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,
ResourceSubscriptionStreamState,
} from "../types.js";
import {
isTerminalStatus,
INACTIVE_SUBSCRIPTION_STREAM_STATE,
} from "../types.js";
import type { Resource } from "@modelcontextprotocol/client";
import {
TypedEventTarget,
type TypedEventGeneric,
} from "../typedEventTarget.js";
export interface ResourceSubscriptionsStateEventMap {
subscriptionsChange: InspectorResourceSubscription[];
/**
* Modern-era (2026-07-28) `subscriptions/listen` stream lifecycle (#1630).
* Mirrors the client's `resourceSubscriptionStreamChange`; `active: false` on
* the legacy era.
*/
streamStateChange: ResourceSubscriptionStreamState;
}
/**
* 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 streamState: ResourceSubscriptionStreamState =
INACTIVE_SUBSCRIPTION_STREAM_STATE;
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;
this.streamState = client.getResourceSubscriptionStreamState();
const onStreamStateChange = (
event: TypedEventGeneric<
InspectorClientEventMap,
"resourceSubscriptionStreamChange"
>,
): void => {
this.streamState = event.detail;
this.dispatchTypedEvent("streamStateChange", this.streamState);
};
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.streamState = INACTIVE_SUBSCRIPTION_STREAM_STATE;
this.dispatchTypedEvent("subscriptionsChange", this.getSubscriptions());
this.dispatchTypedEvent("streamStateChange", this.streamState);
}
};
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(
"resourceSubscriptionStreamChange",
onStreamStateChange,
);
client.addEventListener("resourceUpdated", onResourceUpdated);
client.addEventListener("statusChange", onStatusChange);
resourcesState?.addEventListener("resourcesChange", onResourcesChange);
this.unsubscribe = () => {
this.client?.removeEventListener(
"resourceSubscriptionsChange",
onSubscriptionsChange,
);
this.client?.removeEventListener(
"resourceSubscriptionStreamChange",
onStreamStateChange,
);
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];
}
/**
* Current modern-era listen-stream state (#1630). `active: false` on the
* legacy era, so the Resources screen can show/hide the stream chrome.
*/
getStreamState(): ResourceSubscriptionStreamState {
return this.streamState;
}
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 = [];
this.streamState = INACTIVE_SUBSCRIPTION_STREAM_STATE;
}
}