rsnext/test/production
Damien Simonin Feugas bf089562c7
feat(middleware)!: forbids middleware response body (#36835)
_Hello Next.js team! First PR here, I hope I've followed the right practices._

### What's in there?

It has been decided to only support the following uses cases in Next.js' middleware:
- rewrite the URL (`x-middleware-rewrite` response header)
- redirect to another URL (`Location` response header)
- pass on to the next piece in the request pipeline (`x-middleware-next` response header)

1. during development, a warning on console tells developers when they are returning a response (either with `Response` or `NextResponse`).
2. at build time, this warning becomes an error.
3. at run time, returning a response body will trigger a 500 HTTP error with a JSON payload containing the detailed error.

All returned/thrown errors contain a link to the documentation.

This is a breaking feature compared to the _beta_ middleware implementation, and also removes `NextResponse.json()` which makes no sense any more.

### How to try it?
- runtime behavior: `HEADLESS=true yarn jest test/integration/middleware/core`
- build behavior : `yarn jest test/integration/middleware/build-errors`
- development behavior: `HEADLESS=true yarn jest test/development/middleware-warnings`

### Notes to reviewers

The limitation happens in next's web adapter. ~The initial implementation was to check `response.body` existence, but it turns out [`Response.redirect()`](https://github.com/vercel/next.js/blob/canary/packages/next/server/web/spec-compliant/response.ts#L42-L53) may set the response body (https://github.com/vercel/next.js/pull/31886). Hence why the proposed implementation specifically looks at response headers.~
`Response.redirect()` and `NextResponse.redirect()` do not need to include the final location in their body: it is handled by next server https://github.com/vercel/next.js/blob/canary/packages/next/server/next-server.ts#L1142

Because this is a breaking change, I had to adjust several tests cases, previously returning JSON/stream/text bodies. When relevant, these middlewares are returning data using response headers.

About DevEx: relying on AST analysis to detect forbidden use cases is not as good as running the code.
Such cases are easy to detect:
```js
new Response('a text value')
new Response(JSON.stringify({ /* whatever */ })
```
But these are false-positive cases:
```js
function returnNull() { return null }
new Response(returnNull())

function doesNothing() {}
new Response(doesNothing())
```
However, I see no good reasons to let users ship middleware such as the one above, hence why the build will fail, even if _technically speaking_, they are not setting the response body. 



## Feature

- [x] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
- [ ] Related issues linked using `fixes #number`
- [x] Integration tests added
- [x] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [x] Errors have helpful link attached, see `contributing.md`

## Documentation / Examples

- [x] Make sure the linting passes by running `yarn lint`
2022-05-19 22:02:20 +00:00
..
dependencies-can-use-env-vars-in-middlewares feat(middleware)!: forbids middleware response body (#36835) 2022-05-19 22:02:20 +00:00
emit-decorator-metadata Add decoratorMetadata flag if enabled by tsconfig (#32914) 2022-02-06 16:48:09 +00:00
eslint-plugin-deps Ensure eslint plugins dont conflict (#35667) 2022-03-28 12:31:30 -05:00
fallback-export-error Update check for fallback pages during export (#33323) 2022-01-17 14:44:45 +00:00
generate-middleware-source-maps feat(middleware)!: forbids middleware response body (#36835) 2022-05-19 22:02:20 +00:00
jest Fix interopDefault on jest object-proxy (#37002) 2022-05-18 09:41:13 +00:00
middleware-environment-variables-in-node-server-reflect-the-usage-inference feat(middleware)!: forbids middleware response body (#36835) 2022-05-19 22:02:20 +00:00
middleware-typescript feat(middleware)!: forbids middleware response body (#36835) 2022-05-19 22:02:20 +00:00
middleware-with-dynamic-code Deprecate nested Middleware in favor of root middleware (#36772) 2022-05-19 15:46:21 +00:00
postcss-plugin-config-as-string allow to provide postcss plugin options as a string (#35173) 2022-04-08 16:58:50 +00:00
react-18-streaming-ssr Bump react dev dep to 18.1 (#36491) 2022-04-28 11:29:30 +02:00
reading-request-body-in-middleware feat(middleware)!: forbids middleware response body (#36835) 2022-05-19 22:02:20 +00:00
required-server-files Deprecate nested Middleware in favor of root middleware (#36772) 2022-05-19 15:46:21 +00:00
standalone-mode-and-optimizecss Fix outputStandalone with optimizeCss (#36028) 2022-04-11 16:14:28 -05:00
typescript-basic test: add document head multi child prod test (#35426) 2022-03-18 10:19:55 +00:00
required-server-files-i18n.test.ts Add falling back to wasm swc build on native load failure (#36612) 2022-05-02 21:11:45 +00:00
required-server-files.test.ts Deprecate nested Middleware in favor of root middleware (#36772) 2022-05-19 15:46:21 +00:00