jonschlinkert / write Goto Github PK

I've completely reimplemented mkdirp in vinyl-fs because it is fundamentally broken cross-platform. Just a heads up.

Ref https://github.com/gulpjs/vinyl-fs/blob/master/lib/file-operations.js#L269-L327

In the master branch, the code is using fs.writeFileSync("file.txt", {}, "BBB");, but the node docs says that the signature is fs.writeFileSync("file.txt", "BBB").

Am I missing something?

Using: node v5.7.0.

I think there is a race condition when 2 write() calls write to the same file at almost the same time, like the test case below:

const targetFile = path.join(os.tmpdir(), 'test.txt');

fs.rmSync(targetFile, {force: true});

const content1 = Buffer.alloc(100 * 1024 * 1024); // A will finish writing later than B
const content2 = Buffer.alloc(50 * 1024 * 1024);

crypto.randomFillSync(content1);
crypto.randomFillSync(content2);

process.on('uncaughtException', (e) =>
{
    console.error(e);
});

process.on('beforeExit', () =>
{
    fs.rmSync(targetFile, {force: true});
});

// A
write(targetFile, content1, {overwrite: true}, err =>
{
    if (err)
    {
        console.error(err);
    }
    else
    {
        const targetContent = fs.readFileSync(targetFile);
        assert.ok(targetContent.equals(content1), `The content of targetFile is not content1!`);
    }
});


// B
write(targetFile, content2, {overwrite: true}, err =>
{
    if (err)
    {
        console.error(err);
    }
    else
    {
        const targetContent = fs.readFileSync(targetFile);
        assert.ok(targetContent.equals(content2), `The content of targetFile is not content2!`);
    }
});

And the execution result is:

AssertionError [ERR_ASSERTION]: The content of targetFile is not content2!
...
AssertionError [ERR_ASSERTION]: The content of targetFile is not content1!
...

targetFile may become a corrupted file with content different from either content1 or content2.

I think the bug is caused by the use of stream:

Both A and B can create write streams and write to targetFile at the same time. I think write() should check whether a file is being written before writing to it.

Node fs has mkdir built in with recursive mode available as a promise method
https://nodejs.org/api/fs.html#fs_fspromises_mkdir_path_options

When I call the write function and give it a directory that doesn't exist, I get this error.

Error: ENOENT: no such file or directory, open '<project_dir>/<directory_that_doesn't_exist>/<file>'

node version: 8.17.0
write version: 2.0.0

Suggestion

Because node 8 does not support the recursive option (used here) you could use something like sindresorhus/make-dir which only uses the recursive option if the node version is >=10.12.0 (sindresorhus/make-dir/blob/master/index.js#L12).

error - ./node_modules/add-filename-increment/index.js:3:0
Module not found: Can't resolve 'fs'

Import trace for requested module:
./node_modules/write/index.js

I get this error when I try to use write. npm says the fs plugin has been removed.

Hello!

I've found this issue when tried to use the increment option. In the empty folder I expect the following code to create foo.txt file:

write.sync('foo.txt', 'some data', { increment: true });

But instead it creates foo (2).txt on Windows platform. I dug into the sources and found the fs option in add-filename-increment library. The following code will work correctly:

write.sync('foo.txt', 'some data', {
  increment: true,
  fs: true
});

Uncaught TypeError: xfs.mkdir is not a function index.js?0191:27

I'm using it as per the docs

      writeFile('Report.csv', csv, function(err) {
        if (err) throw err;
      });

csv is a valid object using the json2csv module

Not sure what I'm missing here.
Could be related to #3 ?

I am running Node 12.14.1 and when trying to build my typescript project, your module throw the following errors:

"Namespace '"fs"' has no exported member 'WriteFileOptions'."
"Namespace '"fs"' has no exported member 'MakeDirectoryOptions'."