path: fix win32 volume-relative paths #14440

TimothyGu · 2017-07-24T02:37:57Z

path.resolve() and path.join() are left alone in this commit due to
a lack of clear semantics.

Fixes: #14405

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
commit message follows commit guidelines

Affected core subsystem(s)

path

tniessen

Thanks for working on this!

tniessen · 2017-07-24T09:42:43Z

test/parallel/test-path-parse-format.js

+  ['C:\\path\\dir\\index.html', 'C:\\'],
+  ['C:\\another_path\\DIR\\1\\2\\33\\\\index', 'C:\\'],
+  ['another_path\\DIR with spaces\\1\\2\\33\\index', ''],
+  ['\\foo\\C:', '\\'],


I don't think this is a valid Windows path, is it?

path does not do validation, but it's not:

I don't mean we should validate it, I just don't think we should test against invalid paths.

I don't see any harm in having it here. In fact we should keep it just for compatibility until some future fix that needs to remove it.

tniessen · 2017-07-24T09:46:07Z

test/parallel/test-path-parse-format.js

+  ['C:abc', 'C:'],
+  ['C:\\', 'C:\\'],
+  ['C:\\abc', 'C:\\' ],
+  ['', ''],


Could you add tests for NTFS alterate streams? e.g. ['cd:foo', '']. Not just to test root, but also the other properties used in checkParseFormat.

tniessen · 2017-07-24T09:49:33Z

test/parallel/test-path.js

+assert.strictEqual(path.win32.basename('C:basename.ext'), 'basename.ext');
+assert.strictEqual(path.win32.basename('C:basename.ext\\'), 'basename.ext');
+assert.strictEqual(path.win32.basename('C:basename.ext\\\\'), 'basename.ext');
+assert.strictEqual(path.win32.basename('C:foo'), 'foo');


Again, a test for NTFS alternate streams would be nice: basename('cd:foo') === 'cd:foo'

refack · 2017-07-24T13:10:19Z

test/parallel/test-path-parse-format.js

+  ['C:\\path\\dir\\index.html', 'C:\\'],
+  ['C:\\another_path\\DIR\\1\\2\\33\\\\index', 'C:\\'],
+  ['another_path\\DIR with spaces\\1\\2\\33\\index', ''],
+  ['\\foo\\C:', '\\'],


path does not do validation, but it's not:

refack · 2017-07-24T13:14:30Z

test/parallel/test-path.js

@@ -406,6 +422,11 @@ assert.strictEqual(path.win32.normalize('a//b//.'), 'a\\b');
 assert.strictEqual(path.win32.normalize('//server/share/dir/file.ext'),
                   '\\\\server\\share\\dir\\file.ext');
 assert.strictEqual(path.win32.normalize('/a/b/c/../../../x/y/z'), '\\x\\y\\z');


Optional:

Could you parameterize this part like the others are:

