Commit 5e111aa3703 for nodejs
commit 5e111aa3703963369cb2da147aff4b57112b0663
Author: James M Snell <jasnell@gmail.com>
Date: Wed Oct 7 14:45:19 2026 +0000
stream: create stream/iter pending promises without a result object
The promises stream/iter creates per read, per write and per batch when
it has to wait (a pull() pipeline's pull, a from() async source's read,
a push() or broadcast() consumer's read and pending write, a share()
source read, drain waits, queued operations) were created with
PromiseWithResolvers(), which also allocates an object to return the
promise and its two functions in. Without pointer compression that is
299 bytes per call, against 214 for `new Promise(executor)` with an
executor that is created once.
newPendingPromise() / newResolveOnlyPromise() create the promise with a
shared executor that stores the resolving functions in module slots, and
takeResolve() / takeReject() take them from there right after. The
executor runs synchronously, so nothing can run in between. Paths that
create a promise once per stream or per call are unchanged.
Allocation per chunk (sampling heap profile, 16-byte chunks):
- for await over from(asyncSource): 1053 -> 967 bytes
- pull() with one transform, async source: 1692 -> 1518 bytes
- pull() with one transform, sync source: 917 -> 838 bytes
Assisted-by: OpenCode
Signed-off-by: James M Snell <jasnell@gmail.com>
PR-URL: https://github.com/nodejs/node/pull/66504
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
diff --git a/lib/internal/streams/iter/broadcast.js b/lib/internal/streams/iter/broadcast.js
index 06182e5870f..3d15dc272bb 100644
--- a/lib/internal/streams/iter/broadcast.js
+++ b/lib/internal/streams/iter/broadcast.js
@@ -74,6 +74,9 @@ const {
raceSignal,
validateBatchEntry,
validateBudget,
+ newPendingPromise,
+ takeReject,
+ takeResolve,
} = require('internal/streams/iter/utils');
const {
converters,
@@ -271,12 +274,16 @@ class BroadcastImpl {
}
if (state.resolve) {
- const { promise, resolve, reject } = PromiseWithResolvers();
+ const promise = newPendingPromise();
+ const resolve = takeResolve();
+ const reject = takeReject();
state.pending.push(new PendingRequest(resolve, reject));
return promise;
}
- const { promise, resolve, reject } = PromiseWithResolvers();
+ const promise = newPendingPromise();
+ const resolve = takeResolve();
+ const reject = takeReject();
state.resolve = resolve;
state.reject = reject;
self.#waiters.add(state);
@@ -632,7 +639,9 @@ class BroadcastWriter {
const canWrite = this.canWrite;
if (canWrite === null) return null;
if (canWrite) return PromiseResolve(true);
- const { promise, resolve, reject } = PromiseWithResolvers();
+ const promise = newPendingPromise();
+ const resolve = takeResolve();
+ const reject = takeReject();
ArrayPrototypePush(this.#pendingDrains, new PendingRequest(resolve, reject));
return promise;
}
@@ -823,7 +832,9 @@ class BroadcastWriter {
* @returns {Promise<void>}
*/
#createPendingWrite(batch, signal) {
- const { promise, resolve, reject } = PromiseWithResolvers();
+ const promise = newPendingPromise();
+ const resolve = takeResolve();
+ const reject = takeReject();
const entry = new PendingWrite(batch, resolve, reject);
this.#pendingWrites.push(entry);
if (signal) {
diff --git a/lib/internal/streams/iter/classic.js b/lib/internal/streams/iter/classic.js
index 2b39bc92787..2fe90d58a46 100644
--- a/lib/internal/streams/iter/classic.js
+++ b/lib/internal/streams/iter/classic.js
@@ -69,6 +69,9 @@ const {
onSignalAbort,
validateBackpressure,
toWriterUint8Array,
+ newPendingPromise,
+ takeReject,
+ takeResolve,
} = require('internal/streams/iter/utils');
const { Buffer } = require('buffer');
@@ -773,7 +776,9 @@ function fromWritable(writable, options = kNullPrototype) {
}
function queueWrite(chunks, signal) {
- const { promise, resolve, reject } = PromiseWithResolvers();
+ const promise = newPendingPromise();
+ const resolve = takeResolve();
+ const reject = takeReject();
const entry = new QueuedWrite(chunks, resolve, reject);
pendingWrites.push(entry);
installDrainListener();
@@ -1049,7 +1054,9 @@ function fromWritable(writable, options = kNullPrototype) {
if (pendingWrites.length === 0 && !isFull()) {
return PromiseResolve(true);
}
- const { promise, resolve, reject } = PromiseWithResolvers();
+ const promise = newPendingPromise();
+ const resolve = takeResolve();
+ const reject = takeReject();
ArrayPrototypePush(drainWaiters, new PendingRequest(resolve, reject));
installDrainListener();
return promise;
diff --git a/lib/internal/streams/iter/from.js b/lib/internal/streams/iter/from.js
index 551a91158c5..22821627ac8 100644
--- a/lib/internal/streams/iter/from.js
+++ b/lib/internal/streams/iter/from.js
@@ -21,7 +21,6 @@ const {
PromisePrototypeThen,
PromiseReject,
PromiseResolve,
- PromiseWithResolvers,
Symbol,
SymbolAsyncIterator,
SymbolIterator,
@@ -60,6 +59,9 @@ const {
kActive,
kDone,
kResolvedPromise,
+ newPendingPromise,
+ takeReject,
+ takeResolve,
kStart,
createOperationQueue,
getProtocolMethod,
@@ -113,7 +115,9 @@ function throwIfNormalizationCancelled(context) {
*/
function waitForNormalization(value, context) {
if (context === undefined) return value;
- const { promise, resolve, reject } = PromiseWithResolvers();
+ const promise = newPendingPromise();
+ const resolve = takeResolve();
+ const reject = takeReject();
const onCancel = () => {
if (context.resolve === onCancel) context.resolve = null;
reject(context.reason);
@@ -544,7 +548,9 @@ function yieldNormalizationAbortable(source, context) {
if (context.cancelled) return PromiseReject(context.reason);
reading = true;
- const { promise, resolve, reject } = PromiseWithResolvers();
+ const promise = newPendingPromise();
+ const resolve = takeResolve();
+ const reject = takeReject();
let next;
try {
next = FunctionPrototypeCall(nextMethod, iterator);
@@ -955,9 +961,9 @@ function createAsyncSourceNormalizer(source, context) {
if (readable) {
// One promise for the read, which a cancellation rejects, instead of
// next()'s promise and a reaction to it.
- const { promise, resolve, reject } = PromiseWithResolvers();
- resolveRead = resolve;
- rejectRead = reject;
+ const promise = newPendingPromise();
+ resolveRead = takeResolve();
+ rejectRead = takeReject();
iterator[kRead]();
return promise;
}
diff --git a/lib/internal/streams/iter/pull.js b/lib/internal/streams/iter/pull.js
index 2cc643eafb2..12a6b659b9e 100644
--- a/lib/internal/streams/iter/pull.js
+++ b/lib/internal/streams/iter/pull.js
@@ -17,7 +17,6 @@ const {
PromisePrototypeThen,
PromiseReject,
PromiseResolve,
- PromiseWithResolvers,
Symbol,
SymbolAsyncIterator,
SymbolIterator,
@@ -60,6 +59,9 @@ const {
kDone,
kNullOnceOption,
kResolvedPromise,
+ newPendingPromise,
+ takeReject,
+ takeResolve,
kStart,
callWithByteView,
checkFixedBatchChunk,
@@ -1575,9 +1577,9 @@ function createAsyncPipeline(source, transforms, signal,
}
// The pull is pending from now on: the signal can abort while the
// transforms or the source are called.
- const { promise, resolve, reject } = PromiseWithResolvers();
- resolvePull = resolve;
- rejectPull = reject;
+ const promise = newPendingPromise();
+ resolvePull = takeResolve();
+ rejectPull = takeReject();
let next;
try {
next = PromiseResolve(FunctionPrototypeCall(nextMethod, iterator));
diff --git a/lib/internal/streams/iter/push.js b/lib/internal/streams/iter/push.js
index a5174ad7e55..559f15206ab 100644
--- a/lib/internal/streams/iter/push.js
+++ b/lib/internal/streams/iter/push.js
@@ -44,6 +44,9 @@ const {
parsePullArgs,
validateBatchEntry,
validateBudget,
+ newPendingPromise,
+ takeReject,
+ takeResolve,
} = require('internal/streams/iter/utils');
const {
converters,
@@ -294,7 +297,9 @@ class PushQueue {
* @returns {Promise<void>}
*/
#createPendingWrite(batch, signal) {
- const { promise, resolve, reject } = PromiseWithResolvers();
+ const promise = newPendingPromise();
+ const resolve = takeResolve();
+ const reject = takeReject();
const entry = new PendingWrite(batch, resolve, reject);
this.#pendingWrites.push(entry);
@@ -429,7 +434,9 @@ class PushQueue {
* @returns {Promise<void>}
*/
waitForDrain() {
- const { promise, resolve, reject } = PromiseWithResolvers();
+ const promise = newPendingPromise();
+ const resolve = takeResolve();
+ const reject = takeReject();
ArrayPrototypePush(this.#pendingDrains, new PendingRequest(resolve, reject));
return promise;
}
@@ -467,7 +474,9 @@ class PushQueue {
throw this.#writerError;
}
- const { promise, resolve, reject } = PromiseWithResolvers();
+ const promise = newPendingPromise();
+ const resolve = takeResolve();
+ const reject = takeReject();
this.#pendingReads.push(new PendingRequest(resolve, reject));
return promise;
}
diff --git a/lib/internal/streams/iter/share.js b/lib/internal/streams/iter/share.js
index 57e0885b2ea..2c593fb04c7 100644
--- a/lib/internal/streams/iter/share.js
+++ b/lib/internal/streams/iter/share.js
@@ -12,7 +12,6 @@ const {
PromisePrototypeThen,
PromiseReject,
PromiseResolve,
- PromiseWithResolvers,
SafeSet,
Symbol,
SymbolAsyncIterator,
@@ -49,6 +48,8 @@ const {
splitBatchEntry,
validateBatchEntry,
validateBudget,
+ newResolveOnlyPromise,
+ takeResolve,
} = require('internal/streams/iter/utils');
const {
converters,
@@ -480,7 +481,8 @@ class ShareImpl {
'buffered bytes', `< ${this.#options.budget}`,
this.#bufferedBytes);
case 'unbounded': {
- const { promise, resolve } = PromiseWithResolvers();
+ const promise = newResolveOnlyPromise();
+ const resolve = takeResolve();
ArrayPrototypePush(this.#pullWaiters, resolve);
await promise;
break;
@@ -512,7 +514,8 @@ class ShareImpl {
!this.#cancelled &&
this.#sourceError === kNoShareError &&
!this.#sourceExhausted) {
- const { promise, resolve } = PromiseWithResolvers();
+ const promise = newResolveOnlyPromise();
+ const resolve = takeResolve();
ArrayPrototypePush(this.#pullWaiters, resolve);
await promise;
}
@@ -526,7 +529,8 @@ class ShareImpl {
if (this.#pulling) return this.#pullDone;
this.#pulling = true;
- const { promise, resolve } = PromiseWithResolvers();
+ const promise = newResolveOnlyPromise();
+ const resolve = takeResolve();
this.#pullDone = promise;
this.#resolvePull = resolve;
this.#pullDiscard = discard;
diff --git a/lib/internal/streams/iter/transform.js b/lib/internal/streams/iter/transform.js
index e7239278500..da4258dada0 100644
--- a/lib/internal/streams/iter/transform.js
+++ b/lib/internal/streams/iter/transform.js
@@ -18,7 +18,6 @@ const {
ObjectKeys,
PromisePrototypeThen,
PromiseResolve,
- PromiseWithResolvers,
StringPrototypeStartsWith,
SymbolAsyncIterator,
TypedArrayPrototypeFill,
@@ -39,7 +38,12 @@ const {
} = require('internal/errors');
const { isArrayBufferView, isAnyArrayBuffer } = require('internal/util/types');
const { kValidatedTransform } = require('internal/streams/iter/types');
-const { kNullOnceOption } = require('internal/streams/iter/utils');
+const {
+ kNullOnceOption,
+ newPendingPromise,
+ takeReject,
+ takeResolve,
+} = require('internal/streams/iter/utils');
const {
checkRangesOrGetDefault,
kValidateObjectAllowArray,
@@ -416,7 +420,9 @@ function makeZlibTransform(createHandleFn, processFlag, finishFlag) {
signal.addEventListener('abort', onAbort, kNullOnceOption);
function continueInputAsync() {
- const { promise, resolve, reject } = PromiseWithResolvers();
+ const promise = newPendingPromise();
+ const resolve = takeResolve();
+ const reject = takeReject();
resolveWrite = resolve;
rejectWrite = reject;
writeAvailOutBefore = chunkSize - outOffset;
diff --git a/lib/internal/streams/iter/utils.js b/lib/internal/streams/iter/utils.js
index 0191a4dc83d..daa8f150a70 100644
--- a/lib/internal/streams/iter/utils.js
+++ b/lib/internal/streams/iter/utils.js
@@ -8,6 +8,7 @@ const {
ObjectDefineProperty,
ObjectFreeze,
ObjectSetPrototypeOf,
+ Promise,
PromisePrototypeThen,
PromiseReject,
PromiseResolve,
@@ -62,6 +63,47 @@ const kNullOnceOption = ObjectFreeze({ __proto__: null, once: true });
// Cached resolved promise to avoid allocating a new one on every sync fast-path.
const kResolvedPromise = PromiseResolve();
+// A pending promise and its resolving functions, for paths that create one
+// per read or per batch. PromiseWithResolvers() also allocates an object to
+// return the three in (about 85 of its 300 bytes without pointer
+// compression). The executor runs synchronously, so the functions are taken
+// from these slots right after the promise is created:
+// const promise = newPendingPromise();
+// const resolve = takeResolve();
+// const reject = takeReject();
+let capturedResolve;
+let capturedReject;
+function captureResolvers(resolve, reject) {
+ capturedResolve = resolve;
+ capturedReject = reject;
+}
+
+function newPendingPromise() {
+ return new Promise(captureResolvers);
+}
+
+function takeResolve() {
+ const resolve = capturedResolve;
+ capturedResolve = undefined;
+ return resolve;
+}
+
+function takeReject() {
+ const reject = capturedReject;
+ capturedReject = undefined;
+ return reject;
+}
+
+// The same, for a promise that is only ever resolved: only takeResolve()
+// follows it.
+function captureResolve(resolve) {
+ capturedResolve = resolve;
+}
+
+function newResolveOnlyPromise() {
+ return new Promise(captureResolve);
+}
+
// Shared TextEncoder instance for string conversion.
const encoder = new TextEncoder();
@@ -408,7 +450,9 @@ function createAbortableIterator(source, signal) {
signal.addEventListener('abort', onAbort,
{ __proto__: null, [kWeakHandler]: self });
}
- const { promise, resolve, reject } = PromiseWithResolvers();
+ const promise = newPendingPromise();
+ const resolve = takeResolve();
+ const reject = takeReject();
let next;
try {
signal.throwIfAborted();
@@ -625,7 +669,9 @@ function createOperationQueue() {
// once its result is known, now or after the operations before it.
run(method, arg) {
if (busy || (queue !== null && queue.length !== 0)) {
- const { promise, resolve, reject } = PromiseWithResolvers();
+ const promise = newPendingPromise();
+ const resolve = takeResolve();
+ const reject = takeReject();
queue ??= new RingBuffer();
queue.push(new QueuedOperation(method, arg, resolve, reject));
return promise;
@@ -992,6 +1038,10 @@ module.exports = {
kNullOnceOption,
kPushDefaultBudget,
kResolvedPromise,
+ newPendingPromise,
+ newResolveOnlyPromise,
+ takeReject,
+ takeResolve,
callWithByteView,
concatBytes,
createOperationQueue,