Unverified Commit 26306e7f authored by Jimmy Lai's avatar Jimmy Lai Committed by GitHub

After() docs requests API (#89837)

<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation

- [x] Run `pnpm prettier-fix` to fix formatting issues before opening
the PR.
- [x] Read the Docs Contribution Guide to ensure your contribution
follows the docs guidelines:
https://nextjs.org/docs/community/contribution-guide

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md


## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

### What?
Reworded the "With request APIs" section in the `after()` documentation.

### Why?
To clearly differentiate when `cookies()` and `headers()` can be used
inside `after()` in App Router pages (Server Components) versus Route
Handlers/Server Functions, addressing potential confusion and potential
runtime errors.

### How?
- Split the "With request APIs" section into two subsections: "In Route
Handlers and Server Functions" and "In Server Components (pages and
layouts)".
- Clarified that `cookies()`/`headers()` can be used directly in
`after()` for Route Handlers/Server Functions.
- Explained that `cookies()`/`headers()` *cannot* be used directly in
`after()` for Server Components due to partial prerendering/Cache
Components, and will throw a runtime error.
- Added a new code example demonstrating the correct pattern for Server
Components (reading request data *before* `after()` and passing it in).
- Corrected `await` syntax in existing Route Handler examples and
updated highlight line numbers.

Closes NEXT-
Fixes #

-->

---
[Slack
Thread](https://vercel.slack.com/archives/C03KAR5DCKC/p1770819029314169?thread_ts=1770819029.314169&cid=C03KAR5DCKC)

<p><a
href="https://cursor.com/background-agent?bcId=bc-73042547-63d7-59b4-8f69-6e569308d2e9"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/assets/images/open-in-cursor-dark.png"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/assets/images/open-in-cursor-light.png"><img
alt="Open in Cursor" width="131" height="28"
src="https://cursor.com/assets/images/open-in-cursor-dark.png"></picture></a>&nbsp;<a
href="https://cursor.com/agents?id=bc-73042547-63d7-59b4-8f69-6e569308d2e9"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://cursor.com/assets/images/open-in-web-dark.png"><source
media="(prefers-color-scheme: light)"
srcset="https://cursor.com/assets/images/open-in-web-light.png"><img
alt="Open in Web" width="114" height="28"
src="https://cursor.com/assets/images/open-in-web-dark.png"></picture></a></p>

---------
Co-authored-by: 's avatarCursor Agent <cursoragent@cursor.com>
Co-authored-by: 's avatarJoseph Chamochumbi <joseph.chamochumbi@vercel.com>
parent 7a014a7f
...@@ -59,7 +59,11 @@ export default function Layout({ children }) { ...@@ -59,7 +59,11 @@ export default function Layout({ children }) {
### With request APIs ### With request APIs
You can use request APIs such as [`cookies`](/docs/app/api-reference/functions/cookies) and [`headers`](/docs/app/api-reference/functions/headers) inside `after` in [Server Functions](/docs/app/getting-started/updating-data) and [Route Handlers](/docs/app/api-reference/file-conventions/route). This is useful for logging activity after a mutation. For example: Whether you can use request APIs like [`cookies`](/docs/app/api-reference/functions/cookies) and [`headers`](/docs/app/api-reference/functions/headers) inside `after` depends on where `after` is called from.
#### In Route Handlers and Server Functions
You can call `cookies` and `headers` directly inside the `after` callback when used in [Route Handlers](/docs/app/api-reference/file-conventions/route) and [Server Functions](/docs/app/getting-started/updating-data). This is useful for logging activity after a mutation or API request. For example:
```ts filename="app/api/route.ts" highlight={2,10-16} switcher ```ts filename="app/api/route.ts" highlight={2,10-16} switcher
import { after } from 'next/server' import { after } from 'next/server'
...@@ -72,9 +76,9 @@ export async function POST(request: Request) { ...@@ -72,9 +76,9 @@ export async function POST(request: Request) {
// Log user activity for analytics // Log user activity for analytics
after(async () => { after(async () => {
const userAgent = (await headers().get('user-agent')) || 'unknown' const userAgent = (await headers()).get('user-agent') || 'unknown'
const sessionCookie = const sessionCookie =
(await cookies().get('session-id'))?.value || 'anonymous' (await cookies()).get('session-id')?.value || 'anonymous'
logUserAction({ sessionCookie, userAgent }) logUserAction({ sessionCookie, userAgent })
}) })
...@@ -97,9 +101,9 @@ export async function POST(request) { ...@@ -97,9 +101,9 @@ export async function POST(request) {
// Log user activity for analytics // Log user activity for analytics
after(async () => { after(async () => {
const userAgent = (await headers().get('user-agent')) || 'unknown' const userAgent = (await headers()).get('user-agent') || 'unknown'
const sessionCookie = const sessionCookie =
(await cookies().get('session-id'))?.value || 'anonymous' (await cookies()).get('session-id')?.value || 'anonymous'
logUserAction({ sessionCookie, userAgent }) logUserAction({ sessionCookie, userAgent })
}) })
...@@ -111,7 +115,123 @@ export async function POST(request) { ...@@ -111,7 +115,123 @@ export async function POST(request) {
} }
``` ```
However, you cannot use these request APIs inside `after` in [Server Components](/docs/app/getting-started/server-and-client-components). This is because Next.js needs to know which part of the tree access the request APIs to support [Cache Components](/docs/app/getting-started/cache-components), but `after` runs after React's rendering lifecycle. #### In Server Components (pages and layouts)
[Server Components](/docs/app/getting-started/server-and-client-components) (including pages, layouts, and `generateMetadata`) **cannot** use `cookies`, `headers`, or other [Dynamic APIs](/docs/app/guides/caching#dynamic-rendering) inside `after`. This is because Next.js needs to know which part of the component tree accesses request data to support [Partial Prerendering](/docs/app/glossary#partial-prerendering-ppr) and [Cache Components](/docs/app/getting-started/cache-components), but `after` runs after React's rendering lifecycle.
If you need request data inside an `after` callback in a Server Component, read it beforehand and pass the values in:
```tsx filename="app/page.tsx" highlight={8-10,12} switcher
import { after } from 'next/server'
import { cookies, headers } from 'next/headers'
import { logUserAction } from '@/app/utils'
export default async function Page() {
// Read request data before `after` — this is allowed
// These calls will be read during the component's rendering lifecycle
const userAgent = (await headers()).get('user-agent') || 'unknown'
const sessionCookie =
(await cookies()).get('session-id')?.value || 'anonymous'
after(() => {
// Use the values read above
logUserAction({ sessionCookie, userAgent })
})
return <h1>My Page</h1>
}
```
```jsx filename="app/page.jsx" highlight={8-10,12} switcher
import { after } from 'next/server'
import { cookies, headers } from 'next/headers'
import { logUserAction } from '@/app/utils'
export default async function Page() {
// Read request data before `after` — this is allowed
// These calls will be read during the component's rendering lifecycle
const userAgent = (await headers()).get('user-agent') || 'unknown'
const sessionCookie =
(await cookies()).get('session-id')?.value || 'anonymous'
after(() => {
// Use the values read above
logUserAction({ sessionCookie, userAgent })
})
return <h1>My Page</h1>
}
```
Calling `cookies()` or `headers()` inside the `after` callback in a Server Component will throw a runtime error.
#### With Cache Components
When using [Cache Components](/docs/app/getting-started/cache-components), components that access request data like `cookies` or `headers` must be wrapped in [`<Suspense>`](https://react.dev/reference/react/Suspense) so the rest of the page can be prerendered into a static shell.
You can combine this pattern with `after` by reading request data in a dynamic component and passing it into `after`:
```tsx filename="app/page.tsx" highlight={18-19,22-24} switcher
import { Suspense } from 'react'
import { after } from 'next/server'
import { cookies } from 'next/headers'
import { logUserAction } from '@/app/utils'
export default function Page() {
return (
<>
<h1>Part of the static shell</h1>
<Suspense fallback={<p>Loading...</p>}>
<DynamicContent />
</Suspense>
</>
)
}
async function DynamicContent() {
const sessionCookie =
(await cookies()).get('session-id')?.value || 'anonymous'
// Schedule work after the response is sent
after(() => {
logUserAction({ sessionCookie })
})
return <p>Your session: {sessionCookie}</p>
}
```
```jsx filename="app/page.jsx" highlight={18-19,22-24} switcher
import { Suspense } from 'react'
import { after } from 'next/server'
import { cookies } from 'next/headers'
import { logUserAction } from '@/app/utils'
export default function Page() {
return (
<>
<h1>Part of the static shell</h1>
<Suspense fallback={<p>Loading...</p>}>
<DynamicContent />
</Suspense>
</>
)
}
async function DynamicContent() {
const sessionCookie =
(await cookies()).get('session-id')?.value || 'anonymous'
// Schedule work after the response is sent
after(() => {
logUserAction({ sessionCookie })
})
return <p>Your session: {sessionCookie}</p>
}
```
In this example, `<h1>` and the `<Suspense>` fallback are included in the static shell. `DynamicContent` reads the cookie during rendering and passes it into `after` via closure. Since `cookies()` is called _outside_ the `after` callback (during the component's render), this works correctly.
## Platform Support ## Platform Support
...@@ -177,7 +297,7 @@ const handler = (req, res) => { ...@@ -177,7 +297,7 @@ const handler = (req, res) => {
## Version History ## Version History
| Version History | Description | | Version | Changes |
| --------------- | ---------------------------- | | ------------ | ---------------------------- |
| `v15.1.0` | `after` became stable. | | `v15.1.0` | `after` became stable. |
| `v15.0.0-rc` | `unstable_after` introduced. | | `v15.0.0-rc` | `unstable_after` introduced. |
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