-
Notifications
You must be signed in to change notification settings - Fork 108
fix: close server on process disconnect #414
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.
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
base: main
Are you sure you want to change the base?
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| /** | ||
| * @license | ||
| * Copyright 2025 Google LLC | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| import { EventEmitter } from 'node:events'; | ||
| import { describe, expect, it, jest } from '@jest/globals'; | ||
| import { installProcessLifecycle } from '../../utils/process-lifecycle'; | ||
|
|
||
| class FakeStdin extends EventEmitter { | ||
| destroyed = false; | ||
| readableEnded = false; | ||
| } | ||
|
|
||
| describe('installProcessLifecycle', () => { | ||
| it('closes once when stdin ends and then closes', async () => { | ||
| const stdin = new FakeStdin(); | ||
| const signals = new EventEmitter(); | ||
| const close = jest.fn(async () => {}); | ||
| const exit = jest.fn<(code: number) => void>(); | ||
| const controller = installProcessLifecycle({ | ||
| close, | ||
| stdin, | ||
| signals, | ||
| exit, | ||
| }); | ||
|
|
||
| stdin.emit('end'); | ||
| stdin.emit('close'); | ||
|
|
||
| await controller.getShutdownPromise(); | ||
|
|
||
| expect(close).toHaveBeenCalledTimes(1); | ||
| expect(exit).not.toHaveBeenCalled(); | ||
| }); | ||
|
|
||
| it('upgrades an in-flight stdin shutdown when SIGTERM arrives', async () => { | ||
| const stdin = new FakeStdin(); | ||
| const signals = new EventEmitter(); | ||
| let finishClose: (() => void) | undefined; | ||
| const close = jest.fn( | ||
| () => | ||
| new Promise<void>((resolve) => { | ||
| finishClose = resolve; | ||
| }), | ||
| ); | ||
| const exit = jest.fn<(code: number) => void>(); | ||
| const controller = installProcessLifecycle({ | ||
| close, | ||
| stdin, | ||
| signals, | ||
| exit, | ||
| }); | ||
|
|
||
| stdin.emit('end'); | ||
| signals.emit('SIGTERM'); | ||
|
|
||
| expect(close).toHaveBeenCalledTimes(1); | ||
| expect(exit).not.toHaveBeenCalled(); | ||
|
|
||
| finishClose?.(); | ||
| await controller.getShutdownPromise(); | ||
|
|
||
| expect(close).toHaveBeenCalledTimes(1); | ||
| expect(exit).toHaveBeenCalledWith(143); | ||
| }); | ||
|
|
||
| it('waits for close before exiting on SIGINT', async () => { | ||
| const stdin = new FakeStdin(); | ||
| const signals = new EventEmitter(); | ||
| let finishClose: (() => void) | undefined; | ||
| const close = jest.fn( | ||
| () => | ||
| new Promise<void>((resolve) => { | ||
| finishClose = resolve; | ||
| }), | ||
| ); | ||
| const exit = jest.fn<(code: number) => void>(); | ||
| const controller = installProcessLifecycle({ | ||
| close, | ||
| stdin, | ||
| signals, | ||
| exit, | ||
| }); | ||
|
|
||
| signals.emit('SIGINT'); | ||
|
|
||
| expect(close).toHaveBeenCalledTimes(1); | ||
| expect(exit).not.toHaveBeenCalled(); | ||
|
|
||
| finishClose?.(); | ||
| await controller.getShutdownPromise(); | ||
|
|
||
| expect(exit).toHaveBeenCalledWith(130); | ||
| }); | ||
|
|
||
| it('reports close errors and exits with failure for a signal', async () => { | ||
| const stdin = new FakeStdin(); | ||
| const signals = new EventEmitter(); | ||
| const error = new Error('close failed'); | ||
| const onError = jest.fn<(reason: string, error: unknown) => void>(); | ||
| const exit = jest.fn<(code: number) => void>(); | ||
| const controller = installProcessLifecycle({ | ||
| close: jest.fn(async () => { | ||
| throw error; | ||
| }), | ||
| stdin, | ||
| signals, | ||
| exit, | ||
| onError, | ||
| }); | ||
|
|
||
| signals.emit('SIGTERM'); | ||
| await controller.getShutdownPromise(); | ||
|
|
||
| expect(onError).toHaveBeenCalledWith('SIGTERM', error); | ||
| expect(exit).toHaveBeenCalledWith(1); | ||
| }); | ||
|
|
||
| it('closes immediately when stdin had already ended', async () => { | ||
| const stdin = new FakeStdin(); | ||
| stdin.readableEnded = true; | ||
| const close = jest.fn(async () => {}); | ||
| const controller = installProcessLifecycle({ | ||
| close, | ||
| stdin, | ||
| signals: new EventEmitter(), | ||
| exit: jest.fn<(code: number) => void>(), | ||
| }); | ||
|
|
||
| await controller.getShutdownPromise(); | ||
|
|
||
| expect(close).toHaveBeenCalledTimes(1); | ||
| }); | ||
|
|
||
| it('removes listeners without closing when disposed', () => { | ||
| const stdin = new FakeStdin(); | ||
| const signals = new EventEmitter(); | ||
| const close = jest.fn(async () => {}); | ||
| const controller = installProcessLifecycle({ close, stdin, signals }); | ||
|
|
||
| controller.dispose(); | ||
| stdin.emit('end'); | ||
| signals.emit('SIGTERM'); | ||
|
|
||
| expect(close).not.toHaveBeenCalled(); | ||
| expect(stdin.listenerCount('end')).toBe(0); | ||
| expect(stdin.listenerCount('close')).toBe(0); | ||
| expect(signals.listenerCount('SIGINT')).toBe(0); | ||
| expect(signals.listenerCount('SIGTERM')).toBe(0); | ||
| }); | ||
|
Comment on lines
+187
to
+204
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Update the dispose test to verify that the 'disconnect' event listener is also removed and ignored after disposal. it('removes listeners without closing when disposed', () => {
const stdin = new FakeStdin();
const signals = new EventEmitter();
const close = jest.fn(async () => {});
const controller = installProcessLifecycle({ close, stdin, signals });
controller.dispose();
stdin.emit('end');
signals.emit('SIGTERM');
signals.emit('disconnect');
expect(close).not.toHaveBeenCalled();
expect(stdin.listenerCount('end')).toBe(0);
expect(stdin.listenerCount('close')).toBe(0);
expect(signals.listenerCount('SIGINT')).toBe(0);
expect(signals.listenerCount('SIGTERM')).toBe(0);
expect(signals.listenerCount('disconnect')).toBe(0);
}); |
||
| }); | ||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,133 @@ | ||||||||||||||||||||||
| /** | ||||||||||||||||||||||
| * @license | ||||||||||||||||||||||
| * Copyright 2025 Google LLC | ||||||||||||||||||||||
| * SPDX-License-Identifier: Apache-2.0 | ||||||||||||||||||||||
| */ | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| export type ShutdownReason = 'stdin-end' | 'stdin-close' | 'SIGINT' | 'SIGTERM'; | ||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The PR title and description mention handling process disconnect, but the 'disconnect' event is not currently registered or defined in ShutdownReason. In Node.js, when a process is spawned with an IPC channel, the 'disconnect' event is emitted on process when the parent process disconnects. We should add 'disconnect' to the ShutdownReason type and register a listener for it.
Suggested change
|
||||||||||||||||||||||
|
|
||||||||||||||||||||||
| interface EventSource { | ||||||||||||||||||||||
| once(event: string, listener: () => void): unknown; | ||||||||||||||||||||||
| off(event: string, listener: () => void): unknown; | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| interface StdinEventSource extends EventSource { | ||||||||||||||||||||||
| destroyed?: boolean; | ||||||||||||||||||||||
| readableEnded?: boolean; | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| export interface ProcessLifecycleOptions { | ||||||||||||||||||||||
| close: () => Promise<void>; | ||||||||||||||||||||||
| stdin?: StdinEventSource; | ||||||||||||||||||||||
| signals?: EventSource; | ||||||||||||||||||||||
| exit?: (code: number) => void; | ||||||||||||||||||||||
| setExitCode?: (code: number) => void; | ||||||||||||||||||||||
| onError?: (reason: ShutdownReason, error: unknown) => void; | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| export interface ProcessLifecycleController { | ||||||||||||||||||||||
| dispose: () => void; | ||||||||||||||||||||||
| getShutdownPromise: () => Promise<void> | undefined; | ||||||||||||||||||||||
| shutdown: (reason: ShutdownReason) => Promise<void>; | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| const SIGNAL_EXIT_CODES: Partial<Record<ShutdownReason, number>> = { | ||||||||||||||||||||||
| SIGINT: 130, | ||||||||||||||||||||||
| SIGTERM: 143, | ||||||||||||||||||||||
| }; | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| /** | ||||||||||||||||||||||
| * Installs the process-level lifecycle events that are outside the MCP stdio | ||||||||||||||||||||||
| * transport's responsibility. All events share one shutdown promise so the | ||||||||||||||||||||||
| * server close operation runs at most once. | ||||||||||||||||||||||
| */ | ||||||||||||||||||||||
| export function installProcessLifecycle( | ||||||||||||||||||||||
| options: ProcessLifecycleOptions, | ||||||||||||||||||||||
| ): ProcessLifecycleController { | ||||||||||||||||||||||
| const stdin = options.stdin ?? process.stdin; | ||||||||||||||||||||||
| const signals = options.signals ?? process; | ||||||||||||||||||||||
| const exit = options.exit ?? ((code: number) => process.exit(code)); | ||||||||||||||||||||||
| const setExitCode = | ||||||||||||||||||||||
| options.setExitCode ?? ((code: number) => (process.exitCode = code)); | ||||||||||||||||||||||
| const onError = | ||||||||||||||||||||||
| options.onError ?? | ||||||||||||||||||||||
| ((reason: ShutdownReason, error: unknown) => { | ||||||||||||||||||||||
| console.error(`Failed to close MCP server after ${reason}:`, error); | ||||||||||||||||||||||
| }); | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| let disposed = false; | ||||||||||||||||||||||
| let shutdownPromise: Promise<void> | undefined; | ||||||||||||||||||||||
| let requestedExitCode: number | undefined; | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| const onStdinEnd = () => { | ||||||||||||||||||||||
| void shutdown('stdin-end'); | ||||||||||||||||||||||
| }; | ||||||||||||||||||||||
| const onStdinClose = () => { | ||||||||||||||||||||||
| void shutdown('stdin-close'); | ||||||||||||||||||||||
| }; | ||||||||||||||||||||||
| const onSigint = () => { | ||||||||||||||||||||||
| void shutdown('SIGINT'); | ||||||||||||||||||||||
| }; | ||||||||||||||||||||||
| const onSigterm = () => { | ||||||||||||||||||||||
| void shutdown('SIGTERM'); | ||||||||||||||||||||||
| }; | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| function dispose() { | ||||||||||||||||||||||
| if (disposed) { | ||||||||||||||||||||||
| return; | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| disposed = true; | ||||||||||||||||||||||
| stdin.off('end', onStdinEnd); | ||||||||||||||||||||||
| stdin.off('close', onStdinClose); | ||||||||||||||||||||||
| signals.off('SIGINT', onSigint); | ||||||||||||||||||||||
| signals.off('SIGTERM', onSigterm); | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
|
Comment on lines
+64
to
+91
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Define the onDisconnect handler and ensure it is properly cleaned up in dispose() when the lifecycle controller is disposed. const onStdinEnd = () => {
void shutdown('stdin-end');
};
const onStdinClose = () => {
void shutdown('stdin-close');
};
const onSigint = () => {
void shutdown('SIGINT');
};
const onSigterm = () => {
void shutdown('SIGTERM');
};
const onDisconnect = () => {
void shutdown('disconnect');
};
function dispose() {
if (disposed) {
return;
}
disposed = true;
stdin.off('end', onStdinEnd);
stdin.off('close', onStdinClose);
signals.off('SIGINT', onSigint);
signals.off('SIGTERM', onSigterm);
signals.off('disconnect', onDisconnect);
} |
||||||||||||||||||||||
|
|
||||||||||||||||||||||
| function shutdown(reason: ShutdownReason): Promise<void> { | ||||||||||||||||||||||
| const signalExitCode = SIGNAL_EXIT_CODES[reason]; | ||||||||||||||||||||||
| if (signalExitCode !== undefined) { | ||||||||||||||||||||||
| requestedExitCode = signalExitCode; | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| if (shutdownPromise) { | ||||||||||||||||||||||
| return shutdownPromise; | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| shutdownPromise = (async () => { | ||||||||||||||||||||||
| let closeFailed = false; | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| try { | ||||||||||||||||||||||
| await options.close(); | ||||||||||||||||||||||
| } catch (error) { | ||||||||||||||||||||||
| closeFailed = true; | ||||||||||||||||||||||
| onError(reason, error); | ||||||||||||||||||||||
| } finally { | ||||||||||||||||||||||
| dispose(); | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| if (requestedExitCode !== undefined) { | ||||||||||||||||||||||
| exit(closeFailed ? 1 : requestedExitCode); | ||||||||||||||||||||||
| } else if (closeFailed) { | ||||||||||||||||||||||
| setExitCode(1); | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If options.close() fails during a stdin-initiated shutdown (stdin-end or stdin-close), setting process.exitCode = 1 via setExitCode(1) might not terminate the process if there are active handles (e.g., unclosed sockets, timers, or pending I/O) keeping the event loop alive. To prevent the process from hanging indefinitely on a failed shutdown, it is safer to force-exit the process using exit(1) when closeFailed is true.
Suggested change
|
||||||||||||||||||||||
| })(); | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| return shutdownPromise; | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| stdin.once('end', onStdinEnd); | ||||||||||||||||||||||
| stdin.once('close', onStdinClose); | ||||||||||||||||||||||
| signals.once('SIGINT', onSigint); | ||||||||||||||||||||||
| signals.once('SIGTERM', onSigterm); | ||||||||||||||||||||||
|
Comment on lines
+125
to
+129
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Register the 'disconnect' event listener on the signals event source (which defaults to process) to handle IPC disconnects.
Suggested change
|
||||||||||||||||||||||
|
|
||||||||||||||||||||||
| if (stdin.readableEnded || stdin.destroyed) { | ||||||||||||||||||||||
| void shutdown('stdin-close'); | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| return { | ||||||||||||||||||||||
| dispose, | ||||||||||||||||||||||
| getShutdownPromise: () => shutdownPromise, | ||||||||||||||||||||||
| shutdown, | ||||||||||||||||||||||
| }; | ||||||||||||||||||||||
| } | ||||||||||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a unit test to verify that the process lifecycle controller correctly handles the 'disconnect' event by closing the server.