fs: expose realpath(3) bindings #15776

bnoordhuis · 2017-10-05T11:53:35Z

Make the uv_fs_realpath() binding (which calls the libc realpath()
on UNIX and GetFinalPathNameByHandle() on Windows) available as the
fs.realpath.native() and fs.realpathSync.native() functions.

The binding was already available as process.binding('fs').realpath
but was not exposed or tested - and partly broken as a result.

Fixes: #8715
Refs: #7899
CI: https://ci.nodejs.org/job/node-test-pull-request/10411/

If we don't go down this, ah, path, we should just remove the method from src/node_file.cc.

edit: forgot to mention: no documentation just yet because that would be wasted effort if everyone hates this.

bnoordhuis · 2017-10-05T11:54:57Z

test/parallel/test-fs-realpath.js

-    cleanup();
-  }
-  setup();
+  common.refreshTmpDir();


It gets somewhat lost in the noise but this is a bug fix: the fs.rmdirSync() logic didn't work because a/ contains more than just a/b. It didn't result in actual failures because the test runner cleans it up afterwards.

trevnorris

Think this is worth documenting. With this addition I imagine that if there are other native fs functions people want they'll request something similar (though I'm not sure what those would be).

jasnell · 2017-10-12T14:24:17Z

I'm happy with this approach.

jasnell

Lgtm but needs docs

bnoordhuis · 2017-11-07T20:24:17Z

I wrought documentation, PTAL.

Rebase + new CI: https://ci.nodejs.org/job/node-test-pull-request/11282/

jasnell

LGTM with docs. Thanks @bnoordhuis

Make the `uv_fs_realpath()` binding (which calls the libc `realpath()` on UNIX and `GetFinalPathNameByHandle()` on Windows) available as the `fs.realpath.native()` and `fs.realpathSync.native()` functions. The binding was already available as `process.binding('fs').realpath` but was not exposed or tested - and partly broken as a result. Fixes: nodejs#8715 PR-URL: nodejs#15776 Refs: nodejs#7899 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Minwoo Jung <minwoo@nodesource.com> Reviewed-By: Trevor Norris <trev.norris@gmail.com>

bnoordhuis · 2017-11-09T10:46:29Z

Landed in 74023c0. The one CI failure was a known problematic test on AIX.

Make the `uv_fs_realpath()` binding (which calls the libc `realpath()` on UNIX and `GetFinalPathNameByHandle()` on Windows) available as the `fs.realpath.native()` and `fs.realpathSync.native()` functions. The binding was already available as `process.binding('fs').realpath` but was not exposed or tested - and partly broken as a result. Fixes: #8715 PR-URL: #15776 Refs: #7899 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Minwoo Jung <minwoo@nodesource.com> Reviewed-By: Trevor Norris <trev.norris@gmail.com>

Notable changes: * **crypto**: - Support building with both 1.1.0 and 1.0.2 (David Benjamin) #16130 * **fs**: - fs.realpathSync.native and fs.realpath.native are now exposed (Ben Noordhuis) #15776 * **process**: - expose process.ppid (cjihrig) #16839 PR-URL: #16992

domenic · 2017-11-15T05:32:25Z

Where are the docs? Ctrl+Fing https://nodejs.org/api/fs.html for "native" turns up nothing.

addaleax · 2017-11-15T18:57:37Z

@bnoordhuis ^^^

Mea culpa, somehow I managed to drop the documentation commit while merging the pull request. This should have been included in commit 74023c0 ("fs: expose realpath(3) bindings") from this month. PR-URL: nodejs#17059 Refs: nodejs#15776 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

bnoordhuis · 2017-11-16T15:32:46Z

Back-porters, this should land together with the documentation from #17059.

SimenB · 2017-12-06T19:12:54Z

Hiya, this completely breaks Jest with the following trace:

