Skip to content

fix: clone Headers before mutating them during prerendering - #10030

Merged
Rich-Harris merged 4 commits into
sveltejs:masterfrom
Conduitry:gh-9566
May 25, 2023
Merged

Rich-Harris merged 4 commits into
sveltejs:masterfrom
Conduitry:gh-9566

Conversation

@Conduitry

Copy link
Copy Markdown
Member

Fixes #9566.

I'm not sure how best to test this. I didn't see an easy way to make a given Headers object immutable, so I guess I'm going to have to call undici for real. If I try event.fetch somewhere and it refers to a local endpoint, that won't result in a real network request, and we won't run into the issue where undici makes the headers immutable. I don't think there's an HTTP server running during prerendering anyway. I'd prefer not to do something like export const GET = () => fetch("https://www.google.com/"); in my test. Any ideas?

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:.

@changeset-bot

changeset-bot Bot commented May 25, 2023 •

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: a70dc2b

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

@Conduitry

Copy link
Copy Markdown
Member Author

It looks like I can hack it with Object.defineProperty(response.headers, "set", { value: null });. Now to try to figure out where this test ought to go.

@Conduitry

Copy link
Copy Markdown
Member Author

Pushed a test which I've confirmed fails on master.

@benmccann benmccann left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

lgtm. (assuming creating new Response doesn't cause a streaming response body to get buffered)

@Conduitry

Copy link
Copy Markdown
Member Author

@benmccann I'm not sure whether it does- but I don't think that would really matter, because this is only during prerendering, where we're buffering the whole response and writing it out to a file anyway.

@benmccann

Copy link
Copy Markdown
Member

true. Then yeah, this looks good to me

@benmccann

Copy link
Copy Markdown
Member

@Conduitry it looks like this PR will need a rebase

@Rich-Harris

Copy link
Copy Markdown
Member

assuming creating new Response doesn't cause a streaming response body to get buffered

it won't

@Rich-Harris
Rich-Harris merged commit c1d3458 into sveltejs:master May 25, 2023
@github-actions github-actions Bot mentioned this pull request May 25, 2023
@Conduitry
Conduitry deleted the gh-9566 branch May 25, 2023 22:31
dummdidumm pushed a commit that referenced this pull request Jul 12, 2023
Fixes #10366, related to #10030.

According to the `fetch()`-specification, a header can have
an `immutable`-guard which will throw a `TypeError` if the
header is changed:
https://fetch.spec.whatwg.org/#headers-class

When using `fetch()`, the spec requires the response
header to be `immutable` (see step 12/4):
https://fetch.spec.whatwg.org/#fetch-method

This is implemented in undici (used by Node.js for native
fetch() under the hood):
https://github.com/nodejs/undici/blob/22bdbd8c7820035276b4e876daccef513c29f5c4/lib/fetch/headers.js#L234-L239
@Conduitry Conduitry mentioned this pull request Aug 4, 2024
3 of 6 tasks

This branch was successfully deployed

2 active deployments
Preview – kit-svelte-dev — a70dc2b6 Deployed May 25, 2023 by vercel[bot]
Preview – kit — a70dc2b6 Deployed May 25, 2023 by vercel[bot]
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.

Make prerendering +server.js responses play nicer with undici's Response

3 participants