Expose TS type for onRequestError #67859

huozhi · 2024-07-17T15:59:50Z

What

Expose the TS types for onRequestError API

API

type RequestErrorContext = {
    routerKind: 'Pages Router' | 'App Router';
    routePath: string;
    routeType: 'render' | 'route' | 'action' | 'middleware';
    renderSource?: 'react-server-components' | 'react-server-components-payload' | 'server-rendering';
};

export declare namespace Instrumentation {
    type onRequestError = (error: unknown, errorRequest: Readonly<{
    method: string;
    url: string;
    headers: NodeJS.Dict<string | string[]>;
}>, errorContext: Readonly<RequestErrorContext>) => void | Promise<void>;

Usage

// instrumentation.ts
import { type Instrumentation } from 'next'

export const onRequestError: Instrumentation.onRequestError = (
  err,
  request,
  context
) => {
  //...
}

huozhi · 2024-07-17T16:00:11Z

Expose TS type for onRequestError #67859 👈
Drop the experimental env var for onRequestError API #67856
test: add dynamic routes and suspense test case for onRequestError #67848
canary

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

Join @huozhi and the rest of your teammates on Graphite

huozhi · 2024-07-17T19:34:31Z

Merge activity

Jul 17, 3:34 PM EDT: @huozhi started a stack merge that includes this pull request via Graphite.
Jul 17, 3:35 PM EDT: Graphite couldn't merge this pull request because a downstack PR Drop the experimental env var for onRequestError API #67856 failed to merge.

ijjk · 2024-07-17T19:47:08Z

Stats from current PR

Default Build (Increase detected ⚠️)

General

	vercel/next.js canary	vercel/next.js 07-17-expose_ts_type_of_onrequesterror	Change
buildDuration	17.4s	17.6s	⚠️ +143ms
buildDurationCached	8.9s	7.8s	N/A
nodeModulesSize	365 MB	365 MB	N/A
nextStartRea..uration (ms)	422ms	425ms	N/A

Client Bundles (main, webpack) Overall increase ⚠️

	vercel/next.js canary	vercel/next.js 07-17-expose_ts_type_of_onrequesterror	Change
1780.HASH.js gzip	167 B	167 B	✓
5453-HASH.js gzip	37.2 kB	37.3 kB	⚠️ +154 B
7514-HASH.js gzip	5.06 kB	5.05 kB	N/A
a7a62840-HASH.js gzip	51.7 kB	51.7 kB	N/A
framework-HASH.js gzip	56.7 kB	56.7 kB	N/A
main-app-HASH.js gzip	224 B	223 B	N/A
main-HASH.js gzip	32.2 kB	32.2 kB	N/A
webpack-HASH.js gzip	1.71 kB	1.71 kB	✓
Overall change	39 kB	39.2 kB	⚠️ +154 B

Legacy Client Bundles (polyfills)

	vercel/next.js canary	vercel/next.js 07-17-expose_ts_type_of_onrequesterror	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	vercel/next.js 07-17-expose_ts_type_of_onrequesterror	Change
_app-HASH.js gzip	193 B	193 B	✓
_error-HASH.js gzip	192 B	192 B	✓
amp-HASH.js gzip	508 B	510 B	N/A
css-HASH.js gzip	341 B	341 B	✓
dynamic-HASH.js gzip	2.52 kB	2.52 kB	✓
edge-ssr-HASH.js gzip	264 B	266 B	N/A
head-HASH.js gzip	362 B	363 B	N/A
hooks-HASH.js gzip	391 B	390 B	N/A
image-HASH.js gzip	4.26 kB	4.26 kB	N/A
index-HASH.js gzip	268 B	268 B	✓
link-HASH.js gzip	2.69 kB	2.69 kB	N/A
routerDirect..HASH.js gzip	326 B	325 B	N/A
script-HASH.js gzip	396 B	397 B	N/A
withRouter-HASH.js gzip	322 B	321 B	N/A
1afbb74e6ecf..834.css gzip	106 B	106 B	✓
Overall change	3.62 kB	3.62 kB	✓

Client Build Manifests

	vercel/next.js canary	vercel/next.js 07-17-expose_ts_type_of_onrequesterror	Change
_buildManifest.js gzip	484 B	485 B	N/A
Overall change	0 B	0 B	✓

Rendered Page Sizes

	vercel/next.js canary	vercel/next.js 07-17-expose_ts_type_of_onrequesterror	Change
index.html gzip	520 B	523 B	N/A
link.html gzip	534 B	537 B	N/A
withRouter.html gzip	517 B	519 B	N/A
Overall change	0 B	0 B	✓

Edge SSR bundle Size

