redirect does not respect as-needed locale prefix
#1335
Labels
bug
Something isn't working
Comments
Merged
|
Thanks for the report! I'm currently working on a re-implementation of the navigation APIs in #1316 in order to address some long-standing issues. I think the issue you've reported can be solved too as part of that, I've put this on my list! This is currently my top priority, I'll keep you updated! |
This was referenced Sep 19, 2024
amannn
added a commit
that referenced
this issue
Oct 1, 2024
This PR provides a new **`createNavigation`** function that supersedes
the previously available APIs:
1. `createSharedPathnamesNavigation`
2. `createLocalizedPathnamesNavigation`
The new function unifies the API for both use cases and also fixes a few
quirks in the previous APIs.
**Usage**
```tsx
import {createNavigation} from 'next-intl/navigation';
import {defineRouting} from 'next-intl/routing';
export const routing = defineRouting(/* ... */);
export const {Link, redirect, usePathname, useRouter} =
createNavigation(routing);
```
(see the [updated navigation
docs](https://next-intl-docs-git-feat-create-navigation-next-intl.vercel.app/docs/routing/navigation))
**Improvements**
1. A single API can be used both for shared as well as localized
pathnames. This reduces the API surface and simplifies the corresponding
docs.
2. `Link` can now be composed seamlessly into another component with its
`href` prop without having to add a generic type argument.
3. `getPathname` is now available for both shared as well as localized
pathnames (fixes #785)
4. `router.push` and `redirect` now accept search params consistently
via the object form (e.g. `router.push({pathname: '/users', query:
{sortBy: 'name'})`)—regardless of if you're using shared or localized
pathnames.
5. When using `localePrefix: 'as-necessary'`, the initial render of
`Link` now uses the correct pathname immediately during SSR (fixes
[#444](#444)). Previously, a
prefix for the default locale was added during SSR and removed during
hydration. Also `redirect` now gets the final pathname right without
having to add a superfluous prefix (fixes
[#1335](#1335)). The only
exception is when you use `localePrefix: 'as-necessary'` in combination
with `domains` (see [Special case: Using `domains` with `localePrefix:
'as-needed'`](https://next-intl-docs-git-feat-create-navigation-next-intl.vercel.app/docs/routing#domains-localeprefix-asneeded))
6. `Link` is now compatible with the `asChild` prop of Radix Primitives
when rendered in RSC (see
[#1322](#1322))
**Migrating to `createNavigation`**
`createNavigation` is generally considered a drop-in replacement, but a
few changes might be necessary:
1. `createNavigation` is expected to receive your complete routing
configuration. Ideally, you define this via the
[`defineRouting`](https://next-intl-docs.vercel.app/docs/routing#define-routing)
function and pass the result to `createNavigation`.
2. If you've used `createLocalizedPathnamesNavigation` and have
[composed the `Link` with its `href`
prop](https://next-intl-docs.vercel.app/docs/routing/navigation#link-composition),
you should no longer provide the generic `Pathname` type argument (see
[updated
docs](https://next-intl-docs-git-feat-create-navigation-next-intl.vercel.app/docs/routing/navigation#link-composition)).
```diff
- ComponentProps<typeof Link<Pathname>>
+ ComponentProps<typeof Link>
```
3. If you've used
[`redirect`](https://next-intl-docs.vercel.app/docs/routing/navigation#redirect),
you now have to provide an explicit locale (even if it's just [the
current
locale](https://next-intl-docs.vercel.app/docs/usage/configuration#locale)).
This change was necessary for an upcoming change in Next.js 15 where
`headers()` turns into a promise (see
[#1375](#1375) for details).
```diff
- redirect('/about')
+ redirect({pathname: '/about', locale: 'en'})
```
4. If you've used
[`getPathname`](https://next-intl-docs.vercel.app/docs/routing/navigation#getpathname)
and have previously manually prepended a locale prefix, you should no
longer do so—`getPathname` now takes care of this depending on your
routing strategy.
```diff
- '/'+ locale + getPathname(/* ... */)
+ getPathname(/* ... */);
```
5. If you're using a combination of `localePrefix: 'as-necessary'` and
`domains` and you're using `getPathname`, you now need to provide a
`domain` argument (see [Special case: Using `domains` with
`localePrefix:
'as-needed'`](https://next-intl-docs-git-feat-create-navigation-next-intl.vercel.app/docs/routing#domains-localeprefix-asneeded))
|
The feedback raised in this issue has been addressed as part of an upcoming Also, thanks again for the great feedback here! 🙏❤️ |
1 task
|
@amannn HI! When use the Link component from routing, for links to the default locale you expect an href like but you get DOM render This does not interfere with user navigation (307 redirect works well). But it is a problem for SEO. I suspect the problem is here: missing if locale === defaultLocale ... |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Description
When using locale prefix
as-needed, I would expectredirectto respect this configuration, instead it will append default locale. This is not how usingLinkbehaves, so it is unexpected. For non default locales, I would expect forredirectto append locale prefix.Verifications
Mandatory reproduction URL
https://next-intl-redirect-issue-of1rlux37-jorgemoyas-projects.vercel.app/
Reproduction description
Steps to reproduce:
Click to redirectExpected behaviour
The expected behavior would be to respect the
as-neededlocale prefix configuration and for navigation within the default locale to ignore appending locale, much like using theLinkcomponent. For non default locales it would be fine to append locale prefix.The text was updated successfully, but these errors were encountered: