fix: expose server as Http2SecureServer type (#10196)

Author: PengBoUESTC

docs/guide/api-javascript.md

@@ -72,7 +72,7 @@ interface ViteDevServer {
    * Native Node http server instance.
    * Will be null in middleware mode.
    */
-  httpServer: http.Server | null
+  httpServer: http.Server | Http2SecureServer | null
   /**
    * Chokidar watcher instance.
    * https://github.com/paulmillr/chokidar#api

docs/guide/api-plugin.md

@@ -307,7 +307,7 @@ Vite plugins can also provide hooks that serve Vite-specific purposes. These hoo
 
 ### `configurePreviewServer`
 
-- **Type:** `(server: { middlewares: Connect.Server, httpServer: http.Server }) => (() => void) | void | Promise<(() => void) | void>`
+- **Type:** `(server: { middlewares: Connect.Server, httpServer: http.Server | Http2SecureServer }) => (() => void) | void | Promise<(() => void) | void>`
 - **Kind:** `async`, `sequential`
 
   Same as [`configureServer`](/guide/api-plugin.html#configureserver) but for the preview server. It provides the [connect](https://github.com/senchalabs/connect) server and its underlying [http server](https://nodejs.org/api/http.html). Similarly to `configureServer`, the `configurePreviewServer` hook is called before other middlewares are installed. If you want to inject a middleware **after** other middlewares, you can return a function from `configurePreviewServer`, which will be called after internal middlewares are installed:

packages/vite/src/node/http.ts

@@ -5,6 +5,7 @@ import type {
   OutgoingHttpHeaders as HttpServerHeaders
 } from 'node:http'
 import type { ServerOptions as HttpsServerOptions } from 'node:https'
+import type { Http2SecureServer } from 'node:http2'
 import type { Connect } from 'dep-types/connect'
 import colors from 'picocolors'
 import { isObject } from './utils'
@@ -94,7 +95,7 @@ export async function resolveHttpServer(
   { proxy }: CommonServerOptions,
   app: Connect.Server,
   httpsOptions?: HttpsServerOptions
-): Promise<HttpServer> {
+): Promise<HttpServer | Http2SecureServer> {
   if (!httpsOptions) {
     const { createServer } = await import('node:http')
     return createServer(app)
@@ -116,7 +117,7 @@ export async function resolveHttpServer(
       },
       // @ts-expect-error TODO: is this correct?
       app
-    ) as unknown as HttpServer
+    )
   }
 }
 
@@ -149,7 +150,7 @@ function readFileIfExists(value?: string | Buffer | any[]) {
 }
 
 export async function httpServerStart(
-  httpServer: HttpServer,
+  httpServer: HttpServer | Http2SecureServer,
   serverOptions: {
     port: number
     strictPort: boolean | undefined
@@ -185,7 +186,7 @@ export async function httpServerStart(
 }
 
 export function setClientErrorHandler(
-  server: HttpServer,
+  server: HttpServer | Http2SecureServer,
   logger: Logger
 ): void {
   server.on('clientError', (err, socket) => {

packages/vite/src/node/preview.ts

@@ -1,5 +1,6 @@
 import path from 'node:path'
 import type * as http from 'node:http'
+import type { Http2SecureServer } from 'node:http2'
 import sirv from 'sirv'
 import connect from 'connect'
 import type { Connect } from 'dep-types/connect'
@@ -51,7 +52,7 @@ export interface PreviewServer {
   /**
    * native Node http server instance
    */
-  httpServer: http.Server
+  httpServer: http.Server | Http2SecureServer
   /**
    * The resolved urls Vite prints on the CLI
    */
@@ -66,7 +67,7 @@ export type PreviewServerHook = (
   this: void,
   server: {
     middlewares: Connect.Server
-    httpServer: http.Server
+    httpServer: http.Server | Http2SecureServer
   }
 ) => (() => void) | void | Promise<(() => void) | void>
 

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

@@ -2,6 +2,7 @@ import fs from 'node:fs'
 import path from 'node:path'
 import type * as net from 'node:net'
 import type * as http from 'node:http'
+import type { Http2SecureServer } from 'node:http2'
 import { performance } from 'node:perf_hooks'
 import connect from 'connect'
 import corsMiddleware from 'cors'
@@ -182,7 +183,7 @@ export interface ViteDevServer {
    * native Node http server instance
    * will be null in middleware mode
    */
-  httpServer: http.Server | null
+  httpServer: http.Server | Http2SecureServer | null
   /**
    * chokidar watcher instance
    * https://github.com/paulmillr/chokidar#api
@@ -692,7 +693,7 @@ async function startServer(
   }
 }
 
-function createServerCloseFn(server: http.Server | null) {
+function createServerCloseFn(server: http.Server | Http2SecureServer | null) {
   if (!server) {
     return () => {}
   }

packages/vite/src/node/server/middlewares/proxy.ts

@@ -1,4 +1,5 @@
 import type * as http from 'node:http'
+import type { Http2SecureServer } from 'node:http2'
 import type * as net from 'node:net'
 import httpProxy from 'http-proxy'
 import type { Connect } from 'dep-types/connect'
@@ -30,7 +31,7 @@ export interface ProxyOptions extends HttpProxy.ServerOptions {
 }
 
 export function proxyMiddleware(
-  httpServer: http.Server | null,
+  httpServer: http.Server | Http2SecureServer | null,
   options: NonNullable<CommonServerOptions['proxy']>,
   config: ResolvedConfig
 ): Connect.NextHandleFunction {

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

@@ -2,6 +2,7 @@ import type { Server } from 'node:http'
 import { STATUS_CODES } from 'node:http'
 import type { ServerOptions as HttpsServerOptions } from 'node:https'
 import { createServer as createHttpsServer } from 'node:https'
+import type { Http2SecureServer } from 'node:http2'
 import type { Socket } from 'node:net'
 import colors from 'picocolors'
 import type { ServerOptions, WebSocket as WebSocketRaw } from 'ws'
@@ -78,7 +79,7 @@ const wsServerEvents = [
 ]
 
 export function createWebSocketServer(
-  server: Server | null,
+  server: Server | Http2SecureServer | null,
   config: ResolvedConfig,
   httpsOptions?: HttpsServerOptions
 ): WebSocketServer {