* feat(core): port v1.5 hook layer (useInspectorClient + useManaged*/usePaged* + log hooks) Wholesale port of v1.5's React hook layer and the EventTarget-based state machinery the hooks subscribe to (#1243). Hooks decouple from the concrete InspectorClient via a new `InspectorClientProtocol` interface so this layer can land before the runtime class is ported. Added under `core/`: - `core/react/` — useInspectorClient + 5 useManaged* + 5 usePaged* + 3 log hooks - `core/mcp/state/` — 5 managed*State + 5 paged*State + messageLogState + stderrLogState + fetchRequestLogState - `core/mcp/inspectorClientProtocol.ts`, `inspectorClientEventTarget.ts`, `typedEventTarget.ts`, `samplingCreateMessage.ts`, `sessionStorage.ts` - v2-only wrapper types in `core/mcp/types.ts`: InspectorUrlElicitRequest, InspectorPendingRequest, InspectorRequestHistoryItem Tests live under `clients/web/src/test/core/` (28 new test files, 264 new tests). Test fake: `core/mcp/__tests__/fakeInspectorClient.ts`. Build wiring: - `vite.config.ts`: dedupe react/react-dom so core/ files resolve them via clients/web/node_modules. - `tsconfig.app.json` / `tsconfig.test.json`: paths map react/react-dom/vitest to clients/web/node_modules so `tsc -b` resolves bare imports from core/ source files (which sit above the package's node_modules). Exclude core/__tests__ from app config; include in test config. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * review: address PR #1300 review findings Bugs: - fetchRequestLogState: add .catch() on sessionStorage.loadSession so a corrupt or unreadable session doesn't surface as an unhandled rejection (matches the saveSession swallow pattern). - messageLogState: sync pendingRequestEntries when clearMessages() evicts a pending request entry, so a later response with the same id falls through to the append branch instead of mutating an unreachable map entry. Add tests for both predicate and no-predicate paths. Cleanups: - Extract mergeTaskIntoList helper to core/mcp/state/mergeTaskIntoList.ts so managed/paged RequestorTasks state classes share one definition. - Add a one-line JSDoc note on each PagedTools/Prompts/Resources/Templates state explaining why they deliberately do not subscribe to *ListChanged (cursor invalidation mid-pagination). - Document on useInspectorClient that appRendererClient is read lazily on every render and is not subscribed (changes once at connect time). Carry-overs from v1.5 deliberately left for the follow-up InspectorClient runtime port: - Refresh/status-change race in Managed*State.refresh() (status check is only at entry; a disconnect during await can re-clear before refresh resumes). - nextCursor exposure asymmetry across usePaged* (only usePagedRequestorTasks surfaces it via state field; others return it from loadPage() only). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
162 lines
5.5 KiB
TypeScript
162 lines
5.5 KiB
TypeScript
/**
|
|
* MessageLogState: holds the message log, subscribes to the protocol "message"
|
|
* event. Protocol emits per-entry; this manager owns the list and emits both
|
|
* `message` (single entry) and `messagesChange` (full list) on append/update,
|
|
* and `messagesChange` on clear. Clears on connect (new session) and on
|
|
* disconnect.
|
|
*
|
|
* 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 { MessageEntry } from "../types.js";
|
|
import type { InspectorClientEventMap } from "../inspectorClientEventTarget.js";
|
|
import {
|
|
TypedEventTarget,
|
|
type TypedEventGeneric,
|
|
} from "../typedEventTarget.js";
|
|
|
|
export interface MessageLogStateEventMap {
|
|
message: MessageEntry;
|
|
messagesChange: MessageEntry[];
|
|
}
|
|
|
|
export interface MessageLogStateOptions {
|
|
/**
|
|
* Maximum number of messages to store (0 = unlimited, not recommended).
|
|
* When exceeded, oldest entries are dropped. Default 1000.
|
|
*/
|
|
maxMessages?: number;
|
|
}
|
|
|
|
export class MessageLogState extends TypedEventTarget<MessageLogStateEventMap> {
|
|
private messages: MessageEntry[] = [];
|
|
/** Pending request entries by JSON-RPC message id for matching responses. */
|
|
private pendingRequestEntries = new Map<string | number, MessageEntry>();
|
|
private client: InspectorClientProtocol | null = null;
|
|
private unsubscribe: (() => void) | null = null;
|
|
private readonly maxMessages: number;
|
|
|
|
constructor(
|
|
client: InspectorClientProtocol,
|
|
options: MessageLogStateOptions = {},
|
|
) {
|
|
super();
|
|
this.maxMessages = options.maxMessages ?? 1000;
|
|
this.client = client;
|
|
|
|
const pushEntry = (entry: MessageEntry): void => {
|
|
if (this.maxMessages > 0 && this.messages.length >= this.maxMessages) {
|
|
this.messages.shift();
|
|
}
|
|
this.messages.push(entry);
|
|
this.dispatchTypedEvent("message", entry);
|
|
this.dispatchTypedEvent("messagesChange", this.getMessages());
|
|
};
|
|
|
|
const onMessage = (
|
|
event: TypedEventGeneric<InspectorClientEventMap, "message">,
|
|
): void => {
|
|
const entry = event.detail;
|
|
if (entry.direction === "request") {
|
|
const reqId =
|
|
"id" in entry.message
|
|
? (entry.message as { id?: string | number }).id
|
|
: undefined;
|
|
if (reqId !== undefined) {
|
|
this.pendingRequestEntries.set(reqId, entry);
|
|
}
|
|
pushEntry(entry);
|
|
return;
|
|
}
|
|
if (entry.direction === "response") {
|
|
const messageId =
|
|
"id" in entry.message
|
|
? (entry.message as { id?: string | number }).id
|
|
: undefined;
|
|
const requestEntry =
|
|
messageId !== undefined
|
|
? this.pendingRequestEntries.get(messageId)
|
|
: undefined;
|
|
if (requestEntry) {
|
|
this.pendingRequestEntries.delete(messageId!);
|
|
requestEntry.response = entry.message as MessageEntry["response"];
|
|
requestEntry.duration =
|
|
entry.timestamp.getTime() - requestEntry.timestamp.getTime();
|
|
this.dispatchTypedEvent("message", requestEntry);
|
|
this.dispatchTypedEvent("messagesChange", this.getMessages());
|
|
return;
|
|
}
|
|
}
|
|
pushEntry(entry);
|
|
};
|
|
|
|
const onStatusChange = (): void => {
|
|
if (this.client?.getStatus() === "disconnected") {
|
|
this.messages = [];
|
|
this.pendingRequestEntries.clear();
|
|
this.dispatchTypedEvent("messagesChange", []);
|
|
}
|
|
};
|
|
const onConnect = (): void => {
|
|
this.messages = [];
|
|
this.pendingRequestEntries.clear();
|
|
this.dispatchTypedEvent("messagesChange", []);
|
|
};
|
|
this.client.addEventListener("message", onMessage);
|
|
this.client.addEventListener("statusChange", onStatusChange);
|
|
this.client.addEventListener("connect", onConnect);
|
|
this.unsubscribe = () => {
|
|
if (this.client) {
|
|
this.client.removeEventListener("message", onMessage);
|
|
this.client.removeEventListener("statusChange", onStatusChange);
|
|
this.client.removeEventListener("connect", onConnect);
|
|
}
|
|
this.client = null;
|
|
};
|
|
}
|
|
|
|
getMessages(predicate?: (entry: MessageEntry) => boolean): MessageEntry[] {
|
|
if (predicate) {
|
|
return this.messages.filter(predicate);
|
|
}
|
|
return [...this.messages];
|
|
}
|
|
|
|
/**
|
|
* Remove messages from history. When `predicate` is provided, removes only
|
|
* entries for which predicate returns true. When omitted, clears all messages.
|
|
* Dispatches messagesChange only if the list actually changed.
|
|
*/
|
|
clearMessages(predicate?: (entry: MessageEntry) => boolean): void {
|
|
const before = this.messages.length;
|
|
this.messages = predicate
|
|
? this.messages.filter((m) => !predicate(m))
|
|
: [];
|
|
// Drop pending-request bookkeeping for any entry that was just removed.
|
|
// Without this, a later response matching an evicted request id would
|
|
// mutate a Map-only entry that is no longer reachable from `messages`,
|
|
// silently dropping the response.
|
|
if (predicate) {
|
|
const survivors = new Set(this.messages);
|
|
for (const [id, entry] of this.pendingRequestEntries) {
|
|
if (!survivors.has(entry)) {
|
|
this.pendingRequestEntries.delete(id);
|
|
}
|
|
}
|
|
} else {
|
|
this.pendingRequestEntries.clear();
|
|
}
|
|
if (this.messages.length !== before) {
|
|
this.dispatchTypedEvent("messagesChange", this.getMessages());
|
|
}
|
|
}
|
|
|
|
destroy(): void {
|
|
this.unsubscribe?.();
|
|
this.unsubscribe = null;
|
|
this.messages = [];
|
|
this.pendingRequestEntries.clear();
|
|
}
|
|
}
|