fs: nullish coalescing to respect zero positional reads

mihilmy · richardlau · commit fc328f1ab07c · 2022-01-25T11:05:39.000-05:00
When the file read position is moved passing zero is not respected and `null` is used instead. PR fixes the issues by using nullish coalescing which will return the rhs only when the lhs is `null` or `undefined`; respecting the zero. Fixes: #40715 PR-URL: #40716 Fixes: #40699 Reviewed-By: Robert Nagy <ronagy@icloud.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Evan Lucas <evanlucas@me.com>
diff --git a/lib/internal/fs/promises.js b/lib/internal/fs/promises.js
@@ -399,7 +399,7 @@ async function read(handle, bufferOrOptions, offset, length, position) {
     }
     offset = bufferOrOptions.offset || 0;
     length = buffer.byteLength;
-    position = bufferOrOptions.position || null;
+    position = bufferOrOptions.position ?? null;
   }
 
   if (offset == null) {
diff --git a/test/parallel/test-fs-promises-file-handle-read.js b/test/parallel/test-fs-promises-file-handle-read.js
@@ -68,6 +68,24 @@ async function validateReadNoParams() {
 }
 
 let useConf = false;
+// Validates that the zero position is respected after the position has been
+// moved. The test iterates over the xyz chars twice making sure that the values
+// are read from the correct position.
+async function validateReadWithPositionZero() {
+  const opts = { useConf: true };
+  const filePath = fixtures.path('x.txt');
+  const fileHandle = await open(filePath, 'r');
+  const expectedSequence = ['x', 'y', 'z'];
+
+  for (let i = 0; i < expectedSequence.length * 2; i++) {
+    const len = 1;
+    const pos = i % 3;
+    const buf = Buffer.alloc(len);
+    const { bytesRead } = await read(fileHandle, buf, 0, len, pos, opts);
+    assert.strictEqual(bytesRead, len);
+    assert.strictEqual(buf.toString(), expectedSequence[pos]);
+  }
+}
 
 (async function() {
   for (const value of [false, true]) {
@@ -80,4 +98,5 @@ let useConf = false;
           .then(common.mustCall());
   }
   await validateReadNoParams();
+  await validateReadWithPositionZero();
 })().then(common.mustCall());

Original file line number	Diff line number	Diff line change
`@@ -399,7 +399,7 @@ async function read(handle, bufferOrOptions, offset, length, position) {`
`399`	`399`	`}`
`400`	`400`	`offset = bufferOrOptions.offset \|\| 0;`
`401`	`401`	`length = buffer.byteLength;`
`402`		`- position = bufferOrOptions.position \|\| null;`
	`402`	`+ position = bufferOrOptions.position ?? null;`
`403`	`403`	`}`
`404`	`404`
`405`	`405`	`if (offset == null) {`