Unverified Commit 6d39c38d authored by Andrew Gadzik's avatar Andrew Gadzik Committed by GitHub

Add a `regions` property to the Functions Config Manifest file (#80104)

<!-- 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

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

### Adding or Updating Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### 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?

### Why?

### How?

Closes NEXT-
Fixes #

-->

### What?

The `preferredRegion`
[option](https://nextjs.org/docs/app/api-reference/file-conventions/route-segment-config#preferredregion)
does not work for `nodejs` runtime functions. This PR attempts to fix
that by setting a new `regions` property on the functions config
manifest file if `preferredRegion` was set.
parent 13b8d58a
---
'next': patch
---
Add `regions` to the function config manifest file
...@@ -531,6 +531,7 @@ export interface FunctionsConfigManifest { ...@@ -531,6 +531,7 @@ export interface FunctionsConfigManifest {
{ {
maxDuration?: number | undefined maxDuration?: number | undefined
runtime?: 'nodejs' runtime?: 'nodejs'
regions?: string[] | string
matchers?: Array<{ matchers?: Array<{
regexp: string regexp: string
originalSource: string originalSource: string
...@@ -1872,10 +1873,18 @@ export default async function build( ...@@ -1872,10 +1873,18 @@ export default async function build(
// configuration, we need to add it to the manifest. // configuration, we need to add it to the manifest.
if ( if (
typeof staticInfo?.runtime !== 'undefined' || typeof staticInfo?.runtime !== 'undefined' ||
typeof staticInfo?.maxDuration !== 'undefined' typeof staticInfo?.maxDuration !== 'undefined' ||
typeof staticInfo?.preferredRegion !== 'undefined'
) { ) {
const regions = staticInfo?.preferredRegion
? typeof staticInfo.preferredRegion === 'string'
? [staticInfo.preferredRegion]
: staticInfo.preferredRegion
: undefined
functionsConfigManifest.functions[page] = { functionsConfigManifest.functions[page] = {
maxDuration: staticInfo?.maxDuration, maxDuration: staticInfo?.maxDuration,
...(regions && { regions }),
} }
} }
......
# preferredRegion Test
This test demonstrates the successful implementation of `preferredRegion` configuration support for Node.js runtime in Next.js App Router.
## Test Structure
- **`app/api/test/route.ts`** - Node.js runtime route handler with `preferredRegion = "iad1"` and `maxDuration = 100`
- **`app/api/test-edge/route.ts`** - Edge runtime route handler with `preferredRegion = "iad1"` and `maxDuration = 100`
## What the Test Shows
### ✅ Node.js Runtime (NOW WORKS!)
- Route handler exports `preferredRegion = "iad1"` and `maxDuration = 100`
- Gets processed and stored in `functions-config-manifest.json` as:
```json
{
"/api/test": {
"maxDuration": 100,
"regions": ["iad1"]
}
}
```
- Deployment platforms can now read `regions` for Node.js runtime
### ✅ Edge Runtime (CONTINUES TO WORK)
- Route handler exports `preferredRegion = "iad1"` and `maxDuration = 100`
- Gets processed and stored in both manifests:
- `functions-config-manifest.json` under `functions["/api/test-edge"]`
- `middleware-manifest.json` under `functions["/api/test-edge/route"]`
export const runtime = 'edge'
export const preferredRegion = 'iad1'
export const maxDuration = 100
export async function GET() {
return Response.json({ status: 'success', runtime: 'edge' })
}
export const preferredRegion = 'iad1'
export const maxDuration = 100
export async function GET() {
return Response.json({ status: 'success' })
}
import { ReactNode } from 'react'
export default function Root({ children }: { children: ReactNode }) {
return (
<html>
<body>{children}</body>
</html>
)
}
export default function Page() {
return <p>hello world</p>
}
/**
* @type {import('next').NextConfig}
*/
const nextConfig = {}
module.exports = nextConfig
import { nextTestSetup } from 'e2e-utils'
describe('preferred-region', () => {
const { next, isNextStart } = nextTestSetup({
files: __dirname,
})
it('should return success from Node.js API route', async () => {
const res = await next.fetch('/api/test')
expect(res.status).toBe(200)
const data = await res.json()
expect(data).toEqual({ status: 'success' })
})
it('should return success from Edge API route', async () => {
const res = await next.fetch('/api/test-edge')
expect(res.status).toBe(200)
const data = await res.json()
expect(data).toEqual({ status: 'success', runtime: 'edge' })
})
it('should include preferredRegion in functions config manifest for nodejs runtime', async () => {
if (isNextStart) {
let functionsConfigManifest
let middlewareManifest
try {
// Check Functions Config Manifest (for Node.js runtime)
functionsConfigManifest = JSON.parse(
await next.readFile('.next/server/functions-config-manifest.json')
)
// Check Middleware Manifest (for Edge runtime)
middlewareManifest = JSON.parse(
await next.readFile('.next/server/middleware-manifest.json')
)
} catch (error) {
console.error('Error reading manifests:', error)
throw error
}
// Test our fix: Node.js route should have both maxDuration and regions
expect(functionsConfigManifest.functions).toHaveProperty('/api/test')
expect(functionsConfigManifest.functions['/api/test']).toHaveProperty(
'maxDuration',
100
)
expect(functionsConfigManifest.functions['/api/test']).toHaveProperty(
'regions'
)
expect(functionsConfigManifest.functions['/api/test'].regions).toEqual([
'iad1',
])
// Edge route should also be in functions manifest with regions
expect(functionsConfigManifest.functions).toHaveProperty('/api/test-edge')
expect(
functionsConfigManifest.functions['/api/test-edge']
).toHaveProperty('maxDuration', 100)
expect(
functionsConfigManifest.functions['/api/test-edge']
).toHaveProperty('regions')
expect(
functionsConfigManifest.functions['/api/test-edge'].regions
).toEqual(['iad1'])
// Edge runtime should also work correctly in middleware manifest - check for regions only
const edgeRoutePath = '/api/test-edge/route'
expect(middlewareManifest.functions).toHaveProperty(edgeRoutePath)
expect(middlewareManifest.functions[edgeRoutePath]).toHaveProperty(
'regions'
)
expect(middlewareManifest.functions[edgeRoutePath].regions).toEqual([
'iad1',
])
}
})
})
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