stream: propagate AbortSignal reason

marvinroger · aduh95 · commit 676427312708 · 2024-10-23T22:54:21.000+02: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
@@ -203,7 +203,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
@@ -1344,12 +1344,13 @@ tmpdir.refresh();
 
 {
 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);
 }
 }
 }());
@@ -1362,6 +1363,7 @@ tmpdir.refresh();
 });
 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
`@@ -203,7 +203,7 @@ function pipelineImpl(streams, callback, opts) {`
`203`	`203`	`validateAbortSignal(outerSignal,'options.signal');`
`204`	`204`
`205`	`205`	`functionabort(){`
`206`		`-finishImpl(newAbortError());`
	`206`	`+finishImpl(newAbortError(undefined,{cause: outerSignal?.reason}));`
`207`	`207`	`}`
`208`	`208`
`209`	`209`	`addAbortListener??=require('internal/events/abort_listener').addAbortListener;`
-Original file line number
+Diff line change
+{
 constac=newAbortController();
 +constreason=newError('Reason');
 constr=Readable.from(asyncfunction*(){
 for(leti=0;i<10;i++){
 awaitPromise.resolve();
 yieldString(i);
 if(i===5){
 -ac.abort();
 +ac.abort(reason);
+}
+}
 }());
 });
 constcb=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);