feat(i18n): domain support #9143

ematipico · 2023-11-20T20:17:31Z

Changes

Closes PLT-1317

This PR adds domain support for i18n routing.

Here's the relevant RFC: withastro/roadmap#798

Technical changes

As stated in the RFC, there are a bunch of restrictions when enabling this functionality:

base must be set
output must be server
we shouldn't have pre-rendered pages

Hence, I added a bunch of errors and validation for the configuration schema

Theoretically, the Node.js adapter is the only one that would require less work to set up domains. Some work is still needed because the reserve proxy of the application needs to send the proper headers to the Node.js server, as explained in the RFC. Regardless, I preferred to mark the support as experimental.

Regarding the Vercel adapter, I decided to mark it unsupported for now, although I am open to considering "experimental" too. I want to highlight that serverless environments require more work to set multiple domains, and I am not sure if we were able to set them up from the vercel.json; for this reason I am not sure how to communicate it, and that's why I set unsupported.

Update: myself and @matthewp decided to flag the support as experimental.

Testing

I added new tests that should verify the new behaviour of the *Absolute functions.

I added new integrations tests to very that the Requests are correctly handled when we send the proper headers.

Docs

/cc @withastro/maintainers-docs for feedback!

changeset-bot · 2023-11-20T20:17:36Z

🦋 Changeset detected

Latest commit: 666f3e3

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

…de/vercel

sarah11918

Did a quick review of the changeset first! (Have not yet looked at the API docs) because I want to make sure I understand what's happening here to get the API descriptions just right!

.changeset/tidy-carrots-jump.md

packages/astro/src/core/app/index.ts

matthewp

I think it's better to use the 1 arg form of new URL unless there's a reason to do it the other way that I can't think of?

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

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

matthewp

We're going to release this in 4.x

sarah11918

Thanks for your help with this one, @ematipico ! I fixed some silly formatting/typos in the changeset, but I think it's now quite good!

Had a suggestion for each of the config items. They might be a bit verbose, but we can always refine them, and once we've finalized the guide, we'll know for sure which info we want there vs here. I think these are still the minimum we might want someone to see when they're looking things up in reference, though? Let's see what we think!

.changeset/tidy-carrots-jump.md

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

sarah11918

OK! These update to the agreed-upon configuration set up! I'm happy with the changeset as is, but still want to fine-tune the docs entry, especially because of the experimental-ness of it. (This entry doesn't explicitly mention the experimental flag, for example and we must do that!

I'm thinking that maybe we should put the docs entry under Experimental Flags. I think that makes the most organizational sense, and would make the instruction to enable a flag, then add a domains to a pre-configured i18n site easier to include here. Being experimental, this feature might change anyway. And even if it doesn't that means editing more than just the name of this entry to update config-reference here. So I'm not convinced we save much by having it here vs experimental.

