@vercel/build-utils 8.0.0 → 8.1.1

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @vercel/build-utils
 
+## 8.1.1
+
+### Patch Changes
+
+- [build-utils] pnpm lockfile testing and fixing ([#11591](https://github.com/vercel/vercel/pull/11591))
+
+## 8.1.0
+
+### Minor Changes
+
+- Update pnpm version detection logic ([#11445](https://github.com/vercel/vercel/pull/11445))
+  Add support for pnpm 9
+
 ## 8.0.0
 
 ### Major Changes

package/dist/fs/run-user-scripts.d.ts

@@ -92,6 +92,32 @@ export declare function getEnvForPackageManager({ cliType, lockfileVersion, node
 }): {
     [x: string]: string | undefined;
 };
+/**
+ * Helper to get the binary paths that link to the used package manager.
+ * Note: Make sure it doesn't contain any `console.log` calls.
+ */
+export declare function getPathOverrideForPackageManager({ cliType, lockfileVersion, nodeVersion, env, }: {
+    cliType: CliType;
+    lockfileVersion: number | undefined;
+    nodeVersion: NodeVersion | undefined;
+    env: {
+        [x: string]: string | undefined;
+    };
+}): {
+    /**
+     * Which lockfile was detected.
+     */
+    detectedLockfile: string | undefined;
+    /**
+     * Detected package manager that generated the found lockfile.
+     */
+    detectedPackageManager: string | undefined;
+    /**
+     * Value of $PATH that includes the binaries for the detected package manager.
+     * Undefined if no $PATH are necessary.
+     */
+    path: string | undefined;
+};
 /**
  * Helper to get the binary paths that link to the used package manager.
  * Note: Make sure it doesn't contain any `console.log` calls.

package/dist/fs/run-user-scripts.js

@@ -34,6 +34,7 @@ __export(run_user_scripts_exports, {
   getNodeBinPaths: () => getNodeBinPaths,
   getNodeVersion: () => getNodeVersion,
   getPathForPackageManager: () => getPathForPackageManager,
+  getPathOverrideForPackageManager: () => getPathOverrideForPackageManager,
   getScriptName: () => getScriptName,
   getSpawnOptions: () => getSpawnOptions,
   installDependencies: () => installDependencies,
@@ -389,9 +390,8 @@ function getEnvForPackageManager({
   const {
     detectedLockfile,
     detectedPackageManager,
-    path: newPath,
-    yarnNodeLinker
-  } = getPathForPackageManager({
+    path: newPath
+  } = getPathOverrideForPackageManager({
     cliType,
     lockfileVersion,
     nodeVersion,
@@ -400,75 +400,152 @@ function getEnvForPackageManager({
   const newEnv = {
     ...env
   };
-  if (newPath) {
+  const alreadyInPath = (newPath2) => {
+    const oldPath = env.PATH ?? "";
+    return oldPath.split(import_path.default.delimiter).includes(newPath2);
+  };
+  if (newPath && !alreadyInPath(newPath)) {
     const oldPath = env.PATH + "";
     newEnv.PATH = `${newPath}${import_path.default.delimiter}${oldPath}`;
-  }
-  if (yarnNodeLinker) {
-    newEnv.YARN_NODE_LINKER = yarnNodeLinker;
-  }
-  if (detectedLockfile && detectedPackageManager) {
-    const versionString = cliType === "pnpm" ? `version ${lockfileVersion} ` : "";
-    console.log(
-      `Detected \`${detectedLockfile}\` ${versionString}generated by ${detectedPackageManager}`
-    );
-    if (cliType === "bun") {
-      console.warn(
-        "Warning: Bun is used as a package manager at build time only, not at runtime with Functions"
+    if (detectedLockfile && detectedPackageManager) {
+      const versionString = cliType === "pnpm" ? `version ${lockfileVersion} ` : "";
+      console.log(
+        `Detected \`${detectedLockfile}\` ${versionString}generated by ${detectedPackageManager}`
       );
+      if (cliType === "bun") {
+        console.warn(
+          "Warning: Bun is used as a package manager at build time only, not at runtime with Functions"
+        );
+      }
     }
   }
+  if (cliType === "yarn" && !env.YARN_NODE_LINKER) {
+    newEnv.YARN_NODE_LINKER = "node-modules";
+  }
   return newEnv;
 }
-function getPathForPackageManager({
+function detectPnpmVersion(lockfileVersion, corepackEnabled) {
+  switch (true) {
+    case corepackEnabled:
+      return "corepack_enabled";
+    case lockfileVersion === void 0:
+      return "not found";
+    case lockfileVersion === 5.3:
+      return "pnpm 6";
+    case lockfileVersion === 5.4:
+      return "pnpm 7";
+    case (lockfileVersion === 6 || lockfileVersion === 6.1):
+      return "pnpm 8";
+    case (lockfileVersion === 7 || lockfileVersion === 9):
+      return "pnpm 9";
+    default:
+      return "not found";
+  }
+}
+function shouldUseNpm7(lockfileVersion, nodeVersion) {
+  if (lockfileVersion === void 0)
+    return false;
+  return lockfileVersion >= 2 && (nodeVersion?.major || 0) < 16;
+}
+function getPathOverrideForPackageManager({
   cliType,
   lockfileVersion,
   nodeVersion,
   env
 }) {
-  let detectedLockfile;
-  let detectedPackageManager;
-  let pathValue;
-  let yarnNodeLinker;
-  const oldPath = env.PATH + "";
-  const npm7 = "/node16/bin-npm7";
-  const pnpm7 = "/pnpm7/node_modules/.bin";
-  const pnpm8 = "/pnpm8/node_modules/.bin";
-  const bun1 = "/bun1";
+  const no_override = {
+    detectedLockfile: void 0,
+    detectedPackageManager: void 0,
+    path: void 0
+  };
   const corepackEnabled = env.ENABLE_EXPERIMENTAL_COREPACK === "1";
-  if (cliType === "npm") {
-    if (typeof lockfileVersion === "number" && lockfileVersion >= 2 && (nodeVersion?.major || 0) < 16 && !oldPath.includes(npm7) && !corepackEnabled) {
-      pathValue = npm7;
-      detectedLockfile = "package-lock.json";
-      detectedPackageManager = "npm 7+";
-    }
-  } else if (cliType === "pnpm") {
-    if (typeof lockfileVersion === "number" && lockfileVersion === 5.4 && !oldPath.includes(pnpm7) && !corepackEnabled) {
-      pathValue = pnpm7;
-      detectedLockfile = "pnpm-lock.yaml";
-      detectedPackageManager = "pnpm 7";
-    } else if (typeof lockfileVersion === "number" && lockfileVersion >= 6 && !oldPath.includes(pnpm8) && !corepackEnabled) {
-      pathValue = pnpm8;
-      detectedLockfile = "pnpm-lock.yaml";
-      detectedPackageManager = "pnpm 8";
-    }
-  } else if (cliType === "bun") {
-    if (!oldPath.includes(bun1) && !corepackEnabled) {
-      pathValue = bun1;
-      detectedLockfile = "bun.lockb";
-      detectedPackageManager = "Bun";
-    }
-  } else {
-    if (!env.YARN_NODE_LINKER) {
-      yarnNodeLinker = "node-modules";
-    }
+  switch (cliType) {
+    case "npm":
+      switch (true) {
+        case corepackEnabled:
+          return no_override;
+        case shouldUseNpm7(lockfileVersion, nodeVersion):
+          return {
+            path: "/node16/bin-npm7",
+            detectedLockfile: "package-lock.json",
+            detectedPackageManager: "npm 7+"
+          };
+        default:
+          return no_override;
+      }
+    case "pnpm":
+      switch (detectPnpmVersion(lockfileVersion, corepackEnabled)) {
+        case "corepack_enabled":
+          return no_override;
+        case "pnpm 7":
+          return {
+            path: "/pnpm7/node_modules/.bin",
+            detectedLockfile: "pnpm-lock.yaml",
+            detectedPackageManager: "pnpm 7"
+          };
+        case "pnpm 8":
+          return {
+            path: "/pnpm8/node_modules/.bin",
+            detectedLockfile: "pnpm-lock.yaml",
+            detectedPackageManager: "pnpm 8"
+          };
+        case "pnpm 9":
+          return {
+            path: "/pnpm9/node_modules/.bin",
+            detectedLockfile: "pnpm-lock.yaml",
+            detectedPackageManager: "pnpm 9"
+          };
+        case "pnpm 6":
+        default:
+          return no_override;
+      }
+    case "bun":
+      switch (true) {
+        case corepackEnabled:
+          return no_override;
+        default:
+          return {
+            path: "/bun1",
+            detectedLockfile: "bun.lockb",
+            detectedPackageManager: "Bun"
+          };
+      }
+    case "yarn":
+      return no_override;
   }
-  return {
-    detectedLockfile,
-    detectedPackageManager,
-    path: pathValue,
-    yarnNodeLinker
+}
+function getPathForPackageManager({
+  cliType,
+  lockfileVersion,
+  nodeVersion,
+  env
+}) {
+  const overrides = getPathOverrideForPackageManager({
+    cliType,
+    lockfileVersion,
+    nodeVersion,
+    env
+  });
+  (0, import_debug.default)(
+    `Detected ${overrides.detectedPackageManager} with lockfileVersion ${lockfileVersion} (${typeof lockfileVersion}): ${overrides.path}`
+  );
+  const alreadyInPath = (newPath) => {
+    const oldPath = env.PATH ?? "";
+    return oldPath.split(import_path.default.delimiter).includes(newPath);
   };
+  switch (true) {
+    case (cliType === "yarn" && !env.YARN_NODE_LINKER):
+      return { ...overrides, yarnNodeLinker: "node-modules" };
+    case alreadyInPath(overrides.path ?? ""):
+      return {
+        detectedLockfile: void 0,
+        detectedPackageManager: void 0,
+        path: void 0,
+        yarnNodeLinker: void 0
+      };
+    default:
+      return { ...overrides, yarnNodeLinker: void 0 };
+  }
 }
 async function runCustomInstallCommand({
   destPath,
@@ -573,6 +650,7 @@ const installDependencies = (0, import_util.deprecate)(
   getNodeBinPaths,
   getNodeVersion,
   getPathForPackageManager,
+  getPathOverrideForPackageManager,
   getScriptName,
   getSpawnOptions,
   installDependencies,

package/dist/index.js

@@ -22112,9 +22112,8 @@ function getEnvForPackageManager({
   const {
     detectedLockfile,
     detectedPackageManager,
-    path: newPath,
-    yarnNodeLinker
-  } = getPathForPackageManager({
+    path: newPath
+  } = getPathOverrideForPackageManager({
     cliType,
     lockfileVersion,
     nodeVersion,
@@ -22123,75 +22122,152 @@ function getEnvForPackageManager({
   const newEnv = {
     ...env
   };
-  if (newPath) {
+  const alreadyInPath = (newPath2) => {
+    const oldPath = env.PATH ?? "";
+    return oldPath.split(import_path5.default.delimiter).includes(newPath2);
+  };
+  if (newPath && !alreadyInPath(newPath)) {
     const oldPath = env.PATH + "";
     newEnv.PATH = `${newPath}${import_path5.default.delimiter}${oldPath}`;
-  }
-  if (yarnNodeLinker) {
-    newEnv.YARN_NODE_LINKER = yarnNodeLinker;
-  }
-  if (detectedLockfile && detectedPackageManager) {
-    const versionString = cliType === "pnpm" ? `version ${lockfileVersion} ` : "";
-    console.log(
-      `Detected \`${detectedLockfile}\` ${versionString}generated by ${detectedPackageManager}`
-    );
-    if (cliType === "bun") {
-      console.warn(
-        "Warning: Bun is used as a package manager at build time only, not at runtime with Functions"
+    if (detectedLockfile && detectedPackageManager) {
+      const versionString = cliType === "pnpm" ? `version ${lockfileVersion} ` : "";
+      console.log(
+        `Detected \`${detectedLockfile}\` ${versionString}generated by ${detectedPackageManager}`
       );
+      if (cliType === "bun") {
+        console.warn(
+          "Warning: Bun is used as a package manager at build time only, not at runtime with Functions"
+        );
+      }
     }
   }
+  if (cliType === "yarn" && !env.YARN_NODE_LINKER) {
+    newEnv.YARN_NODE_LINKER = "node-modules";
+  }
   return newEnv;
 }
-function getPathForPackageManager({
+function detectPnpmVersion(lockfileVersion, corepackEnabled) {
+  switch (true) {
+    case corepackEnabled:
+      return "corepack_enabled";
+    case lockfileVersion === void 0:
+      return "not found";
+    case lockfileVersion === 5.3:
+      return "pnpm 6";
+    case lockfileVersion === 5.4:
+      return "pnpm 7";
+    case (lockfileVersion === 6 || lockfileVersion === 6.1):
+      return "pnpm 8";
+    case (lockfileVersion === 7 || lockfileVersion === 9):
+      return "pnpm 9";
+    default:
+      return "not found";
+  }
+}
+function shouldUseNpm7(lockfileVersion, nodeVersion) {
+  if (lockfileVersion === void 0)
+    return false;
+  return lockfileVersion >= 2 && (nodeVersion?.major || 0) < 16;
+}
+function getPathOverrideForPackageManager({
   cliType,
   lockfileVersion,
   nodeVersion,
   env
 }) {
-  let detectedLockfile;
-  let detectedPackageManager;
-  let pathValue;
-  let yarnNodeLinker;
-  const oldPath = env.PATH + "";
-  const npm7 = "/node16/bin-npm7";
-  const pnpm7 = "/pnpm7/node_modules/.bin";
-  const pnpm8 = "/pnpm8/node_modules/.bin";
-  const bun1 = "/bun1";
+  const no_override = {
+    detectedLockfile: void 0,
+    detectedPackageManager: void 0,
+    path: void 0
+  };
   const corepackEnabled = env.ENABLE_EXPERIMENTAL_COREPACK === "1";
-  if (cliType === "npm") {
-    if (typeof lockfileVersion === "number" && lockfileVersion >= 2 && (nodeVersion?.major || 0) < 16 && !oldPath.includes(npm7) && !corepackEnabled) {
-      pathValue = npm7;
-      detectedLockfile = "package-lock.json";
-      detectedPackageManager = "npm 7+";
-    }
-  } else if (cliType === "pnpm") {
-    if (typeof lockfileVersion === "number" && lockfileVersion === 5.4 && !oldPath.includes(pnpm7) && !corepackEnabled) {
-      pathValue = pnpm7;
-      detectedLockfile = "pnpm-lock.yaml";
-      detectedPackageManager = "pnpm 7";
-    } else if (typeof lockfileVersion === "number" && lockfileVersion >= 6 && !oldPath.includes(pnpm8) && !corepackEnabled) {
-      pathValue = pnpm8;
-      detectedLockfile = "pnpm-lock.yaml";
-      detectedPackageManager = "pnpm 8";
-    }
-  } else if (cliType === "bun") {
-    if (!oldPath.includes(bun1) && !corepackEnabled) {
-      pathValue = bun1;
-      detectedLockfile = "bun.lockb";
-      detectedPackageManager = "Bun";
-    }
-  } else {
-    if (!env.YARN_NODE_LINKER) {
-      yarnNodeLinker = "node-modules";
-    }
+  switch (cliType) {
+    case "npm":
+      switch (true) {
+        case corepackEnabled:
+          return no_override;
+        case shouldUseNpm7(lockfileVersion, nodeVersion):
+          return {
+            path: "/node16/bin-npm7",
+            detectedLockfile: "package-lock.json",
+            detectedPackageManager: "npm 7+"
+          };
+        default:
+          return no_override;
+      }
+    case "pnpm":
+      switch (detectPnpmVersion(lockfileVersion, corepackEnabled)) {
+        case "corepack_enabled":
+          return no_override;
+        case "pnpm 7":
+          return {
+            path: "/pnpm7/node_modules/.bin",
+            detectedLockfile: "pnpm-lock.yaml",
+            detectedPackageManager: "pnpm 7"
+          };
+        case "pnpm 8":
+          return {
+            path: "/pnpm8/node_modules/.bin",
+            detectedLockfile: "pnpm-lock.yaml",
+            detectedPackageManager: "pnpm 8"
+          };
+        case "pnpm 9":
+          return {
+            path: "/pnpm9/node_modules/.bin",
+            detectedLockfile: "pnpm-lock.yaml",
+            detectedPackageManager: "pnpm 9"
+          };
+        case "pnpm 6":
+        default:
+          return no_override;
+      }
+    case "bun":
+      switch (true) {
+        case corepackEnabled:
+          return no_override;
+        default:
+          return {
+            path: "/bun1",
+            detectedLockfile: "bun.lockb",
+            detectedPackageManager: "Bun"
+          };
+      }
+    case "yarn":
+      return no_override;
   }
-  return {
-    detectedLockfile,
-    detectedPackageManager,
-    path: pathValue,
-    yarnNodeLinker
+}
+function getPathForPackageManager({
+  cliType,
+  lockfileVersion,
+  nodeVersion,
+  env
+}) {
+  const overrides = getPathOverrideForPackageManager({
+    cliType,
+    lockfileVersion,
+    nodeVersion,
+    env
+  });
+  debug(
+    `Detected ${overrides.detectedPackageManager} with lockfileVersion ${lockfileVersion} (${typeof lockfileVersion}): ${overrides.path}`
+  );
+  const alreadyInPath = (newPath) => {
+    const oldPath = env.PATH ?? "";
+    return oldPath.split(import_path5.default.delimiter).includes(newPath);
   };
+  switch (true) {
+    case (cliType === "yarn" && !env.YARN_NODE_LINKER):
+      return { ...overrides, yarnNodeLinker: "node-modules" };
+    case alreadyInPath(overrides.path ?? ""):
+      return {
+        detectedLockfile: void 0,
+        detectedPackageManager: void 0,
+        path: void 0,
+        yarnNodeLinker: void 0
+      };
+    default:
+      return { ...overrides, yarnNodeLinker: void 0 };
+  }
 }
 async function runCustomInstallCommand({
   destPath,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/build-utils",
-  "version": "8.0.0",
+  "version": "8.1.1",
   "license": "Apache-2.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.js",