rsnext/packages/next/build/webpack/plugins
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
..
terser-webpack-plugin Deprecate nested Middleware in favor of root middleware (#36772) 2022-05-19 15:46:21 +00:00
wellknown-errors-plugin Fix next node buildin module error message for edge runtime (#36434) 2022-05-02 15:21:40 +00:00
build-manifest-plugin.ts Add initial handling for routing tests (#36635) 2022-05-03 10:37:23 +00:00
copy-file-plugin.ts use loader-utils 2 for resolve-url-loader to fix ./data: urls in sass (#31134) 2021-11-08 18:37:25 +00:00
css-minimizer-plugin.ts Pre-compile more dependencies (#32627) 2021-12-20 14:01:35 +01:00
flight-manifest-plugin.ts Simplify the logic for static flight response generation (#36984) 2022-05-18 13:18:28 +02:00
font-stylesheet-gathering-plugin.ts Update font-stylesheet-gathering-plugin.ts (#30709) 2022-02-05 21:46:47 -06:00
jsconfig-paths-plugin.ts chore: replace deprecated String.prototype.substr() (#35421) 2022-03-24 17:49:38 -04:00
middleware-plugin.ts feat(middleware)!: forbids middleware response body (#36835) 2022-05-19 22:02:20 +00:00
middleware-source-maps-plugin.ts Deprecate nested Middleware in favor of root middleware (#36772) 2022-05-19 15:46:21 +00:00
mini-css-extract-plugin.ts use official mini-css-extract-plugin and experimentalUseImportModule (#24573) 2021-05-12 16:04:01 +00:00
next-drop-client-page-plugin.ts Remove isWebpack5 checks (#29677) 2021-10-06 18:46:46 -05:00
next-trace-entrypoints-plugin.ts chore: replace deprecated String.prototype.substr() (#35421) 2022-03-24 17:49:38 -04:00
nextjs-require-cache-hot-reloader.ts Refactor sandbox module cache (#31822) 2021-11-26 12:06:41 +00:00
pages-manifest-plugin.ts Tweak routing tests (#36667) 2022-05-05 13:15:32 +02:00
profiling-plugin.ts partially migrate to webpack 5 types (#30189) 2021-10-24 23:04:26 +02:00
react-loadable-plugin.ts fixes to allow lazy compilation for import() (#32441) 2021-12-14 11:33:04 +01:00
serverless-plugin.ts update serverless plugin to use webpack 5 apis (#31058) 2021-11-06 01:19:25 +01:00
telemetry-plugin.ts Collect packages are used and eliminated in getServerSideProps (#35404) 2022-04-01 15:08:44 +00:00