Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: NPM Workspace throwsENOWORKSPACES error when fetching registry #68522

Merged
merged 8 commits into from
Aug 7, 2024

Conversation

devjiwonchoi
Copy link
Member

@devjiwonchoi devjiwonchoi commented Aug 5, 2024

Why?

This issue occurs when a project is NPM Workspace, and has no other package managers but NPM is installed.

Next.js runs npm config get registry to fetch the registry.
However, running npm config get registry at a NPM Workspace is not allowed resulting a ENOWORKSPACES error.

$ npm config get registry  
npm error code ENOWORKSPACES
npm error This command does not support workspaces.

As we didn't consume the error, it threw when the enabled next telemetry triggered getVersionInfo calling getRegistry which threw as above.

How?

Add --no-workspaces flag when the pkgManager is 'npm'.
It is safe for non-workspace projects as it's equivalent to default --workspaces=false.

Fixes #47121
Fixes NEXT-832
Fixes NDX-150

@ijjk ijjk added created-by: Next.js team PRs by the Next.js team. type: next labels Aug 5, 2024
Copy link
Member Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @devjiwonchoi and the rest of your teammates on Graphite Graphite

@ijjk
Copy link
Member

ijjk commented Aug 5, 2024

Tests Passed

Copy link
Member

@eps1lon eps1lon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should only swallow where we expect the error. We expect it in a very specific situation according to the PR desc so we should only swallow in those.

We should never swallow any error. There might be other runtime errors in here.

Co-authored-by: Sebastian Silbermann <silbermann.sebastian@gmail.com>
@devjiwonchoi devjiwonchoi marked this pull request as ready for review August 5, 2024 16:07
@devjiwonchoi devjiwonchoi changed the title fix: swallow error when fetching registry fix: NPM Workspace throwsENOWORKSPACES error when fetching registry Aug 5, 2024
@ijjk
Copy link
Member

ijjk commented Aug 5, 2024

Stats from current PR

