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

Jump to bottom

Add util for normalizing errors #33159

Merged
merged 7 commits into from Jan 11, 2022
Merged

Add util for normalizing errors #33159

merged 7 commits into from Jan 11, 2022

Conversation

ijjk
Copy link
Member

@ijjk ijjk commented Jan 10, 2022 •
edited

This is an alternative to #31866 which continues the work but adds a shared util and also ensures we don't lose context by unconditionally JSON.stringifying.

Bug

  • Related issues linked using fixes #number
  • Integration tests added
  • Errors have helpful link attached, see contributing.md

Fixes: #31670
Closes: #31866

@ijjk ijjk added created-by: Next.js team PRs by the Next.js team type: next labels Jan 10, 2022
@ijjk

This comment has been minimized.

Sign in to view
@ijjk ijjk marked this pull request as ready for review January 10, 2022 21:48
@mozeryansky mozeryansky mentioned this pull request Jan 10, 2022
Closed
@ijjk ijjk requested a review from styfle January 11, 2022 18:26
@ijjk ijjk requested a review from styfle January 11, 2022 20:12
@ijjk
Copy link
Member Author

ijjk commented Jan 11, 2022

Stats from current PR

Default Build (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary ijjk/next.js add/proper-error-util Change
buildDuration 15.1s 15s -31ms
buildDurationCached 3.3s 3.4s ⚠️ +69ms
nodeModulesSize 355 MB 355 MB ⚠️ +1.74 kB
Page Load Tests Overall decrease ⚠️
vercel/next.js canary ijjk/next.js add/proper-error-util Change
/ failed reqs 0 0 ✓
/ total time (seconds) 2.976 3.047 ⚠️ +0.07
/ avg req/sec 840.06 820.36 ⚠️ -19.7
/error-in-render failed reqs 0 0 ✓
/error-in-render total time (seconds) 1.382 1.426 ⚠️ +0.04
/error-in-render avg req/sec 1809.61 1752.65 ⚠️ -56.96
Client Bundles (main, webpack, commons) Overall increase ⚠️
vercel/next.js canary ijjk/next.js add/proper-error-util Change
450.HASH.js gzip 179 B 179 B ✓
framework-HASH.js gzip 42.2 kB 42.2 kB ✓
main-HASH.js gzip 27.1 kB 27.2 kB ⚠️ +144 B
webpack-HASH.js gzip 1.45 kB 1.45 kB ✓
Overall change 70.9 kB 71 kB ⚠️ +144 B
Legacy Client Bundles (polyfills)
vercel/next.js canary ijjk/next.js add/proper-error-util Change
polyfills-HASH.js gzip 31 kB 31 kB ✓
Overall change 31 kB 31 kB ✓
Client Pages
vercel/next.js canary ijjk/next.js add/proper-error-util Change
_app-HASH.js gzip 1.37 kB 1.37 kB ✓
_error-HASH.js gzip 194 B 194 B ✓
amp-HASH.js gzip 312 B 312 B ✓
css-HASH.js gzip 326 B 326 B ✓
dynamic-HASH.js gzip 2.37 kB 2.37 kB ✓
head-HASH.js gzip 350 B 350 B ✓
hooks-HASH.js gzip 919 B 919 B ✓
image-HASH.js gzip 4.74 kB 4.74 kB ✓
index-HASH.js gzip 263 B 263 B ✓
link-HASH.js gzip 2.13 kB 2.13 kB ✓
routerDirect..HASH.js gzip 321 B 321 B ✓
script-HASH.js gzip 383 B 383 B ✓
withRouter-HASH.js gzip 318 B 318 B ✓
85e02e95b279..7e3.css gzip 107 B 107 B ✓
Overall change 14.1 kB 14.1 kB ✓
Client Build Manifests
vercel/next.js canary ijjk/next.js add/proper-error-util Change
_buildManifest.js gzip 459 B 459 B ✓
Overall change 459 B 459 B ✓
Rendered Page Sizes Overall decrease ✓
vercel/next.js canary ijjk/next.js add/proper-error-util Change
index.html gzip 533 B 532 B -1 B
link.html gzip 547 B 546 B -1 B
withRouter.html gzip 528 B 527 B -1 B
Overall change 1.61 kB 1.6 kB -3 B

Diffs

Diff for main-HASH.js 
@@ -310,17 +310,6 @@
         });
         if (superClass) _setPrototypeOf(subClass, superClass);
       }
