Skip to content

fix(client): remove caller abort listener after successful fetch #1835

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
MukundaKatta wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(client): remove caller abort listener after successful fetch #1835

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
1 change: 1 addition & 0 deletions src/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -892,6 +892,7 @@ export class OpenAI {
return await this.fetch.call(undefined, url, fetchOptions);
} finally {
clearTimeout(timeout);
if (signal) signal.removeEventListener('abort', abort);
}
}

Expand Down
22 changes: 22 additions & 0 deletions tests/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,28 @@ describe('instantiate client', () => {
expect(spy).toHaveBeenCalledTimes(1);
});

test('removes the caller abort listener after a successful request', async () => {
const client = new OpenAI({
baseURL: 'http://localhost:5000/',
apiKey: 'My API Key',
fetch: async () =>
new Response(JSON.stringify({ ok: true }), {
headers: { 'Content-Type': 'application/json' },
}),
});

const controller = new AbortController();
const addSpy = jest.spyOn(controller.signal, 'addEventListener');
const removeSpy = jest.spyOn(controller.signal, 'removeEventListener');

await client.get('/foo', { signal: controller.signal });

expect(addSpy).toHaveBeenCalledWith('abort', expect.any(Function), { once: true });
const listener = addSpy.mock.calls[0]?.[1];
expect(listener).toBeDefined();
expect(removeSpy).toHaveBeenCalledWith('abort', listener);
});

test('normalized method', async () => {
let capturedRequest: RequestInit | undefined;
const testFetch = async (url: string | URL | Request, init: RequestInit = {}): Promise<Response> => {
Expand Down