Default Build (Increase detected ⚠️)
General
vercel/next.js canary vercel/next.js 08-05-fix_swallow_error_when_fetching_registry Change
buildDuration 16.9s 17.9s ⚠️ +997ms
buildDurationCached 8.7s 7.5s N/A
nodeModulesSize 352 MB 352 MB N/A
nextStartRea..uration (ms) 405ms 409ms N/A
Client Bundles (main, webpack)
vercel/next.js canary vercel/next.js 08-05-fix_swallow_error_when_fetching_registry Change
124-HASH.js gzip 37.3 kB 37.3 kB N/A
5121a57b-HASH.js gzip 51.9 kB 51.9 kB N/A
7480.HASH.js gzip 169 B 169 B
935-HASH.js gzip 5.19 kB 5.19 kB N/A
framework-HASH.js gzip 56.7 kB 56.7 kB
main-app-HASH.js gzip 224 B 225 B N/A
main-HASH.js gzip 32.1 kB 32.1 kB N/A
webpack-HASH.js gzip 1.71 kB 1.71 kB
Overall change 58.6 kB 58.6 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary vercel/next.js 08-05-fix_swallow_error_when_fetching_registry Change
polyfills-HASH.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary vercel/next.js 08-05-fix_swallow_error_when_fetching_registry Change
_app-HASH.js gzip 193 B 194 B N/A
_error-HASH.js gzip 193 B 192 B N/A
amp-HASH.js gzip 509 B 511 B N/A
css-HASH.js gzip 342 B 343 B N/A
dynamic-HASH.js gzip 1.84 kB 1.84 kB
edge-ssr-HASH.js gzip 265 B 266 B N/A
head-HASH.js gzip 362 B 364 B N/A
hooks-HASH.js gzip 393 B 393 B
image-HASH.js gzip 4.4 kB 4.4 kB
index-HASH.js gzip 268 B 267 B N/A
link-HASH.js gzip 2.81 kB 2.81 kB N/A
routerDirect..HASH.js gzip 329 B 327 B N/A
script-HASH.js gzip 395 B 396 B N/A
withRouter-HASH.js gzip 325 B 323 B N/A
1afbb74e6ecf..834.css gzip 106 B 106 B
Overall change 6.74 kB 6.74 kB
Client Build Manifests
vercel/next.js canary vercel/next.js 08-05-fix_swallow_error_when_fetching_registry Change
_buildManifest.js gzip 748 B 748 B
Overall change 748 B 748 B
Rendered Page Sizes
vercel/next.js canary vercel/next.js 08-05-fix_swallow_error_when_fetching_registry Change
index.html gzip 522 B 520 B N/A
link.html gzip 537 B 537 B
withRouter.html gzip 517 B 517 B
Overall change 1.05 kB 1.05 kB
Edge SSR bundle Size
vercel/next.js canary vercel/next.js 08-05-fix_swallow_error_when_fetching_registry Change
edge-ssr.js gzip 127 kB 127 kB N/A
page.js gzip 168 kB 168 kB N/A
Overall change 0 B 0 B
Middleware size
vercel/next.js canary vercel/next.js 08-05-fix_swallow_error_when_fetching_registry Change
middleware-b..fest.js gzip 668 B 667 B N/A
middleware-r..fest.js gzip 155 B 156 B N/A
middleware.js gzip 29.6 kB 29.6 kB N/A
edge-runtime..pack.js gzip 1.03 kB 1.03 kB
Overall change 1.03 kB 1.03 kB
Next Runtimes
vercel/next.js canary vercel/next.js 08-05-fix_swallow_error_when_fetching_registry Change
928-experime...dev.js gzip 310 B 310 B
928.runtime.dev.js gzip 301 B 301 B
app-page-exp...dev.js gzip 245 kB 245 kB
app-page-exp..prod.js gzip 120 kB 120 kB
app-page-tur..prod.js gzip 132 kB 132 kB
app-page-tur..prod.js gzip 128 kB 128 kB
app-page.run...dev.js gzip 232 kB 232 kB
app-page.run..prod.js gzip 117 kB 117 kB
app-route-ex...dev.js gzip 23.1 kB 23.1 kB
app-route-ex..prod.js gzip 18.8 kB 18.8 kB
app-route-tu..prod.js gzip 18.8 kB 18.8 kB
app-route-tu..prod.js gzip 18.6 kB 18.6 kB
app-route.ru...dev.js gzip 24.4 kB 24.4 kB
app-route.ru..prod.js gzip 18.6 kB 18.6 kB
pages-api-tu..prod.js gzip 9.6 kB 9.6 kB
pages-api.ru...dev.js gzip 9.87 kB 9.87 kB
pages-api.ru..prod.js gzip 9.59 kB 9.59 kB
pages-turbo...prod.js gzip 21.6 kB 21.6 kB
pages.runtim...dev.js gzip 22.2 kB 22.2 kB
pages.runtim..prod.js gzip 21.6 kB 21.6 kB
server.runti..prod.js gzip 56.8 kB 56.8 kB
Overall change 1.25 MB 1.25 MB
build cache Overall increase ⚠️
vercel/next.js canary vercel/next.js 08-05-fix_swallow_error_when_fetching_registry Change
0.pack gzip 1.41 MB 1.42 MB ⚠️ +3.65 kB
index.pack gzip 120 kB 121 kB ⚠️ +1.03 kB
Overall change 1.53 MB 1.54 MB ⚠️ +4.68 kB
Diff details
Diff for page.js

Diff too large to display

Diff for middleware.js

Diff too large to display

Diff for edge-ssr.js

Diff too large to display