[[a,b]].forEach(([tested, expected]) => ...

(not the scope of this PR but still would be nice)

I'd rather leave that to a dedicated PR, as there are many other tests that do not use this pattern in the file.

refack · 2017-07-24T13:17:12Z

test/parallel/test-path-parse-format.js

    const output = path.parse(element);
    assert.strictEqual(typeof output.root, 'string');
    assert.strictEqual(typeof output.dir, 'string');
    assert.strictEqual(typeof output.base, 'string');
    assert.strictEqual(typeof output.ext, 'string');
    assert.strictEqual(typeof output.name, 'string');
    assert.strictEqual(path.format(output), element);
+    assert.strictEqual(output.root, root);
+    assert.strictEqual(output.dir.indexOf(output.root), 0);


could you use startsWith, so it won't pop up when grepping for indexOf

I don't quite know the reason for grepping indexOf, but changed nevertheless.

refack · 2017-07-24T13:19:49Z

@TimothyGu could you run performance comparison, just for reference?
(minimal set could be with --filter parse path i.e. node benchmark/compare.js --old .\nodefwithout.exe --new Release\nodewith.exe --filter parse path > path.csv)

refack · 2017-07-24T13:20:57Z

P.S. thanks for doing this 👍! Playing with path is not exactly a fun time...

TimothyGu · 2017-07-25T14:30:27Z

@refack For good measure:

$ node benchmark/compare.js --old ./node-master --new ./node-14440 --runs 10 --filter parse-win32 path > path-win32.csv
$ Rscript benchmark/compare.R < path-win32.csv 
                                                                             improvement confidence      p.value
 path/parse-win32.js n=1000000 path=""                                           -1.44 %            1.527455e-01
 path/parse-win32.js n=1000000 path="\\\\foo"                                    29.10 %        *** 4.505598e-07
 path/parse-win32.js n=1000000 path="\\\\foo\\\\bar\\\\baz\\\\asdf\\\\.quux"      3.27 %        *** 7.782213e-11
 path/parse-win32.js n=1000000 path="C:\\\\"                                      0.36 %            2.234293e-01
 path/parse-win32.js n=1000000 path="C:\\\\foo"                                  33.79 %        *** 5.225296e-12
 path/parse-win32.js n=1000000 path="E:\\\\foo\\\\bar.baz"                        0.09 %            7.339049e-01
 path/parse-win32.js n=1000000 path="foo\\\\.bar.baz"                             1.26 %        *** 3.623360e-06
 path/parse-win32.js n=1000000 path="foo\\\\bar"                                 -0.14 %            6.443696e-01

refack

Thank you

TimothyGu · 2017-07-25T14:57:56Z

However:

                                                                                                improvement confidence      p.value
 path/extname-win32.js n=1000000 path=""                                                           -74.64 %        *** 1.674087e-26
 path/extname-win32.js n=1000000 path="\\\\"                                                        -4.91 %        *** 1.755024e-07
 path/extname-win32.js n=1000000 path="\\\\foo\\\\bar\\\\baz\\\\asdf\\\\quux.foobarbazasdfquux"     -7.25 %        *** 1.823382e-05
 path/extname-win32.js n=1000000 path="C:\\\\foo"                                                  -21.36 %        *** 5.547522e-18
 path/extname-win32.js n=1000000 path="D:\\\\foo\\\\bar\\\\baz\\\\asdf\\\\quux"                    -23.40 %        *** 3.036449e-06
 path/extname-win32.js n=1000000 path="foo\\\\.bar.baz"                                             -7.85 %        *** 1.491586e-14
 path/extname-win32.js n=1000000 path="foo\\\\bar\\\\...baz.quux"                                  -12.20 %        *** 4.673165e-05
 path/extname-win32.js n=1000000 path="foo\\\\bar\\\\..baz.quux"                                   -11.68 %        *** 1.828409e-13
 path/extname-win32.js n=1000000 path="index.html"                                                  -8.17 %        *** 1.836566e-09
 path/extname-win32.js n=1000000 path="index"                                                       -7.79 %          * 2.396233e-02

There isn't anything I can do to improve the worst case (path=""). On the other hand, two factors alleviate the drastic change:

The same piece of code is in basename() already.
V8 5.9 used in master is known to not handle charCodeAt() well, and Node.js canary which has V8 6.1 restores the original performance for that benchmark while making all other benchmarks faster as well.

refack · 2017-07-25T15:17:14Z

There isn't anything I can do to improve the worst case (path=""). On the other hand, two factors alleviate the drastic change:

Since this is a bug fix IMHO we can absorb the performance degradation for this case. Especially since the most common case doesn't take a bit hit (and the absolute numbers are probably tiny anyway):

 path/extname-win32.js n=1000000 path="index.html"              -8.17 %        *** 1.836566e-09

addaleax · 2017-07-26T18:21:50Z

@TimothyGu This would need to be rebased ;)

tniessen · 2017-07-26T22:54:02Z

@TimothyGu My bad, sorry, I landed f7f590c this morning. You can safely drop my changes to winPaths.

`path.resolve()` and `path.join()` are left alone in this commit due to the lack of clear semantics. Fixes: nodejs#14405

TimothyGu · 2017-07-28T03:24:47Z

@addaleax @tniessen Rebased. I compared and cherry-picked some changes in f7f590c not already in test-path.js, so this should benefit other path.* functions as well.

tniessen

LGTM, no opinion on performance. Thanks for fixing this :)

TimothyGu · 2017-07-30T11:27:49Z

Landed in 2791761.

`path.resolve()` and `path.join()` are left alone in this commit due to the lack of clear semantics. PR-URL: #14440 Fixes: #14405 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>

MylesBorins · 2017-08-11T23:12:36Z

This does not land cleanly in LTS. Please feel free to manually backport by following the guide. Please also feel free to replace do-not-land if it is being backported

TimothyGu · 2017-08-12T10:30:41Z

@MylesBorins Done: #14787

`path.resolve()` and `path.join()` are left alone in this commit due to the lack of clear semantics. Backport-PR-URL: #14787 PR-URL: #14440 Fixes: #14405 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>

This LTS release comes with 152 commits. This includes 75 which are test related, 25 which are doc related, 21 which are build / tool related and 3 commits which are updates to dependencies. Notable Changes: * build: - Codesigning is fixed on macOS (Evan Lucas) #14179 * deps: - Snapshots are turned back on!!! (Yang Guo) #14385 * path: - win32 volume-relative paths are working again! (Timothy Gu) #14440 * tools: - v6.x can now build with ICU 59 (Steven R. Loomis) #12078 PR-URL: #14852

