rsnext/test/e2e/app-dir/actions/app-action-size-limit-invalid.test.ts

123 lines
3 KiB
TypeScript
Raw Normal View History

feat: add body parser limit for server actions (#51104) <!-- 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 - 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? Add configuration options to modify the `bodyParser` size as it used to be available in Page Router. ### Why? Server Actions "Error: Body exceeded 1mb limit" cannot be resolved since the body-parser limit size is hardcoded to `1mb`. ### How? Closes NEXT- Fixes # --> ### What? Add configuration options to modify the `bodyParser` size as it used to be available in Page Router for APIs. ```js export const config = { api: { responseLimit: false | '8mb' }, } ``` Reference: [API Routes Response Size Limit](https://nextjs.org/docs/messages/api-routes-response-size-limit) ### Why? Server Actions "Error: Body exceeded 1mb limit" cannot be resolved since the body-parser limit size is hardcoded to `1mb`. ```js // /packages/next/src/server/app-render/action-handler.ts // ... const actionData = (await parseBody(req, '1mb')) || '' // ... ``` Reference: https://github.com/vercel/next.js/blob/canary/packages/next/src/server/app-render/action-handler.ts#L355 ### How? - Added option "serverActionsLimit" as `SizeLimit` type to `config-shared.ts` - Modified `action-handler.ts` to validate `serverActions` & `serverActionsLimit` options in nextConfig - Added conditional `serverActionsLimit` value and `1mb` if falsy **Working on testing** Fixes #49891 | #51097 | #51099 --------- Co-authored-by: JJ Kasper <jj@jjsweb.site> Co-authored-by: Shu Ding <g@shud.in>
2023-06-24 01:24:18 +02:00
import { createNextDescribe } from 'e2e-utils'
import { check } from 'next-test-utils'
const CONFIG_ERROR =
'Server Actions Size Limit must be a valid number or filesize format lager than 1MB'
createNextDescribe(
'app-dir action size limit invalid config',
{
files: __dirname,
skipDeployment: true,
dependencies: {
react: 'latest',
'react-dom': 'latest',
'server-only': 'latest',
},
},
({ next, isNextStart, isNextDeploy }) => {
if (!isNextStart) {
it('skip test for dev mode', () => {})
return
}
it('should error if serverActions.bodySizeLimit config is a negative number', async function () {
feat: add body parser limit for server actions (#51104) <!-- 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 - 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? Add configuration options to modify the `bodyParser` size as it used to be available in Page Router. ### Why? Server Actions "Error: Body exceeded 1mb limit" cannot be resolved since the body-parser limit size is hardcoded to `1mb`. ### How? Closes NEXT- Fixes # --> ### What? Add configuration options to modify the `bodyParser` size as it used to be available in Page Router for APIs. ```js export const config = { api: { responseLimit: false | '8mb' }, } ``` Reference: [API Routes Response Size Limit](https://nextjs.org/docs/messages/api-routes-response-size-limit) ### Why? Server Actions "Error: Body exceeded 1mb limit" cannot be resolved since the body-parser limit size is hardcoded to `1mb`. ```js // /packages/next/src/server/app-render/action-handler.ts // ... const actionData = (await parseBody(req, '1mb')) || '' // ... ``` Reference: https://github.com/vercel/next.js/blob/canary/packages/next/src/server/app-render/action-handler.ts#L355 ### How? - Added option "serverActionsLimit" as `SizeLimit` type to `config-shared.ts` - Modified `action-handler.ts` to validate `serverActions` & `serverActionsLimit` options in nextConfig - Added conditional `serverActionsLimit` value and `1mb` if falsy **Working on testing** Fixes #49891 | #51097 | #51099 --------- Co-authored-by: JJ Kasper <jj@jjsweb.site> Co-authored-by: Shu Ding <g@shud.in>
2023-06-24 01:24:18 +02:00
await next.patchFile(
'next.config.js',
`
module.exports = {
experimental: {
serverActions: { bodySizeLimit: -3000 }
feat: add body parser limit for server actions (#51104) <!-- 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 - 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? Add configuration options to modify the `bodyParser` size as it used to be available in Page Router. ### Why? Server Actions "Error: Body exceeded 1mb limit" cannot be resolved since the body-parser limit size is hardcoded to `1mb`. ### How? Closes NEXT- Fixes # --> ### What? Add configuration options to modify the `bodyParser` size as it used to be available in Page Router for APIs. ```js export const config = { api: { responseLimit: false | '8mb' }, } ``` Reference: [API Routes Response Size Limit](https://nextjs.org/docs/messages/api-routes-response-size-limit) ### Why? Server Actions "Error: Body exceeded 1mb limit" cannot be resolved since the body-parser limit size is hardcoded to `1mb`. ```js // /packages/next/src/server/app-render/action-handler.ts // ... const actionData = (await parseBody(req, '1mb')) || '' // ... ``` Reference: https://github.com/vercel/next.js/blob/canary/packages/next/src/server/app-render/action-handler.ts#L355 ### How? - Added option "serverActionsLimit" as `SizeLimit` type to `config-shared.ts` - Modified `action-handler.ts` to validate `serverActions` & `serverActionsLimit` options in nextConfig - Added conditional `serverActionsLimit` value and `1mb` if falsy **Working on testing** Fixes #49891 | #51097 | #51099 --------- Co-authored-by: JJ Kasper <jj@jjsweb.site> Co-authored-by: Shu Ding <g@shud.in>
2023-06-24 01:24:18 +02:00
},
}
`
)
await next.stop()
try {
await next.build()
} catch {}
expect(next.cliOutput).toContain(CONFIG_ERROR)
})
it('should error if serverActions.bodySizeLimit config is invalid', async function () {
feat: add body parser limit for server actions (#51104) <!-- 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 - 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? Add configuration options to modify the `bodyParser` size as it used to be available in Page Router. ### Why? Server Actions "Error: Body exceeded 1mb limit" cannot be resolved since the body-parser limit size is hardcoded to `1mb`. ### How? Closes NEXT- Fixes # --> ### What? Add configuration options to modify the `bodyParser` size as it used to be available in Page Router for APIs. ```js export const config = { api: { responseLimit: false | '8mb' }, } ``` Reference: [API Routes Response Size Limit](https://nextjs.org/docs/messages/api-routes-response-size-limit) ### Why? Server Actions "Error: Body exceeded 1mb limit" cannot be resolved since the body-parser limit size is hardcoded to `1mb`. ```js // /packages/next/src/server/app-render/action-handler.ts // ... const actionData = (await parseBody(req, '1mb')) || '' // ... ``` Reference: https://github.com/vercel/next.js/blob/canary/packages/next/src/server/app-render/action-handler.ts#L355 ### How? - Added option "serverActionsLimit" as `SizeLimit` type to `config-shared.ts` - Modified `action-handler.ts` to validate `serverActions` & `serverActionsLimit` options in nextConfig - Added conditional `serverActionsLimit` value and `1mb` if falsy **Working on testing** Fixes #49891 | #51097 | #51099 --------- Co-authored-by: JJ Kasper <jj@jjsweb.site> Co-authored-by: Shu Ding <g@shud.in>
2023-06-24 01:24:18 +02:00
await next.patchFile(
'next.config.js',
`
module.exports = {
experimental: {
serverActions: { bodySizeLimit: 'testmb' }
feat: add body parser limit for server actions (#51104) <!-- 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 - 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? Add configuration options to modify the `bodyParser` size as it used to be available in Page Router. ### Why? Server Actions "Error: Body exceeded 1mb limit" cannot be resolved since the body-parser limit size is hardcoded to `1mb`. ### How? Closes NEXT- Fixes # --> ### What? Add configuration options to modify the `bodyParser` size as it used to be available in Page Router for APIs. ```js export const config = { api: { responseLimit: false | '8mb' }, } ``` Reference: [API Routes Response Size Limit](https://nextjs.org/docs/messages/api-routes-response-size-limit) ### Why? Server Actions "Error: Body exceeded 1mb limit" cannot be resolved since the body-parser limit size is hardcoded to `1mb`. ```js // /packages/next/src/server/app-render/action-handler.ts // ... const actionData = (await parseBody(req, '1mb')) || '' // ... ``` Reference: https://github.com/vercel/next.js/blob/canary/packages/next/src/server/app-render/action-handler.ts#L355 ### How? - Added option "serverActionsLimit" as `SizeLimit` type to `config-shared.ts` - Modified `action-handler.ts` to validate `serverActions` & `serverActionsLimit` options in nextConfig - Added conditional `serverActionsLimit` value and `1mb` if falsy **Working on testing** Fixes #49891 | #51097 | #51099 --------- Co-authored-by: JJ Kasper <jj@jjsweb.site> Co-authored-by: Shu Ding <g@shud.in>
2023-06-24 01:24:18 +02:00
},
}
`
)
await next.stop()
try {
await next.build()
} catch {}
expect(next.cliOutput).toContain(CONFIG_ERROR)
})
it('should error if serverActions.bodySizeLimit config is a negative size', async function () {
feat: add body parser limit for server actions (#51104) <!-- 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 - 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? Add configuration options to modify the `bodyParser` size as it used to be available in Page Router. ### Why? Server Actions "Error: Body exceeded 1mb limit" cannot be resolved since the body-parser limit size is hardcoded to `1mb`. ### How? Closes NEXT- Fixes # --> ### What? Add configuration options to modify the `bodyParser` size as it used to be available in Page Router for APIs. ```js export const config = { api: { responseLimit: false | '8mb' }, } ``` Reference: [API Routes Response Size Limit](https://nextjs.org/docs/messages/api-routes-response-size-limit) ### Why? Server Actions "Error: Body exceeded 1mb limit" cannot be resolved since the body-parser limit size is hardcoded to `1mb`. ```js // /packages/next/src/server/app-render/action-handler.ts // ... const actionData = (await parseBody(req, '1mb')) || '' // ... ``` Reference: https://github.com/vercel/next.js/blob/canary/packages/next/src/server/app-render/action-handler.ts#L355 ### How? - Added option "serverActionsLimit" as `SizeLimit` type to `config-shared.ts` - Modified `action-handler.ts` to validate `serverActions` & `serverActionsLimit` options in nextConfig - Added conditional `serverActionsLimit` value and `1mb` if falsy **Working on testing** Fixes #49891 | #51097 | #51099 --------- Co-authored-by: JJ Kasper <jj@jjsweb.site> Co-authored-by: Shu Ding <g@shud.in>
2023-06-24 01:24:18 +02:00
await next.patchFile(
'next.config.js',
`
module.exports = {
experimental: {
serverActions: { bodySizeLimit: '-3000mb' }
feat: add body parser limit for server actions (#51104) <!-- 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 - 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? Add configuration options to modify the `bodyParser` size as it used to be available in Page Router. ### Why? Server Actions "Error: Body exceeded 1mb limit" cannot be resolved since the body-parser limit size is hardcoded to `1mb`. ### How? Closes NEXT- Fixes # --> ### What? Add configuration options to modify the `bodyParser` size as it used to be available in Page Router for APIs. ```js export const config = { api: { responseLimit: false | '8mb' }, } ``` Reference: [API Routes Response Size Limit](https://nextjs.org/docs/messages/api-routes-response-size-limit) ### Why? Server Actions "Error: Body exceeded 1mb limit" cannot be resolved since the body-parser limit size is hardcoded to `1mb`. ```js // /packages/next/src/server/app-render/action-handler.ts // ... const actionData = (await parseBody(req, '1mb')) || '' // ... ``` Reference: https://github.com/vercel/next.js/blob/canary/packages/next/src/server/app-render/action-handler.ts#L355 ### How? - Added option "serverActionsLimit" as `SizeLimit` type to `config-shared.ts` - Modified `action-handler.ts` to validate `serverActions` & `serverActionsLimit` options in nextConfig - Added conditional `serverActionsLimit` value and `1mb` if falsy **Working on testing** Fixes #49891 | #51097 | #51099 --------- Co-authored-by: JJ Kasper <jj@jjsweb.site> Co-authored-by: Shu Ding <g@shud.in>
2023-06-24 01:24:18 +02:00
},
}
`
)
await next.stop()
try {
await next.build()
} catch {}
expect(next.cliOutput).toContain(CONFIG_ERROR)
})
if (!isNextDeploy) {
it('should respect the size set in serverActions.bodySizeLimit', async function () {
feat: add body parser limit for server actions (#51104) <!-- 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 - 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? Add configuration options to modify the `bodyParser` size as it used to be available in Page Router. ### Why? Server Actions "Error: Body exceeded 1mb limit" cannot be resolved since the body-parser limit size is hardcoded to `1mb`. ### How? Closes NEXT- Fixes # --> ### What? Add configuration options to modify the `bodyParser` size as it used to be available in Page Router for APIs. ```js export const config = { api: { responseLimit: false | '8mb' }, } ``` Reference: [API Routes Response Size Limit](https://nextjs.org/docs/messages/api-routes-response-size-limit) ### Why? Server Actions "Error: Body exceeded 1mb limit" cannot be resolved since the body-parser limit size is hardcoded to `1mb`. ```js // /packages/next/src/server/app-render/action-handler.ts // ... const actionData = (await parseBody(req, '1mb')) || '' // ... ``` Reference: https://github.com/vercel/next.js/blob/canary/packages/next/src/server/app-render/action-handler.ts#L355 ### How? - Added option "serverActionsLimit" as `SizeLimit` type to `config-shared.ts` - Modified `action-handler.ts` to validate `serverActions` & `serverActionsLimit` options in nextConfig - Added conditional `serverActionsLimit` value and `1mb` if falsy **Working on testing** Fixes #49891 | #51097 | #51099 --------- Co-authored-by: JJ Kasper <jj@jjsweb.site> Co-authored-by: Shu Ding <g@shud.in>
2023-06-24 01:24:18 +02:00
await next.patchFile(
'next.config.js',
`
module.exports = {
experimental: {
serverActions: { bodySizeLimit: '1.5mb' }
feat: add body parser limit for server actions (#51104) <!-- 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 - 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? Add configuration options to modify the `bodyParser` size as it used to be available in Page Router. ### Why? Server Actions "Error: Body exceeded 1mb limit" cannot be resolved since the body-parser limit size is hardcoded to `1mb`. ### How? Closes NEXT- Fixes # --> ### What? Add configuration options to modify the `bodyParser` size as it used to be available in Page Router for APIs. ```js export const config = { api: { responseLimit: false | '8mb' }, } ``` Reference: [API Routes Response Size Limit](https://nextjs.org/docs/messages/api-routes-response-size-limit) ### Why? Server Actions "Error: Body exceeded 1mb limit" cannot be resolved since the body-parser limit size is hardcoded to `1mb`. ```js // /packages/next/src/server/app-render/action-handler.ts // ... const actionData = (await parseBody(req, '1mb')) || '' // ... ``` Reference: https://github.com/vercel/next.js/blob/canary/packages/next/src/server/app-render/action-handler.ts#L355 ### How? - Added option "serverActionsLimit" as `SizeLimit` type to `config-shared.ts` - Modified `action-handler.ts` to validate `serverActions` & `serverActionsLimit` options in nextConfig - Added conditional `serverActionsLimit` value and `1mb` if falsy **Working on testing** Fixes #49891 | #51097 | #51099 --------- Co-authored-by: JJ Kasper <jj@jjsweb.site> Co-authored-by: Shu Ding <g@shud.in>
2023-06-24 01:24:18 +02:00
},
}
`
)
await next.build()
await next.start()
const logs: string[] = []
next.on('stdout', (log) => {
logs.push(log)
})
next.on('stderr', (log) => {
logs.push(log)
})
const browser = await next.browser('/file')
await browser.elementByCss('#size-1mb').click()
await check(() => {
return logs.some((log) => log.includes('size = 1048576')) ? 'yes' : ''
}, 'yes')
await browser.elementByCss('#size-2mb').click()
await check(() => {
const fullLog = logs.join('')
return fullLog.includes('[Error]: Body exceeded 1.5mb limit') &&
fullLog.includes(
'To configure the body size limit for Server Actions, see'
)
feat: add body parser limit for server actions (#51104) <!-- 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 - 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? Add configuration options to modify the `bodyParser` size as it used to be available in Page Router. ### Why? Server Actions "Error: Body exceeded 1mb limit" cannot be resolved since the body-parser limit size is hardcoded to `1mb`. ### How? Closes NEXT- Fixes # --> ### What? Add configuration options to modify the `bodyParser` size as it used to be available in Page Router for APIs. ```js export const config = { api: { responseLimit: false | '8mb' }, } ``` Reference: [API Routes Response Size Limit](https://nextjs.org/docs/messages/api-routes-response-size-limit) ### Why? Server Actions "Error: Body exceeded 1mb limit" cannot be resolved since the body-parser limit size is hardcoded to `1mb`. ```js // /packages/next/src/server/app-render/action-handler.ts // ... const actionData = (await parseBody(req, '1mb')) || '' // ... ``` Reference: https://github.com/vercel/next.js/blob/canary/packages/next/src/server/app-render/action-handler.ts#L355 ### How? - Added option "serverActionsLimit" as `SizeLimit` type to `config-shared.ts` - Modified `action-handler.ts` to validate `serverActions` & `serverActionsLimit` options in nextConfig - Added conditional `serverActionsLimit` value and `1mb` if falsy **Working on testing** Fixes #49891 | #51097 | #51099 --------- Co-authored-by: JJ Kasper <jj@jjsweb.site> Co-authored-by: Shu Ding <g@shud.in>
2023-06-24 01:24:18 +02:00
? 'yes'
: ''
}, 'yes')
})
}
}
)