Skip to content
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.

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

fix: correctly handle pathnames found in the _redirects file #12821

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

eltigerchino
Copy link
Member

@eltigerchino eltigerchino commented Oct 16, 2024

closes #9138

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.

Copy link

changeset-bot bot commented Oct 16, 2024

🦋 Changeset detected

Latest commit: b22a60d

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
Copy link
Member

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
Copy link
Member

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

this is an automated message

@eltigerchino
Copy link
Member Author

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

@@ -217,6 +221,21 @@ function get_routes_json(builder, assets, { include = ['/*'], exclude = ['<all>'
return builder.prerendered.paths;
}

if (rule === '<redirects>' && existsSync(redirects_file)) {
const redirects = readFileSync(redirects_file, 'utf8')
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you might be able to put everything after reading the file into a method like parse_redirects that has a unit test. I get a bit nervous that the adapters keep growing without having any tests

Copy link
Member Author

@eltigerchino eltigerchino Nov 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added a test but I'm not sure if it's enough. Should I add another one to test the case where the redirects parsing fails?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

adapter-cloudflare ignores _redirects config for cloudflare pages
3 participants