Skip to content

Commit

Permalink
fix: don't use origRealPath from patched lstat since origRealPath use…
Browse files Browse the repository at this point in the history 
…s lstat (#258)
  • Loading branch information
@gregmagolan
gregmagolan authored Jun 28, 2022
1 parent 0f73d40 commit e22361d
Show file tree
Hide file tree
Showing 4 changed files with 222 additions and 41 deletions.
4 changes: 0 additions & 4 deletions js/private/coverage/bundle/BUILD.bazel
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,5 @@ rollup_bin.rollup(
"bundle.js",
],
chdir = package_name(),
execution_requirements = {
# TODO: fix in the sandbox
"no-sandbox": "1",
},
visibility = ["//js/private/coverage:__pkg__"],
)
65 changes: 48 additions & 17 deletions js/private/node-patches/fs.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

74 changes: 54 additions & 20 deletions js/private/node-patches/src/fs.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,10 +87,12 @@ export const patcher = (fs: any = _fs, roots: string[]) => {
return cb(null, stats)
}

// there are no hops so lets report the stats of the real file
origRealpath(args[0], (err, str) => {
// there are no hops so lets report the stats of the real file;
// we can't use origRealPath here since that function calls lstat internally
// which can result in an infinite loop
return unguardedRealPath(args[0], (err: Error, str: string) => {
if (err) {
if (err.code === 'ENOENT') {
if ((err as any).code === 'ENOENT') {
// broken link so there is nothing more to do
return cb(null, stats)
}
Expand Down Expand Up @@ -120,14 +122,16 @@ export const patcher = (fs: any = _fs, roots: string[]) => {
}

try {
// there are no hops so lets report the stats of the real file
return origLstatSync(origRealpathSync(args[0]), args.slice(1))
} catch (e) {
if (e.code === 'ENOENT') {
// there are no hops so lets report the stats of the real file;
// we can't use origRealPathSync here since that function calls lstat internally
// which can result in an infinite loop
return origLstatSync(unguardedRealPathSync(args[0]), args.slice(1))
} catch (err) {
if (err.code === 'ENOENT') {
// broken link so there is nothing more to do
return stats
}
throw e
throw err
}
}

Expand Down Expand Up @@ -354,8 +358,8 @@ export const patcher = (fs: any = _fs, roots: string[]) => {
args[args.length - 1] = async (err: Error, dir: Dir) => {
try {
cb(null, await handleDir(dir))
} catch (e) {
cb(e)
} catch (err) {
cb(err)
}
}
origOpendir(...args)
Expand Down Expand Up @@ -494,9 +498,9 @@ export const patcher = (fs: any = _fs, roots: string[]) => {
function nextHop(loc: string, cb: (next: string | false) => void): void {
let nested = []
const oneHop = (maybe, cb: (next: string | false) => void) => {
origReadlink(maybe, (err, str) => {
origReadlink(maybe, (err: Error, str: string) => {
if (err) {
if (err.code === 'ENOENT') {
if ((err as any).code === 'ENOENT') {
// file does not exist
return cb(undefined)
}
Expand Down Expand Up @@ -530,8 +534,8 @@ export const patcher = (fs: any = _fs, roots: string[]) => {
for (;;) {
try {
readlink = origReadlinkSync(maybe)
} catch (e) {
if (e.code === 'ENOENT') {
} catch (err) {
if (err.code === 'ENOENT') {
// file does not exist
return undefined
}
Expand Down Expand Up @@ -618,14 +622,32 @@ export const patcher = (fs: any = _fs, roots: string[]) => {
return next
}

function unguardedRealPath(
start: string,
cb: (err: Error, str?: string) => void
): void {
start = String(start) // handle the "undefined" case (matches behavior as fs.realpath)
const oneHop = (loc, cb) => {
nextHop(loc, (next) => {
if (next == undefined) {
// file does not exist (broken link)
return cb(enoent('realpath', start))
} else if (!next) {
// we've hit a real file
return cb(null, loc)
}
oneHop(next, cb)
})
}
oneHop(start, cb)
}

function guardedRealPath(
start: string,
cb: (err: Error, str?: string) => void,
escapedRoot: string = undefined
): void {
if (!start) {
return cb(enoent('realpath', start))
}
start = String(start) // handle the "undefined" case (matches behavior as fs.realpath)
const oneHop = (
loc: string,
cb: (err: Error, str?: string) => void
Expand Down Expand Up @@ -669,13 +691,25 @@ export const patcher = (fs: any = _fs, roots: string[]) => {
oneHop(start, cb)
}

function unguardedRealPathSync(start: string): string {
start = String(start) // handle the "undefined" case (matches behavior as fs.realpathSync)
for (let loc = start, next; ; loc = next) {
next = nextHopSync(loc)
if (next == undefined) {
// file does not exist (broken link)
throw enoent('realpath', start)
} else if (!next) {
// we've hit a real file
return loc
}
}
}

function guardedRealPathSync(
start: string,
escapedRoot: string = undefined
): string {
if (!start) {
return start
}
start = String(start) // handle the "undefined" case (matches behavior as fs.realpathSync)
for (let loc = start, next: string | false; ; loc = next) {
next = nextHopSync(loc)
if (!next) {
Expand Down
120 changes: 120 additions & 0 deletions js/private/test/node-patches/realpath.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,126 @@ async function it(_, fn) {
}

describe('testing realpath', async () => {
await it('can handle empty, dot, undefined & null values', async () => {
const patchedFs = Object.assign({}, fs)
patchedFs.promises = Object.assign({}, fs.promises)

patcher(patchedFs, [process.cwd()])

// ---------------------------------------------------------------------
// empty string

assert.deepStrictEqual(
patchedFs.realpathSync(''),
process.cwd(),
'should handle an empty string'
)

assert.throws(() => {
patchedFs.realpathSync.native('')
}, 'should throw if empty string is passed')

assert.deepStrictEqual(
await util.promisify(patchedFs.realpath)(''),
process.cwd(),
'should handle an empty string'
)

let thrown
try {
await util.promisify(patchedFs.realpath.native)('')
} catch (e) {
thrown = e
} finally {
if (!thrown) assert.fail('should throw if empty string is passed')
}

// ---------------------------------------------------------------------
// '.'

assert.deepStrictEqual(
patchedFs.realpathSync('.'),
process.cwd(),
"should handle '.'"
)

assert.deepStrictEqual(
patchedFs.realpathSync.native('.'),
process.cwd(),
"should handle '.'"
)

assert.deepStrictEqual(
await util.promisify(patchedFs.realpath)('.'),
process.cwd(),
"should handle '.'"
)

assert.deepStrictEqual(
await util.promisify(patchedFs.realpath.native)('.'),
process.cwd(),
"should handle '.'"
)

// ---------------------------------------------------------------------
// undefined

assert.throws(() => {
patchedFs.realpathSync(undefined)
}, 'should throw if undefined is passed')

assert.throws(() => {
patchedFs.realpathSync.native(undefined)
}, 'should throw if undefined is passed')

thrown = undefined
try {
await util.promisify(patchedFs.realpath)(undefined)
} catch (e) {
thrown = e
} finally {
if (!thrown) assert.fail('should throw if undefined is passed')
}

thrown = undefined
try {
await util.promisify(patchedFs.realpath.native)(undefined)
} catch (e) {
thrown = e
} finally {
if (!thrown) assert.fail('should throw if undefined is passed')
}

// ---------------------------------------------------------------------
// null

assert.throws(() => {
patchedFs.realpathSync(null)
}, 'should throw if null is passed')

assert.throws(() => {
patchedFs.realpathSync.native(null)
}, 'should throw if null is passed')

thrown = undefined
try {
await util.promisify(patchedFs.realpath)(null)
} catch (e) {
thrown = e
} finally {
if (!thrown) assert.fail('should throw if null is passed')
}

thrown = undefined
try {
await util.promisify(patchedFs.realpath.native)(null)
} catch (e) {
thrown = e
} finally {
if (!thrown) assert.fail('should throw if null is passed')
}
})

await it('can resolve symlink in root', async () => {
await withFixtures(
{
Expand Down

0 comments on commit e22361d

Please sign in to comment.