fix: correctly handle pathnames found in the `_redirects` file by teemingc · Pull Request #12821 · sveltejs/kit

teemingc · 2024-10-16T12:23:34Z

We need to add the pathnames found in the Cloudflare _redirects file to the exclude array so that they are handled by Cloudflare Pages rather than the Cloudflare Pages worker. This PR also adds the <redirects> directive so that it can be included manually in the exclude array in _routes.json.

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
This message body should clearly illustrate what problems it solves.
Ideally, include a test that fails without this PR but passes with it.

Tests

Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Edits

Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.

changeset-bot · 2024-10-16T12:23:38Z

🦋 Changeset detected

Latest commit: f99eead

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

This PR includes changesets to release 1 package

Name	Type
@sveltejs/adapter-cloudflare	Patch

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

benmccann · 2024-11-05T02:49:10Z

I see this method is building a RoutesJSONSpec. Is that a structure that's expected by Cloudflare? If so, could you add a comment in the index.d.ts that points to the relevant Cloudflare docs?

Rich-Harris · 2024-11-11T07:01:50Z

preview: https://svelte-dev-git-preview-kit-12821-svelte.vercel.app/

this is an automated message

teemingc · 2024-11-11T07:02:42Z

Thanks, that's a good suggestion. I've added a link to the _routes.json documentation.
77dc208 (#12821)

packages/adapter-cloudflare/index.js

Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com>

svelte-docs-bot · 2025-03-20T08:34:01Z

Preview: https://svelte-dev-git-preview-kit-12821-svelte.vercel.app/

dummdidumm

Is this still all correct now that there was a breaking change about the other things that no longer are in the static directory?

documentation/docs/25-build-and-deploy/60-adapter-cloudflare.md

Co-authored-by: Simon H <5968653+dummdidumm@users.noreply.github.com>

teemingc · 2025-03-21T06:20:38Z

Is this still all correct now that there was a breaking change about the other things that no longer are in the static directory?

Thanks for the reminder. I did a bit of refactoring and added a test for the _routes.json file generation. This should now correctly exclude redirects found during prerender (which were already being added to the _redirects file but did nothing because they weren't excluded).

I've also added a check in case someone added their _routes.json to the /static folder. It would have been overwritten anyway by our own _routes.json generated file but this makes it clearer that they should configure it through the adapter options.

The _route.json file generation also uses a set now so that we don't end up with any duplicate excluded routes. I've also added tests for the utility method.

benmccann · 2025-07-18T19:42:42Z

packages/adapter-cloudflare/index.js

+				/** @type {string[]} */
+				let redirects = [];
+				if (existsSync(redirects_dest)) {
+					const redirect_rules = readFileSync(redirects_dest, 'utf8');


what's this doing? It looks like it's reading redirects created during a previous build and reusing them? why would we want to do that?

This part is reading the _redirects file we've created during the current build from combining the user's redirects with our generated ones. We need to read all of them so that we can add them to the _routes.json file's exclude array to prevent the worker from taking over where it shouldn't.

I got a bit confused myself when I read this code block. I think I should add a comment explaining these bits now that I remember.

EDIT: added a comment here https://github.com/sveltejs/kit/pull/12821/files#diff-78806028d48ad47894445421562b7796c53178948c017e13d4550def4193903eR138-R140

elliott-with-the-longest-name-on-github · 2026-02-03T23:31:56Z

@teemingc is this currently ready for review?

teemingc · 2026-02-04T02:10:11Z

Yes, this one's good to go

elliott-with-the-longest-name-on-github · 2026-02-04T16:32:00Z

packages/adapter-cloudflare/internal.d.ts

+/**
+ * We use a custom `Builder` type here to ensure compatibility with the minimum version of SvelteKit.
+ */
+type Builder2_0_0 = PartialExcept<


thanks i hate it

elliott-with-the-longest-name-on-github · 2026-02-04T16:33:08Z

packages/adapter-cloudflare/utils.js

+		const content = line.trim();
+		if (!content) continue;


If you wanted to be clever you could .map(l => l.trim()).filter(Boolean) 😉

I kinda like it but I tried it and I don't think it's too much better because of the increased iterations.

const redirects = file_contents .split('\n') .map((line) => line.trim()) .filter(Boolean) .map((line) => { const [pathname] = line.split(' '); // pathnames with placeholders are not supported if (!pathname || pathname.includes('/:')) { throw new Error( `The following _redirects rule cannot be excluded by _routes.json: ${line}` ); } return pathname; });

vs

/** @type {string[]} */ const redirects = []; for (const line of file_contents.split('\n')) { const content = line.trim(); if (!content) continue; const [pathname] = line.split(' '); // pathnames with placeholders are not supported if (!pathname || pathname.includes('/:')) { throw new Error(`The following _redirects rule cannot be excluded by _routes.json: ${line}`); } redirects.push(pathname); }

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @sveltejs/adapter-netlify@6.0.0 ### Major Changes - breaking: `platform.context` is now the [modern Netlify Functions (\[#15203\](#15203)) context](https://docs.netlify.com/build/functions/api/#netlify-specific-context-object) Previously, this was the [AWS Lambda-style context](https://github.com/netlify/primitives/blob/c1ae30f2745f0a73e26e83334695e205a04ab47d/packages/functions/prod/src/function/handler_context.ts). If you were using this in your app (unlikely), you will need to update your code to read from new fields. ### Minor Changes - feat: Migrate to the modern Netlify Functions API ([#15203](#15203)) The Netlify adapter now generates "v2" Netlify Functions, which uses modern standards (ESM, `Request`, `Response`) instead of the legacy "Lambda-compatible" or "v1" format. Under the hood, this greatly simplifies the adapter code and improves maintainability. For more details on features this unlocks for your SvelteKit app, see <https://developers.netlify.com/guides/migrating-to-the-modern-netlify-functions/>. - feat: allow configuring redirects in `netlify.toml` ([#15203](#15203)) The limitation of only being able to configure redirects via the `_redirects` file has been removed. ### Patch Changes - fix: populate `App.Platform` with `context` property ([#15203](#15203)) - Updated dependencies \[[`37293a5`](37293a5), [`5d05ca6`](5d05ca6), [`ed69b77`](ed69b77), [`b1fc959`](b1fc959), [`159aece`](159aece), [`c690579`](c690579), [`dc8cf2d`](dc8cf2d), [`ace2116`](ace2116), [`0f38f49`](0f38f49)]: - @sveltejs/kit@2.51.0 ## @sveltejs/kit@2.51.0 ### Minor Changes - feat: add `scroll` property to `NavigationTarget` in navigation callbacks ([#15248](#15248)) Navigation callbacks (`beforeNavigate`, `onNavigate`, and `afterNavigate`) now include scroll position information via the `scroll` property on `from` and `to` targets: - `from.scroll`: The scroll position at the moment navigation was triggered - `to.scroll`: In `beforeNavigate` and `onNavigate`, this is populated for `popstate` navigations (back/forward) with the scroll position that will be restored, and `null` for other navigation types. In `afterNavigate`, this is always the final scroll position after navigation completed. This enables use cases like animating transitions based on the target scroll position when using browser back/forward navigation. - feat: `hydratable`'s injected script now works with CSP ([#15048](#15048)) ### Patch Changes - fix: put preloads before styles ([#15232](#15232)) - fix: suppress false-positive inner content warning when children prop is forwarded to a child component ([#15269](#15269)) - fix: `fetch` not working when URL is same host but different than `paths.base` ([#15291](#15291)) - fix: navigate to hash link when base element is present ([#15236](#15236)) - fix: avoid triggering `handleError` when redirecting in a remote function ([#15222](#15222)) - fix: include `test` directory in generated `tsconfig.json` alongside existing `tests` entry ([#15254](#15254)) - fix: generate `tsconfig.json` using the value of `kit.files.src` ([#15253](#15253)) ## @sveltejs/adapter-cloudflare@7.2.7 ### Patch Changes - fix: error if `_routes.json` is in the `/static` public directory ([#12821](#12821)) - fix: correctly handle pathnames found in the `_redirects` file ([#12821](#12821)) - Updated dependencies \[[`37293a5`](37293a5), [`5d05ca6`](5d05ca6), [`ed69b77`](ed69b77), [`b1fc959`](b1fc959), [`159aece`](159aece), [`c690579`](c690579), [`dc8cf2d`](dc8cf2d), [`ace2116`](ace2116), [`0f38f49`](0f38f49)]: - @sveltejs/kit@2.51.0 ## @sveltejs/adapter-node@5.5.3 ### Patch Changes - fix: validate `ORIGIN` env var at startup ([#15045](#15045)) - chore(deps): update dependency `@rollup/plugin-commonjs` to v29 ([#14856](#14856)) - Updated dependencies \[[`37293a5`](37293a5), [`5d05ca6`](5d05ca6), [`ed69b77`](ed69b77), [`b1fc959`](b1fc959), [`159aece`](159aece), [`c690579`](c690579), [`dc8cf2d`](dc8cf2d), [`ace2116`](ace2116), [`0f38f49`](0f38f49)]: - @sveltejs/kit@2.51.0 ## @sveltejs/enhanced-img@0.10.1 ### Patch Changes - fix: replace erroneous `import.meta.DEV` with `import.meta.env.DEV` in generated code ([#15285](#15285)) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

…ejs#12821) * read redirects * documentation * add link * changeset * add link to expected JSON format * Update packages/adapter-cloudflare/index.js Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com> * extract to function * add test * better error message * Update documentation/docs/25-build-and-deploy/60-adapter-cloudflare.md Co-authored-by: Simon H <5968653+dummdidumm@users.noreply.github.com> * fix lint * refactor * changeset * add test and fix rule truncation * fix lint * fix type error * fix lock file * explain redirect parsing * clarify * format --------- Co-authored-by: Chew Tee Ming <chew.tee.ming@nindatech.com> Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com> Co-authored-by: Simon H <5968653+dummdidumm@users.noreply.github.com>

This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @sveltejs/adapter-netlify@6.0.0 ### Major Changes - breaking: `platform.context` is now the [modern Netlify Functions (\[sveltejs#15203\](sveltejs#15203)) context](https://docs.netlify.com/build/functions/api/#netlify-specific-context-object) Previously, this was the [AWS Lambda-style context](https://github.com/netlify/primitives/blob/c1ae30f2745f0a73e26e83334695e205a04ab47d/packages/functions/prod/src/function/handler_context.ts). If you were using this in your app (unlikely), you will need to update your code to read from new fields. ### Minor Changes - feat: Migrate to the modern Netlify Functions API ([sveltejs#15203](sveltejs#15203)) The Netlify adapter now generates "v2" Netlify Functions, which uses modern standards (ESM, `Request`, `Response`) instead of the legacy "Lambda-compatible" or "v1" format. Under the hood, this greatly simplifies the adapter code and improves maintainability. For more details on features this unlocks for your SvelteKit app, see <https://developers.netlify.com/guides/migrating-to-the-modern-netlify-functions/>. - feat: allow configuring redirects in `netlify.toml` ([sveltejs#15203](sveltejs#15203)) The limitation of only being able to configure redirects via the `_redirects` file has been removed. ### Patch Changes - fix: populate `App.Platform` with `context` property ([sveltejs#15203](sveltejs#15203)) - Updated dependencies \[[`37293a5`](sveltejs@37293a5), [`5d05ca6`](sveltejs@5d05ca6), [`ed69b77`](sveltejs@ed69b77), [`b1fc959`](sveltejs@b1fc959), [`159aece`](sveltejs@159aece), [`c690579`](sveltejs@c690579), [`dc8cf2d`](sveltejs@dc8cf2d), [`ace2116`](sveltejs@ace2116), [`0f38f49`](sveltejs@0f38f49)]: - @sveltejs/kit@2.51.0 ## @sveltejs/kit@2.51.0 ### Minor Changes - feat: add `scroll` property to `NavigationTarget` in navigation callbacks ([sveltejs#15248](sveltejs#15248)) Navigation callbacks (`beforeNavigate`, `onNavigate`, and `afterNavigate`) now include scroll position information via the `scroll` property on `from` and `to` targets: - `from.scroll`: The scroll position at the moment navigation was triggered - `to.scroll`: In `beforeNavigate` and `onNavigate`, this is populated for `popstate` navigations (back/forward) with the scroll position that will be restored, and `null` for other navigation types. In `afterNavigate`, this is always the final scroll position after navigation completed. This enables use cases like animating transitions based on the target scroll position when using browser back/forward navigation. - feat: `hydratable`'s injected script now works with CSP ([sveltejs#15048](sveltejs#15048)) ### Patch Changes - fix: put preloads before styles ([sveltejs#15232](sveltejs#15232)) - fix: suppress false-positive inner content warning when children prop is forwarded to a child component ([sveltejs#15269](sveltejs#15269)) - fix: `fetch` not working when URL is same host but different than `paths.base` ([sveltejs#15291](sveltejs#15291)) - fix: navigate to hash link when base element is present ([sveltejs#15236](sveltejs#15236)) - fix: avoid triggering `handleError` when redirecting in a remote function ([sveltejs#15222](sveltejs#15222)) - fix: include `test` directory in generated `tsconfig.json` alongside existing `tests` entry ([sveltejs#15254](sveltejs#15254)) - fix: generate `tsconfig.json` using the value of `kit.files.src` ([sveltejs#15253](sveltejs#15253)) ## @sveltejs/adapter-cloudflare@7.2.7 ### Patch Changes - fix: error if `_routes.json` is in the `/static` public directory ([sveltejs#12821](sveltejs#12821)) - fix: correctly handle pathnames found in the `_redirects` file ([sveltejs#12821](sveltejs#12821)) - Updated dependencies \[[`37293a5`](sveltejs@37293a5), [`5d05ca6`](sveltejs@5d05ca6), [`ed69b77`](sveltejs@ed69b77), [`b1fc959`](sveltejs@b1fc959), [`159aece`](sveltejs@159aece), [`c690579`](sveltejs@c690579), [`dc8cf2d`](sveltejs@dc8cf2d), [`ace2116`](sveltejs@ace2116), [`0f38f49`](sveltejs@0f38f49)]: - @sveltejs/kit@2.51.0 ## @sveltejs/adapter-node@5.5.3 ### Patch Changes - fix: validate `ORIGIN` env var at startup ([sveltejs#15045](sveltejs#15045)) - chore(deps): update dependency `@rollup/plugin-commonjs` to v29 ([sveltejs#14856](sveltejs#14856)) - Updated dependencies \[[`37293a5`](sveltejs@37293a5), [`5d05ca6`](sveltejs@5d05ca6), [`ed69b77`](sveltejs@ed69b77), [`b1fc959`](sveltejs@b1fc959), [`159aece`](sveltejs@159aece), [`c690579`](sveltejs@c690579), [`dc8cf2d`](sveltejs@dc8cf2d), [`ace2116`](sveltejs@ace2116), [`0f38f49`](sveltejs@0f38f49)]: - @sveltejs/kit@2.51.0 ## @sveltejs/enhanced-img@0.10.1 ### Patch Changes - fix: replace erroneous `import.meta.DEV` with `import.meta.env.DEV` in generated code ([sveltejs#15285](sveltejs#15285)) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Chew Tee Ming added 3 commits October 16, 2024 20:17

read redirects

d8b180d

documentation

ce7e2ef

add link

fce5442

changeset

ab25b0c

teemingc added the pkg:adapter-cloudflare label Oct 16, 2024

vercel bot deployed to Preview – kit-default-template October 16, 2024 12:28 View deployment

vercel bot deployed to Preview – kit-svelte-dev October 16, 2024 12:29 View deployment

add link to expected JSON format

77dc208

teemingc requested a review from benmccann November 11, 2024 07:01

benmccann reviewed Nov 19, 2024

View reviewed changes

packages/adapter-cloudflare/index.js Outdated Show resolved Hide resolved

benmccann reviewed Nov 19, 2024

View reviewed changes

packages/adapter-cloudflare/index.js Outdated Show resolved Hide resolved

teemingc and others added 5 commits November 20, 2024 09:34

Update packages/adapter-cloudflare/index.js

d6d6237

Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com>

extract to function

50178a6

Merge branch 'main' into cloudflare-redirects

d4a35bf

add test

b22a60d

Merge branch 'main' into cloudflare-redirects

6069940

better error message

0bd35c2

dummdidumm reviewed Mar 20, 2025

View reviewed changes

documentation/docs/25-build-and-deploy/60-adapter-cloudflare.md Outdated Show resolved Hide resolved

teemingc and others added 4 commits March 20, 2025 22:41

Update documentation/docs/25-build-and-deploy/60-adapter-cloudflare.md

3619be1

Co-authored-by: Simon H <5968653+dummdidumm@users.noreply.github.com>

Merge branch 'main' into cloudflare-redirects

b02ce97

fix lint

a8effc5

refactor

6bafc72

changeset

d4b55a6

teemingc marked this pull request as draft March 22, 2025 15:28

Chew Tee Ming added 2 commits March 25, 2025 11:12

Merge branch 'main' into cloudflare-redirects

ab4ecff

add test and fix rule truncation

c521645

teemingc marked this pull request as ready for review March 25, 2025 03:27

Chew Tee Ming added 7 commits June 4, 2025 14:27

Merge branch 'main' into cloudflare-redirects

a6eb1f4

fix lint

d8d7ff3

fix type error

3ac8065

fix lock file

acaacb7

Merge branch 'main' into cloudflare-redirects

9f61e6b

Merge branch 'main' into cloudflare-redirects

2a95941

Merge branch 'main' into cloudflare-redirects

5b22d8e

benmccann reviewed Jul 18, 2025

View reviewed changes

Chew Tee Ming and others added 4 commits July 22, 2025 15:37

explain redirect parsing

49268f7

clarify

72eda65

Merge branch 'main' into cloudflare-redirects

521a3b0

format

74ade80

Merge branch 'main' into cloudflare-redirects

f99eead

elliott-with-the-longest-name-on-github reviewed Feb 4, 2026

View reviewed changes

elliott-with-the-longest-name-on-github approved these changes Feb 4, 2026

View reviewed changes

teemingc merged commit b9da77c into main Feb 5, 2026
25 checks passed

teemingc deleted the cloudflare-redirects branch February 5, 2026 18:07

github-actions bot mentioned this pull request Feb 4, 2026

Version Packages #15241

Merged

Uh oh!

Conversation

teemingc commented Oct 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

Tests

Changesets

Edits

Uh oh!

changeset-bot bot commented Oct 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

benmccann commented Nov 5, 2024

Uh oh!

Rich-Harris commented Nov 11, 2024

Uh oh!

teemingc commented Nov 11, 2024

Uh oh!

Uh oh!

Uh oh!

svelte-docs-bot bot commented Mar 20, 2025

Uh oh!

dummdidumm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

teemingc commented Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

benmccann Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

teemingc Jul 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

elliott-with-the-longest-name-on-github commented Feb 3, 2026

Uh oh!

teemingc commented Feb 4, 2026

Uh oh!

elliott-with-the-longest-name-on-github Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

elliott-with-the-longest-name-on-github Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

teemingc Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

teemingc commented Oct 16, 2024 •

edited

Loading

changeset-bot bot commented Oct 16, 2024 •

edited

Loading

teemingc commented Mar 21, 2025 •

edited

Loading

teemingc Jul 22, 2025 •

edited

Loading