	vercel/next.js canary	vercel/next.js 07-17-expose_ts_type_of_onrequesterror	Change
edge-ssr.js gzip	127 kB	127 kB	N/A
page.js gzip	167 kB	167 kB	N/A
Overall change	0 B	0 B	✓

Middleware size

	vercel/next.js canary	vercel/next.js 07-17-expose_ts_type_of_onrequesterror	Change
middleware-b..fest.js gzip	659 B	659 B	✓
middleware-r..fest.js gzip	156 B	155 B	N/A
middleware.js gzip	29.7 kB	29.7 kB	N/A
edge-runtime..pack.js gzip	1.03 kB	1.03 kB	✓
Overall change	1.69 kB	1.69 kB	✓

Next Runtimes

	vercel/next.js canary	vercel/next.js 07-17-expose_ts_type_of_onrequesterror	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	232 kB	232 kB	N/A
app-page-exp..prod.js gzip	119 kB	118 kB	N/A
app-page-tur..prod.js gzip	130 kB	130 kB	N/A
app-page-tur..prod.js gzip	126 kB	126 kB	N/A
app-page.run...dev.js gzip	227 kB	227 kB	N/A
app-page.run..prod.js gzip	115 kB	115 kB	N/A
app-route-ex...dev.js gzip	23.5 kB	23.5 kB	✓
app-route-ex..prod.js gzip	18.8 kB	18.8 kB	✓
app-route-tu..prod.js gzip	18.9 kB	18.9 kB	✓
app-route-tu..prod.js gzip	18.7 kB	18.7 kB	✓
app-route.ru...dev.js gzip	24.7 kB	24.7 kB	✓
app-route.ru..prod.js gzip	18.7 kB	18.7 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.1 kB	22.1 kB	✓
pages.runtim..prod.js gzip	21.6 kB	21.6 kB	✓
server.runti..prod.js gzip	56.7 kB	56.7 kB	N/A
Overall change	218 kB	218 kB	✓

build cache Overall increase ⚠️

