Skip to content

fix(types)!: expose httpServer with Http2SecureServer union#14834

Merged
patak-cat merged 3 commits intovitejs:mainfrom
lzt1008:chore/http-server-type
Nov 2, 2023
Merged

fix(types)!: expose httpServer with Http2SecureServer union#14834
patak-cat merged 3 commits intovitejs:mainfrom
lzt1008:chore/http-server-type

Conversation

@lzt1008
Copy link
Copy Markdown
Contributor

@lzt1008 lzt1008 commented Oct 31, 2023 •
edited
Loading

Description

The http.Server and Http2SecureServer types were previously asserted to HttpServer directly. This meant that some properties were potentially unusable:

vite/packages/vite/src/node/http.ts

Lines 108 to 118 in 9866be0

return createSecureServer(
{
// Manually increase the session memory to prevent 502 ENHANCE_YOUR_CALM
// errors on large numbers of requests
maxSessionMemory: 1000,
...httpsOptions,
allowHTTP1: true,
},
// @ts-expect-error TODO: is this correct?
app,
) as unknown as HttpServer

This PR explicitly declare a HttpServer type as the union of the two server types. These two types share a large common property - only a small subset of properties are unavailable when using the union HttpServer type.

vite/packages/vite/src/node/server/index.ts

Line 185 in 3db374a

export type HttpServer = http.Server | Http2SecureServer

This makes property usage more strict and avoids impossible states when using the two server types interchangeably.

Additional context

Some properties are now inaccessible when using HttpServer:

http.Server only:

  • maxHeadersCount
  • maxRequestsPerSocket
  • timeout
  • headersTimeout
  • keepAliveTimeout
  • requestTimeout
  • closeAllConnections
  • closeIdleConnections

Http2SecureServer only:

  • addContext
  • getTicketKeys
  • setSecureContext
  • setTicketKeys
  • updateSettings

However, none of these properties were used in the current code. So the behavior impact of this type change is theoretically none.

What is the purpose of this pull request?

  • Bug fix
  • New Feature
  • Documentation update
  • Other

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines and follow the PR Title Convention.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.

@bolt-new-by-stackblitz
Copy link
Copy Markdown

bolt-new-by-stackblitz bot commented Oct 31, 2023

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@bluwy
Copy link
Copy Markdown
Member

bluwy commented Nov 1, 2023

This will affect downstream plugins and projects that access the httpServer property so it will break their types. I'll run ecosystem-ci to check this if it's largely safe, but we're close to Vite 5 stable release now.

@bluwy
Copy link
Copy Markdown
Member

bluwy commented Nov 1, 2023

/ecosystem-ci run

@vite-ecosystem-ci
Copy link
Copy Markdown

vite-ecosystem-ci bot commented Nov 1, 2023

📝 Ran ecosystem CI on 8477e1a: Open

suite result latest scheduled
analogjs ✅ success ✅ success
astro ❌ failure ❌ failure
histoire ✅ success ✅ success
ladle ✅ success ✅ success
laravel ❌ failure ❌ failure
marko ❌ failure ❌ failure
nuxt ❌ failure ❌ failure
nx ❌ failure ❌ failure
previewjs ❌ failure ❌ failure
qwik ❌ failure ❌ failure
rakkas ✅ success ✅ success
sveltekit ❌ failure ❌ failure
unocss ✅ success ✅ success
vike ✅ success ✅ success
vite-plugin-pwa ✅ success ✅ success
vite-plugin-react ✅ success ✅ success
vite-plugin-react-pages ❌ failure ✅ success
vite-plugin-react-swc ❌ failure ❌ failure
vite-plugin-svelte ✅ success ✅ success
vite-plugin-vue ✅ success ✅ success
vite-setup-catalogue ✅ success ✅ success
vitepress ✅ success ✅ success
vitest ❌ failure ❌ failure

bluwy
bluwy previously approved these changes Nov 2, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@bluwy bluwy left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I think we can give this a try. It also looks like we attempted this in the past (#10196) but reverted as it's breaking downstream. Now in the Vite 5 beta would be a good time to go with this.

EDIT: oh it looks like there's merge conflicts

@bluwy bluwy changed the title chore(types): use unified HttpServer type to avoid type assertion fix(types)!: expose httpServer with Http2SecureServer union Nov 2, 2023
@bluwy bluwy added p2-nice-to-have Not breaking anything but nice to have (priority) breaking change labels Nov 2, 2023
@lzt1008
Copy link
Copy Markdown
Contributor Author

lzt1008 commented Nov 2, 2023

I think we can give this a try. It also looks like we attempted this in the past (#10196) but reverted as it's breaking downstream. Now in the Vite 5 beta would be a good time to go with this.

EDIT: oh it looks like there's merge conflicts

Looks like new added AsyncDisposable conflicts with this, I've resolved this conflict.

@patak-cat patak-cat merged commit ab5bb40 into vitejs:main Nov 2, 2023
sapphi-red added a commit to sapphi-red/vite that referenced this pull request Nov 6, 2023
@sapphi-red
docs: add vitejs#14834 to migration guide
34d492d
This was referenced Nov 6, 2023
Merged
Merged
patak-cat pushed a commit that referenced this pull request Nov 6, 2023
@sapphi-red
docs: add #14834 to migration guide (#14889)
fc24b07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@patak-cat patak-cat patak-cat approved these changes

@bluwy bluwy bluwy approved these changes

Assignees

No one assigned

Labels

breaking change p2-nice-to-have Not breaking anything but nice to have (priority)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@lzt1008 @bluwy @patak-cat