Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions .changeset/chilly-ads-retire.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@solana/rpc': patch
'@solana/transaction-confirmation': patch
---

Fix transaction confirmation and coalesced RPC request cancellation in environments where abort events have a null target.
19 changes: 19 additions & 0 deletions packages/rpc/src/__tests__/rpc-request-coalescer-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,25 @@ describe('RPC request coalescer', () => {
const transportAbortSignal = mockTransport.mock.lastCall![0].signal!;
expect(transportAbortSignal.aborted).toBe(false);
});
it('rejects with the signal reason when the abort event target is null', async () => {
expect.assertions(2);
const abortController = new AbortController();
const addEventListenerSpy = jest
.spyOn(abortController.signal, 'addEventListener')
.mockImplementation(() => {});
const responsePromise = coalescedTransport({
payload: null,
signal: abortController.signal,
});

abortController.abort('o no');
const abortEvent = new Event('abort');
expect(abortEvent.target).toBeNull();
const handleAbort = addEventListenerSpy.mock.calls[0][1] as EventListener;
handleAbort(abortEvent);

await expect(responsePromise).rejects.toBe('o no');
});
describe('multiple coalesced requests each with an abort signal', () => {
let abortControllerA: AbortController;
let abortControllerB: AbortController;
Expand Down
4 changes: 2 additions & 2 deletions packages/rpc/src/rpc-request-coalescer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ export function getRpcTransportWithRequestCoalescing<TTransport extends RpcTrans
if (signal) {
const responsePromise = coalescedRequest.responsePromise as Promise<RpcResponse<TResponse>>;
return await new Promise<RpcResponse<TResponse>>((resolve, reject) => {
const handleAbort = (e: AbortSignalEventMap['abort']) => {
const handleAbort = () => {
signal.removeEventListener('abort', handleAbort);
coalescedRequest.numConsumers -= 1;
queueMicrotask(() => {
Expand All @@ -85,7 +85,7 @@ export function getRpcTransportWithRequestCoalescing<TTransport extends RpcTrans
}
});
// eslint-disable-next-line @typescript-eslint/prefer-promise-reject-errors
reject((e.target as AbortSignal).reason);
reject(signal.reason);
};
signal.addEventListener('abort', handleAbort);
responsePromise
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,23 @@ describe('getTimeoutPromise', () => {
abortController.abort();
await expect(timeoutPromise).rejects.toThrow(/operation was aborted/);
});
it('throws an abort error with the signal reason when the abort event target is null', async () => {
expect.assertions(2);
const abortController = new AbortController();
const addEventListenerSpy = jest.spyOn(abortController.signal, 'addEventListener').mockImplementation(() => {});
const timeoutPromise = getTimeoutPromise({
abortSignal: abortController.signal,
commitment: 'finalized',
});

abortController.abort('o no');
const abortEvent = new Event('abort');
expect(abortEvent.target).toBeNull();
const handleAbort = addEventListenerSpy.mock.calls[0][1] as EventListener;
handleAbort(abortEvent);

await expect(timeoutPromise).rejects.toMatchObject({ message: 'o no', name: 'AbortError' });
});
it('registers the caller abort listener with an auto-cleanup signal', () => {
const abortController = new AbortController();
const addEventListenerSpy = jest.spyOn(abortController.signal, 'addEventListener');
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ export async function getTimeoutPromise({ abortSignal: callerAbortSignal, commit
let timeoutId: ReturnType<typeof setTimeout> | undefined;
try {
return await new Promise((_, reject) => {
const handleAbort = (e: AbortSignalEventMap['abort']) => {
const handleAbort = () => {
clearTimeout(timeoutId);
const abortError = new DOMException((e.target as AbortSignal).reason, 'AbortError');
const abortError = new DOMException(callerAbortSignal.reason, 'AbortError');
reject(abortError);
};
callerAbortSignal.addEventListener('abort', handleAbort, { signal: abortController.signal });
Expand Down
Loading