fix(plugin-compat): update fsevents patch to support virtual path #1671
There are no files selected for viewing
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| releases: | ||
| "@yarnpkg/plugin-compat": patch |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| diff --git a/fsevents.js b/fsevents.js | ||
| semver exclusivity 2.1.1 | ||
| --- a/fsevents.js | ||
| +++ b/fsevents.js | ||
| @@ -21,12 +21,11 @@ function watch(path, handler) { | ||
| throw new TypeError(`fsevents argument 2 must be a function and not a ${typeof handler}`); | ||
| } | ||
|
|
||
| - let instance = Native.start(path, handler); | ||
| - if (!instance) throw new Error(`could not watch: ${path}`); | ||
| + let VFS = require('./vfs'); | ||
| + let vfs = new VFS(path, Native); | ||
| + vfs.watch(handler); | ||
| return () => { | ||
| - const result = instance ? Promise.resolve(instance).then(Native.stop) : null; | ||
| - instance = null; | ||
| - return result; | ||
| + return vfs.stop(); | ||
| }; | ||
| } | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,22 @@ | ||
| diff --git a/fsevents.js b/fsevents.js | ||
| semver exclusivity ^2.1.2 | ||
| --- a/fsevents.js | ||
| +++ b/fsevents.js | ||
| @@ -21,13 +21,10 @@ function watch(path, handler) { | ||
| throw new TypeError(`fsevents argument 2 must be a function and not a ${typeof handler}`); | ||
| } | ||
| - let instance = Native.start(path, handler); | ||
| - if (!instance) throw new Error(`could not watch: ${path}`); | ||
| + let VFS = require('./vfs'); | ||
| + let vfs = new VFS(path, Native); | ||
| + vfs.watch(handler); | ||
| return () => { | ||
| - const result = instance | ||
| - ? Promise.resolve(instance).then(Native.stop) | ||
| - : Promise.resolve(undefined); | ||
| - instance = undefined; | ||
| - return result; | ||
| + return vfs.stop(); | ||
| }; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,45 +2,108 @@ diff --git a/vfs.js b/vfs.js | |
| new file mode 100644 | ||
| --- /dev/null | ||
| +++ b/vfs.js | ||
| @@ -0,0 +1,104 @@ | ||
| +const path = require(`path`); | ||
| + | ||
| +function getPnpApi() { | ||
| + let pnpApi; | ||
| + try { | ||
| + if (process.versions.pnp) { | ||
| + pnpApi = require(`pnpapi`); | ||
|
There was a problem hiding this comment. @arcanis I am assuming calling |
||
| + } | ||
| + } catch (ex) {} | ||
| + return pnpApi; | ||
| +} | ||
| + | ||
| +function resolveVirtual(p) { | ||
| + const pnpapi = getPnpApi(); | ||
| + if (pnpapi) { | ||
| + const resolved = pnpapi.resolveVirtual(p); | ||
| + // pnp resolveVirtual will return null for non-virtual path. | ||
| + return resolved == null ? p : resolved; | ||
| + } | ||
| + return p; | ||
| +} | ||
| + | ||
| +function findVirtualPaths(root) { | ||
| + const paths = []; | ||
| + const pnpapi = getPnpApi(); | ||
| + if (pnpapi) { | ||
| + for (const locator of pnpapi.getDependencyTreeRoots()) { | ||
| + const pkg = pnpapi.getPackageInformation(locator); | ||
| + for (const [name, referencish] of pkg.packageDependencies) { | ||
| + if (referencish === null) continue; | ||
| + if (referencish.indexOf(`virtual:`) === 0) { | ||
| + const virtualLocator = pnpapi.getLocator(name, referencish); | ||
| + const virtualPkg = pnpapi.getPackageInformation(virtualLocator); | ||
| + if (virtualPkg && virtualPkg.packageLocation.indexOf(root) === 0) { | ||
| + // virtual path fall under root | ||
| + paths.push(virtualPkg.packageLocation); | ||
| + } | ||
| + } | ||
| + } | ||
| + } | ||
| + } | ||
| + return paths; | ||
| +} | ||
| + | ||
| +class VFS { | ||
| + constructor(p, Native) { | ||
| + this.root = path.resolve(p); | ||
| + this.native = Native; | ||
| + this.watchers = []; | ||
| + } | ||
| + | ||
| + transpose(rawPath, resolvedPath, p) { | ||
| + const transposePath = rawPath + p.substr(resolvedPath.length); | ||
| + return transposePath; | ||
| + } | ||
| + | ||
| + /** | ||
| + * build raw and resolved path mapping | ||
| + * @param {*} root | ||
| + */ | ||
| + buildPathMap() { | ||
| + const pathMap = new Map(); | ||
| + this.resolvedRoot = resolveVirtual(this.root); | ||
| + pathMap.set(this.resolvedRoot, this.root); | ||
| + if (!path.extname(this.root)) { | ||
| + // find all direct virtual paths for given root. | ||
| + const virtualPaths = findVirtualPaths(this.root); | ||
| + virtualPaths.forEach((virtualPath) => { | ||
| + const resolvedVirtual = resolveVirtual(virtualPath); | ||
| + if (resolvedVirtual.indexOf(this.resolvedRoot) < 0) { | ||
| + pathMap.set(resolvedVirtual, virtualPath); | ||
| + } | ||
| + }); | ||
| + } | ||
| + return pathMap; | ||
| + } | ||
| + | ||
| + watch(handler) { | ||
| + const pathMap = this.buildPathMap(); | ||
| + pathMap.forEach((virtualPath, resolvedPath) => { | ||
| + const watcher = this.native.start(resolvedPath, (p, ...args) => { | ||
| + return handler(this.transpose(virtualPath, resolvedPath, p), ...args); | ||
| + }); | ||
arcanis marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| + if (!watcher) throw new Error(`could not watch: ${resolvedPath}`); | ||
| + this.watchers.push(watcher); | ||
| + }); | ||
| + return this.watchers; | ||
| + } | ||
| + | ||
| + stop() { | ||
| + const results = this.watchers.map((watcher) => { | ||
| + const p = Promise.resolve(watcher); | ||
| + if (watcher) { | ||
| + p.then(this.native.stop); | ||
| + } | ||
| + return p; | ||
| + }); | ||
| + this.watchers = []; | ||
| + this.resolvedRoot = undefined; | ||
| + return results[0]; | ||
| + } | ||
| +} | ||
| + | ||
| +module.exports = VFS; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the API fsevents 1.x exposed makes it quite challenging to watch multiple files so I only watch the path file instead.( same behavior as current patch)