Files
next.js/errors/next-prerender-runtime-crypto.mdx
T
3f4db01dbc [Cache Components] Discriminate static shell validation errors by type (#85747)
Prior to this change any "hole" in a prerender that would block the
shell was considered an error and you would be presented with a very
generic message explaining all the different ways you could have failed
this validation check.

With this change we use a new technique to validate the static shell
which can now tell the difference between waiting on uncached data or
runtime data. It also improves the heuristics around generateMetadata
and generateViewport errors.

Added new error pages for runtime sync IO and ensure we only validate
sync IO after runtime data if the page will be validating runtime
prefetches.

Restored the validation on HMR update so you can get feedback after
saving a new file.

---

We've also discovered that hanging inputs are not handled correctly.
Fixing this is non-trivial and will be done in a follow-up, so for now,
we're disabling the failing tests.

---------

Co-authored-by: Josh Story <[email protected]>
Co-authored-by: Hendrik Liebau <[email protected]>
2025-11-20 17:13:37 +01:00

146 lines
4.9 KiB
Plaintext

---
title: Cannot access `crypto.getRandomValue()`, `crypto.randomUUID()`, or another web or node crypto API that generates random values synchronously before other uncached data or `connection()` in a Server Component
---
## Why This Error Occurred
An API that produces a random value synchronously from the Web Crypto API or from Node's `crypto` package was used in a Server Component before accessing other uncached data through APIs like `fetch()` and native database drivers, or the `connection()` API. While typically random crypto values can be guarded behind Runtime data like `cookies()`, `headers()`, `params`, and `searchParams`, this particular route is configured for Runtime Prefetching which makes these APIs available as part of the prefetch request. Accessing random values synchronously without preceding it with uncached data or `await connection()` interferes with the framework's ability to produce a correct prefetch result.
## Possible Ways to Fix It
If the random crypto value is appropriate to be prefetched consider moving it into a Cache Component or Cache Function with the `"use cache"` directive.
If the random crypto value is intended to be generated on every user navigation consider whether an async API exists that achieves the same result. If not consider whether you can move the random crypto value generation later, behind other existing uncached data or Request data access. If there is no way to do this you can always precede the random crypto value generation with Request data access by using `await connection()`.
### Cache the token value
If you are generating a token to talk to a database that itself should be cached move the token generation inside the `"use cache"`.
Before:
```jsx filename="app/page.js"
export const unstable_prefetch = {
mode: 'runtime',
samples: [...],
}
async function getCachedData(token: string, userId: string) {
"use cache"
return db.query(token, userId, ...)
}
export default async function Page({ params }) {
const { userId } = await params
const token = crypto.randomUUID()
const data = await getCachedData(token, userId);
return ...
}
```
After:
```jsx filename="app/page.js"
export const unstable_prefetch = {
mode: 'runtime',
samples: [...],
}
async function getCachedData(userId: string) {
"use cache"
const token = crypto.randomUUID()
return db.query(token, userId, ...)
}
export default async function Page({ params }) {
const { userId } = await params
const data = await getCachedData(userId);
return ...
}
```
### Use an async API at request-time
If you require this random value to be unique per Request and an async version of the API exists switch to it instead. Also ensure that there is a parent Suspense boundary that defines a fallback UI Next.js can use while rendering this component on each Request.
Before:
```jsx filename="app/page.js"
export const unstable_prefetch = {
mode: 'runtime',
samples: [...],
}
import { generateKeySync } from 'node:crypto'
export default async function Page({ params }) {
const { dataId } = await params
const data = await fetchData(dataId)
const key = generateKeySync('hmac', { ... })
const digestedData = await digestDataWithKey(data, key);
return ...
}
```
After:
```jsx filename="app/page.js"
export const unstable_prefetch = {
mode: 'runtime',
samples: [...],
}
import { generateKey } from 'node:crypto'
export default async function Page({ params }) {
const { dataId } = await params
const data = await fetchData(dataId)
const key = await new Promise(resolve => generateKey('hmac', { ... }, key => resolve(key)))
const digestedData = await digestDataWithKey(data, key);
return ...
}
```
### Use `await connection()` at request-time
If you require this random value to be unique per Request and an async version of the API does not exist, call `await connection()`. Also ensure that there is a parent Suspense boundary that defines a fallback UI Next.js can use while rendering this component on each Request.
Before:
```jsx filename="app/page.js"
export const unstable_prefetch = {
mode: 'runtime',
samples: [...],
}
export default async function Page({ params }) {
const { sessionId } = await params
const uuid = crypto.randomUUID()
return <RequestId sessionId={sessionId} id={uuid} />
}
```
After:
```jsx filename="app/page.js"
export const unstable_prefetch = {
mode: 'runtime',
samples: [...],
}
import { connection } from 'next/server'
export default async function Page({ params }) {
await connection()
const { sessionId } = await params
const uuid = crypto.randomUUID()
return <RequestId sessionId={sessionId} id={uuid} />
}
```
## Useful Links
- [`connection` function](/docs/app/api-reference/functions/connection)
- [Web Crypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API)
- [Node Crypto API](https://nodejs.org/docs/latest/api/crypto.html)
- [`Suspense` React API](https://react.dev/reference/react/Suspense)