doc: list macOS as supporting filename argument by chris--young · Pull Request #13111 · nodejs/node · GitHub

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

/cc @nodejs/platform-macos

@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.

AIX too please.

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

var fs = 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

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

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

I just checked, it passes on windows.

A few nits

I just checked, it passes on windows.

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

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.

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

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

@chris--young thanks

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

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.

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 👍

@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!

sweet

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.

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 ✌️

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

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.

Fixes: nodejs#13108

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

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 :)

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

+1
Either one liner or braces.

Ditto

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

Fixes: nodejs#13108

@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

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

also added regression tests PR-URL: nodejs#13111 Fixes: nodejs#13108 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>

Landed in c470f04

also added regression tests PR-URL: #13111 Fixes: #13108 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>

nodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels May 19, 2017

refack added the macos Issues and PRs related to the macOS platform / OSX. label May 19, 2017

chris--young force-pushed the watch-filename branch 3 times, most recently from 710747f to 364720e Compare May 19, 2017 06:33

gireeshpunathil requested changes May 19, 2017

View reviewed changes

aashil suggested changes May 19, 2017

View reviewed changes

refack reviewed May 19, 2017

View reviewed changes

refack approved these changes May 19, 2017

View reviewed changes

refack self-assigned this May 19, 2017

refack added aix Issues and PRs related to the AIX platform. windows Issues and PRs related to the Windows platform. labels May 19, 2017

lpinca reviewed May 20, 2017

View reviewed changes

gireeshpunathil approved these changes May 20, 2017

View reviewed changes

aqrln reviewed May 20, 2017

View reviewed changes

Chris Young added 2 commits May 21, 2017 15:13

doc: list macOS as supporting filename argument

5fee2e8

Fixes: nodejs#13108

test: check fs.watch filename on Linux and macOS

9bd4012

Fixes: nodejs#13108

chris--young force-pushed the watch-filename branch from a89bfd1 to 21535c3 Compare May 21, 2017 22:13

chris--young changed the title docs: list macOS as supporting filename argument doc: list macOS as supporting filename argument May 21, 2017

lpinca approved these changes May 22, 2017

View reviewed changes

jasnell approved these changes May 22, 2017

View reviewed changes

aqrln reviewed May 22, 2017

View reviewed changes

aqrln approved these changes May 22, 2017

View reviewed changes

aashil approved these changes May 22, 2017

View reviewed changes

test: fs.watch filename check for Windows & AIX

64884c2

Fixes: nodejs#13108

chris--young force-pushed the watch-filename branch from 21535c3 to 64884c2 Compare May 22, 2017 17:57

refack closed this May 22, 2017

refack mentioned this pull request May 26, 2017

test-fs-watchfile failure on OSX - intermittent ? #13248

Closed

jasnell mentioned this pull request May 28, 2017

8.0.0 Release Proposal #12220

Closed

This was referenced Jun 2, 2017

test: make test-fs-watchfile reliable #13385

Closed

Intermittent failure in parallel/test-fs-watchfile on AIX #13377

Closed

gibfahn mentioned this pull request Jun 15, 2017

Auditing for 6.11.1 nodejs/Release#230

Closed

3 tasks

MylesBorins added the dont-land-on-v6.x label Jul 17, 2017

refack removed their assignment Oct 20, 2018

doc: list macOS as supporting filename argument by chris--young · Pull Request #13111 · nodejs/node · GitHub

Uh oh!

Uh oh!

doc: list macOS as supporting filename argument - #13111

doc: list macOS as supporting filename argument#13111chris--young wants to merge 3 commits intonodejs:masternodejs/node:masterfrom chris--young:watch-filenamechris--young/node:watch-filenameCopy head branch name to clipboard

Conversation

chris--young commented May 19, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Affected core subsystem(s)

Uh oh!

refack commented May 19, 2017

Uh oh!

refack commented May 19, 2017

Uh oh!

gireeshpunathil commented May 19, 2017

Uh oh!

gireeshpunathil left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

refack left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

refack May 19, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

refack May 19, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

refack commented May 19, 2017

Uh oh!

refack commented May 19, 2017

Uh oh!

chris--young commented May 19, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

refack commented May 19, 2017

Uh oh!

refack commented May 19, 2017

Uh oh!

chris--young commented May 19, 2017

Uh oh!

lpinca May 20, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gireeshpunathil left a comment

Choose a reason for hiding this comment

Uh oh!

aqrln left a comment

Choose a reason for hiding this comment

Uh oh!

refack commented May 22, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

refack commented May 22, 2017

Uh oh!

chris--young commented May 22, 2017

Uh oh!

doc: list macOS as supporting filename argument#13111
chris--young wants to merge 3 commits into
nodejs:masterfrom
chris--young:watch-filename

chris--young commented May 19, 2017 •
edited
Loading

refack May 19, 2017 •
edited
Loading

refack May 19, 2017 •
edited
Loading

chris--young commented May 19, 2017 •
edited
Loading

lpinca May 20, 2017 •
edited
Loading