inspector/core/mcp/state/stderrLogState.ts
Cliff Hall e3e70470b5
feat(core): port v1.5 hook layer (#1243) (#1300)
* 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>
2026-05-13 17:43:07 -04:00

88 lines
2.7 KiB
TypeScript

/**
* StderrLogState: holds the stderr log, subscribes to the protocol "stderrLog"
* event. Protocol emits per-entry; this manager owns the list and emits both
* `stderrLog` (single entry) and `stderrLogsChange` (full list) on append,
* and `stderrLogsChange` on clear. Does not clear on connect/disconnect —
* pre-connect and post-connect entries both remain.
*
* 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 { StderrLogEntry } from "../types.js";
import type { InspectorClientEventMap } from "../inspectorClientEventTarget.js";
import {
TypedEventTarget,
type TypedEventGeneric,
} from "../typedEventTarget.js";
export interface StderrLogStateEventMap {
stderrLog: StderrLogEntry;
stderrLogsChange: StderrLogEntry[];
}
export interface StderrLogStateOptions {
/**
* Maximum number of stderr log entries to store (0 = unlimited, not recommended).
* When exceeded, oldest entries are dropped. Default 1000.
*/
maxStderrLogEvents?: number;
}
export class StderrLogState extends TypedEventTarget<StderrLogStateEventMap> {
private stderrLogs: StderrLogEntry[] = [];
private client: InspectorClientProtocol | null = null;
private unsubscribe: (() => void) | null = null;
private readonly maxStderrLogEvents: number;
constructor(
client: InspectorClientProtocol,
options: StderrLogStateOptions = {},
) {
super();
this.maxStderrLogEvents = options.maxStderrLogEvents ?? 1000;
this.client = client;
const onStderrLog = (
event: TypedEventGeneric<InspectorClientEventMap, "stderrLog">,
): void => {
const entry = event.detail;
if (
this.maxStderrLogEvents > 0 &&
this.stderrLogs.length >= this.maxStderrLogEvents
) {
this.stderrLogs.shift();
}
this.stderrLogs.push(entry);
this.dispatchTypedEvent("stderrLog", entry);
this.dispatchTypedEvent("stderrLogsChange", this.getStderrLogs());
};
this.client.addEventListener("stderrLog", onStderrLog);
this.unsubscribe = () => {
if (this.client) {
this.client.removeEventListener("stderrLog", onStderrLog);
}
this.client = null;
};
}
getStderrLogs(): StderrLogEntry[] {
return [...this.stderrLogs];
}
/**
* Clear all stderr log entries. Dispatches stderrLogsChange only if the
* list was non-empty.
*/
clearStderrLogs(): void {
if (this.stderrLogs.length === 0) return;
this.stderrLogs = [];
this.dispatchTypedEvent("stderrLogsChange", []);
}
destroy(): void {
this.unsubscribe?.();
this.unsubscribe = null;
this.stderrLogs = [];
}
}