Skip to content

fix: preserve custom paths in SSE endpoint URLs #466

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 12, 2025
Merged

fix: preserve custom paths in SSE endpoint URLs #466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5a25fe3
fix: preserve custom paths in SSE endpoint URLs
bhosmer-ant May 8, 2025
2f522bf
Add failing tests
olaservo May 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
153 changes: 109 additions & 44 deletions src/client/sse.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down Expand Up @@ -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;
}
});
Expand Down Expand Up @@ -517,25 +582,25 @@ describe("SSEClientTransport", () => {
return;
}

const auth = req.headers.authorization;
if (auth === "Bearer expired-token") {
res.writeHead(401).end();
return;
}
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;
}
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();
res.writeHead(401).end();
});

await new Promise<void>(resolve => {
Expand Down Expand Up @@ -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": {
Expand All @@ -625,19 +690,19 @@ describe("SSEClientTransport", () => {
return;
}

const auth = req.headers.authorization;
if (auth === "Bearer expired-token") {
res.writeHead(401).end();
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;
}
if (auth === "Bearer new-token") {
res.writeHead(200).end();
postAttempts++;
return;
}

res.writeHead(401).end();
res.writeHead(401).end();
break;
}
}
Expand Down
11 changes: 11 additions & 0 deletions src/client/sse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}`,
Expand Down