Skip to content

fix(i18n): pass build.format when computing the redirect #9739

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ematipico merged 4 commits into from
Jan 22, 2024
Merged

fix(i18n): pass build.format when computing the redirect #9739

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2ad0e54
fix(i18n): pass `build.format` when computing the direct
ematipico Jan 19, 2024
c3b1557
Update .changeset/fifty-pots-greet.md
natemoo-re Jan 20, 2024
6bc71ab
update tests
ematipico Jan 22, 2024
7375ebf
add more tests
ematipico Jan 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fifty-pots-greet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"astro": patch
---

Makes i18n redirects take the `build.format` configuration into account
3 changes: 2 additions & 1 deletion packages/astro/src/core/app/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,8 @@ export class App {
const i18nMiddleware = createI18nMiddleware(
this.#manifest.i18n,
this.#manifest.base,
this.#manifest.trailingSlash
this.#manifest.trailingSlash,
this.#manifest.buildFormat
);
if (i18nMiddleware) {
if (mod.onRequest) {
Expand Down
1 change: 1 addition & 0 deletions packages/astro/src/core/app/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ export type SSRManifest = {
site?: string;
base: string;
trailingSlash: 'always' | 'never' | 'ignore';
buildFormat: 'file' | 'directory';
compressHTML: boolean;
assetsPrefix?: string;
renderers: SSRLoadedRenderer[];
Expand Down
4 changes: 3 additions & 1 deletion packages/astro/src/core/build/generate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,8 @@ async function generatePage(
const i18nMiddleware = createI18nMiddleware(
pipeline.getManifest().i18n,
pipeline.getManifest().base,
pipeline.getManifest().trailingSlash
pipeline.getManifest().trailingSlash,
pipeline.getManifest().buildFormat
);
if (config.i18n && i18nMiddleware) {
if (onRequest) {
Expand Down Expand Up @@ -657,5 +658,6 @@ export function createBuildManifest(
: settings.config.site,
componentMetadata: internals.componentMetadata,
i18n: i18nManifest,
buildFormat: settings.config.build.format,
};
}
1 change: 1 addition & 0 deletions packages/astro/src/core/build/plugins/plugin-manifest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,5 +264,6 @@ function buildManifest(
entryModules,
assets: staticFiles.map(prefixAssetPath),
i18n: i18nManifest,
buildFormat: settings.config.build.format,
};
}
6 changes: 4 additions & 2 deletions packages/astro/src/i18n/middleware.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { appendForwardSlash, joinPaths } from '@astrojs/internal-helpers/path';
import type { Locales, MiddlewareHandler, RouteData, SSRManifest } from '../@types/astro.js';
import type { PipelineHookFunction } from '../core/pipeline.js';
import { getPathByLocale, normalizeTheLocale } from './index.js';
import { shouldAppendForwardSlash } from '../core/build/util.js';

const routeDataSymbol = Symbol.for('astro.routeData');

Expand All @@ -26,7 +27,8 @@ function pathnameHasLocale(pathname: string, locales: Locales): boolean {
export function createI18nMiddleware(
i18n: SSRManifest['i18n'],
base: SSRManifest['base'],
trailingSlash: SSRManifest['trailingSlash']
trailingSlash: SSRManifest['trailingSlash'],
buildFormat: SSRManifest['buildFormat']
): MiddlewareHandler | undefined {
if (!i18n) {
return undefined;
Expand Down Expand Up @@ -83,7 +85,7 @@ export function createI18nMiddleware(

case 'pathname-prefix-always': {
if (url.pathname === base + '/' || url.pathname === base) {
if (trailingSlash === 'always') {
if (shouldAppendForwardSlash(trailingSlash, buildFormat)) {
return context.redirect(`${appendForwardSlash(joinPaths(base, i18n.defaultLocale))}`);
} else {
return context.redirect(`${joinPaths(base, i18n.defaultLocale)}`);
Expand Down
1 change: 1 addition & 0 deletions packages/astro/src/vite-plugin-astro-server/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ export function createDevelopmentManifest(settings: AstroSettings): SSRManifest
}
return {
trailingSlash: settings.config.trailingSlash,
buildFormat: settings.config.build.format,
compressHTML: settings.config.compressHTML,
assets: new Set(),
entryModules: {},
Expand Down
7 changes: 6 additions & 1 deletion packages/astro/src/vite-plugin-astro-server/route.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,12 @@ export async function handleRoute({

const onRequest = middleware?.onRequest as MiddlewareHandler | undefined;
if (config.i18n) {
const i18Middleware = createI18nMiddleware(config.i18n, config.base, config.trailingSlash);
const i18Middleware = createI18nMiddleware(
config.i18n,
config.base,
config.trailingSlash,
config.build.format
);

if (i18Middleware) {
if (onRequest) {
Expand Down
84 changes: 82 additions & 2 deletions packages/astro/test/i18n-routing.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,44 @@ describe('[DEV] i18n routing', () => {
const response = await fixture.fetch('/new-site/fr/start');
expect(response.status).to.equal(404);
});

describe('when `build.format` is `directory`', () => {
before(async () => {
fixture = await loadFixture({
root: './fixtures/i18n-routing-prefix-other-locales/',
i18n: {
defaultLocale: 'en',
locales: [
'en',
'pt',
'it',
{
path: 'spanish',
codes: ['es', 'es-AR'],
},
],
fallback: {
it: 'en',
spanish: 'en',
},
},
build: {
format: 'directory',
},
});
devServer = await fixture.startDevServer();
});

after(async () => {
await devServer.stop();
});

it('should redirect to the english locale with trailing slash', async () => {
const response = await fixture.fetch('/new-site/it/start/');
expect(response.status).to.equal(200);
expect(await response.text()).includes('Start');
});
});
});

describe('i18n routing with routing strategy [pathname-prefix-always-no-redirect]', () => {
Expand Down Expand Up @@ -675,6 +713,7 @@ describe('[SSG] i18n routing', () => {
it('should redirect to the index of the default locale', async () => {
const html = await fixture.readFile('/index.html');
expect(html).to.include('http-equiv="refresh');
expect(html).to.include('http-equiv="refresh');
expect(html).to.include('url=/new-site/en');
});

Expand Down Expand Up @@ -744,6 +783,25 @@ describe('[SSG] i18n routing', () => {
expect(html).to.include('url=/new-site/en');
});
});

describe('when `build.format` is `directory`', () => {
before(async () => {
fixture = await loadFixture({
root: './fixtures/i18n-routing-prefix-always/',
build: {
format: 'directory',
},
});
await fixture.build();
});

it('should redirect to the index of the default locale', async () => {
const html = await fixture.readFile('/index.html');
expect(html).to.include('http-equiv="refresh');
expect(html).to.include('http-equiv="refresh');
expect(html).to.include('url=/new-site/en/');
});
});
});

describe('i18n routing with fallback', () => {
Expand Down Expand Up @@ -940,7 +998,7 @@ describe('[SSR] i18n routing', () => {
let request = new Request('http://example.com/new-site');
let response = await app.render(request);
expect(response.status).to.equal(302);
expect(response.headers.get('location')).to.equal('/new-site/en');
expect(response.headers.get('location')).to.equal('/new-site/en/');
});

it('should render the en locale', async () => {
Expand Down Expand Up @@ -1118,7 +1176,7 @@ describe('[SSR] i18n routing', () => {
let request = new Request('http://example.com/new-site');
let response = await app.render(request);
expect(response.status).to.equal(302);
expect(response.headers.get('location')).to.equal('/new-site/en');
expect(response.headers.get('location')).to.equal('/new-site/en/');
});

it('should render the en locale', async () => {
Expand Down Expand Up @@ -1173,6 +1231,28 @@ describe('[SSR] i18n routing', () => {
expect(response.headers.get('location')).to.equal('/new-site/en/');
});
});

describe('when `build.format` is `directory`', () => {
before(async () => {
fixture = await loadFixture({
root: './fixtures/i18n-routing-prefix-always/',
output: 'server',
adapter: testAdapter(),
build: {
format: 'directory',
},
});
await fixture.build();
app = await fixture.loadTestAdapterApp();
});

it('should redirect to the index of the default locale', async () => {
let request = new Request('http://example.com/new-site/');
let response = await app.render(request);
expect(response.status).to.equal(302);
expect(response.headers.get('location')).to.equal('/new-site/en/');
});
});
});

describe('with fallback', () => {
Expand Down