Another option could be to write this entry here as if it were NOT experimental, just not expose it to docs. Then, add a complete corresponding entry as if it IS expermental in the Experimental flags section that DOES show up in docs. When it's no longer experimental, we entirely delete the experimental entry and (making sure it's updated), then add back @docs here. (If I'm writing this once, copy and paste is free!)

Thoughts?

.changeset/tidy-carrots-jump.md

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

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

.changeset/tidy-carrots-jump.md

…l strategy

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

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

.changeset/tidy-carrots-jump.md

sarah11918

ALRIGHT! I am approving for the sake of completion! 🥳

If there are any syntax errors or nits, I'll find them after this is merged on Wed. and I can check and make any quick fixes well before releasing on Thursday. 🫡

Merge day

jlarmstrongiv · 2024-02-02T02:04:51Z

I’m getting errors, despite not using i18nDomains

19:01:17 [ERROR] [config] The feature "i18nDomains" is not supported (used by astro-sst).
19:01:17 [ERROR] The adapter astro-sst doesn't support the feature i18nDomains. Your project won't be built. You should not use it.

* i18n(domains): validation and updated logic (#9099) * feat(i18n): domain with lookup table (#9112) * chore: add changelog, fix types and enable experimental support in node/vercel * rebase and update lock file * chore: fix failing test * Apply suggestions from code review Co-authored-by: Sarah Rainsberger <[email protected]> Co-authored-by: Matthew Phillips <[email protected]> * Update .changeset/tidy-carrots-jump.md Co-authored-by: Sarah Rainsberger <[email protected]> * wip * chore: rebase, conflicts and tests * update lock file * chore: correct configuration * chore: correct configuration * fix: regressions * chore: fix conflicts and add more tests * chore: add more validation * chore: more tests and add more restrictions * fix changeset * change and revert adapters * add another restriction * lock file update * Update packages/astro/src/@types/astro.ts Co-authored-by: Sarah Rainsberger <[email protected]> * Update packages/astro/src/@types/astro.ts Co-authored-by: Bjorn Lu <[email protected]> * wat * fix syntax error * fix config example * Fix for #9673 (#9680) * Fix for #9673 * 🦋 add changeset file * Update breezy-plants-smoke.md Co-authored-by: Florian Lefebvre <[email protected]> * ⚡️ simplified normalizeConfigPath --------- Co-authored-by: Florian Lefebvre <[email protected]> * Fix env var replacement for export const prerender (#9807) * feat(alpinejs): allow customizing the Alpine instance (#9751) * feat(alpinejs): allows customzing the Alpine instance * chore: add e2e tests * fix: rename script * Update index.ts * fix: lockfile * [ci] format * chore: use correct lock file * chore: rebase * fix regressions in tests * fix regressions in tests * fix build * add description * fix missing types * chore: fix tests, again :D * eslint * Update packages/astro/src/@types/astro.ts Co-authored-by: Nate Moore <[email protected]> * chore: address feedback * chore: fix regressions * chore: refactor naming * Update packages/astro/src/core/app/index.ts Co-authored-by: Bjorn Lu <[email protected]> * chore: address feedback * update lock file * chore: infer routing from options, not strategy * merge from main * merge from main * Experimental support in vercel adapter * Update packages/astro/src/@types/astro.ts Co-authored-by: Sarah Rainsberger <[email protected]> * Update packages/astro/src/@types/astro.ts Co-authored-by: Sarah Rainsberger <[email protected]> * Update .changeset/tidy-carrots-jump.md Co-authored-by: Sarah Rainsberger <[email protected]> * better changesets * Updates both experimental.i18nDomains and i18ndomains for experimental strategy * fix link syntax * consistent tabs/spaces * Update packages/astro/src/@types/astro.ts Co-authored-by: Sarah Rainsberger <[email protected]> * apply suggestion --------- Co-authored-by: Sarah Rainsberger <[email protected]> Co-authored-by: Matthew Phillips <[email protected]> Co-authored-by: Bjorn Lu <[email protected]> Co-authored-by: Lou Cyx <[email protected]> Co-authored-by: Florian Lefebvre <[email protected]> Co-authored-by: Florian Lefebvre <[email protected]> Co-authored-by: Nate Moore <[email protected]>

github-actions bot added pkg: astro Related to the core `astro` package (scope) pr: docs A PR that includes documentation for review pkg: integration Related to any renderer integration (scope) labels Nov 20, 2023

ematipico changed the title ~~i18n(domains): validation and updated logic (#9099)~~ feat(i18n): domain support Nov 21, 2023

ematipico added 4 commits November 21, 2023 09:10

i18n(domains): validation and updated logic (#9099)

5f7f011

feat(i18n): domain with lookup table (#9112)

daefc9e

chore: add changelog, fix types and enable experimental support in no…

dbd63d8

…de/vercel

rebase and update lock file

a749caa

ematipico marked this pull request as ready for review November 21, 2023 15:11

ematipico force-pushed the feat/i18n-domain branch from f2099af to a749caa Compare November 21, 2023 15:11

ematipico mentioned this pull request Nov 21, 2023

feat(i18n): domain routing strategy withastro/docs#5469

Closed

sarah11918 reviewed Nov 21, 2023

View reviewed changes

.changeset/tidy-carrots-jump.md Outdated Show resolved Hide resolved

.changeset/tidy-carrots-jump.md Outdated Show resolved Hide resolved

matthewp reviewed Nov 21, 2023

View reviewed changes

packages/astro/src/core/app/index.ts Outdated Show resolved Hide resolved

matthewp reviewed Nov 21, 2023

View reviewed changes

packages/astro/src/core/app/index.ts Outdated Show resolved Hide resolved

matthewp reviewed Nov 21, 2023

View reviewed changes

ematipico force-pushed the feat/i18n-domain branch from a1c4cbc to 4d7f6ed Compare November 21, 2023 17:24

chore: fix failing test

6b4c762

ematipico force-pushed the feat/i18n-domain branch from 4d7f6ed to 6b4c762 Compare November 21, 2023 17:26

ematipico and others added 2 commits November 21, 2023 11:32

Apply suggestions from code review

56f5e3c

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

Update .changeset/tidy-carrots-jump.md

85957c0

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

ematipico requested review from matthewp and sarah11918 November 21, 2023 18:44

matthewp approved these changes Nov 21, 2023

View reviewed changes

matthewp previously requested changes Nov 21, 2023

View reviewed changes

sarah11918 reviewed Nov 23, 2023

View reviewed changes

bluwy approved these changes Nov 23, 2023

View reviewed changes

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

ematipico added 3 commits December 14, 2023 13:23

Merge remote-tracking branch 'origin/main' into feat/i18n-domain

8e548b8

wip

db9b5e8

Merge branch 'main' into feat/i18n-domain

9abdfd7

sarah11918 reviewed Jan 30, 2024

View reviewed changes

.changeset/tidy-carrots-jump.md Outdated Show resolved Hide resolved

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

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

sarah11918 reviewed Jan 30, 2024

View reviewed changes

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

ematipico and others added 4 commits January 30, 2024 16:50

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

24eac1c

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

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

4c16ea7

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

Update .changeset/tidy-carrots-jump.md

ab6cfe8

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

Merge branch 'main' into feat/i18n-domain

090dfec

sarah11918 reviewed Jan 30, 2024

View reviewed changes

.changeset/tidy-carrots-jump.md Outdated Show resolved Hide resolved

ematipico and others added 3 commits January 30, 2024 17:16

better changesets

8033d7d

Merge remote-tracking branch 'origin/main' into feat/i18n-domain

f0b2bfb

Updates both experimental.i18nDomains and i18ndomains for experimenta…

5c28342

…l strategy

sarah11918 reviewed Jan 30, 2024

View reviewed changes

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

sarah11918 reviewed Jan 30, 2024

View reviewed changes

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

fix link syntax

36b73ac

sarah11918 reviewed Jan 30, 2024

View reviewed changes

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

sarah11918 reviewed Jan 30, 2024

View reviewed changes

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

sarah11918 and others added 2 commits January 30, 2024 13:56

consistent tabs/spaces

afaaadf

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

2565610

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

sarah11918 reviewed Jan 30, 2024

View reviewed changes

.changeset/tidy-carrots-jump.md Outdated Show resolved Hide resolved

sarah11918 approved these changes Jan 30, 2024

View reviewed changes

ematipico added 2 commits January 31, 2024 09:57

apply suggestion

b5e20f3

Merge branch 'main' into feat/i18n-domain

666f3e3

ematipico merged commit 041fdd5 into main Jan 31, 2024
14 checks passed

ematipico deleted the feat/i18n-domain branch January 31, 2024 13:55

astrobot-houston mentioned this pull request Jan 31, 2024

[ci] release #9904

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(i18n): domain support #9143

feat(i18n): domain support #9143

ematipico commented Nov 20, 2023 •

edited

Loading

changeset-bot bot commented Nov 20, 2023 •

edited

Loading

sarah11918 left a comment

matthewp left a comment

matthewp left a comment

sarah11918 left a comment

sarah11918 left a comment •

edited

Loading

sarah11918 left a comment

jlarmstrongiv commented Feb 2, 2024

feat(i18n): domain support #9143

feat(i18n): domain support #9143

Conversation

ematipico commented Nov 20, 2023 • edited Loading

Changes

Technical changes

Testing

Docs

changeset-bot bot commented Nov 20, 2023 • edited Loading

🦋 Changeset detected

sarah11918 left a comment

Choose a reason for hiding this comment

matthewp left a comment

Choose a reason for hiding this comment

matthewp left a comment

Choose a reason for hiding this comment

sarah11918 left a comment

Choose a reason for hiding this comment

sarah11918 left a comment • edited Loading

Choose a reason for hiding this comment

sarah11918 left a comment

Choose a reason for hiding this comment

jlarmstrongiv commented Feb 2, 2024

ematipico commented Nov 20, 2023 •

edited

Loading

changeset-bot bot commented Nov 20, 2023 •

edited

Loading

sarah11918 left a comment •

edited

Loading