	vercel/next.js canary	vercel/next.js 07-17-expose_ts_type_of_onrequesterror	Change
0.pack gzip	1.43 MB	1.43 MB	⚠️ +3.52 kB
index.pack gzip	119 kB	120 kB	⚠️ +284 B
Overall change	1.55 MB	1.55 MB	⚠️ +3.81 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],
   {
-    /***/ 1362: /***/ (
+    /***/ 9618: /***/ (
       __unused_webpack_module,
       __unused_webpack_exports,
       __webpack_require__
@@ -9,7 +9,7 @@
       (window.__NEXT_P = window.__NEXT_P || []).push([
         "/image",
         function () {
-          return __webpack_require__(2160);
+          return __webpack_require__(699);
         },
       ]);
       if (false) {
@@ -18,7 +18,7 @@
       /***/
     },
 
-    /***/ 537: /***/ (module, exports, __webpack_require__) => {
+    /***/ 9451: /***/ (module, exports, __webpack_require__) => {
       "use strict";
       /* __next_internal_client_entry_do_not_use__  cjs */
       Object.defineProperty(exports, "__esModule", {
@@ -40,15 +40,15 @@
         __webpack_require__(3537)
       );
       const _head = /*#__PURE__*/ _interop_require_default._(
-        __webpack_require__(7092)
+        __webpack_require__(6490)
       );
-      const _getimgprops = __webpack_require__(9834);
-      const _imageconfig = __webpack_require__(5676);
-      const _imageconfigcontextsharedruntime = __webpack_require__(387);
-      const _warnonce = __webpack_require__(451);
-      const _routercontextsharedruntime = __webpack_require__(5357);
+      const _getimgprops = __webpack_require__(3646);
+      const _imageconfig = __webpack_require__(535);
+      const _imageconfigcontextsharedruntime = __webpack_require__(4724);
+      const _warnonce = __webpack_require__(6321);
+      const _routercontextsharedruntime = __webpack_require__(1759);
       const _imageloader = /*#__PURE__*/ _interop_require_default._(
-        __webpack_require__(3945)
+        __webpack_require__(1882)
       );
       // This is replaced by webpack define plugin
       const configEnv = {
@@ -376,7 +376,7 @@
       /***/
     },
 
-    /***/ 9834: /***/ (
+    /***/ 3646: /***/ (
       __unused_webpack_module,
       exports,
       __webpack_require__
@@ -392,9 +392,9 @@
           return getImgProps;
         },
       });
-      const _warnonce = __webpack_require__(451);
-      const _imageblursvg = __webpack_require__(3547);
-      const _imageconfig = __webpack_require__(5676);
+      const _warnonce = __webpack_require__(6321);
+      const _imageblursvg = __webpack_require__(8297);
+      const _imageconfig = __webpack_require__(535);
       const VALID_LOADING_VALUES =
         /* unused pure expression or super */ null && [
           "lazy",
@@ -766,7 +766,7 @@
       /***/
     },
 
-    /***/ 3547: /***/ (__unused_webpack_module, exports) => {
+    /***/ 8297: /***/ (__unused_webpack_module, exports) => {
       "use strict";
       /**
        * A shared function, used on both client and server, to generate a SVG blur placeholder.
@@ -821,7 +821,7 @@
       /***/
     },
 
-    /***/ 6850: /***/ (
+    /***/ 973: /***/ (
       __unused_webpack_module,
       exports,
       __webpack_require__
@@ -848,10 +848,10 @@
         },
       });
       const _interop_require_default = __webpack_require__(4345);
-      const _getimgprops = __webpack_require__(9834);
-      const _imagecomponent = __webpack_require__(537);
+      const _getimgprops = __webpack_require__(3646);
+      const _imagecomponent = __webpack_require__(9451);
       const _imageloader = /*#__PURE__*/ _interop_require_default._(
-        __webpack_require__(3945)
+        __webpack_require__(1882)
       );
       function getImageProps(imgProps) {
         const { props } = (0, _getimgprops.getImgProps)(imgProps, {
@@ -883,7 +883,7 @@
       /***/
     },
 
-    /***/ 3945: /***/ (__unused_webpack_module, exports) => {
+    /***/ 1882: /***/ (__unused_webpack_module, exports) => {
       "use strict";
 
       Object.defineProperty(exports, "__esModule", {
@@ -918,7 +918,7 @@
       /***/
     },
 
-    /***/ 2160: /***/ (
+    /***/ 699: /***/ (
       __unused_webpack_module,
       __webpack_exports__,
       __webpack_require__
@@ -935,8 +935,8 @@
 
       // EXTERNAL MODULE: ./node_modules/.pnpm/[email protected]/node_modules/react/jsx-runtime.js
       var jsx_runtime = __webpack_require__(898);
-      // EXTERNAL MODULE: ./node_modules/.pnpm/next@file+..+main-repo+packages+next+next-packed.tgz_react-dom@19.0.0-rc-6230622a1a-20240610__zehaskxadtwcczqqbmt6koh6bq/node_modules/next/image.js
-      var next_image = __webpack_require__(6793);
+      // EXTERNAL MODULE: ./node_modules/.pnpm/next@file+..+diff-repo+packages+next+next-packed.tgz_react-dom@19.0.0-rc-6230622a1a-20240610__uulzbengwsfwhwaa2ambxampcy/node_modules/next/image.js
+      var next_image = __webpack_require__(1428);
       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",
@@ -966,12 +966,12 @@
       /***/
     },
 
-    /***/ 6793: /***/ (
+    /***/ 1428: /***/ (
       module,
       __unused_webpack_exports,
       __webpack_require__
     ) => {
-      module.exports = __webpack_require__(6850);
+      module.exports = __webpack_require__(973);
 
       /***/
     },
@@ -981,7 +981,7 @@
     /******/ var __webpack_exec__ = (moduleId) =>
       __webpack_require__((__webpack_require__.s = moduleId));
     /******/ __webpack_require__.O(0, [2888, 9774, 179], () =>
-      __webpack_exec__(1362)
+      __webpack_exec__(9618)
     );
     /******/ var __webpack_exports__ = __webpack_require__.O();
     /******/ _N_E = __webpack_exports__;

Diff for 5453-HASH.js

Diff too large to display

Diff for main-HASH.js

Diff too large to display

Diff for main-app-HASH.js

@@ -1,40 +1,37 @@
 (self["webpackChunk_N_E"] = self["webpackChunk_N_E"] || []).push([
   [1744],
   {
-    /***/ 1869: /***/ (
+    /***/ 1479: /***/ (
       __unused_webpack_module,
       __unused_webpack_exports,
       __webpack_require__
     ) => {
       Promise.resolve(/* import() eager */).then(
-        __webpack_require__.t.bind(__webpack_require__, 9276, 23)
+        __webpack_require__.t.bind(__webpack_require__, 3264, 23)
       );
       Promise.resolve(/* import() eager */).then(
-        __webpack_require__.t.bind(__webpack_require__, 5150, 23)
+        __webpack_require__.t.bind(__webpack_require__, 5407, 23)
       );
       Promise.resolve(/* import() eager */).then(
-        __webpack_require__.t.bind(__webpack_require__, 6978, 23)
+        __webpack_require__.t.bind(__webpack_require__, 6100, 23)
       );
       Promise.resolve(/* import() eager */).then(
-        __webpack_require__.t.bind(__webpack_require__, 4906, 23)
+        __webpack_require__.t.bind(__webpack_require__, 5681, 23)
       );
       Promise.resolve(/* import() eager */).then(
-        __webpack_require__.t.bind(__webpack_require__, 8622, 23)
+        __webpack_require__.t.bind(__webpack_require__, 3721, 23)
       );
       Promise.resolve(/* import() eager */).then(
-        __webpack_require__.t.bind(__webpack_require__, 1810, 23)
+        __webpack_require__.t.bind(__webpack_require__, 9640, 23)
       );
       Promise.resolve(/* import() eager */).then(
-        __webpack_require__.t.bind(__webpack_require__, 2140, 23)
+        __webpack_require__.t.bind(__webpack_require__, 9963, 23)
       );
       Promise.resolve(/* import() eager */).then(
-        __webpack_require__.t.bind(__webpack_require__, 7939, 23)
+        __webpack_require__.t.bind(__webpack_require__, 2882, 23)
       );
       Promise.resolve(/* import() eager */).then(
-        __webpack_require__.t.bind(__webpack_require__, 7995, 23)
-      );
-      Promise.resolve(/* import() eager */).then(
-        __webpack_require__.t.bind(__webpack_require__, 4493, 23)
+        __webpack_require__.t.bind(__webpack_require__, 5468, 23)
       );
 
       /***/
@@ -46,8 +43,8 @@
       __webpack_require__((__webpack_require__.s = moduleId));
     /******/ __webpack_require__.O(
       0,
-      [726, 5453],
-      () => (__webpack_exec__(3048), __webpack_exec__(1869))
+      [4295, 8268],
+      () => (__webpack_exec__(6186), __webpack_exec__(1479))
     );
     /******/ var __webpack_exports__ = __webpack_require__.O();
     /******/ _N_E = __webpack_exports__;

Diff for app-page-exp..ntime.dev.js

failed to diff

Diff for app-page-exp..time.prod.js

Diff too large to display

Diff for app-page-tur..time.prod.js

Diff too large to display

Diff for app-page-tur..time.prod.js

Diff too large to display

Diff for app-page.runtime.dev.js

failed to diff

Diff for app-page.runtime.prod.js

Diff too large to display

Diff for server.runtime.prod.js

Diff too large to display

Commit: cffc965

Expose TS type for onRequestError

cffc965

ijjk added created-by: Next.js team PRs by the Next.js team tests type: next labels Jul 17, 2024

huozhi mentioned this pull request Jul 17, 2024

test: add dynamic routes and suspense test case for onRequestError #67848

Merged

huozhi mentioned this pull request Jul 17, 2024

Drop the experimental env var for onRequestError API #67856

Merged

huozhi marked this pull request as ready for review July 17, 2024 16:38

huozhi requested review from unstubbable, ztanner, eps1lon, ijjk and delbaoliveira July 17, 2024 16:39

ijjk approved these changes Jul 17, 2024

View reviewed changes

huozhi merged commit 517f0e0 into 07-17-remove_the_experimental_env_var Jul 17, 2024
107 checks passed

huozhi deleted the 07-17-expose_ts_type_of_onrequesterror branch July 17, 2024 20:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Expose TS type for onRequestError #67859

Expose TS type for onRequestError #67859

huozhi commented Jul 17, 2024 •

edited

Loading

huozhi commented Jul 17, 2024 •

edited

Loading

huozhi commented Jul 17, 2024 •

edited

Loading

ijjk commented Jul 17, 2024

Expose TS type for onRequestError #67859

Expose TS type for onRequestError #67859

Conversation

huozhi commented Jul 17, 2024 • edited Loading

What

API

Usage

huozhi commented Jul 17, 2024 • edited Loading

huozhi commented Jul 17, 2024 • edited Loading

Merge activity

ijjk commented Jul 17, 2024

Stats from current PR

huozhi commented Jul 17, 2024 •

edited

Loading

huozhi commented Jul 17, 2024 •

edited

Loading

huozhi commented Jul 17, 2024 •

edited

Loading