Unverified Commit f93d8178 authored by Josh Story's avatar Josh Story Committed by GitHub

[dynamicIO] Error in dev when using sync platform APIs that are dynamic (#71346)

stacked on #71345 

When dynamicIO is enabled certain platform APIs that provide access to
outside state like randomness and current time are augmented to bail out
of prerendering. When running in Dev there is no true Prerender but we
still want to communicate to the developer when they are using APIs that
might not work as they intend in Production. This change adds warnings
when you use these platform APIs during the Prerender portion of the dev
render.
parent 0878db24
---
title: Cannot access `crypto.getRandomValue()`, `crypto.randomUUID()`, or another web or node crypto API that generates random values synchronously while prerendering
---
#### Why This Error Occurred
An API that produces a random value synchronously from the Web Crypto API or from Node's `crypto` API was called outside of a `"use cache"` scope and without first calling `await connection()`. Random values that are produced synchronously must either be inside a `"use cache"` scope or be preceded with `await connection()` to explicitly communicate to Next.js whether the random values produced can be reused across many requests (cached) or if they must be unique per Request (`await connection()`).
If the API used has an async version you can also switch to that in instead of using `await connection()`.
#### Possible Ways to Fix It
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"
async function getCachedDate(token: string) {
"use cache"
return db.query(token, ...)
}
export default async function Page() {
const token = crypto.getRandomUUID()
const data = await getCachedData(token);
return ...
}
```
After:
```jsx filename="app/page.js"
async function getCachedDate(token: string) {
"use cache"
const token = crypto.getRandomUUID()
return db.query(token, ...)
}
export default async function Page() {
const data = await getCachedData();
return ...
}
```
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"
import { generateKeySync } from 'node:crypto'
export default async function Page() {
const key = generateKeySync('hmac', { ... })
const digestedData = await digestDataWithKey(data, key);
return ...
}
```
After:
```jsx filename="app/page.js"
import { generateKey } from 'node:crypto'
export default async function Page() {
const key = await new Promise(resolve => generateKey('hmac', { ... }, key => resolve(key)))
const digestedData = await digestDataWithKey(data, key);
return ...
}
```
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 default async function Page() {
const uuid = crypto.randomUUID()
return <RequestId id={uuid}>
}
```
After:
```jsx filename="app/page.js"
import { connection } from 'next/server'
export default async function Page() {
await connection()
const uuid = crypto.randomUUID()
return <RequestId id={uuid}>
}
```
### Useful Links
- [`connection` function](https://nextjs.org/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)
---
title: Cannot access `Date.now()`, `Date()`, or `new Date()` while prerendering
---
#### Why This Error Occurred
A function is calling a `Date` API that provides the current time. The current time is not prerenderable and must be excluded. The correct solution depends on your use case. You can find more information below about possible ways to resolves this issue.
#### Possible Ways to Fix It
If you are using the current time for performance tracking consider using `performance.now()` and related APIs instead.
Before:
```jsx filename="app/page.js"
export default async function Page() {
const start = Date.now();
const data = await somethingSlow();
const end = Date.now();
console.log(`somethingSlow took ${end - start} milliseconds to complete`)
return ...
}
```
After:
```jsx filename="app/page.js"
export default async function Page() {
const start = performance.now();
const data = await somethingSlow();
const end = performance.now();
console.log(`somethingSlow took ${end - start} milliseconds to complete`)
return ...
}
```
If you want the current time to be reactive so it can change and update consider moving this usage to a Client Component. Note that Server Side Rendering timestamps is also problematic because hydration will fail so you must only set the time after hydration has completed using `useEffect()`.
Before:
```jsx filename="app/page.js"
export default async function Page() {
return (
<main>
...
<Timestamp />
</main>
)
}
function Timestamp() {
return 'current time: ' + new Date().toString()
}
```
After:
```jsx filename="app/client-components.js"
'use client'
import { useState, useEffect } from 'react'
export function Timestamp() {
const [time, setTime] = useState(null)
useEffect(() => {
// You can determine when and how often to update
// the time here. In this example we update it only once
setTime(new Date().toString())
}, [])
if (time) {
return 'current time: ' + time
}
return null
}
```
```jsx filename="app/page.js"
import { Timestamp } from './client-components'
export default async function Page() {
return (
<main>
...
<Timestamp />
</main>
)
}
```
If you want to server render the current time add `await connection()` before
```jsx filename="app/page.js"
export default async function Page() {
const currentTime = Date.now()
if (currentTime > someTriggerDate) {
return <SpecialBanner />
} else {
return <NormalBanner />
}
}
```
After:
```jsx filename="app/page.js"
import { connection } from 'next/server'
async function BannerSkeleton() {
...
}
export default async function Page() {
return <Suspense fallback={<BannerSkeleton />}>
<DynamicBanner />
</Suspense>
}
async function DynamicBanner() {
await connection();
const currentTime = Date.now();
if (currentTime > someTriggerDate) {
return <SpecialBanner />
} else {
return <NormalBanner />
}
}
```
### Useful Links
- [`connection` function](https://nextjs.org/docs/app/api-reference/functions/connection)
- [`performance` Web API](https://developer.mozilla.org/en-US/docs/Web/API/Performance)
- [`Suspense` React API](https://react.dev/reference/react/Suspense)
---
title: Cannot access `Math.random()` while prerendering
---
#### Why This Error Occurred
A function is calling `Math.random()`. Random values are not prerenderable and must be excluded. The correct solution depends on your use case. You can find more information below about possible ways to resolves this issue.
#### Possible Ways to Fix It
If your random value is intended to be unique per Request add `await connection()` before you call `Math.random()` and ensure there is a Suspense boundary somewhere above this component. This will inform Next.js that this component should be excluded from prerendering and communicate the necessary fallback UI that should be rendered while the component renders on each Request.
Before:
```jsx filename="app/page.js"
export default async function Page() {
const products = await getCachedProducts()
const randomSeed = Math.random()
const randomizedProducts = randomize(products, randomSeed)
return <ProductsView products={randomizedProducts} />
}
```
After:
```jsx filename="app/page.js"
import { connection } from 'next/server'
async function ProductsSkeleton() {
...
}
export default async function Page() {
const products = await getCachedProducts();
return <Suspense fallback={<ProductsSkeleton />}>
<DynamicProductsView products={products} />
</Suspense>
}
async function DynamicProductsView() {
await connection();
const randomSeed = Math.random()
const randomizedProducts = randomize(products, randomSeed)
return <ProductsView products={randomizedProducts} />
}
```
### Useful Links
- [`connection` function](https://nextjs.org/docs/app/api-reference/functions/connection)
- [`Suspense` React API](https://react.dev/reference/react/Suspense)
......@@ -1549,7 +1549,7 @@ async function renderToStream(
// We only have a Prerender environment for projects opted into dynamicIO
renderOpts.experimental.dynamicIO
) {
let environmentName = 'Prerender'
let environmentName: 'Prerender' | 'Server' = 'Prerender'
requestStore.environment = environmentName
reactServerResult = new ReactServerResult(
await workUnitAsyncStorage.run(
......
......@@ -223,7 +223,7 @@ export function trackDynamicDataAccessed(
if (workUnitStore) {
if (workUnitStore.type === 'prerender') {
// dynamicIO Prerender
abortAndThrowOnSynchronousDynamicDataAccess(
abortAndThrowOnSynchronousRequestDataAccess(
store.route,
expression,
workUnitStore
......@@ -319,7 +319,7 @@ export function trackDynamicDataInDynamicRender(
// Despite it's name we don't actually abort unless we have a controller to call abort on
// There are times when we let a prerender run long to discover caches where we want the semantics
// of tracking dynamic access without terminating the prerender early
export function abortOnSynchronousDynamicDataAccess(
function abortOnSynchronousDynamicDataAccess(
route: string,
expression: string,
prerenderStore: PrerenderStoreModern
......@@ -352,6 +352,14 @@ export function abortOnSynchronousDynamicDataAccess(
}
}
export function abortOnSynchronousPlatformIOAccess(
route: string,
expression: string,
prerenderStore: PrerenderStoreModern
): void {
return abortOnSynchronousDynamicDataAccess(route, expression, prerenderStore)
}
/**
* use this function when prerendering with dynamicIO. If we are doing a
* prospective prerender we don't actually abort because we want to discover
......@@ -360,10 +368,9 @@ export function abortOnSynchronousDynamicDataAccess(
* This function accepts a prerenderStore but the caller should ensure we're
* actually running in dynamicIO mode.
*
*
* @internal
*/
export function abortAndThrowOnSynchronousDynamicDataAccess(
export function abortAndThrowOnSynchronousRequestDataAccess(
route: string,
expression: string,
prerenderStore: PrerenderStoreModern
......
......@@ -51,7 +51,7 @@ export type RequestStore = {
// DEV-only
usedDynamic?: boolean
environment?: string
environment?: 'Prerender' | 'Server'
} & PhasePartial
/**
......
......@@ -14,7 +14,7 @@ import { io } from './utils'
function createNow(originalNow: typeof Date.now) {
return {
now: function now() {
io('`Date.now()`')
io('`Date.now()`', 'time')
return originalNow()
},
}['now'.slice() as 'now'].bind(null)
......@@ -31,11 +31,11 @@ function createDate(originalConstructor: typeof Date): typeof Date {
// Ideally this should not minify the name.
function Date() {
if (new.target === undefined) {
io('`Date()`')
io('`Date()`', 'time')
return apply(originalConstructor, undefined, arguments)
}
if (arguments.length === 0) {
io('`new Date()`')
io('`new Date()`', 'time')
}
return construct(originalConstructor, arguments, new.target)
},
......
......@@ -23,7 +23,7 @@ if (process.env.NEXT_RUNTIME === 'edge') {
try {
const _randomUUID = nodeCrypto.randomUUID
nodeCrypto.randomUUID = function randomUUID() {
io(randomUUIDExpression)
io(randomUUIDExpression, 'random')
return _randomUUID.apply(this, arguments as any)
}
} catch {
......@@ -38,7 +38,7 @@ if (process.env.NEXT_RUNTIME === 'edge') {
nodeCrypto.randomBytes = function randomBytes() {
if (typeof arguments[1] !== 'function') {
// randomBytes is sync if the second arg is undefined
io(randomBytesExpression)
io(randomBytesExpression, 'random')
}
return _randomBytes.apply(this, arguments as any)
}
......@@ -53,7 +53,7 @@ if (process.env.NEXT_RUNTIME === 'edge') {
try {
const _randomFillSync = nodeCrypto.randomFillSync
nodeCrypto.randomFillSync = function randomFillSync() {
io(randomFillSyncExpression)
io(randomFillSyncExpression, 'random')
return _randomFillSync.apply(this, arguments as any)
}
} catch {
......@@ -68,7 +68,7 @@ if (process.env.NEXT_RUNTIME === 'edge') {
nodeCrypto.randomInt = function randomInt() {
if (typeof arguments[2] !== 'function') {
// randomInt is sync if the third arg is undefined
io(randomIntExpression)
io(randomIntExpression, 'random')
}
return _randomInt.apply(this, arguments as any)
}
......@@ -83,7 +83,7 @@ if (process.env.NEXT_RUNTIME === 'edge') {
try {
const _generatePrimeSync = nodeCrypto.generatePrimeSync
nodeCrypto.generatePrimeSync = function generatePrimeSync() {
io(generatePrimeSyncExpression)
io(generatePrimeSyncExpression, 'random')
return _generatePrimeSync.apply(this, arguments as any)
}
} catch {
......@@ -97,7 +97,7 @@ if (process.env.NEXT_RUNTIME === 'edge') {
try {
const _generateKeyPairSync = nodeCrypto.generateKeyPairSync
nodeCrypto.generateKeyPairSync = function generateKeyPairSync() {
io(generateKeyPairSyncExpression)
io(generateKeyPairSyncExpression, 'random')
return _generateKeyPairSync.apply(this, arguments as any)
}
} catch {
......@@ -111,7 +111,7 @@ if (process.env.NEXT_RUNTIME === 'edge') {
try {
const _generateKeySync = nodeCrypto.generateKeySync
nodeCrypto.generateKeySync = function generateKeySync() {
io(generateKeySyncExpression)
io(generateKeySyncExpression, 'random')
return _generateKeySync.apply(this, arguments as any)
}
} catch {
......
......@@ -12,7 +12,7 @@ const expression = '`Math.random()`'
try {
const _random = Math.random
Math.random = function random() {
io(expression)
io(expression, 'random')
return _random.apply(null, arguments as any)
// We bind here to alter the `toString` printing to match `Math.random`'s native `toString`.
......
import { workAsyncStorage } from '../app-render/work-async-storage.external'
import { workUnitAsyncStorage } from '../app-render/work-unit-async-storage.external'
import { abortOnSynchronousDynamicDataAccess } from '../app-render/dynamic-rendering'
import { abortOnSynchronousPlatformIOAccess } from '../app-render/dynamic-rendering'
import { InvariantError } from '../../shared/lib/invariant-error'
export function io(expression: string) {
type DevCategories = 'time' | 'random' | 'crypto'
export function io(expression: string, devAPICategory: DevCategories) {
const workUnitStore = workUnitAsyncStorage.getStore()
if (workUnitStore && workUnitStore.type === 'prerender') {
const workStore = workAsyncStorage.getStore()
const route = workStore ? workStore.route : ''
if (workStore) {
abortOnSynchronousDynamicDataAccess(route, expression, workUnitStore)
if (workUnitStore) {
if (workUnitStore.type === 'prerender') {
const workStore = workAsyncStorage.getStore()
if (workStore) {
abortOnSynchronousPlatformIOAccess(
workStore.route,
expression,
workUnitStore
)
}
} else if (
process.env.NODE_ENV === 'development' &&
workUnitStore.type === 'request' &&
workUnitStore.environment === 'Prerender'
) {
const workStore = workAsyncStorage.getStore()
const route = workStore ? workStore.route : ''
switch (devAPICategory) {
case 'time': {
const errorToLog = new Error(
`Route "${route}" used ${expression} instead of using \`performance\` or without explicitly calling \`await connection()\` beforehand. See more info here: https://nextjs.org/docs/messages/next-prerender-current-time`
)
console.error(errorToLog)
break
}
case 'random': {
const errorToLog = new Error(
`Route ${route} used ${expression} outside of \`"use cache"\` and without explicitly calling \`await connection()\` beforehand. See more info here: https://nextjs.org/docs/messages/next-prerender-random`
)
console.error(errorToLog)
break
}
case 'crypto': {
const errorToLog = new Error(
`Route ${route} used ${expression} outside of \`"use cache"\` and without explicitly calling \`await connection()\` beforehand. See more info here: https://nextjs.org/docs/messages/next-prerender-crypto`
)
console.error(errorToLog)
break
}
default:
throw new InvariantError('Unknown devAPICategory in io function.')
}
}
}
}
......@@ -24,7 +24,7 @@ const getRandomValuesExpression = '`crypto.getRandomValues()`'
try {
const _getRandomValues = webCrypto.getRandomValues
webCrypto.getRandomValues = function getRandomValues() {
io(getRandomValuesExpression)
io(getRandomValuesExpression, 'crypto')
return _getRandomValues.apply(webCrypto, arguments as any)
}
} catch {
......@@ -37,7 +37,7 @@ const randomUUIDExpression = '`crypto.randomUUID()`'
try {
const _randomUUID = webCrypto.randomUUID
webCrypto.randomUUID = function randomUUID() {
io(randomUUIDExpression)
io(randomUUIDExpression, 'crypto')
return _randomUUID.apply(webCrypto, arguments as any)
} as typeof _randomUUID
} catch {
......
......@@ -12,7 +12,7 @@ import {
} from '../app-render/work-unit-async-storage.external'
import {
postponeWithTracking,
abortAndThrowOnSynchronousDynamicDataAccess,
abortAndThrowOnSynchronousRequestDataAccess,
throwToInterruptStaticGeneration,
trackDynamicDataInDynamicRender,
} from '../app-render/dynamic-rendering'
......@@ -167,7 +167,7 @@ function makeDynamicallyTrackedExoticCookies(
[Symbol.iterator]: {
value: function () {
const expression = 'cookies()[Symbol.iterator]()'
abortAndThrowOnSynchronousDynamicDataAccess(
abortAndThrowOnSynchronousRequestDataAccess(
route,
expression,
prerenderStore
......@@ -177,7 +177,7 @@ function makeDynamicallyTrackedExoticCookies(
size: {
get() {
const expression = `cookies().size`
abortAndThrowOnSynchronousDynamicDataAccess(
abortAndThrowOnSynchronousRequestDataAccess(
route,
expression,
prerenderStore
......@@ -192,7 +192,7 @@ function makeDynamicallyTrackedExoticCookies(
} else {
expression = `cookies().get(${describeNameArg(arguments[0])})`
}
abortAndThrowOnSynchronousDynamicDataAccess(
abortAndThrowOnSynchronousRequestDataAccess(
route,
expression,
prerenderStore
......@@ -207,7 +207,7 @@ function makeDynamicallyTrackedExoticCookies(
} else {
expression = `cookies().getAll(${describeNameArg(arguments[0])})`
}
abortAndThrowOnSynchronousDynamicDataAccess(
abortAndThrowOnSynchronousRequestDataAccess(
route,
expression,
prerenderStore
......@@ -222,7 +222,7 @@ function makeDynamicallyTrackedExoticCookies(
} else {
expression = `cookies().has(${describeNameArg(arguments[0])})`
}
abortAndThrowOnSynchronousDynamicDataAccess(
abortAndThrowOnSynchronousRequestDataAccess(
route,
expression,
prerenderStore
......@@ -242,7 +242,7 @@ function makeDynamicallyTrackedExoticCookies(
expression = `cookies().set(...)`
}
}
abortAndThrowOnSynchronousDynamicDataAccess(
abortAndThrowOnSynchronousRequestDataAccess(
route,
expression,
prerenderStore
......@@ -259,7 +259,7 @@ function makeDynamicallyTrackedExoticCookies(
} else {
expression = `cookies().delete(${describeNameArg(arguments[0])}, ...)`
}
abortAndThrowOnSynchronousDynamicDataAccess(
abortAndThrowOnSynchronousRequestDataAccess(
route,
expression,
prerenderStore
......@@ -269,7 +269,7 @@ function makeDynamicallyTrackedExoticCookies(
clear: {
value: function clear() {
const expression = 'cookies().clear()'
abortAndThrowOnSynchronousDynamicDataAccess(
abortAndThrowOnSynchronousRequestDataAccess(
route,
expression,
prerenderStore
......@@ -279,7 +279,7 @@ function makeDynamicallyTrackedExoticCookies(
toString: {
value: function toString() {
const expression = 'cookies().toString()'
abortAndThrowOnSynchronousDynamicDataAccess(
abortAndThrowOnSynchronousRequestDataAccess(
route,
expression,
prerenderStore
......
......@@ -10,7 +10,7 @@ import {
} from '../app-render/work-unit-async-storage.external'
import {
postponeWithTracking,
abortAndThrowOnSynchronousDynamicDataAccess,
abortAndThrowOnSynchronousRequestDataAccess,
throwToInterruptStaticGeneration,
trackDynamicDataInDynamicRender,
} from '../app-render/dynamic-rendering'
......@@ -149,7 +149,7 @@ function makeDynamicallyTrackedExoticHeaders(
append: {
value: function append() {
const expression = `headers().append(${describeNameArg(arguments[0])}, ...)`
abortAndThrowOnSynchronousDynamicDataAccess(
abortAndThrowOnSynchronousRequestDataAccess(
route,
expression,
prerenderStore
......@@ -159,7 +159,7 @@ function makeDynamicallyTrackedExoticHeaders(
delete: {
value: function _delete() {
const expression = `headers().delete(${describeNameArg(arguments[0])})`
abortAndThrowOnSynchronousDynamicDataAccess(
abortAndThrowOnSynchronousRequestDataAccess(
route,
expression,
prerenderStore
......@@ -169,7 +169,7 @@ function makeDynamicallyTrackedExoticHeaders(
get: {
value: function get() {
const expression = `headers().get(${describeNameArg(arguments[0])})`
abortAndThrowOnSynchronousDynamicDataAccess(
abortAndThrowOnSynchronousRequestDataAccess(
route,
expression,
prerenderStore
......@@ -179,7 +179,7 @@ function makeDynamicallyTrackedExoticHeaders(
has: {
value: function has() {
const expression = `headers().has(${describeNameArg(arguments[0])})`
abortAndThrowOnSynchronousDynamicDataAccess(
abortAndThrowOnSynchronousRequestDataAccess(
route,
expression,
prerenderStore
......@@ -189,7 +189,7 @@ function makeDynamicallyTrackedExoticHeaders(
set: {
value: function set() {
const expression = `headers().set(${describeNameArg(arguments[0])}, ...)`
abortAndThrowOnSynchronousDynamicDataAccess(
abortAndThrowOnSynchronousRequestDataAccess(
route,
expression,
prerenderStore
......@@ -199,7 +199,7 @@ function makeDynamicallyTrackedExoticHeaders(
getSetCookie: {
value: function getSetCookie() {
const expression = `headers().getSetCookie()`
abortAndThrowOnSynchronousDynamicDataAccess(
abortAndThrowOnSynchronousRequestDataAccess(
route,
expression,
prerenderStore
......@@ -209,7 +209,7 @@ function makeDynamicallyTrackedExoticHeaders(
forEach: {
value: function forEach() {
const expression = `headers().forEach(...)`
abortAndThrowOnSynchronousDynamicDataAccess(
abortAndThrowOnSynchronousRequestDataAccess(
route,
expression,
prerenderStore
......@@ -219,7 +219,7 @@ function makeDynamicallyTrackedExoticHeaders(
keys: {
value: function keys() {
const expression = `headers().keys()`
abortAndThrowOnSynchronousDynamicDataAccess(
abortAndThrowOnSynchronousRequestDataAccess(
route,
expression,
prerenderStore
......@@ -229,7 +229,7 @@ function makeDynamicallyTrackedExoticHeaders(
values: {
value: function values() {
const expression = `headers().values()`
abortAndThrowOnSynchronousDynamicDataAccess(
abortAndThrowOnSynchronousRequestDataAccess(
route,
expression,
prerenderStore
......@@ -239,7 +239,7 @@ function makeDynamicallyTrackedExoticHeaders(
entries: {
value: function entries() {
const expression = `headers().entries()`
abortAndThrowOnSynchronousDynamicDataAccess(
abortAndThrowOnSynchronousRequestDataAccess(
route,
expression,
prerenderStore
......@@ -249,7 +249,7 @@ function makeDynamicallyTrackedExoticHeaders(
[Symbol.iterator]: {
value: function () {
const expression = 'headers()[Symbol.iterator]()'
abortAndThrowOnSynchronousDynamicDataAccess(
abortAndThrowOnSynchronousRequestDataAccess(
route,
expression,
prerenderStore
......
......@@ -3,7 +3,7 @@ import type { FallbackRouteParams } from './fallback-params'
import { ReflectAdapter } from '../web/spec-extension/adapters/reflect'
import {
abortAndThrowOnSynchronousDynamicDataAccess,
abortAndThrowOnSynchronousRequestDataAccess,
throwToInterruptStaticGeneration,
postponeWithTracking,
} from '../app-render/dynamic-rendering'
......@@ -229,7 +229,7 @@ function makeAbortingExoticParams(
Object.defineProperty(promise, prop, {
get() {
const expression = describeStringPropertyAccess('params', prop)
abortAndThrowOnSynchronousDynamicDataAccess(
abortAndThrowOnSynchronousRequestDataAccess(
route,
expression,
prerenderStore
......
......@@ -2,7 +2,7 @@ import type { WorkStore } from '../app-render/work-async-storage.external'
import { ReflectAdapter } from '../web/spec-extension/adapters/reflect'
import {
abortAndThrowOnSynchronousDynamicDataAccess,
abortAndThrowOnSynchronousRequestDataAccess,
throwToInterruptStaticGeneration,
postponeWithTracking,
trackDynamicDataInDynamicRender,
......@@ -222,7 +222,7 @@ function makeAbortingExoticSearchParams(
'searchParams',
prop
)
abortAndThrowOnSynchronousDynamicDataAccess(
abortAndThrowOnSynchronousRequestDataAccess(
route,
expression,
prerenderStore
......@@ -242,7 +242,7 @@ function makeAbortingExoticSearchParams(
'searchParams',
prop
)
abortAndThrowOnSynchronousDynamicDataAccess(
abortAndThrowOnSynchronousRequestDataAccess(
route,
expression,
prerenderStore
......@@ -253,7 +253,7 @@ function makeAbortingExoticSearchParams(
ownKeys() {
const expression =
'`{...searchParams}`, `Object.keys(searchParams)`, or similar'
abortAndThrowOnSynchronousDynamicDataAccess(
abortAndThrowOnSynchronousRequestDataAccess(
route,
expression,
prerenderStore
......
export default function Root({ children }: { children: React.ReactNode }) {
return (
<html>
<body>{children}</body>
</html>
)
}
import { nextTestSetup } from 'e2e-utils'
describe('dynamic-requests warnings', () => {
const { next } = nextTestSetup({
files: __dirname,
})
it('warnings on sync cookie access', async () => {
const nextDevBootstrapOutputIndex = next.cliOutput.length
const browser = await next.browser('/request/cookies')
const browserLogsserLogs = await browser.log()
const browserConsoleErrors = browserLogsserLogs
.filter((log) => log.source === 'error')
.map((log) => log.message)
const terminalOutput = next.cliOutput.slice(nextDevBootstrapOutputIndex)
const terminalCookieErrors = terminalOutput.split('\n').filter((line) => {
return line.includes('In route /request/cookies')
})
expect({ browserConsoleErrors, terminalCookieErrors }).toEqual({
browserConsoleErrors: [
expect.stringContaining(
"In route /request/cookies a cookie property was accessed directly with `cookies().get('page')`."
),
expect.stringContaining(
"In route /request/cookies a cookie property was accessed directly with `cookies().get('component')`."
),
expect.stringContaining(
"In route /request/cookies a cookie property was accessed directly with `cookies().has('component')`."
),
expect.stringContaining(
'In route /request/cookies cookies were iterated over'
),
],
terminalCookieErrors: [
expect.stringContaining(
"In route /request/cookies a cookie property was accessed directly with `cookies().get('page')`."
),
expect.stringContaining(
"In route /request/cookies a cookie property was accessed directly with `cookies().get('component')`."
),
expect.stringContaining(
"In route /request/cookies a cookie property was accessed directly with `cookies().has('component')`."
),
expect.stringContaining(
'In route /request/cookies cookies were iterated over'
),
],
})
})
it('warnings on sync draftMode access', async () => {
const nextDevBootstrapOutputIndex = next.cliOutput.length
const browser = await next.browser('/request/draftMode')
const browserLogsserLogs = await browser.log()
const browserConsoleErrors = browserLogsserLogs
.filter((log) => log.source === 'error')
.map((log) => log.message)
const terminalOutput = next.cliOutput.slice(nextDevBootstrapOutputIndex)
const terminalCookieErrors = terminalOutput.split('\n').filter((line) => {
return line.includes('In route /request/draftMode')
})
expect({ browserConsoleErrors, terminalCookieErrors }).toEqual({
browserConsoleErrors: [
expect.stringContaining(
'In route /request/draftMode a `draftMode()` property was accessed directly with `draftMode().isEnabled`.'
),
expect.stringContaining(
'In route /request/draftMode a `draftMode()` property was accessed directly with `draftMode().isEnabled`.'
),
expect.stringContaining(
'In route /request/draftMode a `draftMode()` property was accessed directly with `draftMode().enable()`.'
),
expect.stringContaining(
'In route /request/draftMode a `draftMode()` property was accessed directly with `draftMode().isEnabled`.'
),
],
terminalCookieErrors: [
expect.stringContaining(
'In route /request/draftMode a `draftMode()` property was accessed directly with `draftMode().isEnabled`.'
),
expect.stringContaining(
'In route /request/draftMode a `draftMode()` property was accessed directly with `draftMode().isEnabled`.'
),
expect.stringContaining(
'In route /request/draftMode a `draftMode()` property was accessed directly with `draftMode().enable()`.'
),
expect.stringContaining(
'In route /request/draftMode a `draftMode()` property was accessed directly with `draftMode().isEnabled`.'
),
],
})
})
it('warnings on sync headers access', async () => {
const nextDevBootstrapOutputIndex = next.cliOutput.length
const browser = await next.browser('/request/headers')
const browserLogsserLogs = await browser.log()
const browserConsoleErrors = browserLogsserLogs
.filter((log) => log.source === 'error')
.map((log) => log.message)
const terminalOutput = next.cliOutput.slice(nextDevBootstrapOutputIndex)
const terminalCookieErrors = terminalOutput.split('\n').filter((line) => {
return line.includes('In route /request/headers')
})
expect({ browserConsoleErrors, terminalCookieErrors }).toEqual({
browserConsoleErrors: [
expect.stringContaining(
"In route /request/headers a header property was accessed directly with `headers().get('page')`."
),
expect.stringContaining(
"In route /request/headers a header property was accessed directly with `headers().get('component')`."
),
expect.stringContaining(
"In route /request/headers a header property was accessed directly with `headers().has('component')`."
),
expect.stringContaining(
'In route /request/headers headers were iterated over'
),
],
terminalCookieErrors: [
expect.stringContaining(
"In route /request/headers a header property was accessed directly with `headers().get('page')`."
),
expect.stringContaining(
"In route /request/headers a header property was accessed directly with `headers().get('component')`."
),
expect.stringContaining(
"In route /request/headers a header property was accessed directly with `headers().has('component')`."
),
expect.stringContaining(
'In route /request/headers headers were iterated over'
),
],
})
})
it('warnings on sync params access', async () => {
const nextDevBootstrapOutputIndex = next.cliOutput.length
const browser = await next.browser('/request/params/[slug]')
const browserLogsserLogs = await browser.log()
const browserConsoleErrors = browserLogsserLogs
.filter((log) => log.source === 'error')
.map((log) => log.message)
const terminalOutput = next.cliOutput.slice(nextDevBootstrapOutputIndex)
const terminalCookieErrors = terminalOutput.split('\n').filter((line) => {
return line.includes('In route /request/params/[slug]')
})
expect({ browserConsoleErrors, terminalCookieErrors }).toEqual({
browserConsoleErrors: [
expect.stringContaining(
'In route /request/params/[slug] a param property was accessed directly with `params.slug`.'
),
expect.stringContaining(
'In route /request/params/[slug] a param property was accessed directly with `params.slug`.'
),
expect.stringContaining(
'In route /request/params/[slug] a param property was accessed directly with `params.slug`.'
),
expect.stringContaining(
'In route /request/params/[slug] params are being enumerated'
),
],
terminalCookieErrors: [
expect.stringContaining(
'In route /request/params/[slug] a param property was accessed directly with `params.slug`.'
),
expect.stringContaining(
'In route /request/params/[slug] a param property was accessed directly with `params.slug`.'
),
expect.stringContaining(
'In route /request/params/[slug] a param property was accessed directly with `params.slug`.'
),
expect.stringContaining(
'In route /request/params/[slug] params are being enumerated'
),
],
})
})
it('warnings on sync searchParams access', async () => {
const nextDevBootstrapOutputIndex = next.cliOutput.length
const browser = await next.browser('/request/searchParams')
const browserLogsserLogs = await browser.log()
const browserConsoleErrors = browserLogsserLogs
.filter((log) => log.source === 'error')
.map((log) => log.message)
const terminalOutput = next.cliOutput.slice(nextDevBootstrapOutputIndex)
const terminalCookieErrors = terminalOutput.split('\n').filter((line) => {
return line.includes('In route /request/searchParams')
})
expect({ browserConsoleErrors, terminalCookieErrors }).toEqual({
browserConsoleErrors: [
expect.stringContaining(
'In route /request/searchParams a searchParam property was accessed directly with `searchParams.slug`.'
),
expect.stringContaining(
'In route /request/searchParams a searchParam property was accessed directly with `searchParams.slug`.'
),
expect.stringContaining(
'In route /request/searchParams a searchParam property was accessed directly with `searchParams.slug`.'
),
expect.stringContaining(
'In route /request/searchParams searchParams are being enumerated'
),
],
terminalCookieErrors: [
expect.stringContaining(
'In route /request/searchParams a searchParam property was accessed directly with `searchParams.slug`.'
),
expect.stringContaining(
'In route /request/searchParams a searchParam property was accessed directly with `searchParams.slug`.'
),
expect.stringContaining(
'In route /request/searchParams a searchParam property was accessed directly with `searchParams.slug`.'
),
expect.stringContaining(
'In route /request/searchParams searchParams are being enumerated'
),
],
})
})
})
import { randomInt } from 'node:crypto'
export default async function Page() {
return (
<dl>
<dt>require('node:crypto').randomInt(20)</dt>
<dd>{randomInt(20)}</dd>
<dt>require('node:crypto').randomInt(20, 40)</dt>
<dd>{randomInt(20, 40)}</dd>
</dl>
)
}
export default async function Page() {
return (
<dl>
<dt>Random number (`Math.random()`):</dt>
<dd>{Math.random()}</dd>
</dl>
)
}
export default async function Page() {
return (
<dl>
<dt>Current Date (`Date()`):</dt>
<dd>{Date()}</dd>
<dt>Current Date (`new Date().toString()`):</dt>
<dd>{new Date().toString()}</dd>
<dt>Current Timestamp (`Date.now()`):</dt>
<dd>{Date.now()}</dd>
<dt>Current Timestamp (`performance.now()`):</dt>
<dd>{performance.now()}</dd>
</dl>
)
}
export default async function Page() {
const arr = new Uint8Array(16)
crypto.getRandomValues(arr)
return (
<dl>
<dt>crypto.getRandomValues():</dt>
<dd>{arr.toString()}</dd>
<dt>crypto.randomUUID():</dt>
<dd>{crypto.randomUUID()}</dd>
</dl>
)
}
import { randomInt } from 'node:crypto'
import { connection } from 'next/server'
export default async function Page() {
await connection()
return (
<dl>
<dt>require('node:crypto').randomInt(20)</dt>
<dd>{randomInt(20)}</dd>
<dt>require('node:crypto').randomInt(20, 40)</dt>
<dd>{randomInt(20, 40)}</dd>
</dl>
)
}
import { connection } from 'next/server'
export default async function Page() {
await connection()
return (
<dl>
<dt>Random number (`Math.random()`):</dt>
<dd>{Math.random()}</dd>
</dl>
)
}
import { connection } from 'next/server'
export default async function Page() {
await connection()
return (
<dl>
<dt>Current Date (`Date()`):</dt>
<dd>{Date()}</dd>
<dt>Current Date (`new Date().toString()`):</dt>
<dd>{new Date().toString()}</dd>
<dt>Current Timestamp (`Date.now()`):</dt>
<dd>{Date.now()}</dd>
<dt>Current Timestamp (`performance.now()`):</dt>
<dd>{performance.now()}</dd>
</dl>
)
}
import { connection } from 'next/server'
export default async function Page() {
await connection()
const arr = new Uint8Array(16)
crypto.getRandomValues(arr)
return (
<dl>
<dt>crypto.getRandomValues():</dt>
<dd>{arr.toString()}</dd>
<dt>crypto.randomUUID():</dt>
<dd>{crypto.randomUUID()}</dd>
</dl>
)
}
module.exports = {
experimental: {
dynamicIO: true,
},
}
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