-      function _instanceof(left, right) {
-        if (
-          right != null &&
-          typeof Symbol !== "undefined" &&
-          right[Symbol.hasInstance]
-        ) {
-          return right[Symbol.hasInstance](left);
-        } else {
-          return left instanceof right;
-        }
-      }
       function _interopRequireDefault(obj) {
         return obj && obj.__esModule
           ? obj
@@ -484,7 +473,7 @@
       );
       var _routeAnnouncer = __webpack_require__(8982);
       var _router1 = __webpack_require__(387);
-      var _isError = _interopRequireDefault1(__webpack_require__(676));
+      var _isError = __webpack_require__(676);
       var _vitals = __webpack_require__(7813);
       var _refresh = __webpack_require__(7739);
       function asyncGeneratorStep(
@@ -916,9 +905,7 @@
                       _ctx.prev = 30;
                       _ctx.t1 = _ctx["catch"](3);
                       // This catches errors like throwing in the top level of a module
-                      initialErr = (0, _isError).default(_ctx.t1)
-                        ? _ctx.t1
-                        : new Error(_ctx.t1 + "");
+                      initialErr = (0, _isError).getProperError(_ctx.t1);
                     case 33:
                       if (false) {
                       }
@@ -1015,9 +1002,7 @@
                     case 9:
                       _ctx.prev = 9;
                       _ctx.t0 = _ctx["catch"](4);
-                      renderErr = _instanceof(_ctx.t0, Error)
-                        ? _ctx.t0
-                        : new Error(_ctx.t0 + "");
+                      renderErr = (0, _isError).getProperError(_ctx.t0);
                       if (!renderErr.cancelled) {
                         _ctx.next = 14;
                         break;
@@ -4156,7 +4141,7 @@
       exports["default"] = void 0;
       var _normalizeTrailingSlash = __webpack_require__(2392);
       var _routeLoader = __webpack_require__(2669);
-      var _isError = _interopRequireDefault1(__webpack_require__(676));
+      var _isError = _interopRequireWildcard(__webpack_require__(676));
       var _denormalizePagePath = __webpack_require__(4522);
       var _normalizeLocalePath = __webpack_require__(4317);
       var _mitt = _interopRequireDefault1(__webpack_require__(5660));
@@ -4175,6 +4160,30 @@
               default: obj
             };
       }
+      function _interopRequireWildcard(obj) {
+        if (obj && obj.__esModule) {
+          return obj;
+        } else {
+          var newObj = {};
+          if (obj != null) {
+            for (var key in obj) {
+              if (Object.prototype.hasOwnProperty.call(obj, key)) {
+                var desc =
+                  Object.defineProperty && Object.getOwnPropertyDescriptor
+                    ? Object.getOwnPropertyDescriptor(obj, key)
+                    : {};
+                if (desc.get || desc.set) {
+                  Object.defineProperty(newObj, key, desc);
+                } else {
+                  newObj[key] = obj[key];
+                }
+              }
+            }
+          }
+          newObj.default = obj;
+          return newObj;
+        }
+      }
       var detectDomainLocale;
       if (false) {
       }
