Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: avoid endless loop when handling symlinks (#109) by @q0rban #109

Merged
merged 7 commits into from
Oct 25, 2024
Merged

fix: avoid endless loop when handling symlinks (#109) by @q0rban #109

Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1fb8b85
fix: avoid endless loop when handling symlinks #108
q0rban Oct 21, 2024
abfe4ac
Merge branch 'main' into 108--symlinks
robertsLando Oct 24, 2024
9204bcb
Merge branch 'main' into 108--symlinks
robertsLando Oct 24, 2024
b25d570
docs: document findCommonJunctionPoint function with jsdoc
q0rban Oct 24, 2024
a3f8d18
fix: linting
q0rban Oct 24, 2024
338f68d
fix: allow symlink errors to propogate to prevent inconsistent binary…
q0rban Oct 24, 2024
f7b90ec
test: add test for handling symlinks properly
q0rban Oct 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 42 additions & 19 deletions lib/walker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,14 +317,37 @@ function stepDetect(
}
}

function findCommonJunctionPoint(file: string, realFile: string) {
/**
* Find a common junction point between a symlink and the real file path.
*
* @param {string} file The file path, including symlink(s).
* @param {string} realFile The real path to the file.
*
* @throws {Error} If no common junction point is found prior to hitting the
* filesystem root.
*/
async function findCommonJunctionPoint(file: string, realFile: string) {
q0rban marked this conversation as resolved.
Show resolved Hide resolved
// find common denominator => where the link changes
while (toNormalizedRealPath(path.dirname(file)) === path.dirname(realFile)) {
while (true) {
const stats = await fs.lstat(file);

if (stats.isSymbolicLink()) {
return { file, realFile };
}

file = path.dirname(file);
realFile = path.dirname(realFile);
}

return { file, realFile };
// If the directory is /, break out of the loop and log an error.
if (
file === path.parse(file).root ||
realFile === path.parse(realFile).root
) {
throw new Error(
'Reached root directory without finding a common junction point',
);
robertsLando marked this conversation as resolved.
Show resolved Hide resolved
}
}
}

export interface WalkerParams {
Expand Down Expand Up @@ -399,8 +422,8 @@ class Walker {
}
}

appendSymlink(file: string, realFile: string) {
const a = findCommonJunctionPoint(file, realFile);
async appendSymlink(file: string, realFile: string) {
const a = await findCommonJunctionPoint(file, realFile);
file = a.file;
realFile = a.realFile;

Expand Down Expand Up @@ -456,7 +479,7 @@ class Walker {
});
}

appendBlobOrContent(task: Task) {
async appendBlobOrContent(task: Task) {
if (strictVerify) {
assert(task.file === normalizePath(task.file));
}
Expand Down Expand Up @@ -486,7 +509,7 @@ class Walker {
}

this.append({ ...task, file: realFile });
this.appendSymlink(task.file, realFile);
await this.appendSymlink(task.file, realFile);
this.appendStat({
file: task.file,
store: STORE_STAT,
Expand Down Expand Up @@ -514,7 +537,7 @@ class Walker {
]);
}

this.appendBlobOrContent({
await this.appendBlobOrContent({
file: normalizePath(script),
marker,
store: STORE_BLOB,
Expand All @@ -534,7 +557,7 @@ class Walker {
const stat = await fs.stat(asset);

if (stat.isFile()) {
this.appendBlobOrContent({
await this.appendBlobOrContent({
file: normalizePath(asset),
marker,
store: STORE_CONTENT,
Expand All @@ -558,14 +581,14 @@ class Walker {
// 2) non-source (non-js) files of top-level package are shipped as CONTENT
// 3) parsing some js 'files' of non-top-level packages fails, hence all CONTENT
if (marker.toplevel) {
this.appendBlobOrContent({
await this.appendBlobOrContent({
file,
marker,
store: isDotJS(file) ? STORE_BLOB : STORE_CONTENT,
reason: configPath,
});
} else {
this.appendBlobOrContent({
await this.appendBlobOrContent({
file,
marker,
store: STORE_CONTENT,
Expand Down Expand Up @@ -754,7 +777,7 @@ class Walker {
}

if (stat && stat.isFile()) {
this.appendBlobOrContent({
await this.appendBlobOrContent({
file,
marker,
store: STORE_CONTENT,
Expand Down Expand Up @@ -857,15 +880,15 @@ class Walker {
normalizePath(newPackageForNewRecords.packageJson),
);
}
this.appendBlobOrContent({
await this.appendBlobOrContent({
file: newPackageForNewRecords.packageJson,
marker: newPackageForNewRecords.marker,
store: STORE_CONTENT,
reason: record.file,
});
}

this.appendBlobOrContent({
await this.appendBlobOrContent({
file: newFile,
marker: newPackageForNewRecords ? newPackageForNewRecords.marker : marker,
store: STORE_BLOB,
Expand Down Expand Up @@ -921,7 +944,7 @@ class Walker {

if (store === STORE_BLOB) {
if (unlikelyJavascript(record.file) || isDotNODE(record.file)) {
this.appendBlobOrContent({
await this.appendBlobOrContent({
file: record.file,
marker,
store: STORE_CONTENT,
Expand All @@ -930,7 +953,7 @@ class Walker {
}

if (marker.public || marker.hasDictionary) {
this.appendBlobOrContent({
await this.appendBlobOrContent({
file: record.file,
marker,
store: STORE_CONTENT,
Expand Down Expand Up @@ -1090,15 +1113,15 @@ class Walker {

entrypoint = normalizePath(entrypoint);

this.appendBlobOrContent({
await this.appendBlobOrContent({
file: entrypoint,
marker,
store: STORE_BLOB,
});

if (addition) {
addition = normalizePath(addition);
this.appendBlobOrContent({
await this.appendBlobOrContent({
file: addition,
marker,
store: STORE_CONTENT,
Expand Down