refactor: tyes

Author: alexander-akait

lib/Server.js

@@ -109,8 +109,10 @@ const schema = require("./options.json");
  */
 
 /**
+ * @template {BasicApplication} [A=ExpressApplication]
+ * @template {BasicServer} [S=import("http").Server]
  * @typedef {Object} ServerConfiguration
- * @property {ServerType} [type]
+ * @property {ServerType<A, S>} [type]
  * @property {ServerOptions} [options]
  */
 
@@ -202,7 +204,7 @@ const schema = require("./options.json");
  * @typedef {{ name?: string, path?: string, middleware: MiddlewareHandler } | MiddlewareHandler } Middleware
  */
 
-/** @typedef {import("net").Server} BasicServer */
+/** @typedef {import("net").Server | import("tls").Server} BasicServer */
 
 /**
  * @template {BasicApplication} [A=ExpressApplication]
@@ -220,14 +222,14 @@ const schema = require("./options.json");
  * @property {boolean | Record<string, never> | BonjourOptions} [bonjour]
  * @property {string | string[] | WatchFiles | Array<string | WatchFiles>} [watchFiles]
  * @property {boolean | string | Static | Array<string | Static>} [static]
- * @property {ServerType | ServerConfiguration} [server]
+ * @property {ServerType<A, S> | ServerConfiguration<A, S>} [server]
  * @property {() => Promise<A>} [app]
  * @property {boolean | "sockjs" | "ws" | string | WebSocketServerConfiguration} [webSocketServer]
  * @property {ProxyConfigArray} [proxy]
  * @property {boolean | string | Open | Array<string | Open>} [open]
  * @property {boolean} [setupExitSignals]
  * @property {boolean | ClientConfiguration} [client]
- * @property {Headers | ((req: Request, res: Response, context: DevMiddlewareContext<Request, Response>) => Headers)} [headers]
+ * @property {Headers | ((req: Request, res: Response, context: DevMiddlewareContext<Request, Response> | undefined) => Headers)} [headers]
  * @property {(devServer: Server<A, S>) => void} [onListening]
  * @property {(middlewares: Middleware[], devServer: Server<A, S>) => Middleware[]} [setupMiddlewares]
  */
