Skip to content

Commit

Permalink
fix i18n data pathname resolving
Browse files Browse the repository at this point in the history
  • Loading branch information
ztanner committed Aug 15, 2024
1 parent 2865e18 commit 1b9e048
Show file tree
Hide file tree
Showing 7 changed files with 134 additions and 3 deletions.
20 changes: 17 additions & 3 deletions packages/next/src/shared/lib/i18n/normalize-locale-path.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,17 @@ export function normalizeLocalePath(
locales?: string[]
): PathLocale {
let detectedLocale: string | undefined
// first item will be empty string from splitting at first char
const pathnameParts = pathname.split('/')
const isDataRoute = pathname.startsWith('/_next/data')

// Create a pathname for locale detection, removing /_next/data/[buildId] if present
// This is because locale detection relies on path splitting and so the first part
// should be the locale.
const pathNameNoDataPrefix = isDataRoute
? pathname.replace(/^\/_next\/data\/[^/]+/, '')
: pathname

// Split the path for locale detection
const pathnameParts = pathNameNoDataPrefix.split('/')

;(locales || []).some((locale) => {
if (
Expand All @@ -27,12 +36,17 @@ export function normalizeLocalePath(
) {
detectedLocale = locale
pathnameParts.splice(1, 1)
pathname = pathnameParts.join('/') || '/'
return true
}
return false
})

// For non-data routes, we return the path with the locale stripped out.
// For data routes, we keep the path as is, since we only want to extract the locale.
if (detectedLocale && !isDataRoute) {
pathname = pathnameParts.join('/') || '/'
}

return {
pathname,
detectedLocale,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
import { nextTestSetup } from 'e2e-utils'

describe('i18n-navigations-middleware', () => {
const { next } = nextTestSetup({
files: __dirname,
})

it('should respect selected locale when navigating to a dynamic route', async () => {
const browser = await next.browser('/')
// change to "de" locale
await browser.elementByCss("[href='/de']").click()
const dynamicLink = await browser.waitForElementByCss(
"[href='/de/dynamic/1']"
)
expect(await browser.elementById('current-locale').text()).toBe(
'Current locale: de'
)

// navigate to dynamic route
await dynamicLink.click()

// the locale should still be "de"
expect(await browser.elementById('dynamic-locale').text()).toBe(
'Locale: de'
)
})

it('should respect selected locale when navigating to a static route', async () => {
const browser = await next.browser('/')
// change to "de" locale
await browser.elementByCss("[href='/de']").click()
const staticLink = await browser.waitForElementByCss("[href='/de/static']")
expect(await browser.elementById('current-locale').text()).toBe(
'Current locale: de'
)

// navigate to static route
await staticLink.click()

// the locale should still be "de"
expect(await browser.elementById('static-locale').text()).toBe('Locale: de')
})
})
6 changes: 6 additions & 0 deletions test/e2e/i18n-navigations-middleware/middleware.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import { NextResponse } from 'next/server'

export const config = { matcher: ['/foo'] }
export async function middleware(req) {
return NextResponse.next()
}
9 changes: 9 additions & 0 deletions test/e2e/i18n-navigations-middleware/next.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/**
* @type {import('next').NextConfig}
*/
module.exports = {
i18n: {
defaultLocale: 'default',
locales: ['default', 'en', 'de'],
},
}
11 changes: 11 additions & 0 deletions test/e2e/i18n-navigations-middleware/pages/dynamic/[id].js
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
export const getServerSideProps = async ({ locale }) => {
return {
props: {
locale,
},
}
}

export default function Dynamic({ locale }) {
return <div id="dynamic-locale">Locale: {locale}</div>
}
37 changes: 37 additions & 0 deletions test/e2e/i18n-navigations-middleware/pages/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import Link from 'next/link'

export const getServerSideProps = async ({ locale }) => {
return {
props: {
locale,
},
}
}

export default function Home({ locale }) {
return (
<main
style={{
display: 'flex',
flexDirection: 'column',
gap: '20px',
}}
>
<p id="current-locale">Current locale: {locale}</p>
Locale switch:
<Link href="/" locale="default">
Default
</Link>
<Link href="/" locale="en">
English
</Link>
<Link href="/" locale="de">
German
</Link>
<br />
Test links:
<Link href="/dynamic/1">Dynamic 1</Link>
<Link href="/static">Static</Link>
</main>
)
}
11 changes: 11 additions & 0 deletions test/e2e/i18n-navigations-middleware/pages/static.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
export const getServerSideProps = async ({ locale }) => {
return {
props: {
locale,
},
}
}

export default function Static({ locale }) {
return <div id="static-locale">Locale: {locale}</div>
}

0 comments on commit 1b9e048

Please sign in to comment.