Commit 87ee7bf

Browse files
unstubbableaduh95
authored andcommitted
test: cover realpathSync resolving symlinks after a FIFO stat
While walking a path, `realpathSync` skips the components it already knows are real, and in that branch it reads the shared stat buffer to decide whether the walk has reached a pipe or a socket. That buffer holds the result of the last stat made anywhere in the process rather than the last one made by the walk, so an unrelated stat of a FIFO ends the walk early and the path comes back with its symlinks unresolved. The unresolved path is then written to the cache, so every later resolution repeats it. The walk only takes that branch once the ancestors are established as real, which is the state the module loader's cache is in. The test goes through `require()` to reach it, where the stale read costs a second copy of a module reached through a symlink. Signed-off-by: Hendrik Liebau <mail@hendrik-liebau.de> PR-URL: #65113 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 72c37b1 commit 87ee7bf

3 files changed

Lines changed: 153 additions & 7 deletions

File tree

β€Žlib/fs.jsβ€Ž

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,6 @@ const {
8181

8282
const{
8383
FSReqCallback,
84-
statValues,
8584
}=binding;
8685
const{ toPathIfFileURL }=require('internal/url');
8786
const{
@@ -3254,6 +3253,11 @@ function realpathSync(p, options) {
32543253
constseenLinks=newSafeMap();
32553254
constknownHard=newSafeSet();
32563255
constoriginal=p;
3256+
// Whether the symlink this walk resolved last pointed at a pipe or a
3257+
// socket, which is where the walk stops. It cannot be read back from the
3258+
// shared stat buffer, which holds the last stat made anywhere in the
3259+
// process rather than the last one made here.
3260+
letreachedPipeOrSocket=false;
32573261

32583262
// Current character position in p
32593263
letpos;
@@ -3297,8 +3301,7 @@ function realpathSync(p, options) {
32973301

32983302
// Continue if not a symlink, break if a pipe/socket
32993303
if(knownHard.has(base)||cache?.get(base)===base){
3300-
if(isFileType(statValues,S_IFIFO)||
3301-
isFileType(statValues,S_IFSOCK)){
3304+
if(reachedPipeOrSocket){
33023305
break;
33033306
}
33043307
continue;
@@ -3336,7 +3339,9 @@ function realpathSync(p, options) {
33363339
}
33373340
}
33383341
if(linkTarget===null){
3339-
binding.stat(base,false,undefined,true);
3342+
consttargetStats=binding.stat(base,false,undefined,true);
3343+
reachedPipeOrSocket=isFileType(targetStats,S_IFIFO)||
3344+
isFileType(targetStats,S_IFSOCK);
33403345
linkTarget=binding.readlink(base,undefined);
33413346
}
33423347
resolvedLink=pathModule.resolve(previous,linkTarget);
@@ -3418,6 +3423,11 @@ function realpath(p, options, callback) {
34183423

34193424
constseenLinks=newSafeMap();
34203425
constknownHard=newSafeSet();
3426+
// Whether the symlink this walk resolved last pointed at a pipe or a
3427+
// socket, which is where the walk stops. It cannot be read back from the
3428+
// shared stat buffer, which holds the last stat made anywhere in the
3429+
// process rather than the last one made here.
3430+
letreachedPipeOrSocket=false;
34213431

34223432
// Current character position in p
34233433
letpos;
@@ -3466,8 +3476,7 @@ function realpath(p, options, callback) {
34663476

34673477
// Continue if not a symlink, break if a pipe/socket
34683478
if(knownHard.has(base)){
3469-
if(isFileType(statValues,S_IFIFO)||
3470-
isFileType(statValues,S_IFSOCK)){
3479+
if(reachedPipeOrSocket){
34713480
returncallback(null,encodeRealpathResult(p,options));
34723481
}
34733482
returnprocess.nextTick(LOOP);
@@ -3497,9 +3506,11 @@ function realpath(p, options, callback) {
34973506
returngotTarget(null,seenLinks.get(id));
34983507
}
34993508
}
3500-
fs.stat(base,(err)=>{
3509+
fs.stat(base,(err,targetStats)=>{
35013510
if(err)returncallback(err);
35023511

3512+
reachedPipeOrSocket=targetStats.isFIFO()||targetStats.isSocket();
3513+
35033514
fs.readlink(base,(err,target)=>{
35043515
if(!isWindows)seenLinks.set(id,target);
35053516
gotTarget(err,target);
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
'use strict';
2+
3+
// The async realpath() reads the shared stat buffer the same way realpathSync()
4+
// did, to decide whether the walk has reached a pipe or a socket. The walk's
5+
// own fs.stat() does leave the right value there, but it is not read until
6+
// after fs.readlink() and a process.nextTick(), and any stat completing in that
7+
// window replaces it.
8+
//
9+
// Truncating the walk only costs something when a second symlink follows the
10+
// one being resolved, so the path used here has two.
11+
12+
constcommon=require('../common');
13+
14+
if(common.isWindows)
15+
common.skip('no mkfifo on Windows');
16+
17+
constassert=require('assert');
18+
constfs=require('fs');
19+
constpath=require('path');
20+
const{ execFileSync }=require('child_process');
21+
consttmpdir=require('../common/tmpdir');
22+
23+
tmpdir.refresh();
24+
25+
constreal=tmpdir.resolve('real');
26+
constpkg=tmpdir.resolve('pkg');
27+
constfifo=tmpdir.resolve('fifo');
28+
29+
fs.mkdirSync(real);
30+
fs.mkdirSync(pkg);
31+
fs.writeFileSync(path.join(real,'index.js'),'');
32+
fs.symlinkSync(path.join('..','real'),path.join(pkg,'sub'));
33+
fs.symlinkSync('pkg',tmpdir.resolve('link'));
34+
execFileSync('mkfifo',[fifo]);
35+
36+
constthroughLinks=tmpdir.resolve('link','sub','index.js');
37+
constexpected=path.join(real,'index.js');
38+
39+
// Keep stats of the FIFO completing for as long as the walk runs, so that one
40+
// of them lands in the buffer during the window.
41+
letsettled=false;
42+
(functionstatFifo(){
43+
if(settled)return;
44+
fs.stat(fifo,statFifo);
45+
})();
46+
47+
leterror;
48+
letresolvedPath;
49+
50+
fs.realpath(throughLinks,common.mustCall((err,resolved)=>{
51+
settled=true;
52+
error=err;
53+
resolvedPath=resolved;
54+
}));
55+
56+
// Asserted on exit rather than in the callback. An assertion that fails inside
57+
// this callback is lost: it does not reach an `uncaughtException` handler and
58+
// the process still exits 0, so the test would pass over the bug it covers.
59+
process.on('exit',()=>{
60+
assert.ifError(error);
61+
assert.strictEqual(resolvedPath,expected);
62+
});
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
// Flags: --expose-internals
2+
'use strict';
3+
4+
// Resolving a path must not depend on what was stat'ed before it.
5+
//
6+
// While walking a path, realpath skips the components it already knows are
7+
// real, and in that branch it consulted the shared stat buffer to decide
8+
// whether the walk had reached a pipe or a socket. That buffer holds the result
9+
// of the last stat made anywhere in the process, so an unrelated stat of a FIFO
10+
// made the walk stop early and hand back the path with its symlinks unresolved.
11+
// The unresolved path is then cached, so every later resolution repeats it.
12+
13+
constcommon=require('../common');
14+
15+
if(common.isWindows)
16+
common.skip('no mkfifo on Windows');
17+
18+
constassert=require('assert');
19+
constfs=require('fs');
20+
constpath=require('path');
21+
const{ execFileSync }=require('child_process');
22+
const{ realpathCacheKey }=require('internal/fs/utils');
23+
consttmpdir=require('../common/tmpdir');
24+
25+
tmpdir.refresh();
26+
27+
constpkg=tmpdir.resolve('pkg');
28+
constlink=tmpdir.resolve('pkg-link');
29+
constfifo=tmpdir.resolve('fifo');
30+
31+
fs.mkdirSync(pkg);
32+
fs.writeFileSync(path.join(pkg,'index.js'),'module.exports = {};\n');
33+
fs.writeFileSync(tmpdir.resolve('warm.js'),'module.exports = {};\n');
34+
fs.symlinkSync('pkg',link);
35+
execFileSync('mkfifo',[fifo]);
36+
37+
constthroughLink=path.join(link,'index.js');
38+
constthroughReal=path.join(pkg,'index.js');
39+
40+
// The walk only skips a component once something has established it as real. A
41+
// cache carrying the ancestors is that state, and it is the state the module
42+
// loader's own cache is in after it has resolved anything else under the
43+
// directory.
44+
functionancestorCache(){
45+
constcache=newMap();
46+
letdir='';
47+
for(constpartoftmpdir.path.split(path.sep).slice(1)){
48+
dir+=path.sep+part;
49+
cache.set(dir,dir);
50+
}
51+
returncache;
52+
}
53+
54+
fs.statSync(path.join(pkg,'index.js'));
55+
assert.strictEqual(
56+
fs.realpathSync(throughLink,{[realpathCacheKey]: ancestorCache()}),
57+
throughReal,
58+
);
59+
60+
fs.statSync(fifo);
61+
assert.strictEqual(
62+
fs.realpathSync(throughLink,{[realpathCacheKey]: ancestorCache()}),
63+
throughReal,
64+
);
65+
66+
// What the stale read costs through the module loader, whose cache puts the
67+
// walk in that same state: the symlink stays unresolved, so the file is loaded
68+
// a second time under a second name.
69+
require(tmpdir.resolve('warm.js'));
70+
fs.statSync(fifo);
71+
72+
assert.strictEqual(require.resolve(throughLink),throughReal);
73+
assert.strictEqual(require(throughLink),require(throughReal));

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Commit 87ee7bf

Browse files
unstubbableaduh95
authored andcommitted
test: cover realpathSync resolving symlinks after a FIFO stat
While walking a path, `realpathSync` skips the components it already knows are real, and in that branch it reads the shared stat buffer to decide whether the walk has reached a pipe or a socket. That buffer holds the result of the last stat made anywhere in the process rather than the last one made by the walk, so an unrelated stat of a FIFO ends the walk early and the path comes back with its symlinks unresolved. The unresolved path is then written to the cache, so every later resolution repeats it. The walk only takes that branch once the ancestors are established as real, which is the state the module loader's cache is in. The test goes through `require()` to reach it, where the stale read costs a second copy of a module reached through a symlink. Signed-off-by: Hendrik Liebau <mail@hendrik-liebau.de> PR-URL: #65113 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 72c37b1 commit 87ee7bf

3 files changed

Lines changed: 153 additions & 7 deletions

File tree

β€Žlib/fs.jsβ€Ž

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,6 @@ const {
8181

8282
const{
8383
FSReqCallback,
84-
statValues,
8584
}=binding;
8685
const{ toPathIfFileURL }=require('internal/url');
8786
const{
@@ -3254,6 +3253,11 @@ function realpathSync(p, options) {
32543253
constseenLinks=newSafeMap();
32553254
constknownHard=newSafeSet();
32563255
constoriginal=p;
3256+
// Whether the symlink this walk resolved last pointed at a pipe or a
3257+
// socket, which is where the walk stops. It cannot be read back from the
3258+
// shared stat buffer, which holds the last stat made anywhere in the
3259+
// process rather than the last one made here.
3260+
letreachedPipeOrSocket=false;
32573261

32583262
// Current character position in p
32593263
letpos;
@@ -3297,8 +3301,7 @@ function realpathSync(p, options) {
32973301

32983302
// Continue if not a symlink, break if a pipe/socket
32993303
if(knownHard.has(base)||cache?.get(base)===base){
3300-
if(isFileType(statValues,S_IFIFO)||
3301-
isFileType(statValues,S_IFSOCK)){
3304+
if(reachedPipeOrSocket){
33023305
break;
33033306
}
33043307
continue;
@@ -3336,7 +3339,9 @@ function realpathSync(p, options) {
33363339
}
33373340
}
33383341
if(linkTarget===null){
3339-
binding.stat(base,false,undefined,true);
3342+
consttargetStats=binding.stat(base,false,undefined,true);
3343+
reachedPipeOrSocket=isFileType(targetStats,S_IFIFO)||
3344+
isFileType(targetStats,S_IFSOCK);
33403345
linkTarget=binding.readlink(base,undefined);
33413346
}
33423347
resolvedLink=pathModule.resolve(previous,linkTarget);
@@ -3418,6 +3423,11 @@ function realpath(p, options, callback) {
34183423

34193424
constseenLinks=newSafeMap();
34203425
constknownHard=newSafeSet();
3426+
// Whether the symlink this walk resolved last pointed at a pipe or a
3427+
// socket, which is where the walk stops. It cannot be read back from the
3428+
// shared stat buffer, which holds the last stat made anywhere in the
3429+
// process rather than the last one made here.
3430+
letreachedPipeOrSocket=false;
34213431

34223432
// Current character position in p
34233433
letpos;
@@ -3466,8 +3476,7 @@ function realpath(p, options, callback) {
34663476

34673477
// Continue if not a symlink, break if a pipe/socket
34683478
if(knownHard.has(base)){
3469-
if(isFileType(statValues,S_IFIFO)||
3470-
isFileType(statValues,S_IFSOCK)){
3479+
if(reachedPipeOrSocket){
34713480
returncallback(null,encodeRealpathResult(p,options));
34723481
}
34733482
returnprocess.nextTick(LOOP);
@@ -3497,9 +3506,11 @@ function realpath(p, options, callback) {
34973506
returngotTarget(null,seenLinks.get(id));
34983507
}
34993508
}
3500-
fs.stat(base,(err)=>{
3509+
fs.stat(base,(err,targetStats)=>{
35013510
if(err)returncallback(err);
35023511

3512+
reachedPipeOrSocket=targetStats.isFIFO()||targetStats.isSocket();
3513+
35033514
fs.readlink(base,(err,target)=>{
35043515
if(!isWindows)seenLinks.set(id,target);
35053516
gotTarget(err,target);
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
'use strict';
2+
3+
// The async realpath() reads the shared stat buffer the same way realpathSync()
4+
// did, to decide whether the walk has reached a pipe or a socket. The walk's
5+
// own fs.stat() does leave the right value there, but it is not read until
6+
// after fs.readlink() and a process.nextTick(), and any stat completing in that
7+
// window replaces it.
8+
//
9+
// Truncating the walk only costs something when a second symlink follows the
10+
// one being resolved, so the path used here has two.
11+
12+
constcommon=require('../common');
13+
14+
if(common.isWindows)
15+
common.skip('no mkfifo on Windows');
16+
17+
constassert=require('assert');
18+
constfs=require('fs');
19+
constpath=require('path');
20+
const{ execFileSync }=require('child_process');
21+
consttmpdir=require('../common/tmpdir');
22+
23+
tmpdir.refresh();
24+
25+
constreal=tmpdir.resolve('real');
26+
constpkg=tmpdir.resolve('pkg');
27+
constfifo=tmpdir.resolve('fifo');
28+
29+
fs.mkdirSync(real);
30+
fs.mkdirSync(pkg);
31+
fs.writeFileSync(path.join(real,'index.js'),'');
32+
fs.symlinkSync(path.join('..','real'),path.join(pkg,'sub'));
33+
fs.symlinkSync('pkg',tmpdir.resolve('link'));
34+
execFileSync('mkfifo',[fifo]);
35+
36+
constthroughLinks=tmpdir.resolve('link','sub','index.js');
37+
constexpected=path.join(real,'index.js');
38+
39+
// Keep stats of the FIFO completing for as long as the walk runs, so that one
40+
// of them lands in the buffer during the window.
41+
letsettled=false;
42+
(functionstatFifo(){
43+
if(settled)return;
44+
fs.stat(fifo,statFifo);
45+
})();
46+
47+
leterror;
48+
letresolvedPath;
49+
50+
fs.realpath(throughLinks,common.mustCall((err,resolved)=>{
51+
settled=true;
52+
error=err;
53+
resolvedPath=resolved;
54+
}));
55+
56+
// Asserted on exit rather than in the callback. An assertion that fails inside
57+
// this callback is lost: it does not reach an `uncaughtException` handler and
58+
// the process still exits 0, so the test would pass over the bug it covers.
59+
process.on('exit',()=>{
60+
assert.ifError(error);
61+
assert.strictEqual(resolvedPath,expected);
62+
});
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
// Flags: --expose-internals
2+
'use strict';
3+
4+
// Resolving a path must not depend on what was stat'ed before it.
5+
//
6+
// While walking a path, realpath skips the components it already knows are
7+
// real, and in that branch it consulted the shared stat buffer to decide
8+
// whether the walk had reached a pipe or a socket. That buffer holds the result
9+
// of the last stat made anywhere in the process, so an unrelated stat of a FIFO
10+
// made the walk stop early and hand back the path with its symlinks unresolved.
11+
// The unresolved path is then cached, so every later resolution repeats it.
12+
13+
constcommon=require('../common');
14+
15+
if(common.isWindows)
16+
common.skip('no mkfifo on Windows');
17+
18+
constassert=require('assert');
19+
constfs=require('fs');
20+
constpath=require('path');
21+
const{ execFileSync }=require('child_process');
22+
const{ realpathCacheKey }=require('internal/fs/utils');
23+
consttmpdir=require('../common/tmpdir');
24+
25+
tmpdir.refresh();
26+
27+
constpkg=tmpdir.resolve('pkg');
28+
constlink=tmpdir.resolve('pkg-link');
29+
constfifo=tmpdir.resolve('fifo');
30+
31+
fs.mkdirSync(pkg);
32+
fs.writeFileSync(path.join(pkg,'index.js'),'module.exports = {};\n');
33+
fs.writeFileSync(tmpdir.resolve('warm.js'),'module.exports = {};\n');
34+
fs.symlinkSync('pkg',link);
35+
execFileSync('mkfifo',[fifo]);
36+
37+
constthroughLink=path.join(link,'index.js');
38+
constthroughReal=path.join(pkg,'index.js');
39+
40+
// The walk only skips a component once something has established it as real. A
41+
// cache carrying the ancestors is that state, and it is the state the module
42+
// loader's own cache is in after it has resolved anything else under the
43+
// directory.
44+
functionancestorCache(){
45+
constcache=newMap();
46+
letdir='';
47+
for(constpartoftmpdir.path.split(path.sep).slice(1)){
48+
dir+=path.sep+part;
49+
cache.set(dir,dir);
50+
}
51+
returncache;
52+
}
53+
54+
fs.statSync(path.join(pkg,'index.js'));
55+
assert.strictEqual(
56+
fs.realpathSync(throughLink,{[realpathCacheKey]: ancestorCache()}),
57+
throughReal,
58+
);
59+
60+
fs.statSync(fifo);
61+
assert.strictEqual(
62+
fs.realpathSync(throughLink,{[realpathCacheKey]: ancestorCache()}),
63+
throughReal,
64+
);
65+
66+
// What the stale read costs through the module loader, whose cache puts the
67+
// walk in that same state: the symlink stays unresolved, so the file is loaded
68+
// a second time under a second name.
69+
require(tmpdir.resolve('warm.js'));
70+
fs.statSync(fifo);
71+
72+
assert.strictEqual(require.resolve(throughLink),throughReal);
73+
assert.strictEqual(require(throughLink),require(throughReal));

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit 87ee7bf

Browse files
unstubbableaduh95
authored andcommitted
test: cover realpathSync resolving symlinks after a FIFO stat
While walking a path, `realpathSync` skips the components it already knows are real, and in that branch it reads the shared stat buffer to decide whether the walk has reached a pipe or a socket. That buffer holds the result of the last stat made anywhere in the process rather than the last one made by the walk, so an unrelated stat of a FIFO ends the walk early and the path comes back with its symlinks unresolved. The unresolved path is then written to the cache, so every later resolution repeats it. The walk only takes that branch once the ancestors are established as real, which is the state the module loader's cache is in. The test goes through `require()` to reach it, where the stale read costs a second copy of a module reached through a symlink. Signed-off-by: Hendrik Liebau <mail@hendrik-liebau.de> PR-URL: #65113 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 72c37b1 commit 87ee7bf

3 files changed

Lines changed: 153 additions & 7 deletions

File tree

β€Žlib/fs.jsβ€Ž

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,6 @@ const {
8181

8282
const{
8383
FSReqCallback,
84-
statValues,
8584
}=binding;
8685
const{ toPathIfFileURL }=require('internal/url');
8786
const{
@@ -3254,6 +3253,11 @@ function realpathSync(p, options) {
32543253
constseenLinks=newSafeMap();
32553254
constknownHard=newSafeSet();
32563255
constoriginal=p;
3256+
// Whether the symlink this walk resolved last pointed at a pipe or a
3257+
// socket, which is where the walk stops. It cannot be read back from the
3258+
// shared stat buffer, which holds the last stat made anywhere in the
3259+
// process rather than the last one made here.
3260+
letreachedPipeOrSocket=false;
32573261

32583262
// Current character position in p
32593263
letpos;
@@ -3297,8 +3301,7 @@ function realpathSync(p, options) {
32973301

32983302
// Continue if not a symlink, break if a pipe/socket
32993303
if(knownHard.has(base)||cache?.get(base)===base){
3300-
if(isFileType(statValues,S_IFIFO)||
3301-
isFileType(statValues,S_IFSOCK)){
3304+
if(reachedPipeOrSocket){
33023305
break;
33033306
}
33043307
continue;
@@ -3336,7 +3339,9 @@ function realpathSync(p, options) {
33363339
}
33373340
}
33383341
if(linkTarget===null){
3339-
binding.stat(base,false,undefined,true);
3342+
consttargetStats=binding.stat(base,false,undefined,true);
3343+
reachedPipeOrSocket=isFileType(targetStats,S_IFIFO)||
3344+
isFileType(targetStats,S_IFSOCK);
33403345
linkTarget=binding.readlink(base,undefined);
33413346
}
33423347
resolvedLink=pathModule.resolve(previous,linkTarget);
@@ -3418,6 +3423,11 @@ function realpath(p, options, callback) {
34183423

34193424
constseenLinks=newSafeMap();
34203425
constknownHard=newSafeSet();
3426+
// Whether the symlink this walk resolved last pointed at a pipe or a
3427+
// socket, which is where the walk stops. It cannot be read back from the
3428+
// shared stat buffer, which holds the last stat made anywhere in the
3429+
// process rather than the last one made here.
3430+
letreachedPipeOrSocket=false;
34213431

34223432
// Current character position in p
34233433
letpos;
@@ -3466,8 +3476,7 @@ function realpath(p, options, callback) {
34663476

34673477
// Continue if not a symlink, break if a pipe/socket
34683478
if(knownHard.has(base)){
3469-
if(isFileType(statValues,S_IFIFO)||
3470-
isFileType(statValues,S_IFSOCK)){
3479+
if(reachedPipeOrSocket){
34713480
returncallback(null,encodeRealpathResult(p,options));
34723481
}
34733482
returnprocess.nextTick(LOOP);
@@ -3497,9 +3506,11 @@ function realpath(p, options, callback) {
34973506
returngotTarget(null,seenLinks.get(id));
34983507
}
34993508
}
3500-
fs.stat(base,(err)=>{
3509+
fs.stat(base,(err,targetStats)=>{
35013510
if(err)returncallback(err);
35023511

3512+
reachedPipeOrSocket=targetStats.isFIFO()||targetStats.isSocket();
3513+
35033514
fs.readlink(base,(err,target)=>{
35043515
if(!isWindows)seenLinks.set(id,target);
35053516
gotTarget(err,target);
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
'use strict';
2+
3+
// The async realpath() reads the shared stat buffer the same way realpathSync()
4+
// did, to decide whether the walk has reached a pipe or a socket. The walk's
5+
// own fs.stat() does leave the right value there, but it is not read until
6+
// after fs.readlink() and a process.nextTick(), and any stat completing in that
7+
// window replaces it.
8+
//
9+
// Truncating the walk only costs something when a second symlink follows the
10+
// one being resolved, so the path used here has two.
11+
12+
constcommon=require('../common');
13+
14+
if(common.isWindows)
15+
common.skip('no mkfifo on Windows');
16+
17+
constassert=require('assert');
18+
constfs=require('fs');
19+
constpath=require('path');
20+
const{ execFileSync }=require('child_process');
21+
consttmpdir=require('../common/tmpdir');
22+
23+
tmpdir.refresh();
24+
25+
constreal=tmpdir.resolve('real');
26+
constpkg=tmpdir.resolve('pkg');
27+
constfifo=tmpdir.resolve('fifo');
28+
29+
fs.mkdirSync(real);
30+
fs.mkdirSync(pkg);
31+
fs.writeFileSync(path.join(real,'index.js'),'');
32+
fs.symlinkSync(path.join('..','real'),path.join(pkg,'sub'));
33+
fs.symlinkSync('pkg',tmpdir.resolve('link'));
34+
execFileSync('mkfifo',[fifo]);
35+
36+
constthroughLinks=tmpdir.resolve('link','sub','index.js');
37+
constexpected=path.join(real,'index.js');
38+
39+
// Keep stats of the FIFO completing for as long as the walk runs, so that one
40+
// of them lands in the buffer during the window.
41+
letsettled=false;
42+
(functionstatFifo(){
43+
if(settled)return;
44+
fs.stat(fifo,statFifo);
45+
})();
46+
47+
leterror;
48+
letresolvedPath;
49+
50+
fs.realpath(throughLinks,common.mustCall((err,resolved)=>{
51+
settled=true;
52+
error=err;
53+
resolvedPath=resolved;
54+
}));
55+
56+
// Asserted on exit rather than in the callback. An assertion that fails inside
57+
// this callback is lost: it does not reach an `uncaughtException` handler and
58+
// the process still exits 0, so the test would pass over the bug it covers.
59+
process.on('exit',()=>{
60+
assert.ifError(error);
61+
assert.strictEqual(resolvedPath,expected);
62+
});
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
// Flags: --expose-internals
2+
'use strict';
3+
4+
// Resolving a path must not depend on what was stat'ed before it.
5+
//
6+
// While walking a path, realpath skips the components it already knows are
7+
// real, and in that branch it consulted the shared stat buffer to decide
8+
// whether the walk had reached a pipe or a socket. That buffer holds the result
9+
// of the last stat made anywhere in the process, so an unrelated stat of a FIFO
10+
// made the walk stop early and hand back the path with its symlinks unresolved.
11+
// The unresolved path is then cached, so every later resolution repeats it.
12+
13+
constcommon=require('../common');
14+
15+
if(common.isWindows)
16+
common.skip('no mkfifo on Windows');
17+
18+
constassert=require('assert');
19+
constfs=require('fs');
20+
constpath=require('path');
21+
const{ execFileSync }=require('child_process');
22+
const{ realpathCacheKey }=require('internal/fs/utils');
23+
consttmpdir=require('../common/tmpdir');
24+
25+
tmpdir.refresh();
26+
27+
constpkg=tmpdir.resolve('pkg');
28+
constlink=tmpdir.resolve('pkg-link');
29+
constfifo=tmpdir.resolve('fifo');
30+
31+
fs.mkdirSync(pkg);
32+
fs.writeFileSync(path.join(pkg,'index.js'),'module.exports = {};\n');
33+
fs.writeFileSync(tmpdir.resolve('warm.js'),'module.exports = {};\n');
34+
fs.symlinkSync('pkg',link);
35+
execFileSync('mkfifo',[fifo]);
36+
37+
constthroughLink=path.join(link,'index.js');
38+
constthroughReal=path.join(pkg,'index.js');
39+
40+
// The walk only skips a component once something has established it as real. A
41+
// cache carrying the ancestors is that state, and it is the state the module
42+
// loader's own cache is in after it has resolved anything else under the
43+
// directory.
44+
functionancestorCache(){
45+
constcache=newMap();
46+
letdir='';
47+
for(constpartoftmpdir.path.split(path.sep).slice(1)){
48+
dir+=path.sep+part;
49+
cache.set(dir,dir);
50+
}
51+
returncache;
52+
}
53+
54+
fs.statSync(path.join(pkg,'index.js'));
55+
assert.strictEqual(
56+
fs.realpathSync(throughLink,{[realpathCacheKey]: ancestorCache()}),
57+
throughReal,
58+
);
59+
60+
fs.statSync(fifo);
61+
assert.strictEqual(
62+
fs.realpathSync(throughLink,{[realpathCacheKey]: ancestorCache()}),
63+
throughReal,
64+
);
65+
66+
// What the stale read costs through the module loader, whose cache puts the
67+
// walk in that same state: the symlink stays unresolved, so the file is loaded
68+
// a second time under a second name.
69+
require(tmpdir.resolve('warm.js'));
70+
fs.statSync(fifo);
71+
72+
assert.strictEqual(require.resolve(throughLink),throughReal);
73+
assert.strictEqual(require(throughLink),require(throughReal));

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit 87ee7bf

Browse files
unstubbableaduh95
authored andcommitted
test: cover realpathSync resolving symlinks after a FIFO stat
While walking a path, `realpathSync` skips the components it already knows are real, and in that branch it reads the shared stat buffer to decide whether the walk has reached a pipe or a socket. That buffer holds the result of the last stat made anywhere in the process rather than the last one made by the walk, so an unrelated stat of a FIFO ends the walk early and the path comes back with its symlinks unresolved. The unresolved path is then written to the cache, so every later resolution repeats it. The walk only takes that branch once the ancestors are established as real, which is the state the module loader's cache is in. The test goes through `require()` to reach it, where the stale read costs a second copy of a module reached through a symlink. Signed-off-by: Hendrik Liebau <mail@hendrik-liebau.de> PR-URL: #65113 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 72c37b1 commit 87ee7bf

3 files changed

Lines changed: 153 additions & 7 deletions

File tree

β€Žlib/fs.jsβ€Ž

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,6 @@ const {
8181

8282
const{
8383
FSReqCallback,
84-
statValues,
8584
}=binding;
8685
const{ toPathIfFileURL }=require('internal/url');
8786
const{
@@ -3254,6 +3253,11 @@ function realpathSync(p, options) {
32543253
constseenLinks=newSafeMap();
32553254
constknownHard=newSafeSet();
32563255
constoriginal=p;
3256+
// Whether the symlink this walk resolved last pointed at a pipe or a
3257+
// socket, which is where the walk stops. It cannot be read back from the
3258+
// shared stat buffer, which holds the last stat made anywhere in the
3259+
// process rather than the last one made here.
3260+
letreachedPipeOrSocket=false;
32573261

32583262
// Current character position in p
32593263
letpos;
@@ -3297,8 +3301,7 @@ function realpathSync(p, options) {
32973301

32983302
// Continue if not a symlink, break if a pipe/socket
32993303
if(knownHard.has(base)||cache?.get(base)===base){
3300-
if(isFileType(statValues,S_IFIFO)||
3301-
isFileType(statValues,S_IFSOCK)){
3304+
if(reachedPipeOrSocket){
33023305
break;
33033306
}
33043307
continue;
@@ -3336,7 +3339,9 @@ function realpathSync(p, options) {
33363339
}
33373340
}
33383341
if(linkTarget===null){
3339-
binding.stat(base,false,undefined,true);
3342+
consttargetStats=binding.stat(base,false,undefined,true);
3343+
reachedPipeOrSocket=isFileType(targetStats,S_IFIFO)||
3344+
isFileType(targetStats,S_IFSOCK);
33403345
linkTarget=binding.readlink(base,undefined);
33413346
}
33423347
resolvedLink=pathModule.resolve(previous,linkTarget);
@@ -3418,6 +3423,11 @@ function realpath(p, options, callback) {
34183423

34193424
constseenLinks=newSafeMap();
34203425
constknownHard=newSafeSet();
3426+
// Whether the symlink this walk resolved last pointed at a pipe or a
3427+
// socket, which is where the walk stops. It cannot be read back from the
3428+
// shared stat buffer, which holds the last stat made anywhere in the
3429+
// process rather than the last one made here.
3430+
letreachedPipeOrSocket=false;
34213431

34223432
// Current character position in p
34233433
letpos;
@@ -3466,8 +3476,7 @@ function realpath(p, options, callback) {
34663476

34673477
// Continue if not a symlink, break if a pipe/socket
34683478
if(knownHard.has(base)){
3469-
if(isFileType(statValues,S_IFIFO)||
3470-
isFileType(statValues,S_IFSOCK)){
3479+
if(reachedPipeOrSocket){
34713480
returncallback(null,encodeRealpathResult(p,options));
34723481
}
34733482
returnprocess.nextTick(LOOP);
@@ -3497,9 +3506,11 @@ function realpath(p, options, callback) {
34973506
returngotTarget(null,seenLinks.get(id));
34983507
}
34993508
}
3500-
fs.stat(base,(err)=>{
3509+
fs.stat(base,(err,targetStats)=>{
35013510
if(err)returncallback(err);
35023511

3512+
reachedPipeOrSocket=targetStats.isFIFO()||targetStats.isSocket();
3513+
35033514
fs.readlink(base,(err,target)=>{
35043515
if(!isWindows)seenLinks.set(id,target);
35053516
gotTarget(err,target);
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
'use strict';
2+
3+
// The async realpath() reads the shared stat buffer the same way realpathSync()
4+
// did, to decide whether the walk has reached a pipe or a socket. The walk's
5+
// own fs.stat() does leave the right value there, but it is not read until
6+
// after fs.readlink() and a process.nextTick(), and any stat completing in that
7+
// window replaces it.
8+
//
9+
// Truncating the walk only costs something when a second symlink follows the
10+
// one being resolved, so the path used here has two.
11+
12+
constcommon=require('../common');
13+
14+
if(common.isWindows)
15+
common.skip('no mkfifo on Windows');
16+
17+
constassert=require('assert');
18+
constfs=require('fs');
19+
constpath=require('path');
20+
const{ execFileSync }=require('child_process');
21+
consttmpdir=require('../common/tmpdir');
22+
23+
tmpdir.refresh();
24+
25+
constreal=tmpdir.resolve('real');
26+
constpkg=tmpdir.resolve('pkg');
27+
constfifo=tmpdir.resolve('fifo');
28+
29+
fs.mkdirSync(real);
30+
fs.mkdirSync(pkg);
31+
fs.writeFileSync(path.join(real,'index.js'),'');
32+
fs.symlinkSync(path.join('..','real'),path.join(pkg,'sub'));
33+
fs.symlinkSync('pkg',tmpdir.resolve('link'));
34+
execFileSync('mkfifo',[fifo]);
35+
36+
constthroughLinks=tmpdir.resolve('link','sub','index.js');
37+
constexpected=path.join(real,'index.js');
38+
39+
// Keep stats of the FIFO completing for as long as the walk runs, so that one
40+
// of them lands in the buffer during the window.
41+
letsettled=false;
42+
(functionstatFifo(){
43+
if(settled)return;
44+
fs.stat(fifo,statFifo);
45+
})();
46+
47+
leterror;
48+
letresolvedPath;
49+
50+
fs.realpath(throughLinks,common.mustCall((err,resolved)=>{
51+
settled=true;
52+
error=err;
53+
resolvedPath=resolved;
54+
}));
55+
56+
// Asserted on exit rather than in the callback. An assertion that fails inside
57+
// this callback is lost: it does not reach an `uncaughtException` handler and
58+
// the process still exits 0, so the test would pass over the bug it covers.
59+
process.on('exit',()=>{
60+
assert.ifError(error);
61+
assert.strictEqual(resolvedPath,expected);
62+
});
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
// Flags: --expose-internals
2+
'use strict';
3+
4+
// Resolving a path must not depend on what was stat'ed before it.
5+
//
6+
// While walking a path, realpath skips the components it already knows are
7+
// real, and in that branch it consulted the shared stat buffer to decide
8+
// whether the walk had reached a pipe or a socket. That buffer holds the result
9+
// of the last stat made anywhere in the process, so an unrelated stat of a FIFO
10+
// made the walk stop early and hand back the path with its symlinks unresolved.
11+
// The unresolved path is then cached, so every later resolution repeats it.
12+
13+
constcommon=require('../common');
14+
15+
if(common.isWindows)
16+
common.skip('no mkfifo on Windows');
17+
18+
constassert=require('assert');
19+
constfs=require('fs');
20+
constpath=require('path');
21+
const{ execFileSync }=require('child_process');
22+
const{ realpathCacheKey }=require('internal/fs/utils');
23+
consttmpdir=require('../common/tmpdir');
24+
25+
tmpdir.refresh();
26+
27+
constpkg=tmpdir.resolve('pkg');
28+
constlink=tmpdir.resolve('pkg-link');
29+
constfifo=tmpdir.resolve('fifo');
30+
31+
fs.mkdirSync(pkg);
32+
fs.writeFileSync(path.join(pkg,'index.js'),'module.exports = {};\n');
33+
fs.writeFileSync(tmpdir.resolve('warm.js'),'module.exports = {};\n');
34+
fs.symlinkSync('pkg',link);
35+
execFileSync('mkfifo',[fifo]);
36+
37+
constthroughLink=path.join(link,'index.js');
38+
constthroughReal=path.join(pkg,'index.js');
39+
40+
// The walk only skips a component once something has established it as real. A
41+
// cache carrying the ancestors is that state, and it is the state the module
42+
// loader's own cache is in after it has resolved anything else under the
43+
// directory.
44+
functionancestorCache(){
45+
constcache=newMap();
46+
letdir='';
47+
for(constpartoftmpdir.path.split(path.sep).slice(1)){
48+
dir+=path.sep+part;
49+
cache.set(dir,dir);
50+
}
51+
returncache;
52+
}
53+
54+
fs.statSync(path.join(pkg,'index.js'));
55+
assert.strictEqual(
56+
fs.realpathSync(throughLink,{[realpathCacheKey]: ancestorCache()}),
57+
throughReal,
58+
);
59+
60+
fs.statSync(fifo);
61+
assert.strictEqual(
62+
fs.realpathSync(throughLink,{[realpathCacheKey]: ancestorCache()}),
63+
throughReal,
64+
);
65+
66+
// What the stale read costs through the module loader, whose cache puts the
67+
// walk in that same state: the symlink stays unresolved, so the file is loaded
68+
// a second time under a second name.
69+
require(tmpdir.resolve('warm.js'));
70+
fs.statSync(fifo);
71+
72+
assert.strictEqual(require.resolve(throughLink),throughReal);
73+
assert.strictEqual(require(throughLink),require(throughReal));

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Commit 87ee7bf

Browse files
unstubbableaduh95
authored andcommitted
test: cover realpathSync resolving symlinks after a FIFO stat
While walking a path, `realpathSync` skips the components it already knows are real, and in that branch it reads the shared stat buffer to decide whether the walk has reached a pipe or a socket. That buffer holds the result of the last stat made anywhere in the process rather than the last one made by the walk, so an unrelated stat of a FIFO ends the walk early and the path comes back with its symlinks unresolved. The unresolved path is then written to the cache, so every later resolution repeats it. The walk only takes that branch once the ancestors are established as real, which is the state the module loader's cache is in. The test goes through `require()` to reach it, where the stale read costs a second copy of a module reached through a symlink. Signed-off-by: Hendrik Liebau <mail@hendrik-liebau.de> PR-URL: #65113 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 72c37b1 commit 87ee7bf

3 files changed

Lines changed: 153 additions & 7 deletions

File tree

β€Žlib/fs.jsβ€Ž

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,6 @@ const {
8181

8282
const{
8383
FSReqCallback,
84-
statValues,
8584
}=binding;
8685
const{ toPathIfFileURL }=require('internal/url');
8786
const{
@@ -3254,6 +3253,11 @@ function realpathSync(p, options) {
32543253
constseenLinks=newSafeMap();
32553254
constknownHard=newSafeSet();
32563255
constoriginal=p;
3256+
// Whether the symlink this walk resolved last pointed at a pipe or a
3257+
// socket, which is where the walk stops. It cannot be read back from the
3258+
// shared stat buffer, which holds the last stat made anywhere in the
3259+
// process rather than the last one made here.
3260+
letreachedPipeOrSocket=false;
32573261

32583262
// Current character position in p
32593263
letpos;
@@ -3297,8 +3301,7 @@ function realpathSync(p, options) {
32973301

32983302
// Continue if not a symlink, break if a pipe/socket
32993303
if(knownHard.has(base)||cache?.get(base)===base){
3300-
if(isFileType(statValues,S_IFIFO)||
3301-
isFileType(statValues,S_IFSOCK)){
3304+
if(reachedPipeOrSocket){
33023305
break;
33033306
}
33043307
continue;
@@ -3336,7 +3339,9 @@ function realpathSync(p, options) {
33363339
}
33373340
}
33383341
if(linkTarget===null){
3339-
binding.stat(base,false,undefined,true);
3342+
consttargetStats=binding.stat(base,false,undefined,true);
3343+
reachedPipeOrSocket=isFileType(targetStats,S_IFIFO)||
3344+
isFileType(targetStats,S_IFSOCK);
33403345
linkTarget=binding.readlink(base,undefined);
33413346
}
33423347
resolvedLink=pathModule.resolve(previous,linkTarget);
@@ -3418,6 +3423,11 @@ function realpath(p, options, callback) {
34183423

34193424
constseenLinks=newSafeMap();
34203425
constknownHard=newSafeSet();
3426+
// Whether the symlink this walk resolved last pointed at a pipe or a
3427+
// socket, which is where the walk stops. It cannot be read back from the
3428+
// shared stat buffer, which holds the last stat made anywhere in the
3429+
// process rather than the last one made here.
3430+
letreachedPipeOrSocket=false;
34213431

34223432
// Current character position in p
34233433
letpos;
@@ -3466,8 +3476,7 @@ function realpath(p, options, callback) {
34663476

34673477
// Continue if not a symlink, break if a pipe/socket
34683478
if(knownHard.has(base)){
3469-
if(isFileType(statValues,S_IFIFO)||
3470-
isFileType(statValues,S_IFSOCK)){
3479+
if(reachedPipeOrSocket){
34713480
returncallback(null,encodeRealpathResult(p,options));
34723481
}
34733482
returnprocess.nextTick(LOOP);
@@ -3497,9 +3506,11 @@ function realpath(p, options, callback) {
34973506
returngotTarget(null,seenLinks.get(id));
34983507
}
34993508
}
3500-
fs.stat(base,(err)=>{
3509+
fs.stat(base,(err,targetStats)=>{
35013510
if(err)returncallback(err);
35023511

3512+
reachedPipeOrSocket=targetStats.isFIFO()||targetStats.isSocket();
3513+
35033514
fs.readlink(base,(err,target)=>{
35043515
if(!isWindows)seenLinks.set(id,target);
35053516
gotTarget(err,target);
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
'use strict';
2+
3+
// The async realpath() reads the shared stat buffer the same way realpathSync()
4+
// did, to decide whether the walk has reached a pipe or a socket. The walk's
5+
// own fs.stat() does leave the right value there, but it is not read until
6+
// after fs.readlink() and a process.nextTick(), and any stat completing in that
7+
// window replaces it.
8+
//
9+
// Truncating the walk only costs something when a second symlink follows the
10+
// one being resolved, so the path used here has two.
11+
12+
constcommon=require('../common');
13+
14+
if(common.isWindows)
15+
common.skip('no mkfifo on Windows');
16+
17+
constassert=require('assert');
18+
constfs=require('fs');
19+
constpath=require('path');
20+
const{ execFileSync }=require('child_process');
21+
consttmpdir=require('../common/tmpdir');
22+
23+
tmpdir.refresh();
24+
25+
constreal=tmpdir.resolve('real');
26+
constpkg=tmpdir.resolve('pkg');
27+
constfifo=tmpdir.resolve('fifo');
28+
29+
fs.mkdirSync(real);
30+
fs.mkdirSync(pkg);
31+
fs.writeFileSync(path.join(real,'index.js'),'');
32+
fs.symlinkSync(path.join('..','real'),path.join(pkg,'sub'));
33+
fs.symlinkSync('pkg',tmpdir.resolve('link'));
34+
execFileSync('mkfifo',[fifo]);
35+
36+
constthroughLinks=tmpdir.resolve('link','sub','index.js');
37+
constexpected=path.join(real,'index.js');
38+
39+
// Keep stats of the FIFO completing for as long as the walk runs, so that one
40+
// of them lands in the buffer during the window.
41+
letsettled=false;
42+
(functionstatFifo(){
43+
if(settled)return;
44+
fs.stat(fifo,statFifo);
45+
})();
46+
47+
leterror;
48+
letresolvedPath;
49+
50+
fs.realpath(throughLinks,common.mustCall((err,resolved)=>{
51+
settled=true;
52+
error=err;
53+
resolvedPath=resolved;
54+
}));
55+
56+
// Asserted on exit rather than in the callback. An assertion that fails inside
57+
// this callback is lost: it does not reach an `uncaughtException` handler and
58+
// the process still exits 0, so the test would pass over the bug it covers.
59+
process.on('exit',()=>{
60+
assert.ifError(error);
61+
assert.strictEqual(resolvedPath,expected);
62+
});
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
// Flags: --expose-internals
2+
'use strict';
3+
4+
// Resolving a path must not depend on what was stat'ed before it.
5+
//
6+
// While walking a path, realpath skips the components it already knows are
7+
// real, and in that branch it consulted the shared stat buffer to decide
8+
// whether the walk had reached a pipe or a socket. That buffer holds the result
9+
// of the last stat made anywhere in the process, so an unrelated stat of a FIFO
10+
// made the walk stop early and hand back the path with its symlinks unresolved.
11+
// The unresolved path is then cached, so every later resolution repeats it.
12+
13+
constcommon=require('../common');
14+
15+
if(common.isWindows)
16+
common.skip('no mkfifo on Windows');
17+
18+
constassert=require('assert');
19+
constfs=require('fs');
20+
constpath=require('path');
21+
const{ execFileSync }=require('child_process');
22+
const{ realpathCacheKey }=require('internal/fs/utils');
23+
consttmpdir=require('../common/tmpdir');
24+
25+
tmpdir.refresh();
26+
27+
constpkg=tmpdir.resolve('pkg');
28+
constlink=tmpdir.resolve('pkg-link');
29+
constfifo=tmpdir.resolve('fifo');
30+
31+
fs.mkdirSync(pkg);
32+
fs.writeFileSync(path.join(pkg,'index.js'),'module.exports = {};\n');
33+
fs.writeFileSync(tmpdir.resolve('warm.js'),'module.exports = {};\n');
34+
fs.symlinkSync('pkg',link);
35+
execFileSync('mkfifo',[fifo]);
36+
37+
constthroughLink=path.join(link,'index.js');
38+
constthroughReal=path.join(pkg,'index.js');
39+
40+
// The walk only skips a component once something has established it as real. A
41+
// cache carrying the ancestors is that state, and it is the state the module
42+
// loader's own cache is in after it has resolved anything else under the
43+
// directory.
44+
functionancestorCache(){
45+
constcache=newMap();
46+
letdir='';
47+
for(constpartoftmpdir.path.split(path.sep).slice(1)){
48+
dir+=path.sep+part;
49+
cache.set(dir,dir);
50+
}
51+
returncache;
52+
}
53+
54+
fs.statSync(path.join(pkg,'index.js'));
55+
assert.strictEqual(
56+
fs.realpathSync(throughLink,{[realpathCacheKey]: ancestorCache()}),
57+
throughReal,
58+
);
59+
60+
fs.statSync(fifo);
61+
assert.strictEqual(
62+
fs.realpathSync(throughLink,{[realpathCacheKey]: ancestorCache()}),
63+
throughReal,
64+
);
65+
66+
// What the stale read costs through the module loader, whose cache puts the
67+
// walk in that same state: the symlink stays unresolved, so the file is loaded
68+
// a second time under a second name.
69+
require(tmpdir.resolve('warm.js'));
70+
fs.statSync(fifo);
71+
72+
assert.strictEqual(require.resolve(throughLink),throughReal);
73+
assert.strictEqual(require(throughLink),require(throughReal));

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit 87ee7bf

Browse files
unstubbableaduh95
authored andcommitted
test: cover realpathSync resolving symlinks after a FIFO stat
While walking a path, `realpathSync` skips the components it already knows are real, and in that branch it reads the shared stat buffer to decide whether the walk has reached a pipe or a socket. That buffer holds the result of the last stat made anywhere in the process rather than the last one made by the walk, so an unrelated stat of a FIFO ends the walk early and the path comes back with its symlinks unresolved. The unresolved path is then written to the cache, so every later resolution repeats it. The walk only takes that branch once the ancestors are established as real, which is the state the module loader's cache is in. The test goes through `require()` to reach it, where the stale read costs a second copy of a module reached through a symlink. Signed-off-by: Hendrik Liebau <mail@hendrik-liebau.de> PR-URL: #65113 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 72c37b1 commit 87ee7bf

3 files changed

Lines changed: 153 additions & 7 deletions

File tree

β€Žlib/fs.jsβ€Ž

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,6 @@ const {
8181

8282
const{
8383
FSReqCallback,
84-
statValues,
8584
}=binding;
8685
const{ toPathIfFileURL }=require('internal/url');
8786
const{
@@ -3254,6 +3253,11 @@ function realpathSync(p, options) {
32543253
constseenLinks=newSafeMap();
32553254
constknownHard=newSafeSet();
32563255
constoriginal=p;
3256+
// Whether the symlink this walk resolved last pointed at a pipe or a
3257+
// socket, which is where the walk stops. It cannot be read back from the
3258+
// shared stat buffer, which holds the last stat made anywhere in the
3259+
// process rather than the last one made here.
3260+
letreachedPipeOrSocket=false;
32573261

32583262
// Current character position in p
32593263
letpos;
@@ -3297,8 +3301,7 @@ function realpathSync(p, options) {
32973301

32983302
// Continue if not a symlink, break if a pipe/socket
32993303
if(knownHard.has(base)||cache?.get(base)===base){
3300-
if(isFileType(statValues,S_IFIFO)||
3301-
isFileType(statValues,S_IFSOCK)){
3304+
if(reachedPipeOrSocket){
33023305
break;
33033306
}
33043307
continue;
@@ -3336,7 +3339,9 @@ function realpathSync(p, options) {
33363339
}
33373340
}
33383341
if(linkTarget===null){
3339-
binding.stat(base,false,undefined,true);
3342+
consttargetStats=binding.stat(base,false,undefined,true);
3343+
reachedPipeOrSocket=isFileType(targetStats,S_IFIFO)||
3344+
isFileType(targetStats,S_IFSOCK);
33403345
linkTarget=binding.readlink(base,undefined);
33413346
}
33423347
resolvedLink=pathModule.resolve(previous,linkTarget);
@@ -3418,6 +3423,11 @@ function realpath(p, options, callback) {
34183423

34193424
constseenLinks=newSafeMap();
34203425
constknownHard=newSafeSet();
3426+
// Whether the symlink this walk resolved last pointed at a pipe or a
3427+
// socket, which is where the walk stops. It cannot be read back from the
3428+
// shared stat buffer, which holds the last stat made anywhere in the
3429+
// process rather than the last one made here.
3430+
letreachedPipeOrSocket=false;
34213431

34223432
// Current character position in p
34233433
letpos;
@@ -3466,8 +3476,7 @@ function realpath(p, options, callback) {
34663476

34673477
// Continue if not a symlink, break if a pipe/socket
34683478
if(knownHard.has(base)){
3469-
if(isFileType(statValues,S_IFIFO)||
3470-
isFileType(statValues,S_IFSOCK)){
3479+
if(reachedPipeOrSocket){
34713480
returncallback(null,encodeRealpathResult(p,options));
34723481
}
34733482
returnprocess.nextTick(LOOP);
@@ -3497,9 +3506,11 @@ function realpath(p, options, callback) {
34973506
returngotTarget(null,seenLinks.get(id));
34983507
}
34993508
}
3500-
fs.stat(base,(err)=>{
3509+
fs.stat(base,(err,targetStats)=>{
35013510
if(err)returncallback(err);
35023511

3512+
reachedPipeOrSocket=targetStats.isFIFO()||targetStats.isSocket();
3513+
35033514
fs.readlink(base,(err,target)=>{
35043515
if(!isWindows)seenLinks.set(id,target);
35053516
gotTarget(err,target);
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
'use strict';
2+
3+
// The async realpath() reads the shared stat buffer the same way realpathSync()
4+
// did, to decide whether the walk has reached a pipe or a socket. The walk's
5+
// own fs.stat() does leave the right value there, but it is not read until
6+
// after fs.readlink() and a process.nextTick(), and any stat completing in that
7+
// window replaces it.
8+
//
9+
// Truncating the walk only costs something when a second symlink follows the
10+
// one being resolved, so the path used here has two.
11+
12+
constcommon=require('../common');
13+
14+
if(common.isWindows)
15+
common.skip('no mkfifo on Windows');
16+
17+
constassert=require('assert');
18+
constfs=require('fs');
19+
constpath=require('path');
20+
const{ execFileSync }=require('child_process');
21+
consttmpdir=require('../common/tmpdir');
22+
23+
tmpdir.refresh();
24+
25+
constreal=tmpdir.resolve('real');
26+
constpkg=tmpdir.resolve('pkg');
27+
constfifo=tmpdir.resolve('fifo');
28+
29+
fs.mkdirSync(real);
30+
fs.mkdirSync(pkg);
31+
fs.writeFileSync(path.join(real,'index.js'),'');
32+
fs.symlinkSync(path.join('..','real'),path.join(pkg,'sub'));
33+
fs.symlinkSync('pkg',tmpdir.resolve('link'));
34+
execFileSync('mkfifo',[fifo]);
35+
36+
constthroughLinks=tmpdir.resolve('link','sub','index.js');
37+
constexpected=path.join(real,'index.js');
38+
39+
// Keep stats of the FIFO completing for as long as the walk runs, so that one
40+
// of them lands in the buffer during the window.
41+
letsettled=false;
42+
(functionstatFifo(){
43+
if(settled)return;
44+
fs.stat(fifo,statFifo);
45+
})();
46+
47+
leterror;
48+
letresolvedPath;
49+
50+
fs.realpath(throughLinks,common.mustCall((err,resolved)=>{
51+
settled=true;
52+
error=err;
53+
resolvedPath=resolved;
54+
}));
55+
56+
// Asserted on exit rather than in the callback. An assertion that fails inside
57+
// this callback is lost: it does not reach an `uncaughtException` handler and
58+
// the process still exits 0, so the test would pass over the bug it covers.
59+
process.on('exit',()=>{
60+
assert.ifError(error);
61+
assert.strictEqual(resolvedPath,expected);
62+
});
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
// Flags: --expose-internals
2+
'use strict';
3+
4+
// Resolving a path must not depend on what was stat'ed before it.
5+
//
6+
// While walking a path, realpath skips the components it already knows are
7+
// real, and in that branch it consulted the shared stat buffer to decide
8+
// whether the walk had reached a pipe or a socket. That buffer holds the result
9+
// of the last stat made anywhere in the process, so an unrelated stat of a FIFO
10+
// made the walk stop early and hand back the path with its symlinks unresolved.
11+
// The unresolved path is then cached, so every later resolution repeats it.
12+
13+
constcommon=require('../common');
14+
15+
if(common.isWindows)
16+
common.skip('no mkfifo on Windows');
17+
18+
constassert=require('assert');
19+
constfs=require('fs');
20+
constpath=require('path');
21+
const{ execFileSync }=require('child_process');
22+
const{ realpathCacheKey }=require('internal/fs/utils');
23+
consttmpdir=require('../common/tmpdir');
24+
25+
tmpdir.refresh();
26+
27+
constpkg=tmpdir.resolve('pkg');
28+
constlink=tmpdir.resolve('pkg-link');
29+
constfifo=tmpdir.resolve('fifo');
30+
31+
fs.mkdirSync(pkg);
32+
fs.writeFileSync(path.join(pkg,'index.js'),'module.exports = {};\n');
33+
fs.writeFileSync(tmpdir.resolve('warm.js'),'module.exports = {};\n');
34+
fs.symlinkSync('pkg',link);
35+
execFileSync('mkfifo',[fifo]);
36+
37+
constthroughLink=path.join(link,'index.js');
38+
constthroughReal=path.join(pkg,'index.js');
39+
40+
// The walk only skips a component once something has established it as real. A
41+
// cache carrying the ancestors is that state, and it is the state the module
42+
// loader's own cache is in after it has resolved anything else under the
43+
// directory.
44+
functionancestorCache(){
45+
constcache=newMap();
46+
letdir='';
47+
for(constpartoftmpdir.path.split(path.sep).slice(1)){
48+
dir+=path.sep+part;
49+
cache.set(dir,dir);
50+
}
51+
returncache;
52+
}
53+
54+
fs.statSync(path.join(pkg,'index.js'));
55+
assert.strictEqual(
56+
fs.realpathSync(throughLink,{[realpathCacheKey]: ancestorCache()}),
57+
throughReal,
58+
);
59+
60+
fs.statSync(fifo);
61+
assert.strictEqual(
62+
fs.realpathSync(throughLink,{[realpathCacheKey]: ancestorCache()}),
63+
throughReal,
64+
);
65+
66+
// What the stale read costs through the module loader, whose cache puts the
67+
// walk in that same state: the symlink stays unresolved, so the file is loaded
68+
// a second time under a second name.
69+
require(tmpdir.resolve('warm.js'));
70+
fs.statSync(fifo);
71+
72+
assert.strictEqual(require.resolve(throughLink),throughReal);
73+
assert.strictEqual(require(throughLink),require(throughReal));

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit 87ee7bf

Browse files
unstubbableaduh95
authored andcommitted
test: cover realpathSync resolving symlinks after a FIFO stat
While walking a path, `realpathSync` skips the components it already knows are real, and in that branch it reads the shared stat buffer to decide whether the walk has reached a pipe or a socket. That buffer holds the result of the last stat made anywhere in the process rather than the last one made by the walk, so an unrelated stat of a FIFO ends the walk early and the path comes back with its symlinks unresolved. The unresolved path is then written to the cache, so every later resolution repeats it. The walk only takes that branch once the ancestors are established as real, which is the state the module loader's cache is in. The test goes through `require()` to reach it, where the stale read costs a second copy of a module reached through a symlink. Signed-off-by: Hendrik Liebau <mail@hendrik-liebau.de> PR-URL: #65113 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 72c37b1 commit 87ee7bf

3 files changed

Lines changed: 153 additions & 7 deletions

File tree

β€Žlib/fs.jsβ€Ž

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,6 @@ const {
8181

8282
const{
8383
FSReqCallback,
84-
statValues,
8584
}=binding;
8685
const{ toPathIfFileURL }=require('internal/url');
8786
const{
@@ -3254,6 +3253,11 @@ function realpathSync(p, options) {
32543253
constseenLinks=newSafeMap();
32553254
constknownHard=newSafeSet();
32563255
constoriginal=p;
3256+
// Whether the symlink this walk resolved last pointed at a pipe or a
3257+
// socket, which is where the walk stops. It cannot be read back from the
3258+
// shared stat buffer, which holds the last stat made anywhere in the
3259+
// process rather than the last one made here.
3260+
letreachedPipeOrSocket=false;
32573261

32583262
// Current character position in p
32593263
letpos;
@@ -3297,8 +3301,7 @@ function realpathSync(p, options) {
32973301

32983302
// Continue if not a symlink, break if a pipe/socket
32993303
if(knownHard.has(base)||cache?.get(base)===base){
3300-
if(isFileType(statValues,S_IFIFO)||
3301-
isFileType(statValues,S_IFSOCK)){
3304+
if(reachedPipeOrSocket){
33023305
break;
33033306
}
33043307
continue;
@@ -3336,7 +3339,9 @@ function realpathSync(p, options) {
33363339
}
33373340
}
33383341
if(linkTarget===null){
3339-
binding.stat(base,false,undefined,true);
3342+
consttargetStats=binding.stat(base,false,undefined,true);
3343+
reachedPipeOrSocket=isFileType(targetStats,S_IFIFO)||
3344+
isFileType(targetStats,S_IFSOCK);
33403345
linkTarget=binding.readlink(base,undefined);
33413346
}
33423347
resolvedLink=pathModule.resolve(previous,linkTarget);
@@ -3418,6 +3423,11 @@ function realpath(p, options, callback) {
34183423

34193424
constseenLinks=newSafeMap();
34203425
constknownHard=newSafeSet();
3426+
// Whether the symlink this walk resolved last pointed at a pipe or a
3427+
// socket, which is where the walk stops. It cannot be read back from the
3428+
// shared stat buffer, which holds the last stat made anywhere in the
3429+
// process rather than the last one made here.
3430+
letreachedPipeOrSocket=false;
34213431

34223432
// Current character position in p
34233433
letpos;
@@ -3466,8 +3476,7 @@ function realpath(p, options, callback) {
34663476

34673477
// Continue if not a symlink, break if a pipe/socket
34683478
if(knownHard.has(base)){
3469-
if(isFileType(statValues,S_IFIFO)||
3470-
isFileType(statValues,S_IFSOCK)){
3479+
if(reachedPipeOrSocket){
34713480
returncallback(null,encodeRealpathResult(p,options));
34723481
}
34733482
returnprocess.nextTick(LOOP);
@@ -3497,9 +3506,11 @@ function realpath(p, options, callback) {
34973506
returngotTarget(null,seenLinks.get(id));
34983507
}
34993508
}
3500-
fs.stat(base,(err)=>{
3509+
fs.stat(base,(err,targetStats)=>{
35013510
if(err)returncallback(err);
35023511

3512+
reachedPipeOrSocket=targetStats.isFIFO()||targetStats.isSocket();
3513+
35033514
fs.readlink(base,(err,target)=>{
35043515
if(!isWindows)seenLinks.set(id,target);
35053516
gotTarget(err,target);
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
'use strict';
2+
3+
// The async realpath() reads the shared stat buffer the same way realpathSync()
4+
// did, to decide whether the walk has reached a pipe or a socket. The walk's
5+
// own fs.stat() does leave the right value there, but it is not read until
6+
// after fs.readlink() and a process.nextTick(), and any stat completing in that
7+
// window replaces it.
8+
//
9+
// Truncating the walk only costs something when a second symlink follows the
10+
// one being resolved, so the path used here has two.
11+
12+
constcommon=require('../common');
13+
14+
if(common.isWindows)
15+
common.skip('no mkfifo on Windows');
16+
17+
constassert=require('assert');
18+
constfs=require('fs');
19+
constpath=require('path');
20+
const{ execFileSync }=require('child_process');
21+
consttmpdir=require('../common/tmpdir');
22+
23+
tmpdir.refresh();
24+
25+
constreal=tmpdir.resolve('real');
26+
constpkg=tmpdir.resolve('pkg');
27+
constfifo=tmpdir.resolve('fifo');
28+
29+
fs.mkdirSync(real);
30+
fs.mkdirSync(pkg);
31+
fs.writeFileSync(path.join(real,'index.js'),'');
32+
fs.symlinkSync(path.join('..','real'),path.join(pkg,'sub'));
33+
fs.symlinkSync('pkg',tmpdir.resolve('link'));
34+
execFileSync('mkfifo',[fifo]);
35+
36+
constthroughLinks=tmpdir.resolve('link','sub','index.js');
37+
constexpected=path.join(real,'index.js');
38+
39+
// Keep stats of the FIFO completing for as long as the walk runs, so that one
40+
// of them lands in the buffer during the window.
41+
letsettled=false;
42+
(functionstatFifo(){
43+
if(settled)return;
44+
fs.stat(fifo,statFifo);
45+
})();
46+
47+
leterror;
48+
letresolvedPath;
49+
50+
fs.realpath(throughLinks,common.mustCall((err,resolved)=>{
51+
settled=true;
52+
error=err;
53+
resolvedPath=resolved;
54+
}));
55+
56+
// Asserted on exit rather than in the callback. An assertion that fails inside
57+
// this callback is lost: it does not reach an `uncaughtException` handler and
58+
// the process still exits 0, so the test would pass over the bug it covers.
59+
process.on('exit',()=>{
60+
assert.ifError(error);
61+
assert.strictEqual(resolvedPath,expected);
62+
});
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
// Flags: --expose-internals
2+
'use strict';
3+
4+
// Resolving a path must not depend on what was stat'ed before it.
5+
//
6+
// While walking a path, realpath skips the components it already knows are
7+
// real, and in that branch it consulted the shared stat buffer to decide
8+
// whether the walk had reached a pipe or a socket. That buffer holds the result
9+
// of the last stat made anywhere in the process, so an unrelated stat of a FIFO
10+
// made the walk stop early and hand back the path with its symlinks unresolved.
11+
// The unresolved path is then cached, so every later resolution repeats it.
12+
13+
constcommon=require('../common');
14+
15+
if(common.isWindows)
16+
common.skip('no mkfifo on Windows');
17+
18+
constassert=require('assert');
19+
constfs=require('fs');
20+
constpath=require('path');
21+
const{ execFileSync }=require('child_process');
22+
const{ realpathCacheKey }=require('internal/fs/utils');
23+
consttmpdir=require('../common/tmpdir');
24+
25+
tmpdir.refresh();
26+
27+
constpkg=tmpdir.resolve('pkg');
28+
constlink=tmpdir.resolve('pkg-link');
29+
constfifo=tmpdir.resolve('fifo');
30+
31+
fs.mkdirSync(pkg);
32+
fs.writeFileSync(path.join(pkg,'index.js'),'module.exports = {};\n');
33+
fs.writeFileSync(tmpdir.resolve('warm.js'),'module.exports = {};\n');
34+
fs.symlinkSync('pkg',link);
35+
execFileSync('mkfifo',[fifo]);
36+
37+
constthroughLink=path.join(link,'index.js');
38+
constthroughReal=path.join(pkg,'index.js');
39+
40+
// The walk only skips a component once something has established it as real. A
41+
// cache carrying the ancestors is that state, and it is the state the module
42+
// loader's own cache is in after it has resolved anything else under the
43+
// directory.
44+
functionancestorCache(){
45+
constcache=newMap();
46+
letdir='';
47+
for(constpartoftmpdir.path.split(path.sep).slice(1)){
48+
dir+=path.sep+part;
49+
cache.set(dir,dir);
50+
}
51+
returncache;
52+
}
53+
54+
fs.statSync(path.join(pkg,'index.js'));
55+
assert.strictEqual(
56+
fs.realpathSync(throughLink,{[realpathCacheKey]: ancestorCache()}),
57+
throughReal,
58+
);
59+
60+
fs.statSync(fifo);
61+
assert.strictEqual(
62+
fs.realpathSync(throughLink,{[realpathCacheKey]: ancestorCache()}),
63+
throughReal,
64+
);
65+
66+
// What the stale read costs through the module loader, whose cache puts the
67+
// walk in that same state: the symlink stays unresolved, so the file is loaded
68+
// a second time under a second name.
69+
require(tmpdir.resolve('warm.js'));
70+
fs.statSync(fifo);
71+
72+
assert.strictEqual(require.resolve(throughLink),throughReal);
73+
assert.strictEqual(require(throughLink),require(throughReal));

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Commit 87ee7bf

Browse files
unstubbableaduh95
authored andcommitted
test: cover realpathSync resolving symlinks after a FIFO stat
While walking a path, `realpathSync` skips the components it already knows are real, and in that branch it reads the shared stat buffer to decide whether the walk has reached a pipe or a socket. That buffer holds the result of the last stat made anywhere in the process rather than the last one made by the walk, so an unrelated stat of a FIFO ends the walk early and the path comes back with its symlinks unresolved. The unresolved path is then written to the cache, so every later resolution repeats it. The walk only takes that branch once the ancestors are established as real, which is the state the module loader's cache is in. The test goes through `require()` to reach it, where the stale read costs a second copy of a module reached through a symlink. Signed-off-by: Hendrik Liebau <mail@hendrik-liebau.de> PR-URL: #65113 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 72c37b1 commit 87ee7bf

3 files changed

Lines changed: 153 additions & 7 deletions

File tree

β€Žlib/fs.jsβ€Ž

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,6 @@ const {
8181

8282
const{
8383
FSReqCallback,
84-
statValues,
8584
}=binding;
8685
const{ toPathIfFileURL }=require('internal/url');
8786
const{
@@ -3254,6 +3253,11 @@ function realpathSync(p, options) {
32543253
constseenLinks=newSafeMap();
32553254
constknownHard=newSafeSet();
32563255
constoriginal=p;
3256+
// Whether the symlink this walk resolved last pointed at a pipe or a
3257+
// socket, which is where the walk stops. It cannot be read back from the
3258+
// shared stat buffer, which holds the last stat made anywhere in the
3259+
// process rather than the last one made here.
3260+
letreachedPipeOrSocket=false;
32573261

32583262
// Current character position in p
32593263
letpos;
@@ -3297,8 +3301,7 @@ function realpathSync(p, options) {
32973301

32983302
// Continue if not a symlink, break if a pipe/socket
32993303
if(knownHard.has(base)||cache?.get(base)===base){
3300-
if(isFileType(statValues,S_IFIFO)||
3301-
isFileType(statValues,S_IFSOCK)){
3304+
if(reachedPipeOrSocket){
33023305
break;
33033306
}
33043307
continue;
@@ -3336,7 +3339,9 @@ function realpathSync(p, options) {
33363339
}
33373340
}
33383341
if(linkTarget===null){
3339-
binding.stat(base,false,undefined,true);
3342+
consttargetStats=binding.stat(base,false,undefined,true);
3343+
reachedPipeOrSocket=isFileType(targetStats,S_IFIFO)||
3344+
isFileType(targetStats,S_IFSOCK);
33403345
linkTarget=binding.readlink(base,undefined);
33413346
}
33423347
resolvedLink=pathModule.resolve(previous,linkTarget);
@@ -3418,6 +3423,11 @@ function realpath(p, options, callback) {
34183423

34193424
constseenLinks=newSafeMap();
34203425
constknownHard=newSafeSet();
3426+
// Whether the symlink this walk resolved last pointed at a pipe or a
3427+
// socket, which is where the walk stops. It cannot be read back from the
3428+
// shared stat buffer, which holds the last stat made anywhere in the
3429+
// process rather than the last one made here.
3430+
letreachedPipeOrSocket=false;
34213431

34223432
// Current character position in p
34233433
letpos;
@@ -3466,8 +3476,7 @@ function realpath(p, options, callback) {
34663476

34673477
// Continue if not a symlink, break if a pipe/socket
34683478
if(knownHard.has(base)){
3469-
if(isFileType(statValues,S_IFIFO)||
3470-
isFileType(statValues,S_IFSOCK)){
3479+
if(reachedPipeOrSocket){
34713480
returncallback(null,encodeRealpathResult(p,options));
34723481
}
34733482
returnprocess.nextTick(LOOP);
@@ -3497,9 +3506,11 @@ function realpath(p, options, callback) {
34973506
returngotTarget(null,seenLinks.get(id));
34983507
}
34993508
}
3500-
fs.stat(base,(err)=>{
3509+
fs.stat(base,(err,targetStats)=>{
35013510
if(err)returncallback(err);
35023511

3512+
reachedPipeOrSocket=targetStats.isFIFO()||targetStats.isSocket();
3513+
35033514
fs.readlink(base,(err,target)=>{
35043515
if(!isWindows)seenLinks.set(id,target);
35053516
gotTarget(err,target);
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
'use strict';
2+
3+
// The async realpath() reads the shared stat buffer the same way realpathSync()
4+
// did, to decide whether the walk has reached a pipe or a socket. The walk's
5+
// own fs.stat() does leave the right value there, but it is not read until
6+
// after fs.readlink() and a process.nextTick(), and any stat completing in that
7+
// window replaces it.
8+
//
9+
// Truncating the walk only costs something when a second symlink follows the
10+
// one being resolved, so the path used here has two.
11+
12+
constcommon=require('../common');
13+
14+
if(common.isWindows)
15+
common.skip('no mkfifo on Windows');
16+
17+
constassert=require('assert');
18+
constfs=require('fs');
19+
constpath=require('path');
20+
const{ execFileSync }=require('child_process');
21+
consttmpdir=require('../common/tmpdir');
22+
23+
tmpdir.refresh();
24+
25+
constreal=tmpdir.resolve('real');
26+
constpkg=tmpdir.resolve('pkg');
27+
constfifo=tmpdir.resolve('fifo');
28+
29+
fs.mkdirSync(real);
30+
fs.mkdirSync(pkg);
31+
fs.writeFileSync(path.join(real,'index.js'),'');
32+
fs.symlinkSync(path.join('..','real'),path.join(pkg,'sub'));
33+
fs.symlinkSync('pkg',tmpdir.resolve('link'));
34+
execFileSync('mkfifo',[fifo]);
35+
36+
constthroughLinks=tmpdir.resolve('link','sub','index.js');
37+
constexpected=path.join(real,'index.js');
38+
39+
// Keep stats of the FIFO completing for as long as the walk runs, so that one
40+
// of them lands in the buffer during the window.
41+
letsettled=false;
42+
(functionstatFifo(){
43+
if(settled)return;
44+
fs.stat(fifo,statFifo);
45+
})();
46+
47+
leterror;
48+
letresolvedPath;
49+
50+
fs.realpath(throughLinks,common.mustCall((err,resolved)=>{
51+
settled=true;
52+
error=err;
53+
resolvedPath=resolved;
54+
}));
55+
56+
// Asserted on exit rather than in the callback. An assertion that fails inside
57+
// this callback is lost: it does not reach an `uncaughtException` handler and
58+
// the process still exits 0, so the test would pass over the bug it covers.
59+
process.on('exit',()=>{
60+
assert.ifError(error);
61+
assert.strictEqual(resolvedPath,expected);
62+
});
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
// Flags: --expose-internals
2+
'use strict';
3+
4+
// Resolving a path must not depend on what was stat'ed before it.
5+
//
6+
// While walking a path, realpath skips the components it already knows are
7+
// real, and in that branch it consulted the shared stat buffer to decide
8+
// whether the walk had reached a pipe or a socket. That buffer holds the result
9+
// of the last stat made anywhere in the process, so an unrelated stat of a FIFO
10+
// made the walk stop early and hand back the path with its symlinks unresolved.
11+
// The unresolved path is then cached, so every later resolution repeats it.
12+
13+
constcommon=require('../common');
14+
15+
if(common.isWindows)
16+
common.skip('no mkfifo on Windows');
17+
18+
constassert=require('assert');
19+
constfs=require('fs');
20+
constpath=require('path');
21+
const{ execFileSync }=require('child_process');
22+
const{ realpathCacheKey }=require('internal/fs/utils');
23+
consttmpdir=require('../common/tmpdir');
24+
25+
tmpdir.refresh();
26+
27+
constpkg=tmpdir.resolve('pkg');
28+
constlink=tmpdir.resolve('pkg-link');
29+
constfifo=tmpdir.resolve('fifo');
30+
31+
fs.mkdirSync(pkg);
32+
fs.writeFileSync(path.join(pkg,'index.js'),'module.exports = {};\n');
33+
fs.writeFileSync(tmpdir.resolve('warm.js'),'module.exports = {};\n');
34+
fs.symlinkSync('pkg',link);
35+
execFileSync('mkfifo',[fifo]);
36+
37+
constthroughLink=path.join(link,'index.js');
38+
constthroughReal=path.join(pkg,'index.js');
39+
40+
// The walk only skips a component once something has established it as real. A
41+
// cache carrying the ancestors is that state, and it is the state the module
42+
// loader's own cache is in after it has resolved anything else under the
43+
// directory.
44+
functionancestorCache(){
45+
constcache=newMap();
46+
letdir='';
47+
for(constpartoftmpdir.path.split(path.sep).slice(1)){
48+
dir+=path.sep+part;
49+
cache.set(dir,dir);
50+
}
51+
returncache;
52+
}
53+
54+
fs.statSync(path.join(pkg,'index.js'));
55+
assert.strictEqual(
56+
fs.realpathSync(throughLink,{[realpathCacheKey]: ancestorCache()}),
57+
throughReal,
58+
);
59+
60+
fs.statSync(fifo);
61+
assert.strictEqual(
62+
fs.realpathSync(throughLink,{[realpathCacheKey]: ancestorCache()}),
63+
throughReal,
64+
);
65+
66+
// What the stale read costs through the module loader, whose cache puts the
67+
// walk in that same state: the symlink stays unresolved, so the file is loaded
68+
// a second time under a second name.
69+
require(tmpdir.resolve('warm.js'));
70+
fs.statSync(fifo);
71+
72+
assert.strictEqual(require.resolve(throughLink),throughReal);
73+
assert.strictEqual(require(throughLink),require(throughReal));

0 commit comments

Comments
Β (0)