inspector/vitest.shared.mts
cliffhall 19a6df7ad3 SDK v2 migration (behavior-neutral, versionNegotiation: 'legacy') (#1624)
Migrate all three clients + core + test-servers from
@modelcontextprotocol/sdk@1.29 to SDK v2 (2.0.0-beta.4), keeping behavior
identical against legacy (2025-11-25) servers. Foundation for the SDK V2 +
New Spec stack.

Packages
- Split @modelcontextprotocol/sdk -> @modelcontextprotocol/client (Client,
  transports, OAuth, error taxonomy, protocol types) + core (Zod schemas);
  stdio -> client/stdio, Ajv -> client/validators/ajv. Test-servers ->
  @modelcontextprotocol/server (+ server-legacy/sse). Deterministic import
  rewrite (schemas -> core, everything else -> client); the codemod misroutes
  client code to /server so it was not used for path routing.
- new Client(..., { versionNegotiation: { mode: 'legacy' } }) — nothing
  2026-era goes on the wire.

Runtime (core/mcp/inspectorClient.ts)
- Error taxonomy: McpError -> ProtocolError, ErrorCode -> ProtocolErrorCode;
  RequestTimeout -> SdkError/SdkErrorCode.
- Handlers take method strings; task methods (tasks/*, notifications/tasks/*)
  use the 3-arg custom form (excluded from v2's spec-method set).
- Legacy tasks kept working (per project requirement): requestor tasks re-
  implemented over raw client.request + explicit deprecated schemas;
  experimental.tasks.callToolStream replaced by a local pollTaskToolCall
  async generator (with _progressHandlers revival so task-execution progress
  still reaches the caller). Receiver (server-initiated) tasks: the v2 Client
  validates a sampling/elicit handler result and rejects the legacy { task }
  response with -32602 — installReceiverTaskResponseBypass swaps the wrapped
  entry in the private _requestHandlers map for the task-augmented branch so
  { task } reaches the wire (fixes server-initiated sampling-via-task).
- Pagination: list verbs use raw client.request({method}, List*ResultSchema)
  for single-page behavior (v2's client.listX() auto-aggregate all pages).

Web / auth / apps
- Rename local JsonSchemaType -> InspectorFormSchema + add toFormSchema()
  structural narrowing at the SDK-schema -> form boundary.
- ext-apps still peers on SDK v1: one compat boundary with documented casts
  (remove when ext-apps#702 lands a v2 peer).
- OAuth provider saveClientInformation reconciled with v2's
  OAuthClientInformationContext; InvalidClientMetadataError re-homed as a
  local class (server-legacy/auth is not browser-safe).
- vitest.shared.mts dedupes @modelcontextprotocol/client+core to one copy so
  vi.mock intercepts the SUT's import.

Accepted v2 behavior changes (per #1624 / spec §9.2): unknown-tool call
rejects with -32602; cancellation is stream-abort (no guaranteed
notifications/cancelled frame); output-schema strictness restored via the
Inspector's own Ajv check on the default path.

npm run ci green: validate (web 3087 / cli 212 / tui 274 / launcher 5),
coverage (>=90 per-file, all clients), smoke (launcher/cli/web), storybook
(410).

Closes #1624

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-15 10:44:24 -04:00

89 lines
2.9 KiB
TypeScript

/**
* Vitest/Vite resolve aliases shared between clients/web and node clients
* (cli, tui). Pass each client's directory so bare-module pins resolve against
* that client's node_modules.
*/
import path from 'node:path';
import { fileURLToPath } from 'node:url';
export function vitestSharedPaths(clientDir: string) {
const dirname = path.resolve(clientDir);
const repoRoot = path.resolve(dirname, '../..');
const sharedAliases = {
'@inspector/core': path.resolve(repoRoot, 'core'),
'@modelcontextprotocol/inspector-test-server': path.resolve(
repoRoot,
'test-servers/build/index.js',
),
};
const sharedDedupe = [
'react',
'react-dom',
'@modelcontextprotocol/client',
'@modelcontextprotocol/core',
];
const nodeModulesAliases = [
{ find: /^react$/, replacement: path.resolve(dirname, 'node_modules/react') },
{
find: /^react\/jsx-runtime$/,
replacement: path.resolve(dirname, 'node_modules/react/jsx-runtime.js'),
},
{
find: /^react\/jsx-dev-runtime$/,
replacement: path.resolve(dirname, 'node_modules/react/jsx-dev-runtime.js'),
},
{
find: /^react-dom$/,
replacement: path.resolve(dirname, 'node_modules/react-dom'),
},
{
find: /^react-dom\/client$/,
replacement: path.resolve(dirname, 'node_modules/react-dom/client.js'),
},
{ find: /^pino$/, replacement: path.resolve(dirname, 'node_modules/pino') },
{
find: /^pino\/browser\.js$/,
replacement: path.resolve(dirname, 'node_modules/pino/browser.js'),
},
{
find: /^hono$/,
replacement: path.resolve(dirname, 'node_modules/hono/dist/index.js'),
},
{
find: /^hono\/streaming$/,
replacement: path.resolve(dirname, 'node_modules/hono/dist/helper/streaming/index.js'),
},
{
find: /^@hono\/node-server$/,
replacement: path.resolve(dirname, 'node_modules/@hono/node-server'),
},
{ find: /^atomically$/, replacement: path.resolve(dirname, 'node_modules/atomically') },
{ find: /^chokidar$/, replacement: path.resolve(dirname, 'node_modules/chokidar') },
{
find: /^@napi-rs\/keyring$/,
replacement: path.resolve(dirname, 'node_modules/@napi-rs/keyring'),
},
{ find: /^express$/, replacement: path.resolve(dirname, 'node_modules/express') },
{ find: /^yaml$/, replacement: path.resolve(repoRoot, 'node_modules/yaml') },
];
const projectResolve = {
alias: [
...Object.entries(sharedAliases).map(([find, replacement]) => ({ find, replacement })),
...nodeModulesAliases,
],
dedupe: sharedDedupe,
};
return { repoRoot, sharedAliases, sharedDedupe, nodeModulesAliases, projectResolve };
}
/** Convenience for importers that only have import.meta.url. */
export function vitestSharedPathsFromMetaUrl(metaUrl: string) {
const clientDir = path.dirname(fileURLToPath(metaUrl));
return vitestSharedPaths(clientDir);
}