../src/node_file.cc:835:void node::RealPath(const v8::FunctionCallbackInfo<v8::Value>&): Assertion `(args.Length()) >= (2)' failed.
 1: node::Abort() [node]
 2: node::Assert(char const* const (*) [4]) [node]
 3: 0x5595756fed3d [node]
 4: v8::internal::FunctionCallbackArguments::Call(void (*)(v8::FunctionCallbackInfo<v8::Value> const&)) [node]
 5: 0x5595750292df [node]
 6: 0x55957502982f [node]
 7: 0x2e88c60842fd

Should I create a new issue?

Simple repro can be seen in issue jestjs/jest#5030, but also on jest's own code base.

SimenB · 2017-12-06T19:18:35Z

Completely minimal reproduction is: node -p "process.binding('fs').realpath(process.cwd())". Works on 9.1, aborts on 9.2. Adding 'utf8' as second parameter makes it work

cjihrig · 2017-12-06T19:22:08Z

Is Jest using process.binding() directly? If so, it really shouldn't be.

SimenB · 2017-12-06T19:24:53Z

It is indeed. PR on the way.

EDIT: jestjs/jest#5031

jasnell · 2017-12-06T19:27:04Z

Looks like jest also has graceful-fs in it's dependency tree.

graceful-fs is known to be problematic due to it's insistence on using process.binding()

SimenB · 2017-12-06T19:32:21Z

It only happens on the beta releases of jest, not on the version marked latest. Its usage was added recently to fix case sensitivity on Windows (jestjs/jest#4730). PR with "fix": jestjs/jest#5031.

Would be ideal to use the function added in this PR, but we still have to support older versions of node.

Mea culpa, somehow I managed to drop the documentation commit while merging the pull request. This should have been included in commit 74023c0 ("fs: expose realpath(3) bindings") from this month. PR-URL: #17059 Refs: #15776 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com>

gibfahn · 2018-01-15T22:40:54Z

Release team were -1 on landing on 6.x, but +1 on reconsidering for the next 8.x minor.

MylesBorins · 2018-08-02T14:27:27Z

Choosing not to land this on 8.x right now as it had earlier broken jest and could cause similar unexpected breakages. Someone should feel open to change labels / open a PR if they feel otherwise

MylesBorins · 2018-08-17T19:13:07Z

quick ping to ensure no one wants to see this backported

bnoordhuis added the semver-minor PRs that contain new features and should be released in the next minor version. label Oct 5, 2017

nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. fs Issues and PRs related to the fs subsystem / file system. labels Oct 5, 2017

bnoordhuis commented Oct 5, 2017

View reviewed changes

bnoordhuis mentioned this pull request Oct 5, 2017

Provide a way to call the native realpath function #8715

Closed

addaleax approved these changes Oct 5, 2017

View reviewed changes

cjihrig approved these changes Oct 5, 2017

View reviewed changes

JungMinu approved these changes Oct 5, 2017

View reviewed changes

bricss mentioned this pull request Oct 5, 2017

v8.7.0 proposal #15762

Merged

Fishrock123 approved these changes Oct 5, 2017

View reviewed changes

trevnorris approved these changes Oct 12, 2017

View reviewed changes

jasnell approved these changes Oct 12, 2017

View reviewed changes

peterdanis mentioned this pull request Oct 20, 2017

Add path case-insensitivity if onlyChanged option is active, fixes #4644 jestjs/jest#4730

Merged

SimenB mentioned this pull request Oct 22, 2017

Add process.binding facebook/flow#5160

Closed

bnoordhuis force-pushed the fix8715 branch from dabe117 to 20e7cb3 Compare November 7, 2017 20:22

jasnell approved these changes Nov 8, 2017

View reviewed changes

bnoordhuis force-pushed the fix8715 branch from 20e7cb3 to 74023c0 Compare November 9, 2017 10:45

bnoordhuis closed this Nov 9, 2017

bnoordhuis deleted the fix8715 branch November 9, 2017 10:45

bnoordhuis merged commit 74023c0 into nodejs:master Nov 9, 2017

evanlucas mentioned this pull request Nov 13, 2017

v9.2.0 proposal #16992

Merged

bnoordhuis mentioned this pull request Nov 15, 2017

doc: document fs.realpath.native() #17059

Merged

SimenB mentioned this pull request Dec 6, 2017

nodejs 9.2 failure jestjs/jest#5030

Closed

SimenB mentioned this pull request Dec 6, 2017

Use fs.realpathSync.native if available jestjs/jest#5031

Merged

gibfahn added dont-land-on-v6.x labels Jan 15, 2018

gibfahn added the baking-for-lts PRs that need to wait before landing in a LTS release. label Jan 15, 2018

MylesBorins added the dont-land-on-v8.x label Aug 2, 2018

MylesBorins removed baking-for-lts PRs that need to wait before landing in a LTS release. lts-watch-v8.x labels Aug 17, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fs: expose realpath(3) bindings #15776

fs: expose realpath(3) bindings #15776

bnoordhuis commented Oct 5, 2017 •

edited

bnoordhuis Oct 5, 2017

trevnorris left a comment

jasnell commented Oct 12, 2017

jasnell left a comment

bnoordhuis commented Nov 7, 2017

jasnell left a comment

bnoordhuis commented Nov 9, 2017

domenic commented Nov 15, 2017

addaleax commented Nov 15, 2017

bnoordhuis commented Nov 16, 2017

SimenB commented Dec 6, 2017

SimenB commented Dec 6, 2017 •

edited

cjihrig commented Dec 6, 2017

SimenB commented Dec 6, 2017 •

edited

jasnell commented Dec 6, 2017

SimenB commented Dec 6, 2017

gibfahn commented Jan 15, 2018

MylesBorins commented Aug 2, 2018

MylesBorins commented Aug 17, 2018

fs: expose realpath(3) bindings #15776

fs: expose realpath(3) bindings #15776

Conversation

bnoordhuis commented Oct 5, 2017 • edited

bnoordhuis Oct 5, 2017

Choose a reason for hiding this comment

trevnorris left a comment

Choose a reason for hiding this comment

jasnell commented Oct 12, 2017

jasnell left a comment

Choose a reason for hiding this comment

bnoordhuis commented Nov 7, 2017

jasnell left a comment

Choose a reason for hiding this comment

bnoordhuis commented Nov 9, 2017

domenic commented Nov 15, 2017

addaleax commented Nov 15, 2017

bnoordhuis commented Nov 16, 2017

SimenB commented Dec 6, 2017

SimenB commented Dec 6, 2017 • edited

cjihrig commented Dec 6, 2017

SimenB commented Dec 6, 2017 • edited

jasnell commented Dec 6, 2017

SimenB commented Dec 6, 2017

gibfahn commented Jan 15, 2018

MylesBorins commented Aug 2, 2018

MylesBorins commented Aug 17, 2018

bnoordhuis commented Oct 5, 2017 •

edited

SimenB commented Dec 6, 2017 •

edited

SimenB commented Dec 6, 2017 •

edited