Unverified Commit f2adcfeb authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

Handle server actions error in onRequestError (#67769)

### What

Handling server action errors capturing in instrumentation.js
`onRequestError` API

Closes NDX-21
parent d484f466
......@@ -122,6 +122,8 @@ import { parseParameter } from '../../shared/lib/router/utils/route-regex'
import { parseRelativeUrl } from '../../shared/lib/router/utils/parse-relative-url'
import AppRouter from '../../client/components/app-router'
import type { ServerComponentsHmrCache } from '../response-cache'
import type { RequestErrorContext } from '../instrumentation/types'
import { getServerActionRequestMetadata } from '../lib/server-action-request-meta'
export type GetDynamicParamFromSegment = (
// [slug] / [[slug]] / [...slug]
......@@ -780,12 +782,16 @@ async function renderToHTMLOrFlightImpl(
// intentionally silence the error logger in this case to avoid double
// logging.
const silenceStaticGenerationErrors = isRoutePPREnabled && isStaticGeneration
const isActionRequest = getServerActionRequestMetadata(req).isServerAction
const errorContext = {
const errorContext: Pick<
RequestErrorContext,
'routerKind' | 'routePath' | 'routeType'
> = {
routerKind: 'App Router',
routePath: pagePath,
routeType: 'render',
} as const
routeType: isActionRequest ? 'action' : 'render',
}
// Including RSC rendering and flight data rendering
function getRSCError(err: DigestedError) {
......
type RequestErrorContext = {
export type RequestErrorContext = {
routerKind: 'Pages Router' | 'App Router'
routePath: string // the route file path, e.g. /app/blog/[dynamic]
routeType: 'render' | 'route' | 'action' | 'middleware'
......
......@@ -25,51 +25,29 @@ describe('on-request-error - basic', () => {
}
async function validateErrorRecord({
name,
errorMessage,
url,
renderSource,
isMiddleware = false,
}: {
name: string
errorMessage: string
url: string
renderSource: string | undefined
isMiddleware?: boolean
}) {
// Assert the instrumentation is called
await retry(async () => {
const recordLogs = next.cliOutput
.split('\n')
.filter((log) => log.includes('[instrumentation] write-log'))
const expectedLog = recordLogs.find((log) => log.includes(name))
const expectedLog = recordLogs.find((log) => log.includes(errorMessage))
expect(expectedLog).toBeDefined()
}, 5000)
const json = await getOutputLogJson()
const record = json[name]
expect(record).toBeDefined()
const { payload, count } = record
expect(payload.message).toBe(name)
expect(count).toBe(1)
validateRequestByName({
payload: payload,
url,
isMiddleware,
renderSource,
})
}
const record = json[errorMessage]
function validateRequestByName({
payload,
url,
renderSource,
isMiddleware = false,
}: {
payload: any
url: string
renderSource: string | undefined
isMiddleware: boolean
}) {
const { payload } = record
const { request } = payload
if (isMiddleware) {
// For middleware, the URL is absolute url with host
......@@ -79,10 +57,14 @@ describe('on-request-error - basic', () => {
expect(request.url).toBe(url)
}
expect(payload.context.renderSource).toBe(renderSource)
expect(request.method).toBe('GET')
expect(request.headers['accept']).toBe('*/*')
expect(record).toMatchObject({
count: 1,
payload: {
message: errorMessage,
request: { method: 'GET', headers: { accept: '*/*' } },
...(renderSource ? { context: { renderSource } } : undefined),
},
})
}
beforeAll(async () => {
......@@ -93,7 +75,7 @@ describe('on-request-error - basic', () => {
it('should catch server component page error in node runtime', async () => {
await next.fetch('/server-page')
await validateErrorRecord({
name: 'server-page-node-error',
errorMessage: 'server-page-node-error',
url: '/server-page',
renderSource: 'react-server-components',
})
......@@ -102,7 +84,7 @@ describe('on-request-error - basic', () => {
it('should catch server component page error in edge runtime', async () => {
await next.fetch('/server-page/edge')
await validateErrorRecord({
name: 'server-page-edge-error',
errorMessage: 'server-page-edge-error',
url: '/server-page/edge',
renderSource: 'react-server-components',
})
......@@ -111,7 +93,7 @@ describe('on-request-error - basic', () => {
it('should catch client component page error in node runtime', async () => {
await next.fetch('/client-page')
await validateErrorRecord({
name: 'client-page-node-error',
errorMessage: 'client-page-node-error',
url: '/client-page',
renderSource: 'server-rendering',
})
......@@ -119,8 +101,9 @@ describe('on-request-error - basic', () => {
it('should catch client component page error in edge runtime', async () => {
await next.fetch('/client-page/edge')
await validateErrorRecord({
name: 'client-page-edge-error',
errorMessage: 'client-page-edge-error',
url: '/client-page/edge',
renderSource: 'server-rendering',
})
......@@ -128,8 +111,9 @@ describe('on-request-error - basic', () => {
it('should catch app routes error in node runtime', async () => {
await next.fetch('/app-route')
await validateErrorRecord({
name: 'route-node-error',
errorMessage: 'route-node-error',
url: '/app-route',
renderSource: undefined,
})
......@@ -138,7 +122,7 @@ describe('on-request-error - basic', () => {
it('should catch app routes error in edge runtime', async () => {
await next.fetch('/app-route/edge')
await validateErrorRecord({
name: 'route-edge-error',
errorMessage: 'route-edge-error',
url: '/app-route/edge',
renderSource: undefined,
})
......@@ -149,7 +133,7 @@ describe('on-request-error - basic', () => {
it('should catch pages router page error in node runtime', async () => {
await next.fetch('/page')
await validateErrorRecord({
name: 'pages-page-node-error',
errorMessage: 'pages-page-node-error',
url: '/page',
renderSource: undefined,
})
......@@ -158,7 +142,7 @@ describe('on-request-error - basic', () => {
it('should catch pages router page error in edge runtime', async () => {
await next.fetch('/page/edge')
await validateErrorRecord({
name: 'pages-page-edge-error',
errorMessage: 'pages-page-edge-error',
url: '/page/edge',
renderSource: undefined,
})
......@@ -167,7 +151,7 @@ describe('on-request-error - basic', () => {
it('should catch pages router api error in node runtime', async () => {
await next.fetch('/api/pages-route')
await validateErrorRecord({
name: 'api-node-error',
errorMessage: 'api-node-error',
url: '/api/pages-route',
renderSource: undefined,
})
......@@ -176,7 +160,7 @@ describe('on-request-error - basic', () => {
it('should catch pages router api error in edge runtime', async () => {
await next.fetch('/api/pages-route/edge')
await validateErrorRecord({
name: 'api-edge-error',
errorMessage: 'api-edge-error',
url: '/api/pages-route/edge',
renderSource: undefined,
})
......@@ -187,7 +171,7 @@ describe('on-request-error - basic', () => {
it('should catch middleware error', async () => {
await next.fetch('/middleware-error')
await validateErrorRecord({
name: 'middleware-error',
errorMessage: 'middleware-error',
url: '/middleware-error',
isMiddleware: true,
renderSource: undefined,
......
export default function Page() {
return <p>another</p>
}
'use server'
import { notFound, redirect } from 'next/navigation'
export async function redirectAction() {
redirect('/another')
}
export async function notFoundAction() {
notFound()
}
export async function serverLog(content) {
throw new Error('[server-action]:' + content)
}
'use client'
import { serverLog } from '../../actions'
export default function Page() {
return (
<div>
<button onClick={() => serverLog('callback:edge')}>Log to server</button>
</div>
)
}
export const runtime = 'edge'
export const dynamic = 'force-dynamic'
'use client'
import { serverLog } from '../actions'
export default function Page() {
return (
<div>
<button onClick={() => serverLog('callback')}>Log to server</button>
</div>
)
}
export const dynamic = 'force-dynamic'
export default function Page() {
async function action(formData) {
'use server'
throw new Error('[server-action]:form:edge')
}
return (
<form action={action}>
<input type="hidden" name="payload" value={'payload-value'} />
<button type="submit">submit</button>
</form>
)
}
export const runtime = 'edge'
export const dynamic = 'force-dynamic'
export default function Page() {
async function action(formData) {
'use server'
throw new Error('[server-action]:form')
}
return (
<form action={action}>
<input type="hidden" name="payload" value={'payload-value'} />
<button type="submit">submit</button>
</form>
)
}
export const dynamic = 'force-dynamic'
export default function Layout({ children }) {
return (
<html>
<body>{children}</body>
</html>
)
}
export const dynamic = 'force-dynamic'
import fs from 'fs'
import fsp from 'fs/promises'
import path from 'path'
const dir = path.join(path.dirname(new URL(import.meta.url).pathname), '../..')
const logPath = path.join(dir, 'output-log.json')
export async function POST(req) {
let payloadString = ''
const decoder = new TextDecoder()
const reader = req.clone().body.getReader()
while (true) {
const { done, value } = await reader.read()
if (done) {
break
}
payloadString += decoder.decode(value)
}
const payload = JSON.parse(payloadString)
const json = fs.existsSync(logPath)
? JSON.parse(await fsp.readFile(logPath, 'utf8'))
: {}
if (!json[payload.message]) {
json[payload.message] = {
payload,
count: 1,
}
} else {
json[payload.message].count++
}
await fsp.writeFile(logPath, JSON.stringify(json, null, 2), 'utf8')
console.log(`[instrumentation] write-log:${payload.message}`)
return new Response(null, { status: 204 })
}
export function onRequestError(err, request, context) {
fetch(`http://localhost:${process.env.PORT}/write-log`, {
method: 'POST',
body: JSON.stringify({
message: err.message,
request,
context,
}),
headers: {
'Content-Type': 'application/json',
},
})
}
module.exports = {
experimental: {
instrumentationHook: true,
},
}
import { nextTestSetup } from 'e2e-utils'
import { retry } from 'next-test-utils'
describe('on-request-error - server-action-error', () => {
const { next, skipped } = nextTestSetup({
files: __dirname,
skipDeployment: true,
env: {
__NEXT_EXPERIMENTAL_INSTRUMENTATION: '1',
},
})
if (skipped) {
return
}
const outputLogPath = 'output-log.json'
async function getOutputLogJson() {
if (!(await next.hasFile(outputLogPath))) {
return {}
}
const content = await next.readFile(outputLogPath)
return JSON.parse(content)
}
async function validateErrorRecord({
errorMessage,
url,
}: {
errorMessage: string
url: string
}) {
// Assert the instrumentation is called
await retry(async () => {
const recordLogLines = next.cliOutput
.split('\n')
.filter((log) => log.includes('[instrumentation] write-log'))
expect(recordLogLines).toEqual(
expect.arrayContaining([expect.stringContaining(errorMessage)])
)
}, 5000)
const json = await getOutputLogJson()
const record = json[errorMessage]
// Assert error is recorded in the output log
expect(record).toMatchObject({
payload: {
message: errorMessage,
request: {
url,
method: 'POST',
headers: expect.objectContaining({
accept: 'text/x-component',
}),
},
context: {
routerKind: 'App Router',
routeType: 'action',
renderSource: 'react-server-components-payload',
},
},
count: 1,
})
}
beforeAll(async () => {
await next.patchFile(outputLogPath, '{}')
})
it('should catch server action error in listener callback in nodejs runtime', async () => {
const browser = await next.browser('/client/callback')
await browser.elementByCss('button').click()
await validateErrorRecord({
errorMessage: '[server-action]:callback',
url: '/client/callback',
})
})
it('should catch server action error in listener callback in edge runtime', async () => {
const browser = await next.browser('/client/callback/edge')
await browser.elementByCss('button').click()
await validateErrorRecord({
errorMessage: '[server-action]:callback:edge',
url: '/client/callback/edge',
})
})
it('should catch the server action form error in nodejs runtime', async () => {
const browser = await next.browser('/form-error')
await browser.elementByCss('button').click()
await validateErrorRecord({
errorMessage: '[server-action]:form',
url: '/form-error',
})
})
it('should catch the server action form error in edge runtime', async () => {
const browser = await next.browser('/form-error/edge')
await browser.elementByCss('button').click()
await validateErrorRecord({
errorMessage: '[server-action]:form:edge',
url: '/form-error/edge',
})
})
})
'use server'
import { notFound, redirect } from 'next/navigation'
export async function redirectAction() {
redirect('/another')
}
export async function notFoundAction() {
notFound()
}
import { notFoundAction } from '../action'
export default function Page() {
return (
<form action={notFoundAction}>
<input type="hidden" name="payload" value={'payload-value'} />
<button type="submit">submit</button>
</form>
)
}
export const dynamic = 'force-dynamic'
import { redirectAction } from '../action'
export default function Page() {
return (
<form action={redirectAction}>
<input type="hidden" name="payload" value={'payload-value'} />
<button type="submit">submit</button>
</form>
)
}
export const dynamic = 'force-dynamic'
......@@ -65,6 +65,17 @@ describe('on-request-error - skip-next-internal-error', () => {
await next.fetch('/client/no-ssr')
await assertNoNextjsInternalErrors()
})
// Server Actions navigation
it('should not catch server action not-found errors', async () => {
await next.fetch('/form/not-found')
await assertNoNextjsInternalErrors()
})
it('should not catch server action redirect errors', async () => {
await next.fetch('/form/redirect')
await assertNoNextjsInternalErrors()
})
})
describe('app router API', () => {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment