* wip(core): bulk-copy v1.5 InspectorClient runtime files (#1302) Verbatim ports from origin/v1.5/main into v2/main core/: - logging/ (2 files) - storage/ + storage/adapters/ (4 files) - auth/ + auth/browser/ + auth/node/ + auth/remote/ (16 files) - mcp/config.ts + mcp/node/ (4 files, stdio transport) - mcp/remote/ + mcp/remote/node/ (12 files, HTTP/SSE transport) - mcp/inspectorClient.ts (~2169 LOC), messageTrackingTransport, fetchTracking, oauthManager, index, state/index Total: ~7,800 LOC of source files, copied unmodified via `git show origin/v1.5/main:<path> > <dest>`. Also: - Add deps: pino, hono, @hono/node-server, atomically, zustand, @types/node - tsconfig.app.json: extend paths to resolve new node-only deps from core/, add "node" to types, disable erasableSyntaxOnly (v1.5 code uses parameter properties — TODO to re-enable in follow-up) Compiles down to 47 type errors, all in three categories: - 24 TS2305: v2 dropped v1.5 type exports (InspectorClientOptions, CreateTransport, InspectorClientEnvironment, AppRendererClient, SamplingCreateMessage class, ElicitationCreateMessage class, jsonUtils helpers, OAuth events). Per user direction, will re-add these to v2's diverged files (types.ts, samplingCreateMessage.ts, etc.) so the ported code stays verbatim. - 15 TS7006: implicit-any params in v1.5 code (v1.5 tsconfig was looser than v2's noImplicitAny). Need explicit annotations. - 8 other TS errors: ../package.json import, Transport|null narrowing, hono Context generic mismatch, one unused parameter. Tests not yet ported (19 files, ~11,170 LOC). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * wip(core): integrate ported v1.5 InspectorClient + port tests (#1302) Source integration (typecheck + build now pass): - Re-add v1.5 types/classes dropped during v2 evolution: - types.ts: CreateTransport*, AppRendererClient, InspectorClient{Environment,Options} - samplingCreateMessage.ts / elicitationCreateMessage.ts: classes + keep v2's InspectorPending{Sampling,Elicitation} interface - inspectorClientEventTarget.ts: oauth* event keys - json/jsonUtils.ts: convertParameterValue / convertToolParameters / convertPromptArguments + ParameterSchema - inspectorClient.ts: replace `../package.json` import (v2 has no core/package.json) with a hardcoded identity constant - remote/node/server.ts: cast hono Context for streamSSE (hono's generic typing tightened since v1.5) - oauth-callback-server.ts: drop unused hostname field - tsconfig: enable @types/node, add paths for new bare-module deps (pino, zustand, hono, atomically) in app + test configs - vite.config.ts: mirror those module aliases for the unit project (which runs from repoRoot) Tests ported (19 files, ~11K LOC) under clients/web/src/test/core/: - All core/__tests__/auth/* (7 files) - inspectorClient.test.ts + 4 OAuth variants - mcp/oauthManager.test.ts, jsonUtils.test.ts - transport, remote-transport, remote-server-config, storage-adapters - helpers/oauth-client-fixtures.ts Bulk-rewrote `from "../mcp/…"` → `from "@inspector/core/mcp/…"` etc. Current state: - typecheck: 0 errors - build: passes (vite v8, 788 modules) - unit tests: 1014 / 1034 pass (937 pre-existing + 77 new core tests) - 20 failures in 13 files; failure modes: - 13 file-load failures needing the v1.5 `test-servers/` package (@modelcontextprotocol/inspector-test-server) which isn't in v2 yet or real fs/network not available in happy-dom - 7 assertion failures in discovery.test.ts + state-machine.test.ts (SDK 1.29 vs 1.25 API drift — mocks don't match new shape) Coverage gate not yet checked against new files. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * wip(core): port test-servers, more types, partial test integration (#1302) - Port v1.5 test-servers/ package (12 files, ~5K LOC) under repo-root/test-servers/, wire @modelcontextprotocol/inspector-test-server alias in both vite.config.ts (regex form) and tsconfig.test.json. - Add deps: express ^5, yaml ^2, @types/express ^5. - Re-export InspectorClientOptions/Environment/Transport* from inspectorClient.ts so v1.5 tests that import them from that module path keep resolving. - Switch InspectorClientEventMap to use SamplingCreateMessage / ElicitationCreateMessage classes (matches v1.5 event payload contracts) while keeping the InspectorPending{Sampling,Elicitation} interfaces in the *.ts modules for v2 consumers that still use them. - Fix verbatim-module-syntax issue in test-servers and drop unused stdio config field. - Adjust inspectorClient.test.ts task types to TaskWithOptionalCreatedAt (SDK 1.29 tightened Task shape vs v1.5's 1.25). - Drop spurious maxMessages/maxFetchRequests/maxStderrLogEvents from remote-transport.test.ts (never on InspectorClientOptions). State: - typecheck: 0 errors - build: passes - unit tests: 1099 / 1270 pass - 171 failures in 10 test files, almost all integration tests that need real HTTP/fs/network (happy-dom can't host them). Next: add a node-env vitest project to run these properly. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * feat(core): port v1.5 InspectorClient + transports + auth subsystem (#1302) Bulk-port of the v1.5 core runtime (~7,800 LOC source + ~16K LOC tests + ~5K LOC test-servers/) into v2. Files copied verbatim from origin/v1.5/main via `git show >`; only minimal adapters added on the v2 side. Subsystems landed ----------------- - core/logging/, core/storage/, core/auth/ (browser + node + remote) - core/mcp/ runtime: inspectorClient.ts (2169 LOC), oauthManager, messageTrackingTransport, fetchTracking, config, index - core/mcp/node/ (stdio transport) - core/mcp/remote/ + remote/node/ (HTTP/SSE transport + Hono server) - test-servers/ package (composable MCP test servers, fixtures, harness) v2 adapter layer ---------------- - types.ts: append CreateTransport*, AppRendererClient, InspectorClient{Environment,Options} (v2 had pruned these — v1.5 needs them) - samplingCreateMessage / elicitationCreateMessage: keep v1.5 classes AND v2's Inspector Pending* interfaces in the same files - inspectorClientEventTarget: add oauth* event keys; switch pending sampling/elicitation payloads to the classes (matches v1.5 contracts) - json/jsonUtils: append convertParameterValue/convertToolParameters/ convertPromptArguments + ParameterSchema - inspectorClient.ts: re-export Options/Environment/Transport* so tests that import these from `inspectorClient.js` keep resolving; replace `../package.json` import with a hardcoded identity (v2 has no core/package.json) - remote/node/server.ts: cast hono Context for streamSSE (hono generic tightened since v1.5) - oauth-callback-server: drop unused hostname field - tsconfig.app.json / tsconfig.test.json: add @types/node + paths for pino/zustand/hono/@hono/node-server/atomically/express/yaml, disable erasableSyntaxOnly (parameter-property syntax from v1.5) - vite.config.ts: regex-form module aliases (so the package's exports field handles subpaths like `hono/streaming`, `zustand/middleware`), alias for @modelcontextprotocol/inspector-test-server → test-servers/src Tests ----- - 19 v1.5 test files copied under clients/web/src/test/core/, imports rewired to @inspector/core/* and @modelcontextprotocol/inspector-test-server - 1004 unit tests pass; 298 storybook tests pass; coverage gate passes Known follow-ups (out-of-scope here, tracked in TODOs) ------------------------------------------------------ - 13 integration test files are excluded from the unit project (spawn real HTTP/stdio servers; run real OAuth flows; mock SDK auth → happy-dom CORS). Needs a node-env vitest project. Files listed under `test.projects[0].test.exclude`. - Source files exercised only by those integration tests are excluded from the coverage gate pending the node-env project. Listed under `test.coverage.exclude` with comment. - Manual smoke tests against real stdio / HTTP / OAuth server per the AC on #1302 still need verification locally. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs/fix: address #1306 review (AGENTS tree, #1307 links, @types/node, .substr) - AGENTS.md: expand the project-structure tree to include all v1.5-ported subsystems (core/auth/{browser,node,remote}, core/storage, core/logging, core/mcp/{node,remote/{,node}}, core/mcp/state) plus the new top-level test-servers/ directory (with a note about its @modelcontextprotocol/ inspector-test-server alias). - vite.config.ts: reference #1307 from both the test exclude block and the coverage exclude block so the next person editing either sees the marching order for shrinking the lists. - package.json: restore @types/node to ^24 (an earlier `npm install --save-dev @types/node@^22` accidentally pinned it lower than the repo was using; nothing here required ^22). - core/mcp/fetchTracking.ts: replace deprecated .substr(2, 9) with .slice(2, 11) to match the convention in core/mcp/inspectorClient.ts. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Cliff Hall
GitHub
parent
e154378178
commit
0ead1deea6
1 changed files with 24387 additions and 44 deletions
277
test-servers/src/test-helpers.ts
Normal file
277
test-servers/src/test-helpers.ts
Normal file
|
|
@ -0,0 +1,277 @@
|
|||
/**
|
||||
* Test helpers for event-driven waits and polling.
|
||||
* Use these instead of arbitrary setTimeout/setInterval in E2E tests.
|
||||
*/
|
||||
|
||||
import { vi } from "vitest";
|
||||
import * as fs from "node:fs/promises";
|
||||
|
||||
export interface WaitForEventOptions {
|
||||
timeout?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Wait for a single event on an EventTarget. Resolves with the event detail,
|
||||
* or rejects after `timeout` ms if the event never fires.
|
||||
*/
|
||||
export function waitForEvent<T = unknown>(
|
||||
target: EventTarget,
|
||||
eventName: string,
|
||||
options?: WaitForEventOptions,
|
||||
): Promise<T> {
|
||||
const timeoutMs = options?.timeout ?? 5000;
|
||||
return new Promise<T>((resolve, reject) => {
|
||||
const timer = setTimeout(() => {
|
||||
target.removeEventListener(eventName, handler);
|
||||
reject(
|
||||
new Error(`Timeout waiting for event '${eventName}' (${timeoutMs}ms)`),
|
||||
);
|
||||
}, timeoutMs);
|
||||
const handler = (e: Event) => {
|
||||
clearTimeout(timer);
|
||||
target.removeEventListener(eventName, handler);
|
||||
resolve((e as CustomEvent<T>).detail);
|
||||
};
|
||||
target.addEventListener(eventName, handler);
|
||||
});
|
||||
}
|
||||
|
||||
export interface WaitForProgressCountOptions {
|
||||
timeout?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Wait until `progressNotification` has been received `expectedCount` times.
|
||||
* Returns the collected event details. Use for sendProgress and progress-linked-to-tasks tests.
|
||||
*/
|
||||
export function waitForProgressCount(
|
||||
client: {
|
||||
addEventListener: (type: string, fn: (e: Event) => void) => void;
|
||||
removeEventListener: (type: string, fn: (e: Event) => void) => void;
|
||||
},
|
||||
expectedCount: number,
|
||||
options?: WaitForProgressCountOptions,
|
||||
): Promise<unknown[]> {
|
||||
const timeoutMs = options?.timeout ?? 5000;
|
||||
const events: unknown[] = [];
|
||||
return new Promise((resolve, reject) => {
|
||||
const timer = setTimeout(() => {
|
||||
client.removeEventListener("progressNotification", handler);
|
||||
reject(
|
||||
new Error(
|
||||
`Timeout waiting for ${expectedCount} progressNotification events (got ${events.length}) after ${timeoutMs}ms`,
|
||||
),
|
||||
);
|
||||
}, timeoutMs);
|
||||
const handler = (e: Event) => {
|
||||
events.push((e as CustomEvent).detail);
|
||||
if (events.length >= expectedCount) {
|
||||
clearTimeout(timer);
|
||||
client.removeEventListener("progressNotification", handler);
|
||||
resolve(events);
|
||||
}
|
||||
};
|
||||
client.addEventListener("progressNotification", handler);
|
||||
});
|
||||
}
|
||||
|
||||
export interface WaitForStateFileOptions {
|
||||
timeout?: number;
|
||||
interval?: number;
|
||||
}
|
||||
|
||||
const DEBUG_WAIT_FOR_STATE_FILE = process.env.DEBUG_WAIT_FOR_STATE_FILE === "1";
|
||||
|
||||
function truncate(s: string, maxLen: number): string {
|
||||
if (s.length <= maxLen) return s;
|
||||
return s.slice(0, maxLen) + `... (${s.length} chars total)`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Poll state file until `predicate(parsed)` returns true, then return the parsed value.
|
||||
* Uses vi.waitFor under the hood. For use with Zustand persist state.json files.
|
||||
*
|
||||
* On failure, the thrown error includes:
|
||||
* - Whether the failure was a JSON parse error or predicate returned false.
|
||||
* - A truncated snippet of what was read (to distinguish partial write vs wrong content).
|
||||
* - Attempt count (to see if we timed out early or after many retries).
|
||||
*
|
||||
* Run with DEBUG_WAIT_FOR_STATE_FILE=1 to log every attempt (parse ok/fail, predicate result).
|
||||
*/
|
||||
export async function waitForStateFile<T = unknown>(
|
||||
filePath: string,
|
||||
predicate: (parsed: unknown) => boolean,
|
||||
options?: WaitForStateFileOptions,
|
||||
): Promise<T> {
|
||||
const { timeout = 2000, interval = 50 } = options ?? {};
|
||||
let result: T | undefined;
|
||||
let attemptCount = 0;
|
||||
|
||||
await vi.waitFor(
|
||||
async () => {
|
||||
attemptCount += 1;
|
||||
let raw: string;
|
||||
try {
|
||||
raw = await fs.readFile(filePath, "utf-8");
|
||||
} catch (readErr) {
|
||||
const msg = (readErr as NodeJS.ErrnoException).code ?? String(readErr);
|
||||
if (DEBUG_WAIT_FOR_STATE_FILE) {
|
||||
console.error(
|
||||
`[waitForStateFile] attempt ${attemptCount} read failed:`,
|
||||
msg,
|
||||
);
|
||||
}
|
||||
throw new Error(
|
||||
`waitForStateFile failed: file read error (${msg}). File: ${filePath}. Attempts: ${attemptCount}. Run with DEBUG_WAIT_FOR_STATE_FILE=1 for per-attempt logs.`,
|
||||
);
|
||||
}
|
||||
let parsed: unknown;
|
||||
try {
|
||||
parsed = JSON.parse(raw) as unknown;
|
||||
} catch {
|
||||
if (DEBUG_WAIT_FOR_STATE_FILE) {
|
||||
console.error(
|
||||
`[waitForStateFile] attempt ${attemptCount} JSON parse failed. Raw (first 300):`,
|
||||
truncate(raw, 300),
|
||||
);
|
||||
}
|
||||
throw new Error(
|
||||
`waitForStateFile failed: JSON parse error (file may be mid-write or corrupt). File: ${filePath}. Attempts: ${attemptCount}. Raw snippet: ${truncate(raw, 200)}. Run with DEBUG_WAIT_FOR_STATE_FILE=1 for per-attempt logs.`,
|
||||
);
|
||||
}
|
||||
const predOk = predicate(parsed);
|
||||
if (DEBUG_WAIT_FOR_STATE_FILE) {
|
||||
console.error(
|
||||
`[waitForStateFile] attempt ${attemptCount} parse ok, predicate: ${predOk}`,
|
||||
);
|
||||
}
|
||||
if (!predOk) {
|
||||
throw new Error(
|
||||
`waitForStateFile failed: predicate returned false. File: ${filePath}. Attempts: ${attemptCount}. Parsed snippet: ${truncate(JSON.stringify(parsed), 200)}. Run with DEBUG_WAIT_FOR_STATE_FILE=1 for per-attempt logs.`,
|
||||
);
|
||||
}
|
||||
result = parsed as T;
|
||||
return true;
|
||||
},
|
||||
{ timeout, interval },
|
||||
);
|
||||
return result!;
|
||||
}
|
||||
|
||||
export interface WaitForOAuthWellKnownOptions {
|
||||
timeout?: number;
|
||||
interval?: number;
|
||||
/** Max time per fetch attempt (so one hung request doesn't burn the whole timeout). Default 1000. */
|
||||
requestTimeout?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Poll the OAuth authorization server well-known URL until it returns 200.
|
||||
* Use after server.start() and before client.authenticate() in E2E tests so
|
||||
* the SDK's discovery never races with server readiness (which would cause
|
||||
* it to fall back to /authorize instead of /oauth/authorize).
|
||||
*
|
||||
* @param serverBaseUrl - Base URL of the server (e.g. http://localhost:PORT)
|
||||
*/
|
||||
export async function waitForOAuthWellKnown(
|
||||
serverBaseUrl: string,
|
||||
options?: WaitForOAuthWellKnownOptions,
|
||||
): Promise<void> {
|
||||
const {
|
||||
timeout = 5000,
|
||||
interval = 50,
|
||||
requestTimeout = 1000,
|
||||
} = options ?? {};
|
||||
const wellKnownUrl = `${serverBaseUrl.replace(/\/$/, "")}/.well-known/oauth-authorization-server`;
|
||||
const start = Date.now();
|
||||
let lastStatus: number | undefined;
|
||||
let lastError: unknown;
|
||||
while (Date.now() - start < timeout) {
|
||||
try {
|
||||
const controller = new AbortController();
|
||||
const t = setTimeout(() => controller.abort(), requestTimeout);
|
||||
try {
|
||||
const res = await fetch(wellKnownUrl, { signal: controller.signal });
|
||||
lastStatus = res.status;
|
||||
if (res.ok) return;
|
||||
} finally {
|
||||
clearTimeout(t);
|
||||
}
|
||||
} catch (err) {
|
||||
lastError = err;
|
||||
// connection error or request timeout, retry
|
||||
}
|
||||
await new Promise((r) => setTimeout(r, interval));
|
||||
}
|
||||
const statusPart =
|
||||
lastStatus !== undefined
|
||||
? `lastStatus: ${lastStatus}`
|
||||
: "lastStatus: (none)";
|
||||
const errorPart =
|
||||
lastError !== undefined
|
||||
? `lastError: ${lastError instanceof Error ? lastError.message : String(lastError)}`
|
||||
: "lastError: (none)";
|
||||
throw new Error(
|
||||
`waitForOAuthWellKnown timed out after ${timeout}ms: ${wellKnownUrl}. ${statusPart}, ${errorPart}`,
|
||||
);
|
||||
}
|
||||
|
||||
export interface WaitForRemoteStoreOptions {
|
||||
timeout?: number;
|
||||
interval?: number;
|
||||
/** Max time per fetch attempt. Default 1000. */
|
||||
requestTimeout?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Poll GET /api/storage/:storeId until the response body satisfies `predicate`.
|
||||
* Use after persisting state (e.g. setServerState or client disconnect) and before
|
||||
* creating a second client/store or asserting on the API, so the test doesn't race
|
||||
* with async persist (Zustand setItem).
|
||||
*
|
||||
* Uses x-mcp-remote-auth: Bearer <authToken> for the request.
|
||||
*
|
||||
* @param baseUrl - Remote server base URL (e.g. http://127.0.0.1:PORT)
|
||||
* @param storeId - Store ID (e.g. "oauth", "test-store")
|
||||
* @param authToken - Auth token for x-mcp-remote-auth header
|
||||
* @param predicate - Called with parsed JSON body; return true when ready
|
||||
*/
|
||||
export async function waitForRemoteStore(
|
||||
baseUrl: string,
|
||||
storeId: string,
|
||||
authToken: string,
|
||||
predicate: (body: unknown) => boolean,
|
||||
options?: WaitForRemoteStoreOptions,
|
||||
): Promise<void> {
|
||||
const {
|
||||
timeout = 3000,
|
||||
interval = 50,
|
||||
requestTimeout = 1000,
|
||||
} = options ?? {};
|
||||
const url = `${baseUrl.replace(/\/$/, "")}/api/storage/${encodeURIComponent(storeId)}`;
|
||||
const headers: Record<string, string> = {
|
||||
"x-mcp-remote-auth": `Bearer ${authToken}`,
|
||||
};
|
||||
|
||||
await vi.waitFor(
|
||||
async () => {
|
||||
const controller = new AbortController();
|
||||
const t = setTimeout(() => controller.abort(), requestTimeout);
|
||||
try {
|
||||
const res = await fetch(url, { headers, signal: controller.signal });
|
||||
if (!res.ok) {
|
||||
throw new Error(
|
||||
`waitForRemoteStore: GET ${url} returned ${res.status}`,
|
||||
);
|
||||
}
|
||||
const body: unknown = await res.json();
|
||||
if (!predicate(body)) {
|
||||
throw new Error("waitForRemoteStore: predicate not yet satisfied");
|
||||
}
|
||||
} finally {
|
||||
clearTimeout(t);
|
||||
}
|
||||
},
|
||||
{ timeout, interval },
|
||||
);
|
||||
}
|
||||
Loading…
Reference in a new issue