Skip to content

[fix] support and pin undici 5.12.0 - #7412

Merged
benmccann merged 3 commits into
sveltejs:masterfrom
repsac-by:fix-undici
Oct 28, 2022
Merged

[fix] support and pin undici 5.12.0#7412
benmccann merged 3 commits into
sveltejs:masterfrom
repsac-by:fix-undici

Conversation

@repsac-by

@repsac-by repsac-by commented Oct 27, 2022

Copy link
Copy Markdown
Contributor

Fixes #7409

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

changeset-bot Bot commented Oct 27, 2022 •
edited
Loading

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 7873c25

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

@jalavosus

jalavosus commented Oct 27, 2022

Copy link
Copy Markdown

Not to knock your fix (it's a good one) but wouldn't a more stable fix be to pin to the last known good version of undici (5.11.0)?

@repsac-by

repsac-by commented Oct 27, 2022

Copy link
Copy Markdown
Contributor Author

There are many fixes and improvements in 5.12.0.
I don't see any good reason to stay with 5.11.0 other than the addition of the duplex property.

@benmccann benmccann mentioned this pull request Oct 27, 2022
Merged
@N00nDay

N00nDay commented Oct 27, 2022

Copy link
Copy Markdown

Worked like a charm for me. Thanks repsac-by

@benmccann

benmccann commented Oct 27, 2022

Copy link
Copy Markdown
Member

The Undici team indicated this is the correct fix

This is part of the spec now. When you have a ReadableStream body, the duplex option is required.

benmccann
benmccann reviewed Oct 27, 2022
View reviewed changes
Comment thread packages/kit/src/exports/node/index.js
/** @type {import('@sveltejs/kit/node').getRequest} */
export async function getRequest({ request, base, bodySizeLimit }) {
return new Request(base + request.url, {
// @ts-expect-error

@benmccann benmccann Oct 27, 2022

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.

I would expect we shouldn't need this. Is there some detail we can add here about how/when we might be able to remove it. Are the types provided by Typescript or Undici? Is there and open issue we can link to or can we file a new one?

@Conduitry Conduitry Oct 27, 2022

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.

These types appear to be coming from TS, not from undici. Locally, even when I updated the Kit repo to undici 5.12.0, TS still complained about the duplex.

@Conduitry

Conduitry commented Oct 27, 2022

Copy link
Copy Markdown
Member

The undici PR included updates to the types here (https://github.com/nodejs/undici/pull/1681/files#diff-cfe294cd3fb885afcce564fae32dd1524399460a9a04f141e07bb45858a47f92), but it looks like we're not using those. I tries this out locally (and updated the Kit repo to undici 5.12.0), but the types for Request appeared to be coming from TypeScript (lib.dom.d.ts) and not from undici. This @ts-expect-error is probably the best we can do for now. Once the types are added to TS and we upgrade, we'll start getting an error here, so at least we'll remember to remove this.

This change looks good to me. Can we get a changeset?

@Conduitry Conduitry changed the title quick fix for undici 5.12.0 [fix] support undici 5.12 Oct 27, 2022
@benmccann

benmccann commented Oct 27, 2022

Copy link
Copy Markdown
Member

We should probably pin the Undici version as well as they've indicated that it's experimental and may have breaking changes in minor/patch versions: nodejs/undici#1681 (comment)

@Conduitry

Conduitry commented Oct 27, 2022

Copy link
Copy Markdown
Member

That sounds good to me as well.

@Conduitry Conduitry changed the title [fix] support undici 5.12 [fix] support and pin undici 5.12.0 Oct 27, 2022
@Conduitry Conduitry mentioned this pull request Oct 27, 2022
Closed
@benmccann
benmccann merged commit 84f687f into sveltejs:master Oct 28, 2022
@github-actions github-actions Bot mentioned this pull request Oct 28, 2022
Merged
@repsac-by
repsac-by deleted the fix-undici branch October 28, 2022 04:42
@dummdidumm dummdidumm mentioned this pull request Nov 4, 2022
Closed
@rexmondo rexmondo mentioned this pull request Feb 1, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Conduitry Conduitry Conduitry left review comments
@benmccann benmccann benmccann approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

+server.ts API endpoint fails to parse body

5 participants

@repsac-by @jalavosus @N00nDay @benmccann @Conduitry