@vercel/build-utils 8.3.8 → 8.4.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @vercel/build-utils
 
+## 8.4.0
+
+### Minor Changes
+
+- Change warnings to errors in invalid corepack package manager states ([#12062](https://github.com/vercel/vercel/pull/12062))
+
+## 8.3.9
+
+### Patch Changes
+
+- Provide help when users get ERR_PNPM_UNSUPPORTED_ENGINE errors without corepack ([#12034](https://github.com/vercel/vercel/pull/12034))
+
+- Fix package-manager-warning-1 to happen only happen in correct cases ([#12050](https://github.com/vercel/vercel/pull/12050))
+
 ## 8.3.8
 
 ### Patch Changes

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

@@ -124,10 +124,22 @@ export declare function detectPackageManager(cliType: CliType, lockfileVersion:
     path: string;
     detectedLockfile: string;
     detectedPackageManager: string;
+    pnpmVersionRange: string;
 } | {
     path: undefined;
     detectedLockfile: string;
     detectedPackageManager: string;
+    pnpmVersionRange: string;
+} | {
+    path: string;
+    detectedLockfile: string;
+    detectedPackageManager: string;
+    pnpmVersionRange?: undefined;
+} | {
+    path: undefined;
+    detectedLockfile: string;
+    detectedPackageManager: string;
+    pnpmVersionRange?: undefined;
 } | undefined;
 /**
  * Helper to get the binary paths that link to the used package manager.

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

@@ -524,35 +524,47 @@ function getPathOverrideForPackageManager({
 }) {
   const detectedPackageManger = detectPackageManager(cliType, lockfileVersion);
   if (!corepackPackageManager || !corepackEnabled) {
+    if (cliType === "pnpm" && packageJsonEngines?.pnpm) {
+      checkEnginesPnpmAgainstDetected(
+        packageJsonEngines.pnpm,
+        detectedPackageManger
+      );
+    }
     return detectedPackageManger ?? NO_OVERRIDE;
   }
-  if (!validateCorepackPackageManager(
+  validateCorepackPackageManager(
     cliType,
     lockfileVersion,
     corepackPackageManager,
     packageJsonEngines?.pnpm
-  )) {
-    console.warn(
-      `WARN [package-manager-warning-1] Detected lockfile "${lockfileVersion}" which is not compatible with the intended corepack package manager "${corepackPackageManager}". Update your lockfile or change to a compatible corepack version.`
-    );
-  }
+  );
   return NO_OVERRIDE;
 }
+function checkEnginesPnpmAgainstDetected(enginesPnpm, detectedPackageManger) {
+  if (detectedPackageManger?.pnpmVersionRange && (0, import_semver.validRange)(detectedPackageManger.pnpmVersionRange) && (0, import_semver.validRange)(enginesPnpm)) {
+    if (!(0, import_semver.intersects)(detectedPackageManger.pnpmVersionRange, enginesPnpm)) {
+      throw new Error(
+        `Detected pnpm "${detectedPackageManger.pnpmVersionRange}" is not compatible with the engines.pnpm "${enginesPnpm}" in your package.json. Either enable corepack with a valid package.json#packageManager value (https://vercel.com/docs/deployments/configure-a-build#corepack) or remove your package.json#engines.pnpm.`
+      );
+    }
+  }
+  console.warn(
+    `Using package.json#engines.pnpm without corepack and package.json#packageManager could lead to failed builds with ERR_PNPM_UNSUPPORTED_ENGINE. Learn more: https://vercel.com/docs/errors/error-list#pnpm-engine-unsupported`
+  );
+}
 function validateCorepackPackageManager(cliType, lockfileVersion, corepackPackageManager, enginesPnpmVersionRange) {
   const validatedCorepackPackageManager = validateVersionSpecifier(
     corepackPackageManager
   );
   if (!validatedCorepackPackageManager) {
-    console.warn(
-      `WARN [package-manager-warning-2] Intended corepack defined package manager "${corepackPackageManager}" is not a valid semver value.`
+    throw new Error(
+      `Intended corepack defined package manager "${corepackPackageManager}" is not a valid semver value.`
     );
-    return false;
   }
   if (cliType !== validatedCorepackPackageManager.packageName) {
-    console.warn(
-      `WARN [package-manager-warning-3] Detected package manager "${cliType}" does not match intended corepack defined package manager "${validatedCorepackPackageManager.packageName}". Change your lockfile or "package.json#packageManager" value to match.`
+    throw new Error(
+      `Detected package manager "${cliType}" does not match intended corepack defined package manager "${validatedCorepackPackageManager.packageName}". Change your lockfile or "package.json#packageManager" value to match.`
     );
-    return false;
   }
   if (cliType === "pnpm" && enginesPnpmVersionRange) {
     const pnpmWithinEngineRange = (0, import_semver.satisfies)(
@@ -566,13 +578,16 @@ function validateCorepackPackageManager(cliType, lockfileVersion, corepackPackag
     }
   }
   if (lockfileVersion) {
-    return validLockfileForPackageManager(
+    const lockfileValid = validLockfileForPackageManager(
       cliType,
       lockfileVersion,
       validatedCorepackPackageManager.packageVersion
     );
-  } else {
-    return true;
+    if (!lockfileValid) {
+      throw new Error(
+        `Detected lockfile "${lockfileVersion}" which is not compatible with the intended corepack package manager "${corepackPackageManager}". Update your lockfile or change to a compatible corepack version.`
+      );
+    }
   }
 }
 function validateVersionSpecifier(version) {
@@ -608,26 +623,30 @@ function detectPackageManager(cliType, lockfileVersion) {
           return {
             path: "/pnpm7/node_modules/.bin",
             detectedLockfile: "pnpm-lock.yaml",
-            detectedPackageManager: "pnpm@7.x"
+            detectedPackageManager: "pnpm@7.x",
+            pnpmVersionRange: "7.x"
           };
         case "pnpm 8":
           return {
             path: "/pnpm8/node_modules/.bin",
             detectedLockfile: "pnpm-lock.yaml",
-            detectedPackageManager: "pnpm@8.x"
+            detectedPackageManager: "pnpm@8.x",
+            pnpmVersionRange: "8.x"
           };
         case "pnpm 9":
           return {
             path: "/pnpm9/node_modules/.bin",
             detectedLockfile: "pnpm-lock.yaml",
-            detectedPackageManager: "pnpm@9.x"
+            detectedPackageManager: "pnpm@9.x",
+            pnpmVersionRange: "9.x"
           };
         case "pnpm 6":
           return {
             // undefined because pnpm@6 is the current default in the build container
             path: void 0,
             detectedLockfile: "pnpm-lock.yaml",
-            detectedPackageManager: "pnpm@6.x"
+            detectedPackageManager: "pnpm@6.x",
+            pnpmVersionRange: "6.x"
           };
         default:
           return void 0;

package/dist/index.js

@@ -22245,35 +22245,47 @@ function getPathOverrideForPackageManager({
 }) {
   const detectedPackageManger = detectPackageManager(cliType, lockfileVersion);
   if (!corepackPackageManager || !corepackEnabled) {
+    if (cliType === "pnpm" && packageJsonEngines?.pnpm) {
+      checkEnginesPnpmAgainstDetected(
+        packageJsonEngines.pnpm,
+        detectedPackageManger
+      );
+    }
     return detectedPackageManger ?? NO_OVERRIDE;
   }
-  if (!validateCorepackPackageManager(
+  validateCorepackPackageManager(
     cliType,
     lockfileVersion,
     corepackPackageManager,
     packageJsonEngines?.pnpm
-  )) {
-    console.warn(
-      `WARN [package-manager-warning-1] Detected lockfile "${lockfileVersion}" which is not compatible with the intended corepack package manager "${corepackPackageManager}". Update your lockfile or change to a compatible corepack version.`
-    );
-  }
+  );
   return NO_OVERRIDE;
 }
+function checkEnginesPnpmAgainstDetected(enginesPnpm, detectedPackageManger) {
+  if (detectedPackageManger?.pnpmVersionRange && (0, import_semver2.validRange)(detectedPackageManger.pnpmVersionRange) && (0, import_semver2.validRange)(enginesPnpm)) {
+    if (!(0, import_semver2.intersects)(detectedPackageManger.pnpmVersionRange, enginesPnpm)) {
+      throw new Error(
+        `Detected pnpm "${detectedPackageManger.pnpmVersionRange}" is not compatible with the engines.pnpm "${enginesPnpm}" in your package.json. Either enable corepack with a valid package.json#packageManager value (https://vercel.com/docs/deployments/configure-a-build#corepack) or remove your package.json#engines.pnpm.`
+      );
+    }
+  }
+  console.warn(
+    `Using package.json#engines.pnpm without corepack and package.json#packageManager could lead to failed builds with ERR_PNPM_UNSUPPORTED_ENGINE. Learn more: https://vercel.com/docs/errors/error-list#pnpm-engine-unsupported`
+  );
+}
 function validateCorepackPackageManager(cliType, lockfileVersion, corepackPackageManager, enginesPnpmVersionRange) {
   const validatedCorepackPackageManager = validateVersionSpecifier(
     corepackPackageManager
   );
   if (!validatedCorepackPackageManager) {
-    console.warn(
-      `WARN [package-manager-warning-2] Intended corepack defined package manager "${corepackPackageManager}" is not a valid semver value.`
+    throw new Error(
+      `Intended corepack defined package manager "${corepackPackageManager}" is not a valid semver value.`
     );
-    return false;
   }
   if (cliType !== validatedCorepackPackageManager.packageName) {
-    console.warn(
-      `WARN [package-manager-warning-3] Detected package manager "${cliType}" does not match intended corepack defined package manager "${validatedCorepackPackageManager.packageName}". Change your lockfile or "package.json#packageManager" value to match.`
+    throw new Error(
+      `Detected package manager "${cliType}" does not match intended corepack defined package manager "${validatedCorepackPackageManager.packageName}". Change your lockfile or "package.json#packageManager" value to match.`
     );
-    return false;
   }
   if (cliType === "pnpm" && enginesPnpmVersionRange) {
     const pnpmWithinEngineRange = (0, import_semver2.satisfies)(
@@ -22287,13 +22299,16 @@ function validateCorepackPackageManager(cliType, lockfileVersion, corepackPackag
     }
   }
   if (lockfileVersion) {
-    return validLockfileForPackageManager(
+    const lockfileValid = validLockfileForPackageManager(
       cliType,
       lockfileVersion,
       validatedCorepackPackageManager.packageVersion
     );
-  } else {
-    return true;
+    if (!lockfileValid) {
+      throw new Error(
+        `Detected lockfile "${lockfileVersion}" which is not compatible with the intended corepack package manager "${corepackPackageManager}". Update your lockfile or change to a compatible corepack version.`
+      );
+    }
   }
 }
 function validateVersionSpecifier(version) {
@@ -22329,26 +22344,30 @@ function detectPackageManager(cliType, lockfileVersion) {
           return {
             path: "/pnpm7/node_modules/.bin",
             detectedLockfile: "pnpm-lock.yaml",
-            detectedPackageManager: "pnpm@7.x"
+            detectedPackageManager: "pnpm@7.x",
+            pnpmVersionRange: "7.x"
           };
         case "pnpm 8":
           return {
             path: "/pnpm8/node_modules/.bin",
             detectedLockfile: "pnpm-lock.yaml",
-            detectedPackageManager: "pnpm@8.x"
+            detectedPackageManager: "pnpm@8.x",
+            pnpmVersionRange: "8.x"
           };
         case "pnpm 9":
           return {
             path: "/pnpm9/node_modules/.bin",
             detectedLockfile: "pnpm-lock.yaml",
-            detectedPackageManager: "pnpm@9.x"
+            detectedPackageManager: "pnpm@9.x",
+            pnpmVersionRange: "9.x"
           };
         case "pnpm 6":
           return {
             // undefined because pnpm@6 is the current default in the build container
             path: void 0,
             detectedLockfile: "pnpm-lock.yaml",
-            detectedPackageManager: "pnpm@6.x"
+            detectedPackageManager: "pnpm@6.x",
+            pnpmVersionRange: "6.x"
           };
         default:
           return void 0;

package/package.json

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