Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(next): Do not display message when middleware is removed on dev m…
…ode (#39604) Fixes #39532 ## Bug - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Errors have helpful link attached, see `contributing.md`
- Loading branch information
Showing
4 changed files
with
143 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
import { NextResponse } from 'next/server' | ||
|
||
export function middleware(request) { | ||
if (request.nextUrl.pathname.startsWith('/_next/')) return | ||
|
||
const res = NextResponse.rewrite(new URL('/', request.url)) | ||
res.headers.set('X-From-Middleware', 'true') | ||
return res | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
export default (props) => <div id="from-middleware">{props.fromMiddleware}</div> | ||
|
||
export async function getServerSideProps({ res }) { | ||
return { | ||
props: { | ||
fromMiddleware: res.getHeader('x-from-middleware') || '', | ||
}, | ||
} | ||
} |
125 changes: 125 additions & 0 deletions
125
test/integration/middleware-dev-update/test/index.test.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,125 @@ | ||
import { | ||
fetchViaHTTP, | ||
File, | ||
findPort, | ||
killApp, | ||
launchApp, | ||
retry, | ||
} from 'next-test-utils' | ||
import { join } from 'path' | ||
import webdriver from 'next-webdriver' | ||
|
||
const context = { | ||
appDir: join(__dirname, '../'), | ||
logs: { output: '', stdout: '', stderr: '' }, | ||
middleware: new File(join(__dirname, '../middleware.js')), | ||
} | ||
|
||
describe('Middleware development errors', () => { | ||
beforeEach(async () => { | ||
context.logs = { output: '', stdout: '', stderr: '' } | ||
context.appPort = await findPort() | ||
context.app = await launchApp(context.appDir, context.appPort, { | ||
onStdout(msg) { | ||
context.logs.output += msg | ||
context.logs.stdout += msg | ||
}, | ||
onStderr(msg) { | ||
context.logs.output += msg | ||
context.logs.stderr += msg | ||
}, | ||
}) | ||
}) | ||
|
||
afterEach(() => { | ||
context.middleware.restore() | ||
if (context.app) { | ||
killApp(context.app) | ||
} | ||
}) | ||
|
||
async function assertMiddlewareFetch(hasMiddleware, path = '/') { | ||
const res = await fetchViaHTTP(context.appPort, path) | ||
expect(res.status).toBe(200) | ||
expect(res.headers.get('x-from-middleware')).toBe( | ||
hasMiddleware ? 'true' : null | ||
) | ||
} | ||
|
||
async function assertMiddlewareRender(hasMiddleware, path = '/') { | ||
const browser = await webdriver(context.appPort, path) | ||
const fromMiddleware = await browser.elementById('from-middleware').text() | ||
expect(fromMiddleware).toBe(hasMiddleware ? 'true' : '') | ||
} | ||
|
||
describe('when middleware is removed', () => { | ||
beforeEach(async () => { | ||
await assertMiddlewareFetch(true) | ||
context.middleware.delete() | ||
}) | ||
|
||
it('sends response correctly', async () => { | ||
await assertMiddlewareFetch(false) | ||
await assertMiddlewareRender(false) | ||
|
||
// assert no extra message on stderr | ||
expect(context.logs.stderr).toBe('') | ||
}) | ||
}) | ||
|
||
describe('when middleware is removed and re-added', () => { | ||
beforeEach(async () => { | ||
await assertMiddlewareFetch(true) | ||
context.middleware.delete() | ||
await assertMiddlewareFetch(false) | ||
context.middleware.restore() | ||
}) | ||
|
||
it('sends response correctly', async () => { | ||
await assertMiddlewareFetch(true) | ||
await assertMiddlewareRender(true) | ||
}) | ||
}) | ||
|
||
describe('when middleware is added', () => { | ||
beforeEach(async () => { | ||
context.middleware.delete() | ||
await assertMiddlewareFetch(false) | ||
context.middleware.restore() | ||
}) | ||
|
||
it('sends response correctly', async () => { | ||
await retry(() => assertMiddlewareFetch(true)) | ||
await assertMiddlewareRender(true) | ||
}) | ||
}) | ||
|
||
describe('when matcher is added', () => { | ||
beforeEach(async () => { | ||
context.middleware.write( | ||
context.middleware.originalContent + | ||
` | ||
export const config = { | ||
matcher: '/', | ||
} | ||
` | ||
) | ||
|
||
await assertMiddlewareFetch(true) | ||
|
||
context.middleware.write( | ||
context.middleware.originalContent + | ||
` | ||
export const config = { | ||
matcher: '/asdf', | ||
} | ||
` | ||
) | ||
}) | ||
|
||
it('sends response correctly', async () => { | ||
await retry(() => assertMiddlewareFetch(true, '/asdf')) | ||
await retry(() => assertMiddlewareRender(true, '/asdf')) | ||
}) | ||
}) | ||
}) |