modelcontextprotocol/typescript-sdk
Watch
1
0
Fork
You've already forked typescript-sdk
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

v2: SdkError tests + codemod (#2137)

Browse source
This commit is contained in:
Konstantin Konstantinov 2026-06-10 20:15:15 +03:00 • committed by GitHub
commit 542d5c9586
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 101 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

2
packages/codemod/src/migrations/v1-to-v2/transforms/importPaths.ts
View file

@ -14,7 +14,7 @@ const REEXPORT_WARNINGS: Record<string, string> = {
'Re-exported RequestHandlerExtra was renamed to ServerContext/ClientContext in v2. Update this re-export manually.',
IsomorphicHeaders: 'Re-exported IsomorphicHeaders was removed in v2 (replaced by standard Headers API). Remove this re-export.',
StreamableHTTPError:
'Re-exported StreamableHTTPError was renamed to SdkError in v2 with different constructor. Update this re-export manually.'
'Re-exported StreamableHTTPError was renamed to SdkHttpError in v2 with a different constructor. Update this re-export manually.'
};
export const importPathsTransform: Transform = {

15
packages/codemod/src/migrations/v1-to-v2/transforms/removedApis.ts
View file

@ -148,13 +148,14 @@ function handleStreamableHTTPError(sourceFile: SourceFile, diagnostics: Diagnost
warning(
sourceFile.getFilePath(),
node.getStartLineNumber(),
'new StreamableHTTPError(statusCode, statusText, body?) → new SdkError(code, message, data?). ' +
'Constructor arguments differ — manual review required. Map HTTP status to SdkErrorCode enum value.'
'new StreamableHTTPError(statusCode, statusText, body?) → new SdkHttpError(code, message, data). ' +
'Constructor arguments differ — manual review required. Map the HTTP status to a SdkErrorCode enum value ' +
'and pass the HTTP status via the data argument, e.g. { status, statusText }.'
)
);
}
renameAllReferences(sourceFile, localName, 'SdkError');
renameAllReferences(sourceFile, localName, 'SdkHttpError');
changesCount++;
foundImport.remove();
@ -164,7 +165,7 @@ function handleStreamableHTTPError(sourceFile: SourceFile, diagnostics: Diagnost
const targetModule = resolveTargetModule(sourceFile, moduleSpec);
const insertIndex = sourceFile.getImportDeclarations().length;
const importsToAdd = hasConstructorCalls ? ['SdkError', 'SdkErrorCode'] : ['SdkError'];
const importsToAdd = hasConstructorCalls ? ['SdkHttpError', 'SdkErrorCode'] : ['SdkHttpError'];
addOrMergeImport(sourceFile, targetModule, importsToAdd, false, insertIndex);
changesCount++;
@ -172,8 +173,10 @@ function handleStreamableHTTPError(sourceFile: SourceFile, diagnostics: Diagnost
warning(
sourceFile.getFilePath(),
line,
'StreamableHTTPError replaced with SdkError. Constructor arguments differ — manual review required. ' +
'HTTP status is now in error.data?.status.'
'StreamableHTTPError replaced with SdkHttpError (a subclass of SdkError). ' +
'HTTP status and status text are now available via error.status and error.statusText. ' +
'Note: unexpected-content-type responses (HTTP 200 with the wrong content type) are thrown as the ' +
'base SdkError, not SdkHttpError, so a catch-all check should use `instanceof SdkError`.'
)
);

4
packages/codemod/test/integration.test.ts
View file

@ -324,8 +324,8 @@ describe('integration', () => {
expect(output).toContain('const h: Headers');
expect(output).not.toContain('IsomorphicHeaders');
// StreamableHTTPError renamed to SdkError
expect(output).toContain('instanceof SdkError');
// StreamableHTTPError renamed to SdkHttpError
expect(output).toContain('instanceof SdkHttpError');
expect(output).not.toContain('StreamableHTTPError');
// schemaToJson removed (import gone)

24
packages/codemod/test/v1-to-v2/transforms/removedApis.test.ts
View file

@ -163,37 +163,37 @@ describe('removed-apis transform', () => {
});
});
describe('StreamableHTTPError → SdkError', () => {
it('renames StreamableHTTPError to SdkError in references', () => {
describe('StreamableHTTPError → SdkHttpError', () => {
it('renames StreamableHTTPError to SdkHttpError in references', () => {
const input = [
`import { StreamableHTTPError } from '@modelcontextprotocol/client';`,
`if (error instanceof StreamableHTTPError) { throw error; }`,
''
].join('\n');
const { text } = applyTransform(input);
expect(text).toContain('instanceof SdkError');
expect(text).toContain('instanceof SdkHttpError');
expect(text).not.toContain('StreamableHTTPError');
});
it('adds SdkError import without SdkErrorCode when no constructor calls', () => {
it('adds SdkHttpError import without SdkErrorCode when no constructor calls', () => {
const input = [
`import { StreamableHTTPError } from '@modelcontextprotocol/client';`,
`if (error instanceof StreamableHTTPError) {}`,
''
].join('\n');
const { text } = applyTransform(input);
expect(text).toContain('SdkError');
expect(text).toContain('SdkHttpError');
expect(text).not.toContain('SdkErrorCode');
});
it('adds SdkError and SdkErrorCode imports when constructor calls exist', () => {
it('adds SdkHttpError and SdkErrorCode imports when constructor calls exist', () => {
const input = [
`import { StreamableHTTPError } from '@modelcontextprotocol/client';`,
`throw new StreamableHTTPError(404, 'Not Found');`,
''
].join('\n');
const { text } = applyTransform(input);
expect(text).toContain('SdkError');
expect(text).toContain('SdkHttpError');
expect(text).toContain('SdkErrorCode');
});
@ -208,14 +208,14 @@ describe('removed-apis transform', () => {
expect(constructorWarning).toBeDefined();
});
it('emits general migration warning', () => {
it('emits general migration warning pointing at the typed status accessor', () => {
const input = [
`import { StreamableHTTPError } from '@modelcontextprotocol/client';`,
`if (error instanceof StreamableHTTPError) {}`,
''
].join('\n');
const { result } = applyTransform(input);
const migrationWarning = result.diagnostics.find(d => d.message.includes('error.data?.status'));
const migrationWarning = result.diagnostics.find(d => d.message.includes('error.status'));
expect(migrationWarning).toBeDefined();
});
@ -227,7 +227,7 @@ describe('removed-apis transform', () => {
].join('\n');
const { text } = applyTransform(input);
expect(text).not.toContain('import { StreamableHTTPError }');
expect(text).toMatch(/import.*SdkError/);
expect(text).toMatch(/import.*SdkHttpError/);
});
it('is idempotent', () => {
@ -249,9 +249,9 @@ describe('removed-apis transform', () => {
''
].join('\n');
const { text, result } = applyTransform(input);
expect(text).toContain('instanceof SdkError');
expect(text).toContain('instanceof SdkHttpError');
expect(text).not.toMatch(/\bSHE\b/);
expect(text).toMatch(/import.*SdkError/);
expect(text).toMatch(/import.*SdkHttpError/);
const constructorWarning = result.diagnostics.find(d => d.message.includes('Constructor arguments differ'));
expect(constructorWarning).toBeDefined();
});