Skip to content

Commit

Permalink
Handle next/navigation import in middleware (#66175)
Browse files Browse the repository at this point in the history 
## What?

Ensures that `next/navigation` and React is aliased in middleware in the
same way that it's aliased in Route Handlers. This matches the behavior
we have in Next.js with webpack.

Fixes #66162

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

-->

---------

Co-authored-by: Hendrik Liebau <mail@hendrik-liebau.de>
  • Loading branch information
@timneutkens @unstubbable
timneutkens and unstubbable authored May 24, 2024
1 parent 82a7c9c commit 08b75b7
Show file tree
Hide file tree
Showing 7 changed files with 48 additions and 1 deletion.
6 changes: 5 additions & 1 deletion packages/next-swc/crates/next-core/src/next_import_map.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -583,7 +583,10 @@ async fn insert_next_server_special_aliases(

rsc_aliases(import_map, project_path, ty, runtime, next_config).await?;
}
ServerContextType::Middleware | ServerContextType::Instrumentation => {}
ServerContextType::Middleware => {
rsc_aliases(import_map, project_path, ty, runtime, next_config).await?;
}
ServerContextType::Instrumentation => {}
}

// see https://github.com/vercel/next.js/blob/8013ef7372fc545d49dbd060461224ceb563b454/packages/next/src/build/webpack-config.ts#L1449-L1531
Expand Down Expand Up @@ -727,6 +730,7 @@ async fn rsc_aliases(
"react-dom" => format!("next/dist/compiled/react-dom{react_channel}/react-dom.react-server"),
"next/dist/compiled/react-dom" => format!("next/dist/compiled/react-dom{react_channel}/react-dom.react-server"),
"next/dist/compiled/react-dom-experimental" => format!("next/dist/compiled/react-dom-experimental/react-dom.react-server"),
"next/navigation" => format!("next/dist/api/navigation.react-server"),
})
}

Expand Down
8 changes: 8 additions & 0 deletions test/e2e/app-dir/navigation-redirect-import/app/layout.tsx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { ReactNode } from 'react'
export default function Root({ children }: { children: ReactNode }) {
return (
<html>
<body>{children}</body>
</html>
)
}
3 changes: 3 additions & 0 deletions test/e2e/app-dir/navigation-redirect-import/app/page.tsx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export default function Page() {
return <p>hello world</p>
}
8 changes: 8 additions & 0 deletions test/e2e/app-dir/navigation-redirect-import/app/route-handler/route.ts
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { redirect } from 'next/navigation'

// Redirect can't be called in a route handler, but it should be able to be imported.
console.log({ redirect })

export function GET() {
return new Response('hello world')
}
5 changes: 5 additions & 0 deletions test/e2e/app-dir/navigation-redirect-import/middleware.ts
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import { redirect } from 'next/navigation'
// Redirect can't be called in middleware, but it should be able to be imported.
console.log({ redirect })

export default function middleware() {}
13 changes: 13 additions & 0 deletions test/e2e/app-dir/navigation-redirect-import/navigation-redirect-import.test.ts
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import { nextTestSetup } from 'e2e-utils'

describe('navigation-redirect-import', () => {
const { next } = nextTestSetup({
files: __dirname,
})

it('should work using fetch', async () => {
const res = await next.fetch('/route-handler')
expect(res.status).toBe(200)
expect(await res.text()).toBe('hello world')
})
})
6 changes: 6 additions & 0 deletions test/e2e/app-dir/navigation-redirect-import/next.config.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/**
* @type {import('next').NextConfig}
*/
const nextConfig = {}

module.exports = nextConfig

0 comments on commit 08b75b7

Please sign in to comment.