fs: add flush option to appendFile() functions

This commit adds documentation and tests for the 'flush' option
of the fs.appendFile family of functions. Technically, support
was indirectly added in #50009, but this makes it more official.
Refs: #49886
Refs: #50009
PR-URL: #50095
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>

Author: cjihrig

doc/api/fs.md

@@ -180,6 +180,9 @@ longer be used.
 <!-- YAML
 added: v10.0.0
 changes:
+ - version: REPLACEME
+ pr-url: https://github.com/nodejs/node/pull/50095
+ description: The `flush` option is now supported.
  - version:
  - v15.14.0
  - v14.18.0
@@ -194,6 +197,8 @@ changes:
 *`data` {string|Buffer|TypedArray|DataView|AsyncIterable|Iterable|Stream}
 *`options` {Object|string}
 *`encoding` {string|null} **Default:**`'utf8'`
+*`flush` {boolean} If `true`, the underlying file descriptor is flushed
+ prior to closing it. **Default:**`false`.
 * Returns: {Promise} Fulfills with `undefined` upon success.
 
 Alias of [`filehandle.writeFile()`][].
@@ -878,6 +883,10 @@ the error raised if the file is not accessible.
 
 <!-- YAML
 added: v10.0.0
+changes:
+ - version: REPLACEME
+ pr-url: https://github.com/nodejs/node/pull/50095
+ description: The `flush` option is now supported.
 -->
 
 * `path` {string|Buffer|URL|FileHandle} filename or {FileHandle}
@@ -886,6 +895,8 @@ added: v10.0.0
  * `encoding` {string|null} **Default:** `'utf8'`
  * `mode` {integer} **Default:** `0o666`
  * `flag` {string} See [support of file system `flags`][]. **Default:** `'a'`.
+ * `flush` {boolean} If `true`, the underlying file descriptor is flushed
+ prior to closing it. **Default:** `false`.
 * Returns: {Promise} Fulfills with `undefined` upon success.
 
 Asynchronously append data to a file, creating the file if it does not yet
@@ -2028,6 +2039,9 @@ the user from reading or writing to it.
 <!-- YAML
 added: v0.6.7
 changes:
+ - version: REPLACEME
+ pr-url: https://github.com/nodejs/node/pull/50095
+ description: The `flush` option is now supported.
  - version: v18.0.0
  pr-url: https://github.com/nodejs/node/pull/41678
  description: Passing an invalid callback to the `callback` argument
@@ -2055,6 +2069,8 @@ changes:
  * `encoding` {string|null} **Default:** `'utf8'`
  * `mode` {integer} **Default:** `0o666`
  * `flag` {string} See [support of file system `flags`][]. **Default:** `'a'`.
+ * `flush` {boolean} If `true`, the underlying file descriptor is flushed
+ prior to closing it. **Default:** `false`.
 * `callback` {Function}
  * `err` {Error}
 
