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: prefer pages over endpoints when prerendering #12998

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

Conversation

eltigerchino
Copy link
Member

@eltigerchino eltigerchino commented Nov 14, 2024

fixes #10735

This PR adds an Accept header to the prerender requests, preferring text/html first then whatever with */*. Previously, it would always end up as */* during content negotiation, which invokes the endpoint handler, causing a 405 method not allowed if the GET handler doesn't exist.


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.
    No test because it would break the prerender app build.

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 Nov 14, 2024

🦋 Changeset detected

Latest commit: 7ab5f97

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

This PR includes changesets to release 1 package
Name Type
@sveltejs/kit 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

@Rich-Harris
Copy link
Member

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

this is an automated message

Copy link
Member

@dummdidumm dummdidumm left a comment

Choose a reason for hiding this comment

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

Is a test still TODO or is it basically impossable to test?

const response = await server.respond(
new Request(config.prerender.origin + encoded, {
headers: {
accept: 'text/html,*/*'
Copy link
Member

Choose a reason for hiding this comment

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

Should we add a comment here explaining why we do this?

Copy link
Member Author

Choose a reason for hiding this comment

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

I'll add a comment (although, I'm not quite sure how to best phrase it)

@Rich-Harris
Copy link
Member

Is this the right fix? Feels like maybe 405 is the wrong response for a GET request with */* if a page exists. Thoughts?

@eltigerchino
Copy link
Member Author

eltigerchino commented Nov 15, 2024

Is a test still TODO or is it basically impossable to test?

I chose not to add a test because it's only reproducible by breaking the prerender app build. But I could add a test that just sends a request to the route and see if we get a 405.

Is this the right fix? Feels like maybe 405 is the wrong response for a GET request with */* if a page exists. Thoughts?

An alternative is to await the route.endpoint() call earlier so we can check which methods it has but I'm not sure what kind of impact that will have. Either that, or prefer pages over endpoints during content negotiation (or earlier).

response = await render_endpoint(event, await route.endpoint(), state);

@eltigerchino
Copy link
Member Author

related to content negotiation #11794

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

Successfully merging this pull request may close these issues.

+server.ts must have a GET method or build fails
3 participants