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] Remove 'Shadow' from error message #3943

Merged
merged 2 commits into from Feb 16, 2022

Conversation

baseballyama
Copy link
Member

fix: #3917

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 pnpx changeset and following the prompts. All changesets should be patch until SvelteKit 1.0

@changeset-bot
Copy link

changeset-bot bot commented Feb 16, 2022

🦋 Changeset detected

Latest commit: 75128ee

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

);
}
} else {
headers = lowercase_keys(/** @type {Record<string, string>} */ (headers));
}

if (!is_pojo(body)) {
throw new Error('Body returned from shadow endpoint request handler must be a plain object');
throw new Error('Body returned from endpoint request handler must be a plain object');
Copy link
Member

Choose a reason for hiding this comment

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

So... this is a bit clunky but strictly speaking I think we need something like this, since standalone endpoint request handlers can return either a POJO or any valid Request body. Thoughts?

Suggested change
throw new Error('Body returned from endpoint request handler must be a plain object');
throw new Error('Body returned from page's endpoint request handler must be a plain object');

Copy link
Member Author

Choose a reason for hiding this comment

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

Essentially, the definition of the words may be ambiguous.
I think we should always stick to using the following three words which are the same as the document.

  • Page
  • Endpoint
  • Standalone Endpoint

These are already described in the documentation, but I'm sure we can add additional explanations to the definitions of the words if users request them. Or do you want to drop the use of "Endpoint" and always use the word "Page's Endpoint"?
It's more clear to me, but I'm not sure if it's cool.

Personally, I don't have a problem with either of them, as it is important that the same word are used, but in any case, I suggest that the terminology be unified, including the codebase.

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, I guess that's a fair point, we do already separate out 'standalone endpoints' and document the extra flexibility they have. So it's probably fine as-is. Thanks for the gut check!

@Rich-Harris Rich-Harris merged commit 4b0f0e6 into sveltejs:master Feb 16, 2022
This was referenced Feb 16, 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.

Clarify meaning of shadow endpoint.
2 participants