Include basePath in resolver cache file, instead of being external (microsoft#4906)

* [webpack-resolve] Expect basePath in resolver cache file

* [rush-resolve] Include basePath in resolver cache file

---------

Co-authored-by: David Michon <dmichon-msft@users.noreply.github.com>

Author: dmichon-msft

common/changes/@microsoft/rush/base-path_2024-08-27-21-36.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush",
+      "comment": "In rush-resolver-cache-plugin, include the base path in the resolver cache file.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush"
+}

common/changes/@rushstack/webpack-workspace-resolve-plugin/base-path_2024-08-27-21-36.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/webpack-workspace-resolve-plugin",
+      "comment": "Expect the base path to be part of the resolver cache file.",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@rushstack/webpack-workspace-resolve-plugin"
+}

common/reviews/api/webpack-workspace-resolve-plugin.api.md

@@ -20,6 +20,7 @@ export interface IResolveContext {
 
 // @beta
 export interface IResolverCacheFile {
+    basePath: string;
     contexts: ISerializedResolveContext[];
 }
 
@@ -35,7 +36,6 @@ export interface ISerializedResolveContext {
 export interface IWorkspaceLayoutCacheOptions {
     cacheData: IResolverCacheFile;
     resolverPathSeparator?: '/' | '\\';
-    workspaceRoot: string;
 }
 
 // @beta

rush-plugins/rush-resolver-cache-plugin/README.md

@@ -4,4 +4,4 @@ A Rush plugin that runs after successful dependency installation and generates a
 
 When this plugin is installed, it will produce a file called `resolver-cache.json` in the temp directory of the default subspace, e.g. `<repo>/common/temp/default/resolver-cache.json`
 
-To use this file, load it, call JSON.parse, and pass the result as the `cacheData` property to the `WorkspaceLayoutCache` constructor from `@rushstack/webpack-workspace-resolve-plugin`. The `workspaceRoot` property should be set to the path `<repo>`.
+To use this file, load it, call JSON.parse, and pass the result as the `cacheData` property to the `WorkspaceLayoutCache` constructor from `@rushstack/webpack-workspace-resolve-plugin`.

rush-plugins/rush-resolver-cache-plugin/src/computeResolverCacheFromLockfileAsync.ts

@@ -254,6 +254,7 @@ export async function computeResolverCacheFromLockfileAsync(
   );
 
   const cacheFile: IResolverCacheFile = {
+    basePath: commonPrefixToTrim,
     contexts: serializedContexts
   };
 

rush-plugins/rush-resolver-cache-plugin/src/test/__snapshots__/computeResolverCacheFromLockfileAsync.test.ts.snap

@@ -24,17 +24,17 @@ interface ITestCase {
 const TEST_CASES: readonly ITestCase[] = [
   {
     workspaceRoot: '/$root/common/temp/build-tests',
-    commonPrefixToTrim: '/$root',
+    commonPrefixToTrim: '/$root/',
     lockfileName: 'build-tests-subspace.yaml'
   },
   {
     workspaceRoot: '/$root/common/temp/default',
-    commonPrefixToTrim: '/$root',
+    commonPrefixToTrim: '/$root/',
     lockfileName: 'default-subspace.yaml'
   },
   {
     workspaceRoot: '/$root/common/temp/bundled-dependencies',
-    commonPrefixToTrim: '/$root',
+    commonPrefixToTrim: '/$root/',
     lockfileName: 'bundled-dependencies.yaml',
     afterExternalPackagesAsync: async (contexts: Map<string, IResolverContext>) => {
       for (const context of contexts.values()) {
@@ -105,7 +105,7 @@ describe(computeResolverCacheFromLockfileAsync.name, () => {
       for (const importerPath of lockfile.importers.keys()) {
         const remainder: string = importerPath.slice(importerPath.lastIndexOf('../') + 3);
         projectByImporterPath.setItem(importerPath, {
-          projectFolder: `${commonPrefixToTrim}/${remainder}`,
+          projectFolder: `${commonPrefixToTrim}${remainder}`,
           packageJson: {
             name: `@local/${remainder.replace(/\//g, '+')}`
           }

rush-plugins/rush-resolver-cache-plugin/src/test/computeResolverCacheFromLockfileAsync.test.ts

@@ -17,6 +17,14 @@ When using this plugin, the following options should be configured for your reso
 - `symlinks: false` - Since the cache knows the symlinks for package dependencies, you can avoid the cost of testing for other symlinks unless you are using additional symlinks.
 - `modules: []` - The cache should contain all information necessary to locate available dependencies for any arbitrary folder. If you need to allow resolution in other roots, you can add those, but omit `'node_modules'`.
 
+## Impact
+
+This plugin should eliminate file system calls associated with the following operations of NodeJS module resolution in webpack:
+- Find the nearest `package.json` to the calling module
+- Locate a named package from a calling module
+- Identify a `package.json` in a resolved directory
+- Find the nearest `package.json` to a resolved file path
+
 ## Limitations
 
 This plugin depends on the presence of a cache file in the workspace to function. Data in this cache file is assumed not to change while the webpack process is running.

webpack/webpack-workspace-resolve-plugin/README.md

@@ -37,6 +37,10 @@ export interface ISerializedResolveContext {
  * @beta
  */
 export interface IResolverCacheFile {
+  /**
+   * The base path. All paths in context entries are prefixed by this path.
+   */
+  basePath: string;
   /**
    * The ordered list of all contexts in the cache
    */
@@ -64,10 +68,6 @@ export interface IResolveContext {
  * @beta
  */
 export interface IWorkspaceLayoutCacheOptions {
-  /**
-   * The root folder of the workspace. All paths in the cache file are assumed to be relative to this folder.
-   */
-  workspaceRoot: string;
   /**
    * The parsed cache data. File reading is left as an exercise for the caller.
    */
@@ -114,12 +114,13 @@ export class WorkspaceLayoutCache {
   public readonly normalizeToPlatform: IPathNormalizationFunction;
 
   public constructor(options: IWorkspaceLayoutCacheOptions) {
-    const { workspaceRoot, cacheData, resolverPathSeparator = directorySeparator } = options;
+    const { cacheData, resolverPathSeparator = directorySeparator } = options;
 
     if (resolverPathSeparator !== '/' && resolverPathSeparator !== '\\') {
       throw new Error(`Unsupported directory separator: ${resolverPathSeparator}`);
     }
 
+    const { basePath } = cacheData;
     const resolveContexts: ResolveContext[] = [];
     const contextLookup: LookupByPath<IResolveContext> = new LookupByPath(undefined, resolverPathSeparator);
 
@@ -149,7 +150,7 @@ export class WorkspaceLayoutCache {
 
       public get descriptionFileRoot(): string {
         if (!this._descriptionFileRoot) {
-          this._descriptionFileRoot = `${workspaceRoot}${resolverPathSeparator}${
+          this._descriptionFileRoot = `${basePath}${
             normalizeToPlatform?.(this._serialized.root) ?? this._serialized.root
           }`;
         }

webpack/webpack-workspace-resolve-plugin/src/WorkspaceLayoutCache.ts

@@ -30,8 +30,8 @@ export function createResolveForTests(
   const fileSystem: Volume = new Volume();
 
   const cache: WorkspaceLayoutCache = new WorkspaceLayoutCache({
-    workspaceRoot: `${separator}workspace`,
     cacheData: {
+      basePath: `${separator}workspace${separator}`,
       contexts: [
         {
           root: 'a',