fix: show warning using custom hostname and port with sockjs (#4848)

Author: snitin315

lib/Server.js

@@ -555,18 +555,27 @@ class Server {
         let hostname;
 
         // SockJS is not supported server mode, so `hostname` and `port` can't specified, let's ignore them
-        // TODO show warning about this
         const isSockJSType = webSocketServer.type === "sockjs";
+        const isWebSocketServerHostDefined =
+          typeof webSocketServer.options.host !== "undefined";
+        const isWebSocketServerPortDefined =
+          typeof webSocketServer.options.port !== "undefined";
+
+        if (
+          isSockJSType &&
+          (isWebSocketServerHostDefined || isWebSocketServerPortDefined)
+        ) {
+          this.logger.warn(
+            "SockJS only supports client mode and does not support custom hostname and port options. Please consider using 'ws' if you need to customize these options."
+          );
+        }
 
         // We are proxying dev server and need to specify custom `hostname`
         if (typeof webSocketURL.hostname !== "undefined") {
           hostname = webSocketURL.hostname;
         }
         // Web socket server works on custom `hostname`, only for `ws` because `sock-js` is not support custom `hostname`
-        else if (
-          typeof webSocketServer.options.host !== "undefined" &&
-          !isSockJSType
-        ) {
+        else if (isWebSocketServerHostDefined && !isSockJSType) {
           hostname = webSocketServer.options.host;
         }
         // The `host` option is specified
@@ -588,10 +597,7 @@ class Server {
           port = webSocketURL.port;
         }
         // Web socket server works on custom `port`, only for `ws` because `sock-js` is not support custom `port`
-        else if (
-          typeof webSocketServer.options.port !== "undefined" &&
-          !isSockJSType
-        ) {
+        else if (isWebSocketServerPortDefined && !isSockJSType) {
           port = webSocketServer.options.port;
         }
         // The `port` option is specified

types/lib/Server.d.ts

@@ -1229,14 +1229,15 @@ declare class Server {
       };
       StaticObject: {
         type: string;
-        additionalProperties: boolean;
+        /** @type {MultiCompiler} */ additionalProperties: boolean;
         properties: {
           directory: {
             type: string;
             minLength: number;
             description: string;
             link: string;
           };
+          /** @type {MultiCompiler} */
           staticOptions: {
             type: string;
             link: string;