refactor!: remove deprecated listen and close methods (#4659)

Author: snitin315

lib/Server.js

@@ -3356,95 +3356,6 @@ class Server {
  .then(() => callback(), callback)
  .catch(callback);
  }
-
- // TODO remove in the next major release
- /**
- * @param {Port} port
- * @param {Host} hostname
- * @param {(err?: Error) => void} fn
- * @returns {void}
- */
- listen(port, hostname, fn) {
- util.deprecate(
- () => {},
- "'listen' is deprecated. Please use the async 'start' or 'startCallback' method.",
- "DEP_WEBPACK_DEV_SERVER_LISTEN"
- )();
-
- if (typeof port === "function") {
- fn = port;
- }
-
- if (
- typeof port !== "undefined" &&
- typeof this.options.port !== "undefined" &&
- port !== this.options.port
- ) {
- this.options.port = port;
-
- this.logger.warn(
- 'The "port" specified in options is different from the port passed as an argument. Will be used from arguments.'
- );
- }
-
- if (!this.options.port) {
- this.options.port = port;
- }
-
- if (
- typeof hostname !== "undefined" &&
- typeof this.options.host !== "undefined" &&
- hostname !== this.options.host
- ) {
- this.options.host = hostname;
-
- this.logger.warn(
- 'The "host" specified in options is different from the host passed as an argument. Will be used from arguments.'
- );
- }
-
- if (!this.options.host) {
- this.options.host = hostname;
- }
-
- this.start()
- .then(() => {
- if (fn) {
- fn.call(this.server);
- }
- })
- .catch((error) => {
- // Nothing
- if (fn) {
- fn.call(this.server, error);
- }
- });
- }
-
- /**
- * @param {(err?: Error) => void} [callback]
- * @returns {void}
- */
- // TODO remove in the next major release
- close(callback) {
- util.deprecate(
- () => {},
- "'close' is deprecated. Please use the async 'stop' or 'stopCallback' method.",
- "DEP_WEBPACK_DEV_SERVER_CLOSE"
- )();
-
- this.stop()
- .then(() => {
- if (callback) {
- callback();
- }
- })
- .catch((error) => {
- if (callback) {
- callback(error);
- }
- });
- }
 }
 
 module.exports = Server;

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

