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

prefer JSON error responses over HTML in fetch case #6497

Merged
merged 3 commits into from
Sep 1, 2022
Merged

Conversation

Rich-Harris
Copy link
Member

closes #1931.

Today, if you have a route like this...

// src/routes/error/+server.js
export function GET() {
  throw new Error('yikes');
}

...then visiting /error will show you the fallback error page:

image

If you fetch the page with an application/json header, you'll get a JSON representation of the error...

image

...but by default fetch will get HTML. In most cases that's probably not that helpful.

This PR reverses the precedence during content negotiation, so that if a request has an accept: */* header (which fetch requests do, by default) it will prefer JSON to HTML.

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. All changesets should be patch until SvelteKit 1.0

@changeset-bot
Copy link

changeset-bot bot commented Aug 31, 2022

🦋 Changeset detected

Latest commit: 39df1b6

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 Author

Marked this as draft because https://github.com/sveltejs/kit/pull/6497/files#diff-964f525b2136e97820d0ba82ceb5c6ab8d7a38c365fe198cfe855910500972cfR182 is unforgivable. Need to come up with some unambiguous way to communicate error information in a way that's comprehensible to both SvelteKit and users

@Rich-Harris
Copy link
Member Author

Ok, I have an idea for what to do about errors more broadly, but I think it falls out of the scope of this PR, so I'm marking it as ready again

@dummdidumm dummdidumm merged commit 544c5d0 into master Sep 1, 2022
@dummdidumm dummdidumm deleted the gh-1931 branch September 1, 2022 08:39
@github-actions github-actions bot mentioned this pull request Sep 1, 2022
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.

Allow error pages with json bodies
3 participants