feat: support isr reason for on request error (#68845)

### What

Provide `revalidateReason` in the `errorContext` argument of
`onRequestError` API

#### API

```ts
revalidateReason?: 'on-demand' | 'stale' | undefined
```

### Why

With this property, developer is able to determine if current error is
attached to an ISR request.

* `stale` means it revalidated due to the cache is expired
* `on-demand` means it revalidated due to a user initiated revalidation,
e.g. using `res.revalidate` to revalidate certain path

### Misc

* We don't generate edge entry of instrumentation when there's no edge
routes but instrumentation is presented

Note: for PPR case we'll tackle it later with another PPR specific task,
since we need to provide the render is a postpone render or just normal
render

Closes NDX-23

Author: huozhi

packages/next/src/build/entries.ts

@@ -792,6 +792,12 @@ export async function createEntrypoints(
 
   await Promise.all(promises)
 
+  // Optimization: If there's only one instrumentation hook in edge compiler, which means there's no edge server entry.
+  // We remove the edge instrumentation entry from edge compiler as it can be pure server side.
+  if (edgeServer.instrumentation && Object.keys(edgeServer).length === 1) {
+    delete edgeServer.instrumentation
+  }
+
   return {
     client,
     server,

packages/next/src/build/templates/middleware.ts

@@ -40,6 +40,7 @@ function errorHandledHandler(fn: AdapterOptions['handler']) {
           routerKind: 'Pages Router',
           routePath: '/middleware',
           routeType: 'middleware',
+          revalidateReason: undefined,
         }
       )
 

packages/next/src/server/api-utils/node/api-resolver.ts

@@ -441,6 +441,7 @@ export async function apiResolver(
       routerKind: 'Pages Router',
       routePath: page || '',
       routeType: 'route',
+      revalidateReason: undefined,
     })
 
     if (err instanceof ApiError) {

packages/next/src/server/app-render/app-render.tsx

@@ -132,6 +132,7 @@ import { getServerActionRequestMetadata } from '../lib/server-action-request-met
 import { createInitialRouterState } from '../../client/components/router-reducer/create-initial-router-state'
 import { createMutableActionQueue } from '../../shared/lib/router/action-queue'
 import { prerenderAsyncStorage } from './prerender-async-storage.external'
+import { getRevalidateReason } from '../instrumentation/utils'
 
 export type GetDynamicParamFromSegment = (
   // [slug] / [[slug]] / [...slug]
@@ -420,6 +421,7 @@ function createErrorContext(
     routePath: ctx.pagePath,
     routeType: ctx.isAction ? 'action' : 'render',
     renderSource,
+    revalidateReason: getRevalidateReason(ctx.staticGenerationStore),
   }
 }
 /**

packages/next/src/server/base-server.ts

@@ -161,6 +161,7 @@ import {
 } from './after/builtin-request-context'
 import { ENCODED_TAGS } from './stream-utils/encodedTags'
 import { NextRequestHint } from './web/adapter'
+import { getRevalidateReason } from './instrumentation/utils'
 import { RouteKind } from './route-kind'
 import type { RouteModule } from './route-modules/route-module'
 
@@ -2520,17 +2521,18 @@ export default abstract class Server<
             )
             return null
           } catch (err) {
-            // If this is during static generation, throw the error again.
-            if (isSSG) throw err
-
-            Log.error(err)
-
             await this.instrumentationOnRequestError(err, req, {
               routerKind: 'App Router',
               routePath: pathname,
               routeType: 'route',
+              revalidateReason: getRevalidateReason(renderOpts),
             })
 
+            // If this is during static generation, throw the error again.
+            if (isSSG) throw err
+
+            Log.error(err)
+
             // Otherwise, send a 500 response.
             await sendResponse(req, res, handleInternalServerErrorResponse())
 
@@ -2579,6 +2581,10 @@ export default abstract class Server<
                 routerKind: 'Pages Router',
                 routePath: pathname,
                 routeType: 'render',
+                revalidateReason: getRevalidateReason({
+                  isRevalidate: isSSG,
+                  isOnDemandRevalidate: renderOpts.isOnDemandRevalidate,
+                }),
               })
               throw err
             }

packages/next/src/server/instrumentation/types.ts

@@ -6,6 +6,7 @@ export type RequestErrorContext = {
     | 'react-server-components'
     | 'react-server-components-payload'
     | 'server-rendering'
+  revalidateReason: 'on-demand' | 'stale' | undefined
   // TODO: other future instrumentation context
 }
 

packages/next/src/server/instrumentation/utils.ts

@@ -0,0 +1,12 @@
+export function getRevalidateReason(params: {
+  isOnDemandRevalidate?: boolean
+  isRevalidate?: boolean
+}): 'on-demand' | 'stale' | undefined {
+  if (params.isOnDemandRevalidate) {
+    return 'on-demand'
+  }
+  if (params.isRevalidate) {
+    return 'stale'
+  }
+  return undefined
+}

packages/next/src/server/next-server.ts

@@ -984,6 +984,8 @@ export default class NextNodeServer extends BaseServer<
             routePath: match.definition.page,
             routerKind: 'Pages Router',
             routeType: 'route',
+            // Edge runtime does not support ISR
+            revalidateReason: undefined,
           })
           throw apiError
         }

test/e2e/on-request-error/isr/app/app/on-demand/page.js

@@ -0,0 +1,8 @@
+export default function Page() {
+  if (process.env.NEXT_PHASE !== 'phase-production-build') {
+    throw new Error('app:on-demand')
+  }
+  return <p>{Date.now()}</p>
+}
+
+export const revalidate = 1000

test/e2e/on-request-error/isr/app/app/route/on-demand/route.js

@@ -0,0 +1,8 @@
+export function GET() {
+  if (process.env.NEXT_PHASE !== 'phase-production-build') {
+    throw new Error('app:route:on-demand')
+  }
+  return new Response('app:route')
+}
+
+export const revalidate = 1000