@@ -116,30 +116,6 @@ exports[`API WEBPACK_SERVE environment variable should be present: page errors 1
 
 exports[`API WEBPACK_SERVE environment variable should be present: response status 1`] = `200`;
 
-exports[`API deprecated API should log warning when the "port" and "host" options from options different from arguments ('listen' method): console messages 1`] = `
-Array [
- "[webpack-dev-server] Server started: Hot Module Replacement enabled, Live Reloading enabled, Progress disabled, Overlay enabled.",
- "[HMR] Waiting for update signal from WDS...",
- "Hey.",
-]
-`;
-
-exports[`API deprecated API should log warning when the "port" and "host" options from options different from arguments ('listen' method): page errors 1`] = `Array []`;
-
-exports[`API deprecated API should work with deprecated API ('listen' and 'close' methods): close deprecation log 1`] = `"'close' is deprecated. Please use the async 'stop' or 'stopCallback' method."`;
-
-exports[`API deprecated API should work with deprecated API ('listen' and 'close' methods): console messages 1`] = `
-Array [
- "[webpack-dev-server] Server started: Hot Module Replacement enabled, Live Reloading enabled, Progress disabled, Overlay enabled.",
- "[HMR] Waiting for update signal from WDS...",
- "Hey.",
-]
-`;
-
-exports[`API deprecated API should work with deprecated API ('listen' and 'close' methods): listen deprecation log 1`] = `"'listen' is deprecated. Please use the async 'start' or 'startCallback' method."`;
-
-exports[`API deprecated API should work with deprecated API ('listen' and 'close' methods): page errors 1`] = `Array []`;
-
 exports[`API deprecated API should work with deprecated API (only compiler in constructor): console messages 1`] = `
 Array [
  "[webpack-dev-server] Server started: Hot Module Replacement enabled, Live Reloading enabled, Progress disabled, Overlay enabled.",

test/e2e/api.test.js

@@ -269,132 +269,6 @@ describe("API", () => {
  });
 
  describe("deprecated API", () => {
- it("should work with deprecated API ('listen' and 'close' methods)", async () => {
- const compiler = webpack(config);
- const devServerOptions = { port };
- const utilSpy = jest.spyOn(util, "deprecate");
- const server = new Server(devServerOptions, compiler);
-
- await new Promise((resolve, reject) => {
- server.listen(devServerOptions.port, devServerOptions.host, (error) => {
- if (error) {
- reject(error);
-
- return;
- }
-
- resolve();
- });
- });
-
- const { page, browser } = await runBrowser();
-
- const pageErrors = [];
- const consoleMessages = [];
-
- page
- .on("console", (message) => {
- consoleMessages.push(message);
- })
- .on("pageerror", (error) => {
- pageErrors.push(error);
- });
-
- await page.goto(`http://127.0.0.1:${port}/`, {
- waitUntil: "networkidle0",
- });
-
- expect(utilSpy.mock.calls[0][1]).toMatchSnapshot(
- "listen deprecation log"
- );
- expect(consoleMessages.map((message) => message.text())).toMatchSnapshot(
- "console messages"
- );
- expect(pageErrors).toMatchSnapshot("page errors");
-
- await browser.close();
- await new Promise((resolve) => {
- server.close(() => {
- resolve();
- });
- });
-
- expect(
- utilSpy.mock.calls[utilSpy.mock.calls.length - 1][1]
- ).toMatchSnapshot("close deprecation log");
-
- utilSpy.mockRestore();
- });
-
- it(`should log warning when the "port" and "host" options from options different from arguments ('listen' method)`, async () => {
- const compiler = webpack(config);
- const devServerOptions = { port: 9999, host: "127.0.0.2" };
- const warnSpy = jest.fn();
- const getInfrastructureLoggerSpy = jest
- .spyOn(compiler, "getInfrastructureLogger")
- .mockImplementation(() => {
- return {
- warn: warnSpy,
- info: () => {},
- log: () => {},
- };
- });
- const server = new Server(devServerOptions, compiler);
-
- await new Promise((resolve, reject) => {
- server.listen(port, "127.0.0.1", (error) => {
- if (error) {
- reject(error);
-
- return;
- }
-
- resolve();
- });
- });
-
- const { page, browser } = await runBrowser();
-
- const pageErrors = [];
- const consoleMessages = [];
-
- page
- .on("console", (message) => {
- consoleMessages.push(message);
- })
- .on("pageerror", (error) => {
- pageErrors.push(error);
- });
-
- await page.goto(`http://127.0.0.1:${port}/`, {
- waitUntil: "networkidle0",
- });
-
- expect(warnSpy).toHaveBeenNthCalledWith(
- 1,
- 'The "port" specified in options is different from the port passed as an argument. Will be used from arguments.'
- );
- expect(warnSpy).toHaveBeenNthCalledWith(
- 2,
- 'The "host" specified in options is different from the host passed as an argument. Will be used from arguments.'
- );
-
- expect(consoleMessages.map((message) => message.text())).toMatchSnapshot(
- "console messages"
- );
- expect(pageErrors).toMatchSnapshot("page errors");
-
- warnSpy.mockRestore();
- getInfrastructureLoggerSpy.mockRestore();
-
- await browser.close();
- await new Promise((resolve) => {
- server.close(() => {
- resolve();
- });
- });
- });
-
  it(`should work with deprecated API (the order of the arguments in the constructor)`, async () => {
  const compiler = webpack(config);
  const devServerOptions = { port };

types/lib/Server.d.ts

@@ -1970,18 +1970,6 @@ declare class Server {
  * @param {(err?: Error) => void} [callback]
  */
  stopCallback(callback?: ((err?: Error) => void) | undefined): void;
- /**
- * @param {Port} port
- * @param {Host} hostname
- * @param {(err?: Error) => void} fn
- * @returns {void}
- */
- listen(port: Port, hostname: Host, fn: (err?: Error) => void): void;
- /**
- * @param {(err?: Error) => void} [callback]
- * @returns {void}
- */
- close(callback?: ((err?: Error) => void) | undefined): void;
 }
 declare namespace Server {
  export {
@@ -2120,8 +2108,8 @@ type ClientConnection = (
 ) & {
  isAlive?: boolean;
 };
-type Port = number | string | "auto";
 type Host = "local-ip" | "local-ipv4" | "local-ipv6" | string;
+type Port = number | string | "auto";
 type MultiCompiler = import("webpack").MultiCompiler;
 declare class DEFAULT_STATS {
  private constructor();