fix(core): handle self referencing workspaces field (#5917)

**What's the problem this PR addresses?**

`Workspace.getRecursiveWorkspaceChildren` throws `Range Error: Maximum
call stack size exceeded` when it encounters a workspace more than once.

Fixes #5799

**How did you fix it?**

Use a `Set` to keep track of the workspaces that have been found.

**Checklist**
- [x] I have read the [Contributing
Guide](https://yarnpkg.com/advanced/contributing).
- [x] I have set the packages that need to be released for my changes to
be effective.
- [x] I will check that all automated PR checks pass before the PR gets
reviewed.

(cherry picked from commit 32979f3)

Author: merceyz

.yarn/versions/4b66efea.yml

@@ -0,0 +1,34 @@
+releases:
+  "@yarnpkg/cli": patch
+  "@yarnpkg/core": patch
+
+declined:
+  - "@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-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/doctor"
+  - "@yarnpkg/extensions"
+  - "@yarnpkg/nm"
+  - "@yarnpkg/pnpify"
+  - "@yarnpkg/sdks"

packages/acceptance-tests/pkg-tests-specs/sources/commands/workspaces/__snapshots__/foreach.test.js.snap

@@ -40,9 +40,9 @@ Object {
   "stdout": "Test Workspace B
 Test Workspace C
 Test Workspace D
-Test Workspace E
 Test Workspace F
 Test Workspace G
+Test Workspace E
 Done
 ",
 }
@@ -55,9 +55,9 @@ Object {
   "stdout": "Test Workspace B
 Test Workspace C
 Test Workspace D
-Test Workspace E
 Test Workspace F
 Test Workspace G
+Test Workspace E
 Done
 ",
 }
@@ -146,17 +146,17 @@ Object {
 [workspace-d]: Test Workspace D
 [workspace-d]: Process exited (exit code 0)
 
-[workspace-e]: Process started
-[workspace-e]: Test Workspace E
-[workspace-e]: Process exited (exit code 0)
-
 [workspace-f]: Process started
 [workspace-f]: Test Workspace F
 [workspace-f]: Process exited (exit code 0)
 
 [workspace-g]: Process started
 [workspace-g]: Test Workspace G
 [workspace-g]: Process exited (exit code 0)
+
+[workspace-e]: Process started
+[workspace-e]: Test Workspace E
+[workspace-e]: Process exited (exit code 0)
 Done
 ",
 }
@@ -170,9 +170,9 @@ Object {
 Test Workspace B
 Test Workspace C
 Test Workspace D
-Test Workspace E
 Test Workspace F
 Test Workspace G
+Test Workspace E
 Done
 ",
 }
@@ -186,9 +186,9 @@ Object {
 Test Workspace B
 Test Workspace C
 Test Workspace D
-Test Workspace E
 Test Workspace F
 Test Workspace G
+Test Workspace E
 Done
 ",
 }
@@ -230,17 +230,17 @@ Object {
 [workspace-d]: Test Workspace D
 [workspace-d]: Process exited (exit code 0)
 
-[workspace-e]: Process started
-[workspace-e]: Test Workspace E
-[workspace-e]: Process exited (exit code 0)
-
 [workspace-f]: Process started
 [workspace-f]: Test Workspace F
 [workspace-f]: Process exited (exit code 0)
 
 [workspace-g]: Process started
 [workspace-g]: Test Workspace G
 [workspace-g]: Process exited (exit code 0)
+
+[workspace-e]: Process started
+[workspace-e]: Test Workspace E
+[workspace-e]: Process exited (exit code 0)
 Done
 ",
 }
@@ -269,9 +269,9 @@ Object {
   "stderr": "",
   "stdout": "Test Workspace C
 Test Workspace D
-Test Workspace E
 Test Workspace F
 Test Workspace G
+Test Workspace E
 Done
 ",
 }
@@ -303,9 +303,9 @@ packages/workspace-a
 packages/workspace-b
 packages/workspace-c
 packages/workspace-c/packages/workspace-d
-packages/workspace-c/packages/workspace-d/packages/workspace-e
 packages/workspace-c/packages/workspace-f
 packages/workspace-c/packages/workspace-g
+packages/workspace-c/packages/workspace-d/packages/workspace-e
 Done
 ",
 }

packages/acceptance-tests/pkg-tests-specs/sources/commands/workspaces/foreach.test.js

@@ -110,6 +110,28 @@ describe(`Commands`, () => {
       ),
     );
 
+    test(
+      `should support self referencing workspaces field`,
+      makeTemporaryEnv(
+        {
+          private: true,
+          workspaces: [`.`],
+        },
+        async ({path, run}) => {
+          await writeFile(`${path}/.yarnrc.yml`, `plugins:\n  - ${JSON.stringify(require.resolve(`@yarnpkg/monorepo/scripts/plugin-workspace-tools.js`))}\n`);
+          await run(`install`);
+
+          await expect(run(`workspaces`, `foreach`, `exec`, `echo`, `42`)).resolves.toMatchObject(
+            {
+              code: 0,
+              stdout: `42\nDone\n`,
+              stderr: ``,
+            },
+          );
+        },
+      ),
+    );
+
     test(
       `should execute 'node' command`,
       makeTemporaryEnv(

packages/yarnpkg-core/sources/Workspace.ts

@@ -202,17 +202,21 @@ export class Workspace {
    * @returns all the child workspaces
    */
   getRecursiveWorkspaceChildren() {
-    const workspaceList: Array<Workspace> = [];
+    const workspaceSet = new Set<Workspace>([this]);
 
-    for (const childWorkspaceCwd of this.workspacesCwds) {
-      const childWorkspace = this.project.workspacesByCwd.get(childWorkspaceCwd);
+    for (const workspace of workspaceSet) {
+      for (const childWorkspaceCwd of workspace.workspacesCwds) {
+        const childWorkspace = this.project.workspacesByCwd.get(childWorkspaceCwd);
 
-      if (childWorkspace) {
-        workspaceList.push(childWorkspace, ...childWorkspace.getRecursiveWorkspaceChildren());
+        if (childWorkspace) {
+          workspaceSet.add(childWorkspace);
+        }
       }
     }
 
-    return workspaceList;
+    workspaceSet.delete(this);
+
+    return Array.from(workspaceSet);
   }
 
   async persistManifest() {