fix: update listen and close deprecation warning message (#4097)

* fix: update `listen` and `close` deprecation warning message * test: add snapshots * test: update webpack 4 snapshot
webpack · Dec 10, 2021 · b217a19 · b217a19
1 parent 693c28a
commit b217a19
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 11 deletions.
diff --git a/lib/Server.js b/lib/Server.js
@@ -2405,7 +2405,7 @@ class Server {
   listen(port, hostname, fn) {
     util.deprecate(
       () => {},
-      "'listen' is deprecated. Please use async 'start' or 'startCallback' methods.",
+      "'listen' is deprecated. Please use the async 'start' or 'startCallback' method.",
       "DEP_WEBPACK_DEV_SERVER_LISTEN"
     )();
 
@@ -2465,7 +2465,7 @@ class Server {
   close(callback) {
     util.deprecate(
       () => {},
-      "'close' is deprecated. Please use async 'stop' or 'stopCallback' methods.",
+      "'close' is deprecated. Please use the async 'stop' or 'stopCallback' method.",
       "DEP_WEBPACK_DEV_SERVER_CLOSE"
     )();
 

diff --git a/test/e2e/__snapshots__/api.test.js.snap.webpack4 b/test/e2e/__snapshots__/api.test.js.snap.webpack4
@@ -55,7 +55,9 @@ Array [
 
 exports[`API should work with callback API: page errors 1`] = `Array []`;
 
-exports[`API should work with deprecated API ('listen' and \`close\` methods): console messages 1`] = `
+exports[`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 should work with deprecated API ('listen' and 'close' methods): console messages 1`] = `
 Array [
   "[HMR] Waiting for update signal from WDS...",
   "Hey.",
@@ -64,9 +66,9 @@ Array [
 ]
 `;
 
-exports[`API should work with deprecated API ('listen' and \`close\` methods): deprecation log 1`] = `"'listen' is deprecated. Please use async 'start' or 'startCallback' methods."`;
+exports[`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 should work with deprecated API ('listen' and \`close\` methods): page errors 1`] = `Array []`;
+exports[`API should work with deprecated API ('listen' and 'close' methods): page errors 1`] = `Array []`;
 
 exports[`API should work with deprecated API (only compiler in constructor): console messages 1`] = `
 Array [

diff --git a/test/e2e/__snapshots__/api.test.js.snap.webpack5 b/test/e2e/__snapshots__/api.test.js.snap.webpack5
@@ -55,7 +55,9 @@ Array [
 
 exports[`API should work with callback API: page errors 1`] = `Array []`;
 
-exports[`API should work with deprecated API ('listen' and \`close\` methods): console messages 1`] = `
+exports[`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 should work with deprecated API ('listen' and 'close' methods): console messages 1`] = `
 Array [
   "[HMR] Waiting for update signal from WDS...",
   "Hey.",
@@ -64,9 +66,9 @@ Array [
 ]
 `;
 
-exports[`API should work with deprecated API ('listen' and \`close\` methods): deprecation log 1`] = `"'listen' is deprecated. Please use async 'start' or 'startCallback' methods."`;
+exports[`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 should work with deprecated API ('listen' and \`close\` methods): page errors 1`] = `Array []`;
+exports[`API should work with deprecated API ('listen' and 'close' methods): page errors 1`] = `Array []`;
 
 exports[`API should work with deprecated API (only compiler in constructor): console messages 1`] = `
 Array [

diff --git a/test/e2e/api.test.js b/test/e2e/api.test.js
@@ -204,7 +204,7 @@ describe("API", () => {
     await server.stop();
   });
 
-  it("should work with deprecated API ('listen' and `close` methods)", async () => {
+  it("should work with deprecated API ('listen' and 'close' methods)", async () => {
     const compiler = webpack(config);
     const devServerOptions = { port };
     const utilSpy = jest.spyOn(util, "deprecate");
@@ -239,19 +239,24 @@ describe("API", () => {
       waitUntil: "networkidle0",
     });
 
-    expect(utilSpy.mock.calls[0][1]).toMatchSnapshot("deprecation log");
+    expect(utilSpy.mock.calls[0][1]).toMatchSnapshot("listen deprecation log");
     expect(consoleMessages.map((message) => message.text())).toMatchSnapshot(
       "console messages"
     );
     expect(pageErrors).toMatchSnapshot("page errors");
 
-    utilSpy.mockRestore();
     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 work with deprecated API (the order of the arguments in the constructor)`, async () => {