This LTS release comes with 152 commits. This includes 75 which are test related, 25 which are doc related, 21 which are build / tool related and 3 commits which are updates to dependencies. Notable Changes: * build: - Codesigning is fixed on macOS (Evan Lucas) nodejs#14179 * deps: - Snapshots are turned back on!!! (Yang Guo) nodejs#14385 * path: - win32 volume-relative paths are working again! (Timothy Gu) nodejs#14440 * tools: - v6.x can now build with ICU 59 (Steven R. Loomis) nodejs#12078 PR-URL: nodejs#14852

`path.resolve()` and `path.join()` are left alone in this commit due to the lack of clear semantics. PR-URL: nodejs/node#14440 Fixes: nodejs/node#14405 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>

TimothyGu added path Issues and PRs related to the path subsystem. windows Issues and PRs related to the Windows platform. labels Jul 24, 2017

nodejs-github-bot added the path Issues and PRs related to the path subsystem. label Jul 24, 2017

TimothyGu mentioned this pull request Jul 24, 2017

path.join('C:') = 'C:.' only in windows node LTS version #14405

Closed

tniessen reviewed Jul 24, 2017

View reviewed changes

refack approved these changes Jul 24, 2017

View reviewed changes

TimothyGu force-pushed the path-win32 branch from 6425535 to faf0b67 Compare July 25, 2017 14:46

refack approved these changes Jul 25, 2017

View reviewed changes

path: fix win32 volume-relative paths

25ac3d2

`path.resolve()` and `path.join()` are left alone in this commit due to the lack of clear semantics. Fixes: nodejs#14405

TimothyGu force-pushed the path-win32 branch from faf0b67 to 25ac3d2 Compare July 28, 2017 03:21

tniessen approved these changes Jul 30, 2017

View reviewed changes

TimothyGu closed this Jul 30, 2017

TimothyGu deleted the path-win32 branch July 30, 2017 11:27

addaleax mentioned this pull request Aug 2, 2017

v8.3.0 proposal #14594

Merged

MylesBorins added the backport-requested-v6.x label Aug 11, 2017

This was referenced Aug 12, 2017

path: remove unnecessary string copies #14438

Closed

[v6.x backport] path.win32 related fixes and tests #14787

Closed

MylesBorins added backported-to-v6.x and removed backport-requested-v6.x labels Aug 14, 2017

MylesBorins mentioned this pull request Aug 16, 2017

v6.11.3-proposal #14852

Merged

TimothyGu mentioned this pull request Dec 2, 2017

path.relative on windows returns incorrect result #17413

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

path: fix win32 volume-relative paths #14440

path: fix win32 volume-relative paths #14440

TimothyGu commented Jul 24, 2017

tniessen left a comment

tniessen Jul 24, 2017

refack Jul 24, 2017

tniessen Jul 24, 2017

TimothyGu Jul 28, 2017

tniessen Jul 24, 2017

tniessen Jul 24, 2017

refack Jul 24, 2017

refack Jul 24, 2017

TimothyGu Jul 25, 2017

refack Jul 24, 2017

TimothyGu Jul 25, 2017

refack commented Jul 24, 2017

refack commented Jul 24, 2017

TimothyGu commented Jul 25, 2017

refack left a comment

TimothyGu commented Jul 25, 2017 •

edited

Loading

refack commented Jul 25, 2017

addaleax commented Jul 26, 2017

tniessen commented Jul 26, 2017 •

edited

Loading

TimothyGu commented Jul 28, 2017

tniessen left a comment •

edited

Loading

TimothyGu commented Jul 30, 2017

MylesBorins commented Aug 11, 2017

TimothyGu commented Aug 12, 2017

path: fix win32 volume-relative paths #14440

path: fix win32 volume-relative paths #14440

Conversation

TimothyGu commented Jul 24, 2017

Checklist

Affected core subsystem(s)

tniessen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Optional:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

refack commented Jul 24, 2017

refack commented Jul 24, 2017

TimothyGu commented Jul 25, 2017

refack left a comment

Choose a reason for hiding this comment

TimothyGu commented Jul 25, 2017 • edited Loading

refack commented Jul 25, 2017

addaleax commented Jul 26, 2017

tniessen commented Jul 26, 2017 • edited Loading

TimothyGu commented Jul 28, 2017

tniessen left a comment • edited Loading

Choose a reason for hiding this comment

TimothyGu commented Jul 30, 2017

MylesBorins commented Aug 11, 2017

TimothyGu commented Aug 12, 2017

TimothyGu commented Jul 25, 2017 •

edited

Loading

tniessen commented Jul 26, 2017 •

edited

Loading

tniessen left a comment •

edited

Loading