Skip to content

Fix abort signal listener leak in _requestWithSchema #1672

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

Open
lucaalbinati wants to merge 1 commit into
base: main
Choose a base branch
from
+160 −2
Open

Fix abort signal listener leak in _requestWithSchema #1672

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 8 additions & 2 deletions packages/core/src/shared/protocol.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1248,6 +1248,7 @@ export abstract class Protocol<ContextT extends BaseContext> {
}

const cancel = (reason: unknown) => {
options?.signal?.removeEventListener('abort', onAbort);
this._responseHandlers.delete(messageId);
this._progressHandlers.delete(messageId);
this._cleanupTimeout(messageId);
Expand All @@ -1272,6 +1273,8 @@ export abstract class Protocol<ContextT extends BaseContext> {
};

this._responseHandlers.set(messageId, response => {
options?.signal?.removeEventListener('abort', onAbort);

if (options?.signal?.aborted) {
return;
}
Expand All @@ -1292,9 +1295,10 @@ export abstract class Protocol<ContextT extends BaseContext> {
}
});

options?.signal?.addEventListener('abort', () => {
const onAbort = () => {
cancel(options?.signal?.reason);
});
};
options?.signal?.addEventListener('abort', onAbort, { once: true });

const timeout = options?.timeout ?? DEFAULT_REQUEST_TIMEOUT_MSEC;
const timeoutHandler = () => cancel(new SdkError(SdkErrorCode.RequestTimeout, 'Request timed out', { timeout }));
Expand All @@ -1321,6 +1325,7 @@ export abstract class Protocol<ContextT extends BaseContext> {
message: jsonrpcRequest,
timestamp: Date.now()
}).catch(error => {
options?.signal?.removeEventListener('abort', onAbort);
this._cleanupTimeout(messageId);
reject(error);
});
Expand All @@ -1330,6 +1335,7 @@ export abstract class Protocol<ContextT extends BaseContext> {
} else {
// No related task - send through transport normally
this._transport.send(jsonrpcRequest, { relatedRequestId, resumptionToken, onresumptiontoken }).catch(error => {
options?.signal?.removeEventListener('abort', onAbort);
this._cleanupTimeout(messageId);
reject(error);
});
Expand Down
152 changes: 152 additions & 0 deletions packages/core/test/shared/protocol.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5723,3 +5723,155 @@ describe('Error handling for missing resolvers', () => {
});
});
});

describe('Abort signal listener cleanup', () => {
let protocol: Protocol<BaseContext>;
let transport: MockTransport;

beforeEach(() => {
vi.useFakeTimers();
transport = new MockTransport();
vi.spyOn(transport, 'send');
protocol = new (class extends Protocol<BaseContext> {
protected assertCapabilityForMethod(): void {}
protected assertNotificationCapability(): void {}
protected assertRequestHandlerCapability(): void {}
protected assertTaskCapability(): void {}
protected buildContext(ctx: BaseContext): BaseContext {
return ctx;
}
protected assertTaskHandlerCapability(): void {}
})();
});

afterEach(() => {
vi.useRealTimers();
});

test('should remove abort listener when request completes successfully', async () => {
await protocol.connect(transport);

const abortController = new AbortController();
const removeEventListenerSpy = vi.spyOn(abortController.signal, 'removeEventListener');

const mockSchema: ZodType<{ result: string }> = z.object({
result: z.string()
});

const requestPromise = testRequest(protocol, { method: 'example', params: {} }, mockSchema, {
timeout: 5000,
signal: abortController.signal
});

// Simulate a successful response
if (transport.onmessage) {
transport.onmessage({
jsonrpc: '2.0',
id: 0,
result: { result: 'success' }
});
}

await expect(requestPromise).resolves.toEqual({ result: 'success' });
expect(removeEventListenerSpy).toHaveBeenCalledWith('abort', expect.any(Function));
});

test('should remove abort listener when request times out', async () => {
await protocol.connect(transport);

const abortController = new AbortController();
const removeEventListenerSpy = vi.spyOn(abortController.signal, 'removeEventListener');

const mockSchema: ZodType<{ result: string }> = z.object({
result: z.string()
});

const requestPromise = testRequest(protocol, { method: 'example', params: {} }, mockSchema, {
timeout: 100,
signal: abortController.signal
});

vi.advanceTimersByTime(101);

await expect(requestPromise).rejects.toThrow('Request timed out');
expect(removeEventListenerSpy).toHaveBeenCalledWith('abort', expect.any(Function));
});

test('should not accumulate listeners across multiple requests on the same signal', async () => {
await protocol.connect(transport);

const abortController = new AbortController();
const addEventListenerSpy = vi.spyOn(abortController.signal, 'addEventListener');
const removeEventListenerSpy = vi.spyOn(abortController.signal, 'removeEventListener');

const mockSchema: ZodType<{ result: string }> = z.object({
result: z.string()
});

// Make 3 sequential requests on the same signal
for (let i = 0; i < 3; i++) {
const requestPromise = testRequest(protocol, { method: 'example', params: {} }, mockSchema, {
timeout: 5000,
signal: abortController.signal
});

if (transport.onmessage) {
transport.onmessage({
jsonrpc: '2.0',
id: i,
result: { result: 'success' }
});
}

await expect(requestPromise).resolves.toEqual({ result: 'success' });
}

// Each request should have added and removed exactly one listener
expect(addEventListenerSpy).toHaveBeenCalledTimes(3);
expect(removeEventListenerSpy).toHaveBeenCalledTimes(3);
});

test('should remove abort listener when abort signal is triggered', async () => {
await protocol.connect(transport);

const abortController = new AbortController();
const removeEventListenerSpy = vi.spyOn(abortController.signal, 'removeEventListener');

const mockSchema: ZodType<{ result: string }> = z.object({
result: z.string()
});

const requestPromise = testRequest(protocol, { method: 'example', params: {} }, mockSchema, {
timeout: 5000,
signal: abortController.signal
});

abortController.abort('User cancelled');

await expect(requestPromise).rejects.toThrow();
// cancel() calls removeEventListener even though once:true also cleans up
expect(removeEventListenerSpy).toHaveBeenCalledWith('abort', expect.any(Function));
});

test('should remove abort listener when transport.send fails', async () => {
await protocol.connect(transport);

const abortController = new AbortController();
const removeEventListenerSpy = vi.spyOn(abortController.signal, 'removeEventListener');

// Make transport.send reject
vi.spyOn(transport, 'send').mockRejectedValueOnce(new Error('Transport failure'));

const mockSchema: ZodType<{ result: string }> = z.object({
result: z.string()
});

const requestPromise = testRequest(protocol, { method: 'example', params: {} }, mockSchema, {
timeout: 5000,
signal: abortController.signal
});

await expect(requestPromise).rejects.toThrow('Transport failure');
expect(removeEventListenerSpy).toHaveBeenCalledWith('abort', expect.any(Function));
});
});
Loading