Repository navigation
Fix preferredLocaleList dropping object-form locale codes that differ in case - #17700
Conversation
The codes branch compared the configured code against the browser locale raw, while the sibling string branch and sortAndFilterLocales both compare normalized values. A code differing only by case or separator passed the filter and was then dropped by the raw compare, so preferredLocaleList came back empty while preferredLocale returned the code on the same request.
🦋 Changeset detectedLatest commit: 86365a9 The changes in this PR will be included in the next version bump. This PR includes changesets to release 420 packages
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 |
|
Please file a bug report with a minimal reproduction first. Happy to open again once we confirmed the bug |
|
Filed the bug report with a minimal reproduction: #17969. It includes |
|
Thank you! |
|
Thanks for the quick turnaround — glad the repro made it easy to confirm. |
This PR contains the following updates: | Package | Change | [Age](https://docs.renovatebot.com/merge-confidence/) | [Confidence](https://docs.renovatebot.com/merge-confidence/) | |---|---|---|---| | [astro](https://astro.build) ([source](https://github.com/withastro/astro/tree/HEAD/packages/astro)) | [`7.3.2` → `7.3.3`](https://renovatebot.com/diffs/npm/astro/7.3.2/7.3.3) |  |  | --- ### Release Notes <details> <summary>withastro/astro (astro)</summary> ### [`v7.3.3`](https://github.com/withastro/astro/blob/HEAD/packages/astro/CHANGELOG.md#733) [Compare Source](https://github.com/withastro/astro/compare/astro@7.3.2...astro@7.3.3) ##### Patch Changes - [#​17651](withastro/astro#17651) [`504333c`](withastro/astro@504333c) Thanks [@​sxzz](https://github.com/sxzz)! - Refactors internal version handling to use a smaller, ESM-native dependency - [#​17942](withastro/astro#17942) [`0bc5715`](withastro/astro@0bc5715) Thanks [@​matthewp](https://github.com/matthewp)! - Returns appropriate 400 and 404 responses from the image endpoint for invalid and missing local image paths - [#​17700](withastro/astro#17700) [`b2222fc`](withastro/astro@b2222fc) Thanks [@​winklemad](https://github.com/winklemad)! - Fixes `Astro.preferredLocaleList` returning an empty list when a locale is configured with the object form (`{ path, codes }`) and the browser sends the code with different casing or an underscore, such as `en-US` matching a configured `en-us` - [#​17941](withastro/astro#17941) [`394ff79`](withastro/astro@394ff79) Thanks [@​matthewp](https://github.com/matthewp)! - Fixes `astro preview --ignore-lock` (and `astro dev --ignore-lock`) being refused when run from an AI agent environment. The flag now starts the server in the foreground instead of erroring, since agent detection only inferred background mode and was never explicitly requested. An explicit `--background` combined with `--ignore-lock` still errors. - [#​17928](withastro/astro#17928) [`3277927`](withastro/astro@3277927) Thanks [@​ArmandPhilippot](https://github.com/ArmandPhilippot)! - Fixes TypeScript autocompletion for `getImage()` to suggest all available predefined options. - [#​17928](withastro/astro#17928) [`3277927`](withastro/astro@3277927) Thanks [@​ArmandPhilippot](https://github.com/ArmandPhilippot)! - Fixes a type error in `getImage()` options that allowed passing both `widths` and `densities` at the same time. - [#​17857](withastro/astro#17857) [`2637ed1`](withastro/astro@2637ed1) Thanks [@​Princesseuh](https://github.com/Princesseuh)! - Improves rendering performance - [#​17943](withastro/astro#17943) [`2fc7ce9`](withastro/astro@2fc7ce9) Thanks [@​matthewp](https://github.com/matthewp)! - Fixes a WebAssembly error when importing `astro:actions` in tests that run under `@cloudflare/vitest-pool-workers` - [#​18018](withastro/astro#18018) [`1b5a234`](withastro/astro@1b5a234) Thanks [@​astro-factory](https://github.com/apps/astro-factory)! - Fixes trailing-slash redirect response body pointing to the incoming URL instead of the redirect target. The `location` header was correct, but the HTML body (`<meta http-equiv="refresh">`, `<title>`, and `<a>` tag) contained the original request path without the trailing-slash correction or query string. - [#​17905](withastro/astro#17905) [`eaf70fa`](withastro/astro@eaf70fa) Thanks [@​SudoDevStudio](https://github.com/SudoDevStudio)! - Fixes custom dev toolbar apps losing their UI after client-side navigation with `<ClientRouter />`. - [#​18011](withastro/astro#18011) [`558b301`](withastro/astro@558b301) Thanks [@​astro-factory](https://github.com/apps/astro-factory)! - Fixes prerendered Cloudflare pages rendering as `[object Object]` when `nodejs_compat` is enabled in `wrangler.toml` - [#​17944](withastro/astro#17944) [`ba08e35`](withastro/astro@ba08e35) Thanks [@​matthewp](https://github.com/matthewp)! - Fixes a regression in `astro dev` where writes outside the module graph (for example, `@astrojs/cloudflare`'s `.wrangler/state` files) invalidated the middleware on every request, causing repeated SSR reloads. Such writes no longer invalidate the middleware. - [#​17531](withastro/astro#17531) [`ae837db`](withastro/astro@ae837db) Thanks [@​danilloestrela](https://github.com/danilloestrela)! - Updates `svgo` to `4.0.2` to resolve a security advisory - [#​17953](withastro/astro#17953) [`dbbf10e`](withastro/astro@dbbf10e) Thanks [@​astro-factory](https://github.com/apps/astro-factory)! - Fixes a one-time page reload shortly after the first load on cold dev-server starts when a project has framework components imported from MDX content entries. MDX files are now included in the dev dependency pre-bundling scan, so their framework dependencies are bundled up front instead of being discovered (and reloaded for) at runtime. - [#​17955](withastro/astro#17955) [`4e8ad9a`](withastro/astro@4e8ad9a) Thanks [@​matthewp](https://github.com/matthewp)! - Improves dev server startup time. The content config and dev server app module graphs now begin compiling during server creation without blocking the server from listening. Request handling waits for the shared setup result when needed, cutting `astro dev` ready time by roughly a third on projects with a content config. - [#​17960](withastro/astro#17960) [`9838049`](withastro/astro@9838049) Thanks [@​Chy-Zaber-Bin-Zahid](https://github.com/Chy-Zaber-Bin-Zahid)! - Improves the diagnostics of some Astro errors. - [#​17998](withastro/astro#17998) [`0e5478d`](withastro/astro@0e5478d) Thanks [@​astro-factory](https://github.com/apps/astro-factory)! - Fixes SVG `<style>` elements nested inside `<defs>` or other container elements not being hashed for CSP - [#​17994](withastro/astro#17994) [`80f9f1d`](withastro/astro@80f9f1d) Thanks [@​astro-factory](https://github.com/apps/astro-factory)! - Fixes `experimental.incrementalBuild` restoring pages with stale CSS after a preprocessor partial changes or missing original images referenced by restored pages - [#​17889](withastro/astro#17889) [`8ae6b46`](withastro/astro@8ae6b46) Thanks [@​ajfAfg](https://github.com/ajfAfg)! - Fixes a bug where the dev server stripped the configured `base` from URLs that only share a prefix with it. With `base: '/s'`, requests to `/src/...` were rewritten to `/rc/...` and failed, breaking those pages during development. - [#​17980](withastro/astro#17980) [`cfccafa`](withastro/astro@cfccafa) Thanks [@​gameroman](https://github.com/gameroman)! - Improves JSDoc for fonts api - [#​17953](withastro/astro#17953) [`dbbf10e`](withastro/astro@dbbf10e) Thanks [@​astro-factory](https://github.com/apps/astro-factory)! - Fixes CSS HMR for framework components rendered through content entries after `ClientRouter` navigation - [#​17970](withastro/astro#17970) [`0b4dc3a`](withastro/astro@0b4dc3a) Thanks [@​matthewp](https://github.com/matthewp)! - Improves serialization of transition animation values in generated CSS - [#​17999](withastro/astro#17999) [`30ef3cb`](withastro/astro@30ef3cb) Thanks [@​astro-factory](https://github.com/apps/astro-factory)! - Fixes content collection HMR not updating prerendered pages when an adapter enables a separate prerender environment (e.g. `@astrojs/cloudflare` with `prerenderEnvironment: 'node'`) - [#​18002](withastro/astro#18002) [`312ab49`](withastro/astro@312ab49) Thanks [@​shoutoutuoadi325](https://github.com/shoutoutuoadi325)! - Fixes redirect targets being corrupted when a dynamic route parameter value contains `$` replacement patterns like `$&` - [#​17937](withastro/astro#17937) [`e294953`](withastro/astro@e294953) Thanks [@​matthewp](https://github.com/matthewp)! - Fixes a bug where the `glob()` content loader kept stale entries in the data store after the last file in a collection was deleted. Empty collections are now pruned correctly, and the file watcher is registered in dev so the first file added to an empty collection is picked up without a restart. - [#​17945](withastro/astro#17945) [`750b4db`](withastro/astro@750b4db) Thanks [@​matthewp](https://github.com/matthewp)! - Pre-bundles renderer server entrypoints and the default console logger during dev so they are included in the initial optimization pass, preventing a mid-request re-optimization that could crash the dev server on Cloudflare (workerd). </details> --- ### Configuration 📅 **Schedule**: (UTC) - Branch creation - At any time (no schedule defined) - Automerge - At any time (no schedule defined) 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate CLI](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0NC4xMDMuMiIsInVwZGF0ZWRJblZlciI6IjQ0LjEwMy4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->
Changes
Closes #17969
computePreferredLocaleListcompared object-form locale codes exactly, while every other locale comparison ini18n/utils.tsnormalizes both sides first. That one raw comparison is now normalized like the rest.sortAndFilterLocalesfilters on normalized codes, so a locale configured as{ path: 'english', codes: ['en-us'] }passes the filter when a browser sendsAccept-Language: en-US, and is then silently dropped by the exact comparison.Astro.preferredLocalereturns'en-us'whileAstro.preferredLocaleListreturns[].locales: ['en-us']works today), the object-form branch did not. Underscore codes such asen_USwere affected the same way, sincenormalizeTheLocalemaps_to-.codeis what's pushed, matching howgetLocaleByPathcompares normalized and returns the configured value.Production change is one line:
One thing I deliberately left out:
computePreferredLocalebreaks out of its codes loop on first match (#16600), and this list function doesn't. That's a visible behaviour difference between the pair, but it's a separate change with its own semantics, so I'd rather ask than bundle it — happy to follow up if you want them aligned.Testing
Added to the existing
packages/astro/test/units/i18n/i18n-utils.test.ts, in the style of the surrounding cases:codes: ['en-us']vsen-US) — failed before this change, returning[]codes: ['en_US']) — failed before, returning[]The last three pass both before and after, so they guard against a regression rather than describing the fix.
Locally: 32/32 in that file, and the full i18n unit suite (396 tests),
tsc -b,format:ci, biome and eslint all pass. One caveat —astro-scripts testfails on my machine withERR_UNKNOWN_FILE_EXTENSIONfor.tson Node 22.17.1 (the repo's.nvmrcis 24.14.0); it fails identically on files I didn't touch, so I ran the units via the equivalentnode --experimental-strip-types --test. CI on Node 24 will run them through the wrapper.Docs
No docs change needed.
Astro.preferredLocaleListis already documented as returning the list of matching locales; this makes the object-form config shape behave as documented, rather than changing any documented behaviour.