stream: propagate AbortSignal reason

marvinroger · marco-ippolito · commit ac583d45497d · 2025-01-24T22:17:37.000+01:00
PR-URL: #55473 Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Robert Nagy <ronagy@icloud.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: LiviaMedeiros <livia@cirno.name> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Jake Yuesong Li <jake.yuesong@gmail.com>
diff --git a/lib/internal/streams/pipeline.js b/lib/internal/streams/pipeline.js
@@ -204,7 +204,7 @@ function pipelineImpl(streams, callback, opts) {
   validateAbortSignal(outerSignal, 'options.signal');
 
   function abort() {
-    finishImpl(new AbortError());
+    finishImpl(new AbortError(undefined, { cause: outerSignal?.reason }));
   }
 
   addAbortListener ??= require('internal/events/abort_listener').addAbortListener;
diff --git a/test/parallel/test-stream-pipeline.js b/test/parallel/test-stream-pipeline.js
@@ -1331,12 +1331,13 @@ const tsp = require('timers/promises');
 
 {
   const ac = new AbortController();
+  const reason = new Error('Reason');
   const r = Readable.from(async function* () {
     for (let i = 0; i < 10; i++) {
       await Promise.resolve();
       yield String(i);
       if (i === 5) {
-        ac.abort();
+        ac.abort(reason);
       }
     }
   }());
@@ -1349,6 +1350,7 @@ const tsp = require('timers/promises');
   });
   const cb = common.mustCall((err) => {
     assert.strictEqual(err.name, 'AbortError');
+    assert.strictEqual(err.cause, reason);
     assert.strictEqual(res, '012345');
     assert.strictEqual(w.destroyed, true);
     assert.strictEqual(r.destroyed, true);

Original file line number	Diff line number	Diff line change
`@@ -204,7 +204,7 @@ function pipelineImpl(streams, callback, opts) {`
`204`	`204`	`validateAbortSignal(outerSignal, 'options.signal');`
`205`	`205`
`206`	`206`	`function abort() {`
`207`		`- finishImpl(new AbortError());`
	`207`	`+ finishImpl(new AbortError(undefined, { cause: outerSignal?.reason }));`
`208`	`208`	`}`
`209`	`209`
`210`	`210`	`addAbortListener ??= require('internal/events/abort_listener').addAbortListener;`