Skip to content

fix: add a ping loop for http transport clients #484

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
Aug 28, 2025
+45 −3
Merged

fix: add a ping loop for http transport clients #484

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f54b86f
add a ping loop for http transport clients
nirinchev Aug 27, 2025
6930bf1
Wrap the transport.close in a try-catch
nirinchev Aug 28, 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
2 changes: 2 additions & 0 deletions src/common/logger.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ export const LogId = {
streamableHttpTransportSessionCloseNotificationFailure: mongoLogId(1_006_004),
streamableHttpTransportRequestFailure: mongoLogId(1_006_005),
streamableHttpTransportCloseFailure: mongoLogId(1_006_006),
streamableHttpTransportKeepAliveFailure: mongoLogId(1_006_007),
streamableHttpTransportKeepAlive: mongoLogId(1_006_008),

exportCleanupError: mongoLogId(1_007_001),
exportCreationError: mongoLogId(1_007_002),
Expand Down
4 changes: 3 additions & 1 deletion src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,10 @@ async function main(): Promise<void> {
transportRunner.logger.info({
id: LogId.serverCloseRequested,
context: "server",
message: "Closing server",
message: `Closing server due to error: ${error as string}`,
noRedaction: true,
});

try {
await transportRunner.close();
transportRunner.logger.info({
Expand Down
36 changes: 34 additions & 2 deletions src/transports/streamableHttp.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ export class StreamableHttpRunner extends TransportRunnerBase {
jsonrpc: "2.0",
error: {
code: JSON_RPC_ERROR_CODE_SESSION_ID_INVALID,
message: `session id is invalid`,
message: "session id is invalid",
},
});
return;
Expand All @@ -85,7 +85,7 @@ export class StreamableHttpRunner extends TransportRunnerBase {
jsonrpc: "2.0",
error: {
code: JSON_RPC_ERROR_CODE_SESSION_NOT_FOUND,
message: `session not found`,
message: "session not found",
},
});
return;
Expand Down Expand Up @@ -114,12 +114,42 @@ export class StreamableHttpRunner extends TransportRunnerBase {
}

const server = this.setupServer();
let keepAliveLoop: NodeJS.Timeout;
const transport = new StreamableHTTPServerTransport({
sessionIdGenerator: (): string => randomUUID().toString(),
onsessioninitialized: (sessionId): void => {
server.session.logger.setAttribute("sessionId", sessionId);

this.sessionStore.setSession(sessionId, transport, server.session.logger);

let failedPings = 0;
// eslint-disable-next-line @typescript-eslint/no-misused-promises
keepAliveLoop = setInterval(async () => {
try {
this.logger.debug({
id: LogId.streamableHttpTransportKeepAlive,
context: "streamableHttpTransport",
message: "Sending ping",
});

await transport.send({
jsonrpc: "2.0",
method: "ping",
});
failedPings = 0;
} catch (err) {
this.logger.warning({
id: LogId.streamableHttpTransportKeepAliveFailure,
context: "streamableHttpTransport",
message: `Error sending ping (attempt #${failedPings + 1}): ${err instanceof Error ? err.message : String(err)}`,
});

if (++failedPings > 3) {
clearInterval(keepAliveLoop);
await transport.close();
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be in a try-catch

}
}
}, 30_000);
},
onsessionclosed: async (sessionId): Promise<void> => {
try {
Expand All @@ -135,6 +165,8 @@ export class StreamableHttpRunner extends TransportRunnerBase {
});

transport.onclose = (): void => {
clearInterval(keepAliveLoop);

server.close().catch((error) => {
this.logger.error({
id: LogId.streamableHttpTransportCloseFailure,
Expand Down
Loading