Skip to content
Open
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
83 changes: 77 additions & 6 deletions lib/internal/streams/iter/pull.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ const {
ArrayPrototypePush,
ArrayPrototypeSlice,
PromisePrototypeThen,
PromiseWithResolvers,
SafePromisePrototypeFinally,
SafePromiseRace,
SymbolAsyncIterator,
SymbolIterator,
TypedArrayPrototypeGetByteLength,
Expand Down Expand Up @@ -607,6 +610,77 @@ async function* applyValidatedStatefulAsyncTransform(source, transform, options)
options.signal?.throwIfAborted();
}

/**
* Read one item from an async iterator, rejecting early if the signal aborts.
* @param {AsyncIterator} iterator - The iterator to read from.
* @param {AbortSignal|undefined} signal - Optional abort signal.
* @returns {Promise<IteratorResult<Uint8Array[]>>|IteratorResult<Uint8Array[]>}
*/
function abortableNext(iterator, signal) {
if (signal === undefined) {
return iterator.next();
}

signal.throwIfAborted();

const next = iterator.next();
const { promise, reject } = PromiseWithResolvers();
const onAbort = () => reject(signal.reason);
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It would be better if the closure didn't include the iterator. Suggest moving this out a top level function like...

function getOnAbort(reject, signal) {
  return () => reject(signal.reason);
}

 // then here..

signal.addEventListener('abort', getOnAbort(reject, signal), {
  __proto__: null,
  once: true,
});

signal.addEventListener('abort', onAbort, { __proto__: null, once: true });
if (signal.aborted) {
onAbort();
}

return SafePromisePrototypeFinally(SafePromiseRace([next, promise]), () => {
signal.removeEventListener('abort', onAbort);
});
}

/**
* Wrap an async source so each pending read is abort-aware.
* @param {AsyncIterable<Uint8Array[]>} source - The source to read from.
* @param {AbortSignal|undefined} signal - Optional abort signal.
* @returns {AsyncIterable<Uint8Array[]>}
*/
function yieldAbortable(source, signal) {
if (signal === undefined) {
return source;
}

return {
__proto__: null,
async *[SymbolAsyncIterator]() {
const iterator = source[SymbolAsyncIterator]();
let completed = false;
let aborted = false;

try {
while (true) {
const { done, value } = await abortableNext(iterator, signal);
if (done) {
completed = true;
return;
}
signal.throwIfAborted();
yield value;
}
} catch (error) {
aborted = signal.aborted;
throw error;
} finally {
if (!completed && typeof iterator.return === 'function') {
const result = iterator.return();
if (aborted) {
PromisePrototypeThen(result, undefined, () => {});
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Better to either define the () => {} as a top level constant or use...

const {
  markPromiseAsHandled,
} = internalBinding('util');

} else {
await result;
}
}
}
},
};
}

/**
* Create an async pipeline from source through transforms.
* @yields {Uint8Array[]}
Expand All @@ -615,17 +689,14 @@ async function* createAsyncPipeline(source, transforms, signal) {
// Check for abort
signal?.throwIfAborted();

const normalized = source;

// Fast path: no transforms, just yield normalized source directly
if (transforms.length === 0) {
for await (const batch of normalized) {
signal?.throwIfAborted();
yield batch;
}
yield* yieldAbortable(source, signal);
return;
}

const normalized = yieldAbortable(source, signal);

// Create internal controller for transform cancellation.
// Note: if signal was already aborted, we threw above - no need to check here.
const controller = new AbortController();
Expand Down
40 changes: 40 additions & 0 deletions test/parallel/test-stream-iter-pull-async.js
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,44 @@ async function testPullSignalAbortMidIteration() {
await assert.rejects(() => iter.next(), { name: 'AbortError' });
}

async function testPullSignalAbortWhileSourceNextPending() {
const source = {
[Symbol.asyncIterator]() {
return {
async next() {
await new Promise(() => {});
},
};
},
};
const ac = new AbortController();
const iter = pull(source, { signal: ac.signal })[Symbol.asyncIterator]();
const next = iter.next();
ac.abort();
await assert.rejects(next, { name: 'AbortError' });
}

async function testPullSignalAbortWithTransformWhileSourceNextPending() {
const source = {
[Symbol.asyncIterator]() {
return {
async next() {
await new Promise(() => {});
},
};
},
};
const ac = new AbortController();
const iter = pull(
source,
(chunks) => chunks,
{ signal: ac.signal },
)[Symbol.asyncIterator]();
const next = iter.next();
ac.abort();
await assert.rejects(next, { name: 'AbortError' });
}

// Pull consumer break (return()) cleans up transform signal
async function testPullConsumerBreakCleanup() {
let signalAborted = false;
Expand Down Expand Up @@ -351,6 +389,8 @@ async function testTransformOptionsNotShared() {
testPullSourceError(),
testTapCallbackError(),
testPullSignalAbortMidIteration(),
testPullSignalAbortWhileSourceNextPending(),
testPullSignalAbortWithTransformWhileSourceNextPending(),
testPullConsumerBreakCleanup(),
testPullTransformReturnsPromise(),
testPullTransformYieldsStrings(),
Expand Down
Loading