@@ -5112,6 +5128,9 @@ try {
 <!--YAML
 added: v0.6.7
 changes:
+- version:REPLACEME
+ pr-url: https://github.com/nodejs/node/pull/50095
+ description: The `flush` option is now supported.
 - version: v7.0.0
  pr-url: https://github.com/nodejs/node/pull/7831
  description: The passed `options` object will never be modified.
@@ -5126,6 +5145,8 @@ changes:
 *`encoding` {string|null} **Default:**`'utf8'`
 *`mode` {integer} **Default:**`0o666`
 *`flag` {string} See [support of file system `flags`][]. **Default:**`'a'`.
+*`flush` {boolean} If `true`, the underlying file descriptor is flushed
+ prior to closing it. **Default:**`false`.
 
 Synchronously append data to a file, creating the file if it does not yet
 exist. `data` can be a string or a {Buffer}.

test/parallel/test-fs-append-file-flush.js

@@ -0,0 +1,114 @@
+'use strict';
+constcommon=require('../common');
+consttmpdir=require('../common/tmpdir');
+constassert=require('node:assert');
+constfs=require('node:fs');
+constfsp=require('node:fs/promises');
+consttest=require('node:test');
+constdata='foo';
+letcnt=0;
+
+functionnextFile(){
+returntmpdir.resolve(`${cnt++}.out`);
+}
+
+tmpdir.refresh();
+
+test('synchronous version',async(t)=>{
+awaitt.test('validation',(t)=>{
+for(constvof['true','',0,1,[],{},Symbol()]){
+assert.throws(()=>{
+fs.appendFileSync(nextFile(),data,{flush: v});
+},{code: 'ERR_INVALID_ARG_TYPE'});
+}
+});
+
+awaitt.test('performs flush',(t)=>{
+constspy=t.mock.method(fs,'fsyncSync');
+constfile=nextFile();
+fs.appendFileSync(file,data,{flush: true});
+constcalls=spy.mock.calls;
+assert.strictEqual(calls.length,1);
+assert.strictEqual(calls[0].result,undefined);
+assert.strictEqual(calls[0].error,undefined);
+assert.strictEqual(calls[0].arguments.length,1);
+assert.strictEqual(typeofcalls[0].arguments[0],'number');
+assert.strictEqual(fs.readFileSync(file,'utf8'),data);
+});
+
+awaitt.test('does not perform flush',(t)=>{
+constspy=t.mock.method(fs,'fsyncSync');
+
+for(constvof[undefined,null,false]){
+constfile=nextFile();
+fs.appendFileSync(file,data,{flush: v});
+assert.strictEqual(fs.readFileSync(file,'utf8'),data);
+}
+
+assert.strictEqual(spy.mock.calls.length,0);
+});
+});
+
+test('callback version',async(t)=>{
+awaitt.test('validation',(t)=>{
+for(constvof['true','',0,1,[],{},Symbol()]){
+assert.throws(()=>{
+fs.appendFileSync(nextFile(),data,{flush: v});
+},{code: 'ERR_INVALID_ARG_TYPE'});
+}
+});
+
+awaitt.test('performs flush',(t,done)=>{
+constspy=t.mock.method(fs,'fsync');
+constfile=nextFile();
+fs.appendFile(file,data,{flush: true},common.mustSucceed(()=>{
+constcalls=spy.mock.calls;
+assert.strictEqual(calls.length,1);
+assert.strictEqual(calls[0].result,undefined);
+assert.strictEqual(calls[0].error,undefined);
+assert.strictEqual(calls[0].arguments.length,2);
+assert.strictEqual(typeofcalls[0].arguments[0],'number');
+assert.strictEqual(typeofcalls[0].arguments[1],'function');
+assert.strictEqual(fs.readFileSync(file,'utf8'),data);
+done();
+}));
+});
+
+awaitt.test('does not perform flush',(t,done)=>{
+constvalues=[undefined,null,false];
+constspy=t.mock.method(fs,'fsync');
+letcnt=0;
+
+for(constvofvalues){
+constfile=nextFile();
+
+fs.appendFile(file,data,{flush: v},common.mustSucceed(()=>{
+assert.strictEqual(fs.readFileSync(file,'utf8'),data);
+cnt++;
+
+if(cnt===values.length){
+assert.strictEqual(spy.mock.calls.length,0);
+done();
+}
+}));
+}
+});
+});
+
+test('promise based version',async(t)=>{
+awaitt.test('validation',async(t)=>{
+for(constvof['true','',0,1,[],{},Symbol()]){
+awaitassert.rejects(()=>{
+returnfsp.appendFile(nextFile(),data,{flush: v});
+},{code: 'ERR_INVALID_ARG_TYPE'});
+}
+});
+
+awaitt.test('success path',async(t)=>{
+for(constvof[undefined,null,false,true]){
+constfile=nextFile();
+awaitfsp.appendFile(file,data,{flush: v});
+assert.strictEqual(awaitfsp.readFile(file,'utf8'),data);
+}
+});
+});