@@ -643,11 +645,7 @@ class Server {
         if (typeof webSocketURL.protocol !== "undefined") {
           protocol = webSocketURL.protocol;
         } else {
-          protocol =
-            typeof this.server.key !== "undefined" ||
-            typeof this.server.pfx !== "undefined"
-              ? "wss:"
-              : "ws:";
+          protocol = this.isTlsServer ? "wss:" : "ws:";
         }
 
         searchParams.set("protocol", protocol);
@@ -1125,7 +1123,7 @@ class Server {
       };
     } else {
       const serverOptions =
-        /** @type {ServerConfiguration} */
+        /** @type {ServerConfiguration<A, S>} */
         (options.server || {});
 
       options.server = {
@@ -1953,7 +1951,8 @@ class Server {
     });
 
     const isHTTP2 =
-      /** @type {ServerConfiguration} */ (this.options.server).type === "http2";
+      /** @type {ServerConfiguration<A, S>} */ (this.options.server).type ===
+      "http2";
 
     if (isHTTP2) {
       // TODO patch for https://github.com/pillarjs/finalhandler/pull/45, need remove then will be resolved
@@ -2484,9 +2483,10 @@ class Server {
       (item) => item.name === "webpack-dev-middleware",
     );
 
+    // TODO make it lazy
     /** @type {import("webpack-dev-middleware").API<Request, Response> | undefined} */
     this.middleware = foundDevMiddleware
-      ? /** @type {Middleware} */ (foundDevMiddleware).middleware
+      ? /** @type {any} */ (foundDevMiddleware).middleware
       : // eslint-disable-next-line no-undefined
         undefined;
 
@@ -2520,7 +2520,7 @@ class Server {
    */
   async createServer() {
     const { type, options } =
-      /** @type {ServerConfiguration} */
+      /** @type {ServerConfiguration<A, S>} */
       (this.options.server);
 
     if (typeof type === "function") {
@@ -2545,6 +2545,11 @@ class Server {
           : serverType.createServer(options, this.app);
     }
 
+    this.isTlsServer =
+      typeof (
+        /** @type {import("tls").Server} */ (this.server).setSecureContext
+      ) !== "undefined";
+
     /** @type {S} */
     (this.server).on(
       "connection",
@@ -2748,16 +2753,12 @@ class Server {
    */
   runBonjour() {
     const { Bonjour } = require("bonjour-service");
+    const type = this.isTlsServer ? "https" : "http";
+
     /**
      * @private
      * @type {Bonjour | undefined}
      */
-    const type =
-      typeof this.server.key !== "undefined" ||
-      typeof this.server.pfx !== "undefined"
-        ? "https"
-        : "http";
-
     this.bonjour = new Bonjour();
     this.bonjour.publish({
       // @ts-expect-error
@@ -2852,10 +2853,7 @@ class Server {
     if (this.options.ipc) {
       this.logger.info(`Project is running at: "${server.address()}"`);
     } else {
-      const protocol =
-        typeof server.key !== "undefined" || typeof server.pfx !== "undefined"
-          ? "https"
-          : "http";
+      const protocol = this.isTlsServer ? "https" : "http";
       const { address, port } =
         /** @type {import("net").AddressInfo} */
         (server.address());
@@ -3005,11 +3003,7 @@ class Server {
     if (this.options.bonjour) {
       const bonjourProtocol =
         /** @type {BonjourOptions} */
-        (this.options.bonjour).type ||
-        typeof server.key !== "undefined" ||
-        typeof server.pfx !== "undefined"
-          ? "https"
-          : "http";
+        (this.options.bonjour).type || this.isTlsServer ? "https" : "http";
 
       this.logger.info(
         `Broadcasting "${bonjourProtocol}" with subtype of "webpack" via ZeroConf DNS (Bonjour)`,
@@ -3031,7 +3025,8 @@ class Server {
         headers = headers(
           req,
           res,
-          this.middleware ? this.middleware.context : {},
+          // eslint-disable-next-line no-undefined
+          this.middleware ? this.middleware.context : undefined,
         );
       }
 

types/lib/Server.d.ts

@@ -602,6 +602,9 @@ declare class Server<
       ServerType: {
         enum: string[];
       };
+      ServerFn: {
+        instanceof: string;
+      };
       ServerEnum: {
         enum: string[];
         cli: {
@@ -1260,34 +1263,6 @@ declare class Server<
    * @type {Stats | MultiStats}
    */
   private stats;
-  /**
-   * @private
-   * @returns {void}
-   */
-  private setupHostHeaderCheck;
-  /**
-   * @private
-   * @returns {void}
-   */
-  private setupDevMiddleware;
-  middleware:
-    | import("webpack-dev-middleware").API<
-        import("express").Request<
-          import("express-serve-static-core").ParamsDictionary,
-          any,
-          any,
-          qs.ParsedQs,
-          Record<string, any>
-        >,
-        import("express").Response<any, Record<string, any>>
-      >
-    | null
-    | undefined;
-  /**
-   * @private
-   * @returns {void}
-   */
-  private setupBuiltInRoutes;
   /**
    * @private
    * @returns {void}
@@ -1303,13 +1278,18 @@ declare class Server<
    * @returns {void}
    */
   private setupMiddlewares;
+  /** @type {import("webpack-dev-middleware").API<Request, Response> | undefined} */
+  middleware:
+    | import("webpack-dev-middleware").API<Request, Response>
+    | undefined;
   /**
    * @private
-   * @returns {void}
+   * @returns {Promise<void>}
    */
   private createServer;
-  /** @type {S | null | undefined}*/
-  server: S | null | undefined;
+  /** @type {S | undefined}*/
+  server: S | undefined;
+  isTlsServer: boolean | undefined;
   /**
    * @private
    * @returns {void}
@@ -1589,9 +1569,27 @@ type NormalizedStatic = {
   staticOptions: ServeStaticOptions;
   watch: false | WatchOptions;
 };
-type ServerType = "http" | "https" | "spdy" | "http2" | string;
-type ServerConfiguration = {
-  type?: string | undefined;
+type ServerType<
+  A extends BasicApplication = import("express").Application,
+  S extends BasicServer = import("http").Server<
+    typeof import("http").IncomingMessage,
+    typeof import("http").ServerResponse
+  >,
+> =
+  | "http"
+  | "https"
+  | "spdy"
+  | "http2"
+  | string
+  | ((arg0: ServerOptions, arg1: A) => S);
+type ServerConfiguration<
+  A extends BasicApplication = import("express").Application,
+  S extends BasicServer = import("http").Server<
+    typeof import("http").IncomingMessage,
+    typeof import("http").ServerResponse
+  >,
+> = {
+  type?: ServerType<A, S> | undefined;
   options?: ServerOptions | undefined;
 };
 type WebSocketServerConfiguration = {
@@ -1690,7 +1688,7 @@ type Middleware =
       middleware: MiddlewareHandler;
     }
   | MiddlewareHandler;
-type BasicServer = import("net").Server;
+type BasicServer = import("net").Server | import("tls").Server;
 type Configuration<
   A extends BasicApplication = import("express").Application,
   S extends BasicServer = import("http").Server<
@@ -1733,7 +1731,7 @@ type Configuration<
     | (string | WatchFiles)[]
     | undefined;
   static?: string | boolean | Static | (string | Static)[] | undefined;
-  server?: string | ServerConfiguration | undefined;
+  server?: ServerType<A, S> | ServerConfiguration<A, S> | undefined;
   app?: (() => Promise<A>) | undefined;
   webSocketServer?: string | boolean | WebSocketServerConfiguration | undefined;
   proxy?: ProxyConfigArray | undefined;
@@ -1745,7 +1743,7 @@ type Configuration<
     | ((
         req: Request,
         res: Response,
-        context: DevMiddlewareContext<Request, Response>,
+        context: DevMiddlewareContext<Request, Response> | undefined,
       ) => Headers)
     | undefined;
   onListening?: ((devServer: Server<A, S>) => void) | undefined;