|
| 1 | +import { describe, expect, it, vi } from 'vitest'; |
| 2 | + |
| 3 | +import { OAuthError, OAuthErrorCode } from '../../src/auth/errors'; |
| 4 | +import { SdkError, SdkErrorCode, SdkHttpError } from '../../src/errors/sdkErrors'; |
| 5 | +import { ProtocolErrorCode } from '../../src/types/enums'; |
| 6 | +import { |
| 7 | + MissingRequiredClientCapabilityError, |
| 8 | + ProtocolError, |
| 9 | + ResourceNotFoundError, |
| 10 | + UnsupportedProtocolVersionError, |
| 11 | + UrlElicitationRequiredError |
| 12 | +} from '../../src/types/errors'; |
| 13 | + |
| 14 | +// `@modelcontextprotocol/client` and `@modelcontextprotocol/server` each bundle their |
| 15 | +// own copy of core-internal; `vi.resetModules()` + a dynamic import reproduces that |
| 16 | +// dual-copy situation faithfully (separate class objects, shared registry symbol). |
| 17 | +async function loadForeignCopies() { |
| 18 | + vi.resetModules(); |
| 19 | + const sdkErrors = await import('../../src/errors/sdkErrors'); |
| 20 | + const protocolErrors = await import('../../src/types/errors'); |
| 21 | + const authErrors = await import('../../src/auth/errors'); |
| 22 | + return { sdkErrors, protocolErrors, authErrors }; |
| 23 | +} |
| 24 | + |
| 25 | +describe('cross-bundle error instanceof (branded)', () => { |
| 26 | + it('same-bundle instanceof keeps working for every class', () => { |
| 27 | + const http = new SdkHttpError(SdkErrorCode.ClientHttpNotImplemented, 'boom', { status: 404 }); |
| 28 | + expect(http instanceof SdkHttpError).toBe(true); |
| 29 | + expect(http instanceof SdkError).toBe(true); |
| 30 | + expect(http instanceof Error).toBe(true); |
| 31 | + |
| 32 | + const proto = new ProtocolError(ProtocolErrorCode.InvalidParams, 'bad'); |
| 33 | + expect(proto instanceof ProtocolError).toBe(true); |
| 34 | + |
| 35 | + const rnf = new ResourceNotFoundError('file:///missing'); |
| 36 | + expect(rnf instanceof ResourceNotFoundError).toBe(true); |
| 37 | + expect(rnf instanceof ProtocolError).toBe(true); |
| 38 | + |
| 39 | + const oauth = new OAuthError(OAuthErrorCode.InvalidToken, 'nope'); |
| 40 | + expect(oauth instanceof OAuthError).toBe(true); |
| 41 | + }); |
| 42 | + |
| 43 | + it('hierarchies stay disjoint', () => { |
| 44 | + const sdk = new SdkError(SdkErrorCode.NotConnected, 'x'); |
| 45 | + const proto = new ProtocolError(ProtocolErrorCode.InvalidParams, 'x'); |
| 46 | + expect(sdk instanceof ProtocolError).toBe(false); |
| 47 | + expect(proto instanceof SdkError).toBe(false); |
| 48 | + expect(proto instanceof OAuthError).toBe(false); |
| 49 | + |
| 50 | + const rnf = new ResourceNotFoundError('file:///missing'); |
| 51 | + expect(rnf instanceof UrlElicitationRequiredError).toBe(false); |
| 52 | + expect(rnf instanceof UnsupportedProtocolVersionError).toBe(false); |
| 53 | + expect(rnf instanceof MissingRequiredClientCapabilityError).toBe(false); |
| 54 | + }); |
| 55 | + |
| 56 | + it('an instance from a second module copy satisfies instanceof against this copy (and vice versa)', async () => { |
| 57 | + const { sdkErrors, protocolErrors, authErrors } = await loadForeignCopies(); |
| 58 | + |
| 59 | + // Sanity: these really are different class objects. |
| 60 | + expect(sdkErrors.SdkHttpError).not.toBe(SdkHttpError); |
| 61 | + expect(protocolErrors.ProtocolError).not.toBe(ProtocolError); |
| 62 | + |
| 63 | + const foreignHttp = new sdkErrors.SdkHttpError(sdkErrors.SdkErrorCode.ClientHttpAuthentication, '401', { status: 401 }); |
| 64 | + expect(foreignHttp instanceof SdkHttpError).toBe(true); |
| 65 | + expect(foreignHttp instanceof SdkError).toBe(true); |
| 66 | + expect(foreignHttp instanceof ProtocolError).toBe(false); |
| 67 | + |
| 68 | + const localHttp = new SdkHttpError(SdkErrorCode.ClientHttpAuthentication, '401', { status: 401 }); |
| 69 | + expect(localHttp instanceof sdkErrors.SdkHttpError).toBe(true); |
| 70 | + expect(localHttp instanceof sdkErrors.SdkError).toBe(true); |
| 71 | + |
| 72 | + const foreignRnf = new protocolErrors.ResourceNotFoundError('file:///missing'); |
| 73 | + expect(foreignRnf instanceof ResourceNotFoundError).toBe(true); |
| 74 | + expect(foreignRnf instanceof ProtocolError).toBe(true); |
| 75 | + expect(foreignRnf instanceof UrlElicitationRequiredError).toBe(false); |
| 76 | + |
| 77 | + const foreignPlainProto = new protocolErrors.ProtocolError(ProtocolErrorCode.InvalidParams, 'x'); |
| 78 | + expect(foreignPlainProto instanceof ProtocolError).toBe(true); |
| 79 | + expect(foreignPlainProto instanceof ResourceNotFoundError).toBe(false); |
| 80 | + |
| 81 | + const foreignOauth = new authErrors.OAuthError(authErrors.OAuthErrorCode.InvalidGrant, 'x'); |
| 82 | + expect(foreignOauth instanceof OAuthError).toBe(true); |
| 83 | + expect(foreignOauth instanceof SdkError).toBe(false); |
| 84 | + }); |
| 85 | + |
| 86 | + it('ProtocolError.fromError from a second copy reconstructs instances this copy recognizes', async () => { |
| 87 | + const { protocolErrors } = await loadForeignCopies(); |
| 88 | + const reconstructed = protocolErrors.ProtocolError.fromError(ProtocolErrorCode.InvalidParams, 'gone', { |
| 89 | + uri: 'file:///missing' |
| 90 | + }); |
| 91 | + expect(reconstructed instanceof ResourceNotFoundError).toBe(true); |
| 92 | + expect(reconstructed instanceof ProtocolError).toBe(true); |
| 93 | + }); |
| 94 | + |
| 95 | + it('user-defined subclasses keep plain prototype semantics (no cross-class false positives)', () => { |
| 96 | + class MyError extends ProtocolError {} |
| 97 | + const mine = new MyError(ProtocolErrorCode.InternalError, 'mine'); |
| 98 | + expect(mine instanceof MyError).toBe(true); |
| 99 | + expect(mine instanceof ProtocolError).toBe(true); |
| 100 | + |
| 101 | + // A base-class instance — same or foreign bundle — must never satisfy the subclass. |
| 102 | + const base = new ProtocolError(ProtocolErrorCode.InternalError, 'base'); |
| 103 | + expect(base instanceof MyError).toBe(false); |
| 104 | + }); |
| 105 | + |
| 106 | + it('a foreign base instance does not satisfy a user-defined subclass of this copy', async () => { |
| 107 | + const { protocolErrors } = await loadForeignCopies(); |
| 108 | + class MyError extends ProtocolError {} |
| 109 | + const foreignBase = new protocolErrors.ProtocolError(ProtocolErrorCode.InternalError, 'x'); |
| 110 | + expect(foreignBase instanceof MyError).toBe(false); |
| 111 | + }); |
| 112 | + |
| 113 | + it('does not leak the brand through enumeration or serialization', () => { |
| 114 | + const err = new SdkHttpError(SdkErrorCode.ClientHttpForbidden, 'nope', { status: 403 }); |
| 115 | + expect(Object.keys(err)).not.toContain(expect.stringContaining('mcp')); |
| 116 | + const json = JSON.stringify({ ...err }); |
| 117 | + expect(json).not.toContain('mcp.Sdk'); |
| 118 | + }); |
| 119 | + |
| 120 | + it('tolerates primitives, null, and brandless objects', () => { |
| 121 | + for (const value of [null, undefined, 42, 'x', Symbol('s'), {}, new Error('plain')]) { |
| 122 | + expect((value as unknown) instanceof SdkError).toBe(false); |
| 123 | + expect((value as unknown) instanceof ProtocolError).toBe(false); |
| 124 | + expect((value as unknown) instanceof OAuthError).toBe(false); |
| 125 | + } |
| 126 | + }); |
| 127 | +}); |
0 commit comments