feat(i18n): disable redirect to default language #9638

ematipico · 2024-01-08T11:57:58Z

Changes

Closes PLT-1318

This PR adds a new option to the i18n.routing object, called redirectToDefaultLocale, which comes into play when the option prefixDefaultLocale comes into play (it's true).

This new option is true by default to maintain the current behaviour of the routing, where Astro does a redirect from / to /<defaultLocale>.

When this option is set to false, the redirect isn't triggered anymore.

List of technical changes inside the PR:

I added a new schema validation, where we throw an error when redirectToDefaultLocale is false and prefixDefaultLocale is false. The reason why I added an error is that this combination of options doesn't have any effect, so I want to enforce a sense of correctness when configuring the i18n.
I refactored some types. Before, the routing name types were copied all over the code base, and it was unmaintainable. I created a type that is now imported everywhere.
The core of the logic occurs in the middleware.

Testing

I added new test cases that should cover DEV, SSG and SSR

Docs

/cc @withastro/maintainers-docs for feedback!

I will create a PR in the docs repository to update the page.

changeset-bot · 2024-01-08T11:58:02Z

🦋 Changeset detected

Latest commit: 598a1ae

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

packages/astro/src/core/config/schema.ts

packages/astro/src/i18n/middleware.ts

bluwy · 2024-01-11T08:29:19Z

packages/astro/src/i18n/middleware.ts

+				case 'pathname-prefix-always': {
+					if (url.pathname === base + '/' || url.pathname === base) {
+						if (trailingSlash === 'always') {


Unrelated: It looks like the prefix is only added when trailingSlash is set to always. Shouldn't the prefix also be added for other trailingSlash configurations?

Right, although to check the other variants, we need build.format, which is a piece of information that we don't have in SSR (in the SSR manifest), that's why I only check always. Should we store build.format in the SSRManifest?

Ah ok that makes sense. I think it's fine to store build.format then if it helps improve things here. We can definitely improve this in a later PR.

Co-authored-by: Bjorn Lu <[email protected]>

sarah11918

Thanks, @ematipico ! Made some suggestions here, based on the docs PR suggestions I made. See what you think of these, and edit to taste!

.changeset/cyan-grapes-suffer.md

packages/astro/src/@types/astro.ts

Co-authored-by: Sarah Rainsberger <[email protected]>

…9666) * Remove the header script before a view transition takes place to force a reload on the next page * Add changeset * Save another char

) * fix(assets): Implement all hooks in the passthrough image service * chore: changeset

… to toolbar/apps (#9647) * refactor(toolbar): Rename every internal reference of overlay/plugins to toolbar/apps * refactor: rename vite plugin * fix: update import * nit: add setting fallback

* fix(i18n): emit an error when the index isn't found * changeset * Update .changeset/proud-guests-bake.md Co-authored-by: Sarah Rainsberger <[email protected]> * rename * Update packages/astro/src/core/errors/errors-data.ts Co-authored-by: Florian Lefebvre <[email protected]> --------- Co-authored-by: Sarah Rainsberger <[email protected]> Co-authored-by: Florian Lefebvre <[email protected]>

.changeset/cyan-grapes-suffer.md

.changeset/long-mangos-walk.md

sarah11918

Docs is happy! Looking forward to this, @ematipico ! 🥳

…-language

github-actions

This PR is blocked because it contains a minor changeset. A reviewer will merge this at the next release if approved.

bluwy

Looks great 👍

packages/astro/src/@types/astro.ts

Co-authored-by: Bjorn Lu <[email protected]>

…-language

Merge day

github-actions

This PR is blocked because it contains a minor changeset. A reviewer will merge this at the next release if approved.

github-actions bot added pkg: astro Related to the core `astro` package (scope) pr: docs A PR that includes documentation for review labels Jan 8, 2024

bluwy reviewed Jan 11, 2024

View reviewed changes

ematipico added this to the 4.2.0 milestone Jan 11, 2024

ematipico mentioned this pull request Jan 11, 2024

feat(i18n): document new option withastro/docs#6265

Merged

ematipico and others added 8 commits January 11, 2024 12:55

feat(i18n): disable redirect

9f44a51

feat(i18n): add option to disable redirect to default language

6aff285

chore: add schema validation

3165346

docs

eefdf81

changeset

6130aed

Update packages/astro/src/core/config/schema.ts

312ec61

Co-authored-by: Bjorn Lu <[email protected]>

chore: address feedback

12e139c

fix test

5a864a1

ematipico force-pushed the feat/redirect-default-language branch from bd56a60 to 5a864a1 Compare January 11, 2024 12:59

sarah11918 reviewed Jan 12, 2024

View reviewed changes

.changeset/cyan-grapes-suffer.md Outdated Show resolved Hide resolved

packages/astro/src/@types/astro.ts Outdated Show resolved Hide resolved

ematipico and others added 13 commits January 12, 2024 14:18

Update .changeset/cyan-grapes-suffer.md

3bd5d53

Co-authored-by: Sarah Rainsberger <[email protected]>

Update packages/astro/src/@types/astro.ts

81f9d9f

Co-authored-by: Sarah Rainsberger <[email protected]>

Fix discord fetch code (#9663)

fad30d5

Force re-execution of Partytown's head snippet on view transitions (#…

4e5f64f

…9666) * Remove the header script before a view transition takes place to force a reload on the next page * Add changeset * Save another char

[ci] format

c24746e

fix(assets): Implement all hooks in the passthrough image service (#9668

92cca7e

) * fix(assets): Implement all hooks in the passthrough image service * chore: changeset

refactor(toolbar): Rename every internal reference of overlay/plugins…

3e408a3

… to toolbar/apps (#9647) * refactor(toolbar): Rename every internal reference of overlay/plugins to toolbar/apps * refactor: rename vite plugin * fix: update import * nit: add setting fallback

Disable file watcher for internal one-off vite servers (#9665)

9bb779d

Use node:test and node:assert/strict (#9649)

9b1f251

[ci] format

5291484

feat(i18n): add option to disable redirect to default language

8574140

chore: rebase

e3255cb

github-actions bot added the pkg: integration Related to any renderer integration (scope) label Jan 12, 2024

sarah11918 reviewed Jan 12, 2024

View reviewed changes

.changeset/cyan-grapes-suffer.md Show resolved Hide resolved

sarah11918 reviewed Jan 12, 2024

View reviewed changes

.changeset/long-mangos-walk.md Outdated Show resolved Hide resolved

sarah11918 approved these changes Jan 12, 2024

View reviewed changes

Merge remote-tracking branch 'origin/main' into feat/redirect-default…

a5fd580

…-language

ematipico force-pushed the feat/redirect-default-language branch from 07defb4 to a5fd580 Compare January 16, 2024 09:33

github-actions bot added semver: minor Change triggers a `minor` release and removed pkg: integration Related to any renderer integration (scope) labels Jan 16, 2024

github-actions bot previously requested changes Jan 16, 2024

View reviewed changes

bluwy approved these changes Jan 16, 2024

View reviewed changes

packages/astro/src/@types/astro.ts Outdated Show resolved Hide resolved

ematipico and others added 4 commits January 16, 2024 09:55

Update packages/astro/src/@types/astro.ts

668fb66

Co-authored-by: Bjorn Lu <[email protected]>

lock file update

92c83ed

Merge remote-tracking branch 'origin/main' into feat/redirect-default…

e159b10

…-language

Merge branch 'main' into feat/redirect-default-language

598a1ae

ematipico merged commit f1a6126 into main Jan 17, 2024
3 checks passed

ematipico deleted the feat/redirect-default-language branch January 17, 2024 13:25

github-actions bot requested changes Jan 17, 2024

View reviewed changes

astrobot-houston mentioned this pull request Jan 17, 2024

[ci] release #9709

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(i18n): disable redirect to default language #9638

feat(i18n): disable redirect to default language #9638

ematipico commented Jan 8, 2024

changeset-bot bot commented Jan 8, 2024 •

edited

Loading

bluwy Jan 11, 2024

ematipico Jan 11, 2024 •

edited

Loading

bluwy Jan 16, 2024

sarah11918 left a comment

sarah11918 left a comment

github-actions bot left a comment

bluwy left a comment

github-actions bot left a comment

feat(i18n): disable redirect to default language #9638

feat(i18n): disable redirect to default language #9638

Conversation

ematipico commented Jan 8, 2024

Changes

Testing

Docs

changeset-bot bot commented Jan 8, 2024 • edited Loading

🦋 Changeset detected

bluwy Jan 11, 2024

Choose a reason for hiding this comment

ematipico Jan 11, 2024 • edited Loading

Choose a reason for hiding this comment

bluwy Jan 16, 2024

Choose a reason for hiding this comment

sarah11918 left a comment

Choose a reason for hiding this comment

sarah11918 left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

bluwy left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

changeset-bot bot commented Jan 8, 2024 •

edited

Loading

ematipico Jan 11, 2024 •

edited

Loading