fix: allow to pass options for custom server (#4110)

Author: snitin315

lib/options.json

@@ -667,7 +667,14 @@
       "type": "object",
       "properties": {
         "type": {
-          "$ref": "#/definitions/ServerType"
+          "anyOf": [
+            {
+              "$ref": "#/definitions/ServerType"
+            },
+            {
+              "$ref": "#/definitions/ServerString"
+            }
+          ]
         },
         "options": {
           "$ref": "#/definitions/ServerOptions"

test/e2e/__snapshots__/server.test.js.snap.webpack4

@@ -511,6 +511,23 @@ exports[`server option as object cacert, pfx, key and cert are buffer should han
 "
 `;
 
+exports[`server option as object custom server with options should handle GET request to index route (/): console messages 1`] = `Array []`;
+
+exports[`server option as object custom server with options should handle GET request to index route (/): http options 1`] = `
+Object {
+  "maxHeaderSize": 16384,
+}
+`;
+
+exports[`server option as object custom server with options should handle GET request to index route (/): page errors 1`] = `Array []`;
+
+exports[`server option as object custom server with options should handle GET request to index route (/): response status 1`] = `200`;
+
+exports[`server option as object custom server with options should handle GET request to index route (/): response text 1`] = `
+"Heyo.
+"
+`;
+
 exports[`server option as object options should be prioritized over http2 options should handle GET request to index route (/): console messages 1`] = `Array []`;
 
 exports[`server option as object options should be prioritized over http2 options should handle GET request to index route (/): https options 1`] = `

test/e2e/__snapshots__/server.test.js.snap.webpack5

@@ -511,6 +511,23 @@ exports[`server option as object cacert, pfx, key and cert are buffer should han
 "
 `;
 
+exports[`server option as object custom server with options should handle GET request to index route (/): console messages 1`] = `Array []`;
+
+exports[`server option as object custom server with options should handle GET request to index route (/): http options 1`] = `
+Object {
+  "maxHeaderSize": 16384,
+}
+`;
+
+exports[`server option as object custom server with options should handle GET request to index route (/): page errors 1`] = `Array []`;
+
+exports[`server option as object custom server with options should handle GET request to index route (/): response status 1`] = `200`;
+
+exports[`server option as object custom server with options should handle GET request to index route (/): response text 1`] = `
+"Heyo.
+"
+`;
+
 exports[`server option as object options should be prioritized over http2 options should handle GET request to index route (/): console messages 1`] = `Array []`;
 
 exports[`server option as object options should be prioritized over http2 options should handle GET request to index route (/): https options 1`] = `

test/e2e/server.test.js

@@ -10,6 +10,7 @@ const Server = require("../../lib/Server");
 const config = require("../fixtures/static-config/webpack.config");
 const runBrowser = require("../helpers/run-browser");
 const { skipTestOnWindows } = require("../helpers/conditional-test");
+const customHTTP = require("../helpers/custom-http");
 const normalizeOptions = require("../helpers/normalize-options");
 const port = require("../ports-map")["server-option"];
 
@@ -1643,5 +1644,81 @@ describe("server option", () => {
         expect(pageErrors).toMatchSnapshot("page errors");
       });
     });
+
+    describe("custom server with options", () => {
+      let compiler;
+      let server;
+      let createServerSpy;
+      let page;
+      let browser;
+      let pageErrors;
+      let consoleMessages;
+
+      beforeEach(async () => {
+        compiler = webpack(config);
+
+        createServerSpy = jest.spyOn(customHTTP, "createServer");
+
+        server = new Server(
+          {
+            static: {
+              directory: staticDirectory,
+              watch: false,
+            },
+            server: {
+              type: path.join(__dirname, "../helpers/custom-http.js"),
+              options: {
+                maxHeaderSize: 16384,
+              },
+            },
+            port,
+          },
+          compiler
+        );
+
+        await server.start();
+
+        ({ page, browser } = await runBrowser());
+
+        pageErrors = [];
+        consoleMessages = [];
+      });
+
+      afterEach(async () => {
+        createServerSpy.mockRestore();
+
+        await browser.close();
+        await server.stop();
+      });
+
+      it("should handle GET request to index route (/)", async () => {
+        page
+          .on("console", (message) => {
+            consoleMessages.push(message);
+          })
+          .on("pageerror", (error) => {
+            pageErrors.push(error);
+          });
+
+        const response = await page.goto(`http://127.0.0.1:${port}/`, {
+          waitUntil: "networkidle0",
+        });
+
+        const HTTPVersion = await page.evaluate(
+          () => performance.getEntries()[0].nextHopProtocol
+        );
+
+        expect(HTTPVersion).toEqual("http/1.1");
+        expect(
+          normalizeOptions(createServerSpy.mock.calls[0][0])
+        ).toMatchSnapshot("http options");
+        expect(response.status()).toMatchSnapshot("response status");
+        expect(await response.text()).toMatchSnapshot("response text");
+        expect(
+          consoleMessages.map((message) => message.text())
+        ).toMatchSnapshot("console messages");
+        expect(pageErrors).toMatchSnapshot("page errors");
+      });
+    });
   });
 });

test/validate-options.test.js

@@ -393,6 +393,7 @@ const tests = {
       "http",
       "https",
       "spdy",
+      "custom-server.js",
       {
         type: "http",
       },
@@ -402,6 +403,9 @@ const tests = {
       {
         type: "spdy",
       },
+      {
+        type: "custom-server.js",
+      },
       {
         type: "https",
         options: {