@@ -5731,9 +5740,7 @@
                               return _ctx.abrupt(
                                 "return",
                                 this.handleRouteInfoError(
-                                  (0, _isError).default(_ctx.t1)
-                                    ? _ctx.t1
-                                    : new Error(_ctx.t1 + ""),
+                                  (0, _isError).getProperError(_ctx.t1),
                                   pathname,
                                   query,
                                   as,
@@ -9037,13 +9044,19 @@
       /***/
     },
 
-    /***/ 676: /***/ function(__unused_webpack_module, exports) {
+    /***/ 676: /***/ function(
+      __unused_webpack_module,
+      exports,
+      __webpack_require__
+    ) {
       "use strict";
 
       Object.defineProperty(exports, "__esModule", {
         value: true
       });
       exports["default"] = isError;
+      exports.getProperError = getProperError;
+      var _isPlainObject = __webpack_require__(2288);
       function isError(err) {
         return (
           typeof err === "object" &&
@@ -9052,12 +9065,48 @@
           "message" in err
         );
       }
+      function getProperError(err) {
+        if (isError(err)) {
+          return err;
+        }
+        if (false) {
+        }
+        return new Error(
+          (0, _isPlainObject).isPlainObject(err)
+            ? JSON.stringify(err)
+            : err + ""
+        );
+      }
 
       //# sourceMappingURL=is-error.js.map
 
       /***/
     },
 
+    /***/ 2288: /***/ function(__unused_webpack_module, exports) {
+      "use strict";
+
+      Object.defineProperty(exports, "__esModule", {
+        value: true
+      });
+      exports.getObjectClassLabel = getObjectClassLabel;
+      exports.isPlainObject = isPlainObject;
+      function getObjectClassLabel(value) {
+        return Object.prototype.toString.call(value);
+      }
+      function isPlainObject(value) {
+        if (getObjectClassLabel(value) !== "[object Object]") {
+          return false;
+        }
+        const prototype = Object.getPrototypeOf(value);
+        return prototype === null || prototype === Object.prototype;
+      }
+
+      //# sourceMappingURL=is-plain-object.js.map
+
+      /***/
+    },
+
     /***/ 4522: /***/ function(
       __unused_webpack_module,
       exports,
Diff for index.html 
@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-80c8b12ed145074f.js"
+      src="/_next/static/chunks/main-4503571de4c37bda.js"
       defer=""
     ></script>
     <script
Diff for link.html 
@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-80c8b12ed145074f.js"
+      src="/_next/static/chunks/main-4503571de4c37bda.js"
       defer=""
     ></script>
     <script
Diff for withRouter.html 
@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-80c8b12ed145074f.js"
+      src="/_next/static/chunks/main-4503571de4c37bda.js"
       defer=""
     ></script>
     <script
Default Build with SWC (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary ijjk/next.js add/proper-error-util Change
buildDuration 16.5s 16.4s -83ms
buildDurationCached 3.3s 3.3s ⚠️ +64ms
nodeModulesSize 355 MB 355 MB ⚠️ +1.74 kB
Page Load Tests Overall decrease ⚠️
vercel/next.js canary ijjk/next.js add/proper-error-util Change
/ failed reqs 0 0 ✓
/ total time (seconds) 2.972 3.009 ⚠️ +0.04
/ avg req/sec 841.25 830.8 ⚠️ -10.45
/error-in-render failed reqs 0 0 ✓
/error-in-render total time (seconds) 1.373 1.389 ⚠️ +0.02
/error-in-render avg req/sec 1821.1 1799.96 ⚠️ -21.14
Client Bundles (main, webpack, commons) Overall increase ⚠️
vercel/next.js canary ijjk/next.js add/proper-error-util Change
450.HASH.js gzip 179 B 179 B ✓
framework-HASH.js gzip 42.3 kB 42.3 kB ✓
main-HASH.js gzip 27.2 kB 27.3 kB ⚠️ +108 B
webpack-HASH.js gzip 1.44 kB 1.44 kB ✓
Overall change 71.1 kB 71.2 kB ⚠️ +108 B
Legacy Client Bundles (polyfills)
vercel/next.js canary ijjk/next.js add/proper-error-util Change
polyfills-HASH.js gzip 31 kB 31 kB ✓
Overall change 31 kB 31 kB ✓
Client Pages
vercel/next.js canary ijjk/next.js add/proper-error-util Change
_app-HASH.js gzip 1.35 kB 1.35 kB ✓
_error-HASH.js gzip 180 B 180 B ✓
amp-HASH.js gzip 305 B 305 B ✓
css-HASH.js gzip 321 B 321 B ✓
dynamic-HASH.js gzip 2.36 kB 2.36 kB ✓
head-HASH.js gzip 342 B 342 B ✓
hooks-HASH.js gzip 906 B 906 B ✓
image-HASH.js gzip 4.76 kB 4.76 kB ✓
index-HASH.js gzip 256 B 256 B ✓
link-HASH.js gzip 2.19 kB 2.19 kB ✓
routerDirect..HASH.js gzip 314 B 314 B ✓
script-HASH.js gzip 375 B 375 B ✓
withRouter-HASH.js gzip 309 B 309 B ✓
85e02e95b279..7e3.css gzip 107 B 107 B ✓
Overall change 14.1 kB 14.1 kB ✓
Client Build Manifests
vercel/next.js canary ijjk/next.js add/proper-error-util Change
_buildManifest.js gzip 458 B 458 B ✓
Overall change 458 B 458 B ✓
Rendered Page Sizes Overall decrease ✓
vercel/next.js canary ijjk/next.js add/proper-error-util Change
index.html gzip 532 B 531 B -1 B
link.html gzip 545 B 544 B -1 B
withRouter.html gzip 526 B 526 B ✓
Overall change 1.6 kB 1.6 kB -2 B

Diffs

Diff for main-HASH.js 
@@ -310,17 +310,6 @@
         });
         if (superClass) _setPrototypeOf(subClass, superClass);
       }
-      function _instanceof(left, right) {
-        if (
-          right != null &&
-          typeof Symbol !== "undefined" &&
-          right[Symbol.hasInstance]
-        ) {
-          return right[Symbol.hasInstance](left);
-        } else {
-          return left instanceof right;
-        }
-      }
       function _interopRequireDefault(obj) {
         return obj && obj.__esModule
           ? obj
@@ -484,7 +473,7 @@
       );
       var _routeAnnouncer = __webpack_require__(8982);
       var _router1 = __webpack_require__(387);
-      var _isError = _interopRequireDefault1(__webpack_require__(676));
+      var _isError = __webpack_require__(676);
       var _vitals = __webpack_require__(7813);
       var _refresh = __webpack_require__(7739);
       function asyncGeneratorStep(
@@ -916,9 +905,7 @@
                       _ctx.prev = 30;
                       _ctx.t1 = _ctx["catch"](3);
                       // This catches errors like throwing in the top level of a module
-                      initialErr = (0, _isError).default(_ctx.t1)
-                        ? _ctx.t1
-                        : new Error(_ctx.t1 + "");
+                      initialErr = (0, _isError).getProperError(_ctx.t1);
                     case 33:
                       if (false) {
                       }
@@ -1015,9 +1002,7 @@
                     case 9:
                       _ctx.prev = 9;
                       _ctx.t0 = _ctx["catch"](4);
-                      renderErr = _instanceof(_ctx.t0, Error)
-                        ? _ctx.t0
-                        : new Error(_ctx.t0 + "");
+                      renderErr = (0, _isError).getProperError(_ctx.t0);
                       if (!renderErr.cancelled) {
                         _ctx.next = 14;
                         break;
@@ -4156,7 +4141,7 @@
       exports["default"] = void 0;
       var _normalizeTrailingSlash = __webpack_require__(2392);
       var _routeLoader = __webpack_require__(2669);
-      var _isError = _interopRequireDefault1(__webpack_require__(676));
+      var _isError = _interopRequireWildcard(__webpack_require__(676));
       var _denormalizePagePath = __webpack_require__(4522);
       var _normalizeLocalePath = __webpack_require__(4317);
       var _mitt = _interopRequireDefault1(__webpack_require__(5660));
@@ -4175,6 +4160,30 @@
               default: obj
             };
       }
+      function _interopRequireWildcard(obj) {
+        if (obj && obj.__esModule) {
+          return obj;
+        } else {
+          var newObj = {};
+          if (obj != null) {
+            for (var key in obj) {
+              if (Object.prototype.hasOwnProperty.call(obj, key)) {
+                var desc =
+                  Object.defineProperty && Object.getOwnPropertyDescriptor
+                    ? Object.getOwnPropertyDescriptor(obj, key)
+                    : {};
+                if (desc.get || desc.set) {
+                  Object.defineProperty(newObj, key, desc);
+                } else {
+                  newObj[key] = obj[key];
+                }
+              }
+            }
+          }
+          newObj.default = obj;
+          return newObj;
+        }
+      }
       var detectDomainLocale;
       if (false) {
       }
@@ -5731,9 +5740,7 @@
                               return _ctx.abrupt(
                                 "return",
                                 this.handleRouteInfoError(
-                                  (0, _isError).default(_ctx.t1)
-                                    ? _ctx.t1
-                                    : new Error(_ctx.t1 + ""),
+                                  (0, _isError).getProperError(_ctx.t1),
                                   pathname,
                                   query,
                                   as,
@@ -9037,13 +9044,19 @@
       /***/
     },
 
-    /***/ 676: /***/ function(__unused_webpack_module, exports) {
+    /***/ 676: /***/ function(
+      __unused_webpack_module,
+      exports,
+      __webpack_require__
+    ) {
       "use strict";
 
       Object.defineProperty(exports, "__esModule", {
         value: true
       });
       exports["default"] = isError;
+      exports.getProperError = getProperError;
+      var _isPlainObject = __webpack_require__(2288);
       function isError(err) {
         return (
           typeof err === "object" &&
@@ -9052,12 +9065,48 @@
           "message" in err
         );
       }
+      function getProperError(err) {
+        if (isError(err)) {
+          return err;
+        }
+        if (false) {
+        }
+        return new Error(
+          (0, _isPlainObject).isPlainObject(err)
+            ? JSON.stringify(err)
+            : err + ""
+        );
+      }
 
       //# sourceMappingURL=is-error.js.map
 
       /***/
     },
 
+    /***/ 2288: /***/ function(__unused_webpack_module, exports) {
+      "use strict";
+
+      Object.defineProperty(exports, "__esModule", {
+        value: true
+      });
+      exports.getObjectClassLabel = getObjectClassLabel;
+      exports.isPlainObject = isPlainObject;
+      function getObjectClassLabel(value) {
+        return Object.prototype.toString.call(value);
+      }
+      function isPlainObject(value) {
+        if (getObjectClassLabel(value) !== "[object Object]") {
+          return false;
+        }
+        const prototype = Object.getPrototypeOf(value);
+        return prototype === null || prototype === Object.prototype;
+      }
+
+      //# sourceMappingURL=is-plain-object.js.map
+
+      /***/
+    },
+
     /***/ 4522: /***/ function(
       __unused_webpack_module,
       exports,
Diff for index.html 
@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-80c8b12ed145074f.js"
+      src="/_next/static/chunks/main-4503571de4c37bda.js"
       defer=""
     ></script>
     <script
Diff for link.html 
@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-80c8b12ed145074f.js"
+      src="/_next/static/chunks/main-4503571de4c37bda.js"
       defer=""
     ></script>
     <script
Diff for withRouter.html 
@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-80c8b12ed145074f.js"
+      src="/_next/static/chunks/main-4503571de4c37bda.js"
       defer=""
     ></script>
     <script
Commit: c0dae27

styfle
styfle approved these changes Jan 11, 2022
View reviewed changes
Copy link
Member

@styfle styfle left a comment

Choose a reason for hiding this comment

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

Great, thanks! 🎉

@ijjk ijjk merged commit 57a8705 into vercel:canary Jan 11, 2022
@ijjk ijjk deleted the add/proper-error-util branch January 11, 2022 20:40
teleaziz added a commit to teleaziz/next.js that referenced this pull request Jan 12, 2022
@teleaziz
Merge branch 'canary' of github.com:vercel/next.js into cms-builder-i…
7c161cf 
…o-example

* 'canary' of github.com:vercel/next.js:
  Added links to data fetching api refs, fixed title (vercel#33221)
  Removed backticks on data fetching api titles (vercel#33216)
  middlewares: limit `process.env` to inferred usage (vercel#33186)
  Fixed broken link (vercel#33209)
  v12.0.8
  v12.0.8-canary.22
  Refactor data fetching API docs (vercel#30615)
  Docs: correct ignorance pattern for .env.local (vercel#32647)
  Fixes vercel#33153: Updating cross-references from master to main + canary (vercel#33198)
  v12.0.8-canary.21
  Add util for normalizing errors (vercel#33159)
  Fix broken yarn pnp (vercel#32867)
@tfkhim tfkhim mentioned this pull request Jan 14, 2022
Closed
@vercel vercel locked as resolved and limited conversation to collaborators Feb 11, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@mozeryansky mozeryansky mozeryansky left review comments

@styfle styfle styfle approved these changes

@huozhi huozhi Awaiting requested review from huozhi huozhi is a code owner

@shuding shuding Awaiting requested review from shuding shuding is a code owner

@timneutkens timneutkens Awaiting requested review from timneutkens timneutkens is a code owner

Assignees
No one assigned
Labels
created-by: Next.js team PRs by the Next.js team type: next
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Custom error object appears as [Object object]
3 participants
@ijjk @styfle @mozeryansky