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

Internal refactor TreeFS collectLinkPaths #1276

Closed
wants to merge 1 commit into from
Closed

Internal refactor TreeFS collectLinkPaths #1276

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
41 changes: 17 additions & 24 deletions packages/metro-file-map/src/lib/TreeFS.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,20 +142,20 @@ export default class TreeFS implements MutableFileSystem {

lookup(mixedPath: Path): LookupResult {
const normalPath = this._normalizePath(mixedPath);
const result = this._lookupByNormalPath(normalPath, {followLeaf: true});
const links = new Set<string>();
const result = this._lookupByNormalPath(normalPath, {
collectLinkPaths: links,
followLeaf: true,
});
if (!result.exists) {
const {canonicalMissingPath, canonicalLinkPaths} = result;
const {canonicalMissingPath} = result;
return {
exists: false,
links: new Set(
canonicalLinkPaths.map(canonicalPath =>
this.#pathUtils.normalToAbsolute(canonicalPath),
),
),
links,
missing: this.#pathUtils.normalToAbsolute(canonicalMissingPath),
};
}
const {canonicalPath, canonicalLinkPaths, node} = result;
const {canonicalPath, node} = result;
const type = node instanceof Map ? 'd' : node[H.SYMLINK] === 0 ? 'f' : 'l';
invariant(
type !== 'l',
Expand All @@ -165,11 +165,7 @@ export default class TreeFS implements MutableFileSystem {
);
return {
exists: true,
links: new Set(
canonicalLinkPaths.map(canonicalPath =>
this.#pathUtils.normalToAbsolute(canonicalPath),
),
),
links,
realPath: this.#pathUtils.normalToAbsolute(canonicalPath),
type,
};
Expand Down Expand Up @@ -367,6 +363,9 @@ export default class TreeFS implements MutableFileSystem {
_lookupByNormalPath(
requestedNormalPath: string,
opts: {
// Mutable Set into which absolute real paths of traversed symlinks will
// be added. Omit for performance if not needed.
collectLinkPaths?: ?Set<string>,
// Like lstat vs stat, whether to follow a symlink at the basename of
// the given path, or return the details of the symlink itself.
followLeaf?: boolean,
Expand All @@ -375,29 +374,24 @@ export default class TreeFS implements MutableFileSystem {
):
| {
ancestorOfRootIdx: ?number,
canonicalLinkPaths: Array<string>,
canonicalPath: string,
exists: true,
node: MixedNode,
parentNode: DirectoryNode,
}
| {
ancestorOfRootIdx: ?number,
canonicalLinkPaths: Array<string>,
canonicalPath: string,
exists: true,
node: DirectoryNode,
parentNode: null,
}
| {
canonicalLinkPaths: Array<string>,
canonicalMissingPath: string,
exists: false,
} {
// We'll update the target if we hit a symlink.
let targetNormalPath = requestedNormalPath;
// Set of traversed symlink paths to return.
const canonicalLinkPaths: Array<string> = [];
// Lazy-initialised set of seen target paths, to detect symlink cycles.
let seen: ?Set<string>;
// Pointer to the first character of the current path segment in
Expand Down Expand Up @@ -435,7 +429,6 @@ export default class TreeFS implements MutableFileSystem {
if (segmentNode == null) {
if (opts.makeDirectories !== true && segmentName !== '..') {
return {
canonicalLinkPaths,
canonicalMissingPath: isLastSegment
? targetNormalPath
: targetNormalPath.slice(0, fromIdx - 1),
Expand All @@ -458,7 +451,6 @@ export default class TreeFS implements MutableFileSystem {
) {
return {
ancestorOfRootIdx,
canonicalLinkPaths,
canonicalPath: targetNormalPath,
exists: true,
node: segmentNode,
Expand All @@ -477,7 +469,6 @@ export default class TreeFS implements MutableFileSystem {
if (segmentNode[H.SYMLINK] === 0) {
// Regular file in a directory path
return {
canonicalLinkPaths,
canonicalMissingPath: currentPath,
exists: false,
};
Expand All @@ -488,7 +479,11 @@ export default class TreeFS implements MutableFileSystem {
segmentNode,
currentPath,
);
canonicalLinkPaths.push(currentPath);
if (opts.collectLinkPaths) {
opts.collectLinkPaths.add(
this.#pathUtils.normalToAbsolute(currentPath),
);
}

// Append any subsequent path segments to the symlink target, and reset
// with our new target.
Expand All @@ -506,7 +501,6 @@ export default class TreeFS implements MutableFileSystem {
if (seen.has(targetNormalPath)) {
// TODO: Warn `Symlink cycle detected: ${[...seen, node].join(' -> ')}`
return {
canonicalLinkPaths,
canonicalMissingPath: targetNormalPath,
exists: false,
};
Expand All @@ -519,7 +513,6 @@ export default class TreeFS implements MutableFileSystem {
invariant(parentNode === this.#rootNode, 'Unexpectedly escaped traversal');
return {
ancestorOfRootIdx: null,
canonicalLinkPaths,
canonicalPath: targetNormalPath,
exists: true,
node: this.#rootNode,
Expand Down