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

Merge pull request #466 from modelcontextprotocol/fix/sse-custom-endpoint-paths

Browse source 
fix: preserve custom paths in SSE endpoint URLs
This commit is contained in:
ihrpr 2025-05-12 17:24:46 +01:00 • committed by GitHub
commit 68a0ca3505
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 120 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

157
src/client/sse.test.ts
View file

@ -68,6 +68,71 @@ describe("SSEClientTransport", () => {
});
describe("connection handling", () => {
it("maintains custom path when constructing endpoint URL", async () => {
// Create a URL with a custom path
const customPathUrl = new URL("/custom/path/sse", baseUrl);
transport = new SSEClientTransport(customPathUrl);
// Start the transport
await transport.start();
// Send a test message to verify the endpoint URL
const message: JSONRPCMessage = {
jsonrpc: "2.0",
id: "test-1",
method: "test",
params: {}
};
await transport.send(message);
// Verify the POST request maintains the custom path
expect(lastServerRequest.url).toBe("/custom/path/messages");
});
it("handles multiple levels of custom paths", async () => {
// Test with a deeper nested path
const nestedPathUrl = new URL("/api/v1/custom/deep/path/sse", baseUrl);
transport = new SSEClientTransport(nestedPathUrl);
await transport.start();
const message: JSONRPCMessage = {
jsonrpc: "2.0",
id: "test-1",
method: "test",
params: {}
};
await transport.send(message);
// Verify the POST request maintains the full custom path
expect(lastServerRequest.url).toBe("/api/v1/custom/deep/path/messages");
});
it("maintains custom path for SSE connection", async () => {
const customPathUrl = new URL("/custom/path/sse", baseUrl);
transport = new SSEClientTransport(customPathUrl);
await transport.start();
expect(lastServerRequest.url).toBe("/custom/path/sse");
});
it("handles URLs with query parameters", async () => {
const urlWithQuery = new URL("/custom/path/sse?param=value", baseUrl);
transport = new SSEClientTransport(urlWithQuery);
await transport.start();
const message: JSONRPCMessage = {
jsonrpc: "2.0",
id: "test-1",
method: "test",
params: {}
};
await transport.send(message);
expect(lastServerRequest.url).toBe("/custom/path/messages");
});
it("establishes SSE connection and receives endpoint", async () => {
transport = new SSEClientTransport(baseUrl);
await transport.start();
@ -397,18 +462,18 @@ describe("SSEClientTransport", () => {
return;
}
res.writeHead(200, {
"Content-Type": "text/event-stream",
"Cache-Control": "no-cache, no-transform",
Connection: "keep-alive",
});
res.write("event: endpoint\n");
res.write(`data: ${baseUrl.href}\n\n`);
res.writeHead(200, {
"Content-Type": "text/event-stream",
"Cache-Control": "no-cache, no-transform",
Connection: "keep-alive",
});
res.write("event: endpoint\n");
res.write(`data: ${baseUrl.href}\n\n`);
break;
case "POST":
res.writeHead(401);
res.end();
res.writeHead(401);
res.end();
break;
}
});
@ -517,25 +582,25 @@ describe("SSEClientTransport", () => {
return;
}
const auth = req.headers.authorization;
if (auth === "Bearer expired-token") {
const auth = req.headers.authorization;
if (auth === "Bearer expired-token") {
res.writeHead(401).end();
return;
}
if (auth === "Bearer new-token") {
res.writeHead(200, {
"Content-Type": "text/event-stream",
"Cache-Control": "no-cache, no-transform",
Connection: "keep-alive",
});
res.write("event: endpoint\n");
res.write(`data: ${baseUrl.href}\n\n`);
connectionAttempts++;
return;
}
res.writeHead(401).end();
return;
}
if (auth === "Bearer new-token") {
res.writeHead(200, {
"Content-Type": "text/event-stream",
"Cache-Control": "no-cache, no-transform",
Connection: "keep-alive",
});
res.write("event: endpoint\n");
res.write(`data: ${baseUrl.href}\n\n`);
connectionAttempts++;
return;
}
res.writeHead(401).end();
});
await new Promise<void>(resolve => {
@ -610,13 +675,13 @@ describe("SSEClientTransport", () => {
return;
}
res.writeHead(200, {
"Content-Type": "text/event-stream",
"Cache-Control": "no-cache, no-transform",
Connection: "keep-alive",
});
res.write("event: endpoint\n");
res.write(`data: ${baseUrl.href}\n\n`);
res.writeHead(200, {
"Content-Type": "text/event-stream",
"Cache-Control": "no-cache, no-transform",
Connection: "keep-alive",
});
res.write("event: endpoint\n");
res.write(`data: ${baseUrl.href}\n\n`);
break;
case "POST": {
@ -625,19 +690,19 @@ describe("SSEClientTransport", () => {
return;
}
const auth = req.headers.authorization;
if (auth === "Bearer expired-token") {
res.writeHead(401).end();
return;
}
if (auth === "Bearer new-token") {
res.writeHead(200).end();
postAttempts++;
return;
}
const auth = req.headers.authorization;
if (auth === "Bearer expired-token") {
res.writeHead(401).end();
return;
}
if (auth === "Bearer new-token") {
res.writeHead(200).end();
postAttempts++;
return;
}
res.writeHead(401).end();
break;
}
}

11
src/client/sse.ts
View file

@ -143,7 +143,18 @@ export class SSEClientTransport implements Transport {
const messageEvent = event as MessageEvent;
try {
// Use the original URL as the base to resolve the received endpoint
this._endpoint = new URL(messageEvent.data, this._url);
// If the original URL had a custom path, preserve it in the endpoint URL
const originalPath = this._url.pathname;
if (originalPath && originalPath !== '/' && originalPath !== '/sse') {
// Extract the base path from the original URL (everything before the /sse suffix)
const basePath = originalPath.replace(/\/sse$/, '');
// The endpoint should use the same base path but with /messages instead of /sse
this._endpoint.pathname = basePath + '/messages';
}
if (this._endpoint.origin !== this._url.origin) {
throw new Error(
`Endpoint origin does not match connection origin: ${this._endpoint.origin}`,