fs: acknowledge signal option in filehandle.createReadStream()

PR-URL: #55148 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]>

Author: LiviaMedeiros

doc/api/fs.md

@@ -265,6 +265,7 @@ added: v16.11.0
  * `start`{integer}
  * `end`{integer} **Default:** `Infinity`
  * `highWaterMark`{integer} **Default:** `64*1024`
+ * `signal`{AbortSignal|undefined} **Default:** `undefined`
 * Returns:{fs.ReadStream}
 
 Unlike the 16 KiB default `highWaterMark` for a{stream.Readable}, the stream

test/parallel/test-fs-read-stream-file-handle.js

@@ -80,3 +80,75 @@ fs.promises.open(file, 'r').then((handle) =>{
 assert.strictEqual(output,input);
 }));
 }).then(common.mustCall());
+
+// AbortSignal option test
+fs.promises.open(file,'r').then((handle)=>{
+constcontroller=newAbortController();
+const{ signal }=controller;
+conststream=handle.createReadStream({ signal });
+
+stream.on('data',common.mustNotCall());
+stream.on('end',common.mustNotCall());
+
+stream.on('error',common.mustCall((err)=>{
+assert.strictEqual(err.name,'AbortError');
+}));
+
+stream.on('close',common.mustCall(()=>{
+handle.close();
+}));
+
+controller.abort();
+}).then(common.mustCall());
+
+// Already-aborted signal test
+fs.promises.open(file,'r').then((handle)=>{
+constsignal=AbortSignal.abort();
+conststream=handle.createReadStream({ signal });
+
+stream.on('data',common.mustNotCall());
+stream.on('end',common.mustNotCall());
+
+stream.on('error',common.mustCall((err)=>{
+assert.strictEqual(err.name,'AbortError');
+}));
+
+stream.on('close',common.mustCall(()=>{
+handle.close();
+}));
+}).then(common.mustCall());
+
+// Invalid signal type test
+fs.promises.open(file,'r').then((handle)=>{
+for(constsignalof[1,{},[],'',null,NaN,1n,()=>{},Symbol(),false,true]){
+assert.throws(()=>{
+handle.createReadStream({ signal });
+},{
+code: 'ERR_INVALID_ARG_TYPE',
+name: 'TypeError',
+});
+}
+returnhandle.close();
+}).then(common.mustCall());
+
+// Custom abort reason test
+fs.promises.open(file,'r').then((handle)=>{
+constcontroller=newAbortController();
+const{ signal }=controller;
+constreason=newError('some silly abort reason');
+conststream=handle.createReadStream({ signal });
+
+stream.on('data',common.mustNotCall());
+stream.on('end',common.mustNotCall());
+
+stream.on('error',common.mustCall((err)=>{
+assert.strictEqual(err.name,'AbortError');
+assert.strictEqual(err.cause,reason);
+}));
+
+stream.on('close',common.mustCall(()=>{
+handle.close();
+}));
+
+controller.abort(reason);
+}).then(common.mustCall());