Add enableWorkspacePatternAnalysis configuration option

Author: joverbye-atlassian

.yarn/versions/607ebb1b.yml

@@ -0,0 +1,36 @@
+releases:
+  "@yarnpkg/core": patch
+
+declined:
+  - "@yarnpkg/plugin-catalog"
+  - "@yarnpkg/plugin-compat"
+  - "@yarnpkg/plugin-constraints"
+  - "@yarnpkg/plugin-dlx"
+  - "@yarnpkg/plugin-essentials"
+  - "@yarnpkg/plugin-exec"
+  - "@yarnpkg/plugin-file"
+  - "@yarnpkg/plugin-git"
+  - "@yarnpkg/plugin-github"
+  - "@yarnpkg/plugin-http"
+  - "@yarnpkg/plugin-init"
+  - "@yarnpkg/plugin-interactive-tools"
+  - "@yarnpkg/plugin-jsr"
+  - "@yarnpkg/plugin-link"
+  - "@yarnpkg/plugin-nm"
+  - "@yarnpkg/plugin-npm"
+  - "@yarnpkg/plugin-npm-cli"
+  - "@yarnpkg/plugin-pack"
+  - "@yarnpkg/plugin-patch"
+  - "@yarnpkg/plugin-pnp"
+  - "@yarnpkg/plugin-pnpm"
+  - "@yarnpkg/plugin-stage"
+  - "@yarnpkg/plugin-typescript"
+  - "@yarnpkg/plugin-version"
+  - "@yarnpkg/plugin-workspace-tools"
+  - "@yarnpkg/builder"
+  - "@yarnpkg/cli"
+  - "@yarnpkg/doctor"
+  - "@yarnpkg/extensions"
+  - "@yarnpkg/nm"
+  - "@yarnpkg/pnpify"
+  - "@yarnpkg/sdks"

packages/acceptance-tests/pkg-tests-specs/sources/commands/patchCommit.test.ts

@@ -114,7 +114,7 @@ describe(`Commands`, () => {
         });
 
         expect(manifest.resolutions).toEqual({
-        [`no-deps@npm:1.0.0`]: expect.stringMatching(/^patch:no-deps/),
+          [`no-deps@npm:1.0.0`]: expect.stringMatching(/^patch:no-deps/),
         });
       }),
     );

packages/acceptance-tests/pkg-tests-specs/sources/workspace.test.ts

@@ -35,6 +35,27 @@ describe(`Workspaces tests`, () => {
     }),
   );
 
+  test(
+    `it should support basic glob patterns with enableWorkspacePatternAnalysis`,
+    makeTemporaryMonorepoEnv({
+      workspaces: [
+        `packages/*`,
+      ],
+    }, {
+      [`packages/foo`]: {},
+      [`packages/bar`]: {},
+      [`packages/baz`]: {},
+    }, async ({path, run, source}) => {
+      await run(`config`, `set`, `enableWorkspacePatternAnalysis`, `true`);
+      await expect(getWorkspaces(run)).resolves.toStrictEqual([
+        `.`,
+        `packages/bar`,
+        `packages/baz`,
+        `packages/foo`,
+      ]);
+    }),
+  );
+
   test(
     `it should support negated glob patterns`,
     makeTemporaryMonorepoEnv({
@@ -55,6 +76,27 @@ describe(`Workspaces tests`, () => {
     }),
   );
 
+  test(
+    `it should support negated glob patterns with enableWorkspacePatternAnalysis`,
+    makeTemporaryMonorepoEnv({
+      workspaces: [
+        `packages/*`,
+        `!packages/foo`,
+      ],
+    }, {
+      [`packages/foo`]: {},
+      [`packages/bar`]: {},
+      [`packages/baz`]: {},
+    }, async ({path, run, source}) => {
+      await run(`config`, `set`, `enableWorkspacePatternAnalysis`, `true`);
+      await expect(getWorkspaces(run)).resolves.toStrictEqual([
+        `.`,
+        `packages/bar`,
+        `packages/baz`,
+      ]);
+    }),
+  );
+
   test(
     `it should not implicitly make workspaces require-able`,
     makeTemporaryEnv(

packages/yarnpkg-core/sources/Configuration.ts

@@ -348,6 +348,11 @@ export const coreDefinitions: {[coreSettingName: string]: SettingsDefinition} =
     type: SettingsType.STRING,
     default: `npm:`,
   },
+  enableWorkspacePatternAnalysis: {
+    description: `If true, optimizes workspace pattern matching by separating static and dynamic globs for better performance when using mostly static patterns.`,
+    type: SettingsType.BOOLEAN,
+    default: false,
+  },
   enableTransparentWorkspaces: {
     description: `If false, Yarn won't automatically resolve workspace dependencies unless they use the \`workspace:\` protocol`,
     type: SettingsType.BOOLEAN,

packages/yarnpkg-core/sources/Workspace.ts

@@ -48,19 +48,46 @@ export class Workspace {
     // @ts-expect-error: It's ok to initialize it now, even if it's readonly (setup is called right after construction)
     this.anchoredLocator = structUtils.makeLocator(ident, `${WorkspaceResolver.protocol}${this.relativeCwd}`);
 
-    const patterns = this.manifest.workspaceDefinitions.map(({pattern}) => pattern);
+    const workspaceDefinitionPatterns = this.manifest.workspaceDefinitions.map(({pattern}) => pattern);
 
-    if (patterns.length === 0)
+    if (workspaceDefinitionPatterns.length === 0)
       return;
 
-    const relativeCwds = await fastGlob(patterns, {
+    const getOptimizedRelativeCwds = async () => {
+      const staticPatterns: Array<string> = [];
+      const dynamicPatterns: Array<string> = [];
+
+      workspaceDefinitionPatterns.forEach(pattern => {
+        if (fastGlob.isDynamicPattern(pattern)) {
+          dynamicPatterns.push(pattern);
+        } else {
+          staticPatterns.push(pattern);
+        }
+      });
+
+      const globResults = dynamicPatterns.length > 0
+        ? await resolveGlobPatterns(dynamicPatterns)
+        : [];
+
+      // fast-glob returns results in arbitrary order
+      return [...staticPatterns, ...globResults].sort();
+    };
+
+    const getStandardRelativeCwds = async () => {
+      const relativeCwds = await resolveGlobPatterns(workspaceDefinitionPatterns);
+      // fast-glob returns results in arbitrary order
+      return relativeCwds.sort();
+    };
+
+    const resolveGlobPatterns = async (globPatterns: Array<string>) => fastGlob(globPatterns, {
       cwd: npath.fromPortablePath(this.cwd),
       onlyDirectories: true,
       ignore: [`**/node_modules`, `**/.git`, `**/.yarn`],
     });
 
-    // fast-glob returns results in arbitrary order
-    relativeCwds.sort();
+    const relativeCwds = this.project.configuration.get(`enableWorkspacePatternAnalysis`) ?
+      await getOptimizedRelativeCwds() :
+      await getStandardRelativeCwds();
 
     await relativeCwds.reduce(async (previousTask, relativeCwd) => {
       const candidateCwd = ppath.resolve(this.cwd, npath.toPortablePath(relativeCwd));