doc: list macOS as supporting filename argument

[chris--young]

macOS is not currently listed as a supported os for the fs.watch filename argument, but it does work. This commit updates the documentation to reflect that.

Fixes: #13108

Checklist

• make -j4 test (UNIX), or vcbuild test (Windows) passes
• documentation is changed or added
• commit message follows commit guidelines

Affected core subsystem(s)

docs, tests

[refack]

/cc @nodejs/platform-macos

[refack]

@chris--young thank you very much for the contribution 🥇

It would be extra beneficial if you tried to add some test cases that validate that the filename is indeed passed to the callback. That way we could run automated testing that validate the doc.
IMHO a good file to add the tests to is test/parallel/test-fs-watchfile.js, and you could use the helpers in our common test module to distunguish between the plafroms.

[gireeshpunathil]

AIX too please.

bash-4.3$ uname AIX
bash-4.3$ cat w.js

varfs=require('fs');fs.watch('myfile',(eventType,filename)=>{console.log(`event type is: ${eventType}`);if(filename){console.log(`filename provided: ${filename}`);}else{console.log('filename not provided');}});

bash-4.3$ node w.js &
[1] 1769476
bash-4.3$ echo hello > myfile
bash-4.3$ event type is: change
filename provided: myfile
event type is: change
filename provided: myfile

[gireeshpunathil]

Per my comment - will you please add AIX also into the list?

[aashil]

I would add Windows too. You can also add AIX according to @gireeshpunathil's suggestion.

[refack]

I just checked, it passes on windows.

[refack]

A few nits

[refack]

I just checked, it passes on windows.

[refack]

If you could use assert.ifErrorif (err) assert.fail(err); instead. It will rethrow the error so we know what went wrong.
assert(!err) will just say true != false

[refack]

For the test to pass on Windows you should remove the common.refreshTmpDir();. Don't worry about it, the test harness will take care of it.

[refack]

you can replace the whole callback with (err) => assert.ifError(err)
Ref: #13092 (comment)

[refack]

you should replace the whole callback with common.mustCall((err) => {if (err) assert.fail(err)})
Ref: #13115

[refack]

@chris--young thanks

[refack]

CI: https://ci.nodejs.org/job/node-test-commit/10021/

[chris--young]

Any idea what's up with that failed windows-fanned test? Seeing this in the logs...

node-test-binary-windows » 1,vs2015-x86,win2008r2 completed with result FAILURE

I don't have a Windows box to test on right now, should be able to setup a vm over the weekend if needed.

[refack]

Any idea what's up with that failed windows-fanned test?

Ignore, it's a infrastructure fail. Also the linux fan is backlogged.
You can consider it green 👍

[refack]

@chris--young if you're not aware of our landing procedure; now that your part is done, we keep the PR open for 48-72 hours so that anyone who might want to voice an opinion will have a chance.
Ref: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md#step-8-landing
If it all goes smoothly I'll land this on Monday.

Thanks again!

[chris--young]

sweet

[lpinca]

Nit: can you please replace this with assert.ifError()?

Edit: Just read @refack comments against assert.ifError(). It is actually widely used in our tests but what is used here is also ok so feel free to ignore this.

[refack]

Edit: Just read @refack comments against assert.ifError(). It is actually widely used in our tests but what is used here is also ok so feel free to ignore this.

Vote for a better ifError#12820 ✌️

[gireeshpunathil]

@chris--young - thanks! I am fine with the changes.

[aqrln]

Thanks for your contribution! Can you please change the message of the first commit to use doc:, not docs:? That can be fixed by whoever lands the commit as well, though.

[refack]

CI: https://ci.nodejs.org/job/node-test-commit/10067/
/cc @lpinca@aqrln, where your comments addressed?

[aqrln]

I'd prefer it to be either a one-liner or to have braces, but maybe it's just me, and it clearly does not violate the code style this way too, so you can ignore this comment :)

[cjihrig]

I really think we should use assert.ifError(err) in these cases.

[refack]

+1
Either one liner or braces.

[aqrln]

Ditto

[refack]

@chris--young we raised a code style nit, then this will land.

[chris--young]

@refack made those changes. It looks like a new test is failing now, possibly another infrastructure fail

Checking out Revision 21535c38a3f800117089872f890e9d1f336024e0 (refs/remotes/origin/_jenkins_local_branch)
> git config core.sparsecheckout # timeout=10
> git checkout -f 21535c38a3f800117089872f890e9d1f336024e0
FATAL: Could not checkout 21535c38a3f800117089872f890e9d1f336024e0
hudson.plugins.git.GitException: Command "git checkout -f 21535c38a3f800117089872f890e9d1f336024e0" returned status code 128:
stdout: stderr: fatal: reference is not a tree: 21535c38a3f800117089872f890e9d1f336024e0

[refack]

Ignore it fedora22 is obsolete anyway. I'm landing this.

[refack]

Landed in c470f04