Diff for image-HASH.js
@@ -1,7 +1,7 @@
 (self["webpackChunk_N_E"] = self["webpackChunk_N_E"] || []).push([
   [8358],
   {
-    /***/ 8316: /***/ (
+    /***/ 8834: /***/ (
       __unused_webpack_module,
       __unused_webpack_exports,
       __webpack_require__
@@ -9,7 +9,7 @@
       (window.__NEXT_P = window.__NEXT_P || []).push([
         "/image",
         function () {
-          return __webpack_require__(4765);
+          return __webpack_require__(5780);
         },
       ]);
       if (false) {
@@ -18,7 +18,7 @@
       /***/
     },
 
-    /***/ 1112: /***/ (module, exports, __webpack_require__) => {
+    /***/ 7481: /***/ (module, exports, __webpack_require__) => {
       "use strict";
       /* __next_internal_client_entry_do_not_use__  cjs */
       Object.defineProperty(exports, "__esModule", {
@@ -40,17 +40,17 @@
         __webpack_require__(5596)
       );
       const _head = /*#__PURE__*/ _interop_require_default._(
-        __webpack_require__(9382)
+        __webpack_require__(9639)
       );
-      const _getimgprops = __webpack_require__(2097);
-      const _imageconfig = __webpack_require__(8714);
-      const _imageconfigcontextsharedruntime = __webpack_require__(1327);
-      const _warnonce = __webpack_require__(6055);
-      const _routercontextsharedruntime = __webpack_require__(8275);
+      const _getimgprops = __webpack_require__(1607);
+      const _imageconfig = __webpack_require__(2867);
+      const _imageconfigcontextsharedruntime = __webpack_require__(1015);
+      const _warnonce = __webpack_require__(6694);
+      const _routercontextsharedruntime = __webpack_require__(9562);
       const _imageloader = /*#__PURE__*/ _interop_require_default._(
-        __webpack_require__(6067)
+        __webpack_require__(3463)
       );
-      const _usemergedref = __webpack_require__(1261);
+      const _usemergedref = __webpack_require__(1057);
       // This is replaced by webpack define plugin
       const configEnv = {
         deviceSizes: [640, 750, 828, 1080, 1200, 1920, 2048, 3840],
@@ -371,7 +371,7 @@
       /***/
     },
 
-    /***/ 1261: /***/ (module, exports, __webpack_require__) => {
+    /***/ 1057: /***/ (module, exports, __webpack_require__) => {
       "use strict";
 
       Object.defineProperty(exports, "__esModule", {
@@ -440,7 +440,7 @@
       /***/
     },
 
-    /***/ 2097: /***/ (
+    /***/ 1607: /***/ (
       __unused_webpack_module,
       exports,
       __webpack_require__
@@ -456,9 +456,9 @@
           return getImgProps;
         },
       });
-      const _warnonce = __webpack_require__(6055);
-      const _imageblursvg = __webpack_require__(9254);
-      const _imageconfig = __webpack_require__(8714);
+      const _warnonce = __webpack_require__(6694);
+      const _imageblursvg = __webpack_require__(9866);
+      const _imageconfig = __webpack_require__(2867);
       const VALID_LOADING_VALUES =
         /* unused pure expression or super */ null && [
           "lazy",
@@ -830,7 +830,7 @@
       /***/
     },
 
-    /***/ 9254: /***/ (__unused_webpack_module, exports) => {
+    /***/ 9866: /***/ (__unused_webpack_module, exports) => {
       "use strict";
       /**
        * A shared function, used on both client and server, to generate a SVG blur placeholder.
@@ -885,7 +885,7 @@
       /***/
     },
 
-    /***/ 9331: /***/ (
+    /***/ 3484: /***/ (
       __unused_webpack_module,
       exports,
       __webpack_require__
@@ -912,10 +912,10 @@
         },
       });
       const _interop_require_default = __webpack_require__(4345);
-      const _getimgprops = __webpack_require__(2097);
-      const _imagecomponent = __webpack_require__(1112);
+      const _getimgprops = __webpack_require__(1607);
+      const _imagecomponent = __webpack_require__(7481);
       const _imageloader = /*#__PURE__*/ _interop_require_default._(
-        __webpack_require__(6067)
+        __webpack_require__(3463)
       );
       function getImageProps(imgProps) {
         const { props } = (0, _getimgprops.getImgProps)(imgProps, {
@@ -947,7 +947,7 @@
       /***/
     },
 
-    /***/ 6067: /***/ (__unused_webpack_module, exports) => {
+    /***/ 3463: /***/ (__unused_webpack_module, exports) => {
       "use strict";
 
       Object.defineProperty(exports, "__esModule", {
@@ -982,7 +982,7 @@
       /***/
     },
 
-    /***/ 4765: /***/ (
+    /***/ 5780: /***/ (
       __unused_webpack_module,
       __webpack_exports__,
       __webpack_require__
@@ -999,8 +999,8 @@
 
       // EXTERNAL MODULE: ./node_modules/.pnpm/react@19.0.0-rc-06d0b89e-20240801/node_modules/react/jsx-runtime.js
       var jsx_runtime = __webpack_require__(3262);
-      // EXTERNAL MODULE: ./node_modules/.pnpm/next@file+..+main-repo+packages+next+next-packed.tgz_react-dom@19.0.0-rc-06d0b89e-20240801_re_432dyi3er6pnalgpduyz2i6axm/node_modules/next/image.js
-      var next_image = __webpack_require__(2692);
+      // EXTERNAL MODULE: ./node_modules/.pnpm/next@file+..+diff-repo+packages+next+next-packed.tgz_react-dom@19.0.0-rc-06d0b89e-20240801_re_wusbvjw3sleq6d7g7gklhdw6bm/node_modules/next/image.js
+      var next_image = __webpack_require__(8565);
       var image_default = /*#__PURE__*/ __webpack_require__.n(next_image); // CONCATENATED MODULE: ./pages/nextjs.png
       /* harmony default export */ const nextjs = {
         src: "/_next/static/media/nextjs.cae0b805.png",
@@ -1030,12 +1030,12 @@
       /***/
     },
 
-    /***/ 2692: /***/ (
+    /***/ 8565: /***/ (
       module,
       __unused_webpack_exports,
       __webpack_require__
     ) => {
-      module.exports = __webpack_require__(9331);
+      module.exports = __webpack_require__(3484);
 
       /***/
     },
@@ -1045,7 +1045,7 @@
     /******/ var __webpack_exec__ = (moduleId) =>
       __webpack_require__((__webpack_require__.s = moduleId));
     /******/ __webpack_require__.O(0, [2888, 9774, 179], () =>
-      __webpack_exec__(8316)
+      __webpack_exec__(8834)
     );
     /******/ var __webpack_exports__ = __webpack_require__.O();
     /******/ _N_E = __webpack_exports__;
Diff for 124-HASH.js

Diff too large to display

Diff for main-HASH.js

Diff too large to display

Commit: 50a3518

@eps1lon
Copy link
Member

eps1lon commented Aug 5, 2024

Shouldn't we instead use a separate function that ignores the npm config and use that in the specific instance were we errored? Silently ignoring the config will be hard to debug if we ignore the registry in a place where we shouldn't.

It's important to be very accurate here because regressions may remain undetected until months later somebody realizes some download is taking longer because we stopped using the configured registry.

@devjiwonchoi
Copy link
Member Author

devjiwonchoi commented Aug 6, 2024

@eps1lon What do you think of passing --no-workspace for non-workspaces?
I could just nest it down to the catch and add only if ENOWORKSPACES error.
prev-commit: 108f749

Co-authored-by: Sebastian Silbermann <silbermann.sebastian@gmail.com>
Comment on lines +12 to +16
// Since `npm config` command fails in npm workspace to prevent workspace config conflicts,
// add `--no-workspaces` flag to run under the context of the root project only.
// Safe for non-workspace projects as it's equivalent to default `--workspaces=false`.
// x-ref: https://github.com/vercel/next.js/issues/47121#issuecomment-1499044345
// x-ref: https://github.com/npm/statusboard/issues/371#issue-920669998
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New implementation has way more confidence given the explainer. This is valueable context, thank you!

@devjiwonchoi devjiwonchoi merged commit f17f570 into canary Aug 7, 2024
107 checks passed
@devjiwonchoi devjiwonchoi deleted the 08-05-fix_swallow_error_when_fetching_registry branch August 7, 2024 06:46
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[NEXT-832] Dev Server NPM error code ENOWORKSPACES
3 participants