fix: make sources zip work with Yarn Berry

Author: rmn-mathieu-ezannic

packages/wxt/src/core/package-managers/__tests__/fixtures/simple-yarn-berry-project/.gitattributes

@@ -0,0 +1,4 @@
+/.yarn/**            linguist-vendored
+/.yarn/releases/*    binary
+/.yarn/plugins/**/*  binary
+/.pnp.*              binary linguist-generated

packages/wxt/src/core/package-managers/__tests__/fixtures/simple-yarn-berry-project/.gitignore

@@ -0,0 +1,13 @@
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+# Swap the comments on the following lines if you wish to use zero-installs
+# In that case, don't forget to run `yarn config set enableGlobalCache false`!
+# Documentation here: https://yarnpkg.com/features/caching#zero-installs
+
+#!.yarn/cache
+.pnp.*

packages/wxt/src/core/package-managers/__tests__/fixtures/simple-yarn-berry-project/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "yarn-berry-ls",
+  "packageManager": "yarn@4.4.0",
+  "dependencies": {
+    "mime-types": "2.1.35"
+  },
+  "devDependencies": {
+    "flatten": "1.0.3"
+  }
+}

packages/wxt/src/core/package-managers/__tests__/fixtures/simple-yarn-berry-project/yarn.lock

@@ -1,5 +1,5 @@
 {
-  "name": "yarn-ls",
+  "name": "yarn-classic-ls",
   "packageManager": "yarn@1.22.22",
   "dependencies": {
     "mime-types": "2.1.35"

packages/wxt/src/core/package-managers/__tests__/fixtures/simple-yarn-project/package.json renamed to packages/wxt/src/core/package-managers/__tests__/fixtures/simple-yarn-classic-project/package.json

@@ -3,8 +3,8 @@ import path from 'node:path';
 import { yarn } from '../yarn';
 
 describe('Yarn Package Management Utils', () => {
-  describe('listDependencies', () => {
-    const cwd = path.resolve(__dirname, 'fixtures/simple-yarn-project');
+  describe('listDependencies (Yarn 1 / Classic)', () => {
+    const cwd = path.resolve(__dirname, 'fixtures/simple-yarn-classic-project');
 
     it('should list direct dependencies', async () => {
       const actual = await yarn.listDependencies({ cwd });
@@ -24,4 +24,25 @@ describe('Yarn Package Management Utils', () => {
       ]);
     });
   });
+
+  describe('listDependencies (Yarn 2+ / Berry)', () => {
+    const cwd = path.resolve(__dirname, 'fixtures/simple-yarn-berry-project');
+
+    it('should list direct dependencies', async () => {
+      const actual = await yarn.listDependencies({ cwd });
+      expect(actual).toEqual([
+        { name: 'mime-types', version: 'npm:2.1.35' },
+        { name: 'flatten', version: 'npm:1.0.3' },
+      ]);
+    });
+
+    it('should list all dependencies', async () => {
+      const actual = await yarn.listDependencies({ cwd, all: true });
+      expect(actual).toEqual([
+        { name: 'mime-types', version: 'npm:2.1.35' },
+        { name: 'mime-db', version: 'npm:1.52.0' },
+        { name: 'flatten', version: 'npm:1.0.3' },
+      ]);
+    });
+  });
 });

packages/wxt/src/core/package-managers/__tests__/fixtures/simple-yarn-project/yarn.lock renamed to packages/wxt/src/core/package-managers/__tests__/fixtures/simple-yarn-classic-project/yarn.lock

@@ -1,8 +1,12 @@
+import { dirname, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+import { pathExists } from "fs-extra";
 import { Dependency } from '../../types';
 import { WxtPackageManagerImpl } from './types';
 import { dedupeDependencies, npm } from './npm';
 
-export const yarn: WxtPackageManagerImpl = {
+// Yarn 1 (Classic) package manager implementation
+export const yarnClassic: WxtPackageManagerImpl = {
   overridesKey: 'resolutions',
   downloadDependency(...args) {
     return npm.downloadDependency(...args);
@@ -39,6 +43,89 @@ export const yarn: WxtPackageManagerImpl = {
   },
 };
 
+// Returns the absolute path of the root directory of a Yarn Berry mono-repository
+const getMonorepoRootDir = async () => {
+  let monorepoRootDir = dirname(fileURLToPath(import.meta.url));
+  while (!(await pathExists(resolve(monorepoRootDir, "yarn.lock"))) && monorepoRootDir !== "/") {
+    monorepoRootDir = dirname(monorepoRootDir);
+  }
+  return monorepoRootDir;
+}
+
+// yarn 2+ (Berry) package manager implementation
+export const yarnBerry: WxtPackageManagerImpl = {
+  overridesKey: 'resolutions',
+  async downloadDependency(id: string, downloadDir: string) {
+    const { execa } = await import('execa');
+    if (!id.includes("@workspace:")) {
+      return npm.downloadDependency(id.replace('@npm:', '@'), downloadDir);
+    }
+    const monorepoRootDir = await getMonorepoRootDir();
+    const [dependencyName, dependencyDirRelativeToMonorepoRootDir] = id.split("@workspace:");
+    const dependencyDir = resolve(monorepoRootDir, dependencyDirRelativeToMonorepoRootDir);
+    const packedFilename = `${dependencyName.replace("@", "").replace("/", "-")}.tgz`;
+    const archivePath = resolve(downloadDir, packedFilename);
+    await execa('yarn', ['pack', '--out', archivePath], {
+      cwd: dependencyDir
+    });
+    return archivePath;
+  },
+  async listDependencies(options) {
+    const monorepoRootDir = await getMonorepoRootDir();
+    let currentWorkspace = '.';
+    if (monorepoRootDir !== '/' && options?.cwd?.startsWith(monorepoRootDir)) {
+      currentWorkspace = options.cwd.substring(monorepoRootDir.length);
+    }
+
+    const args = ['info', '--name-only', '--json'];
+    if (options?.all) {
+      args.push('--all');
+      args.push("--recursive");
+    }
+    const { execa } = await import('execa');
+    const res = await execa('yarn', args, { cwd: options?.cwd });
+    const lines = res.stdout.split('\n').map((line) => JSON.parse(line));
+
+    const dependencies: Dependency[] = [];
+
+    while (lines.length > 0) {
+      const line = lines.pop();
+      // example output formats
+      // - "foo@npm:0.0.1"
+      // - "@acme/foo@npm:1.2.3"
+      // - "@acme/bar@workspace:packages/bar"
+      // - "typescript@patch:typescript@npm%3A5.6.2#optional!builtin<compat/typescript>::version=5.6.2&hash=8c6c40"
+      const name = line.substring(0, line.substring(1).indexOf('@') + 1);
+      const version = line.substring(name.length + 1);
+      let isCurrentPackage = false;
+      if (version.startsWith('workspace:')) {
+        isCurrentPackage = version.substring('workspace:'.length) === currentWorkspace;
+      }
+      if (name === '' || version === '' || isCurrentPackage) continue;
+      dependencies.push({ name, version });
+    }
+
+    return dedupeDependencies(dependencies);
+  },
+};
+
+// Yarn 1 (Classic) and Yarn 2+ (Berry) have different CLI and output formats
+export const yarn: WxtPackageManagerImpl = {
+  overridesKey: 'resolutions',
+  async downloadDependency(id: string, downloadDir: string) {
+    const { execa } = await import('execa');
+    const execRes = await execa('yarn', ['--version']);
+    const _yarn = execRes.stdout.startsWith('1.') ? yarnClassic : yarnBerry;
+    return _yarn.downloadDependency(id, downloadDir);
+  },
+  async listDependencies(options) {
+    const { execa } = await import('execa');
+    const execRes = await execa('yarn', ['--version'], { cwd: options?.cwd });
+    const _yarn = execRes.stdout.startsWith('1.') ? yarnClassic : yarnBerry;
+    return _yarn.listDependencies(options);
+  }
+};
+
 type JsonLine =
   | { type: unknown; data: unknown }
   | { type: 'tree'; data: JsonLineTree };

packages/wxt/src/core/package-managers/__tests__/yarn.test.ts

@@ -177,7 +177,12 @@ async function downloadPrivatePackages() {
         wxt.config.zip.downloadedPackagesDir,
       );
       files.push(tgzPath);
-      overrides[id] = tgzPath;
+      // removes protocols that may cause issues with Yarn Berry
+      // FIXME: should we replace the version of the dependency listed in the
+      // dependencies / devDependencies fields of the package.json file with a
+      // link to the tgz file instead of using altered overrides entries?
+      const overrideKey = id.replace(/@(npm|workspace):.*$/, '');
+      overrides[overrideKey] = tgzPath;
     }
   }
 

packages/wxt/src/core/package-managers/yarn.ts

@@ -1438,7 +1438,8 @@ export interface WxtPackageManager extends Nypm.PackageManager {
   /**
    * Run `npm ls`, `pnpm ls`, or `bun pm ls`, or `yarn list` and return the results.
    *
-   * WARNING: Yarn always returns all dependencies
+   * WARNING: Yarn Classic always returns all dependencies
+   * WARNING: Yarn Berry prefixes dependency versions with a protocol name (such as `npm:` or `workspace:`)
    */
   listDependencies: (options?: {
     cwd?: string;