refactor: server access property name (#2879)

Author: alexander-akait

lib/Server.js

@@ -70,15 +70,15 @@ class Server {
     this.createServer();
 
     routes(this);
-    killable(this.listeningApp);
+    killable(this.server);
 
     setupExitSignals(this);
 
     // Proxy WebSocket without the initial http request
     // https://github.com/chimurai/http-proxy-middleware#external-websocket-upgrade
     // eslint-disable-next-line func-names
     this.websocketProxies.forEach(function (wsProxy) {
-      this.listeningApp.on('upgrade', wsProxy.upgrade);
+      this.server.on('upgrade', wsProxy.upgrade);
     }, this);
   }
 
@@ -96,8 +96,8 @@ class Server {
 
       this.sockWrite(this.sockets, 'progress-update', { percent, msg });
 
-      if (this.listeningApp) {
-        this.listeningApp.emit('progress-update', { percent, msg });
+      if (this.server) {
+        this.server.emit('progress-update', { percent, msg });
       }
     }).apply(this.compiler);
   }
@@ -497,7 +497,7 @@ class Server {
     if (this.options.https) {
       if (this.options.http2) {
         // TODO: we need to replace spdy with http2 which is an internal module
-        this.listeningApp = require('spdy').createServer(
+        this.server = require('spdy').createServer(
           {
             ...this.options.https,
             spdy: {
@@ -507,13 +507,13 @@ class Server {
           this.app
         );
       } else {
-        this.listeningApp = https.createServer(this.options.https, this.app);
+        this.server = https.createServer(this.options.https, this.app);
       }
     } else {
-      this.listeningApp = http.createServer(this.app);
+      this.server = http.createServer(this.app);
     }
 
-    this.listeningApp.on('error', (err) => {
+    this.server.on('error', (err) => {
       throw err;
     });
   }
@@ -581,7 +581,7 @@ class Server {
 
   showStatus() {
     const suffix = '/';
-    const uri = `${createDomain(this.options, this.listeningApp)}${suffix}`;
+    const uri = `${createDomain(this.options, this.server)}${suffix}`;
 
     const configArr = getCompilerConfigArray(this.compiler);
     const colors = getColorsOption(configArr);
@@ -603,7 +603,7 @@ class Server {
         .then((port) => {
           this.port = port;
 
-          return this.listeningApp.listen(port, hostname, (err) => {
+          return this.server.listen(port, hostname, (err) => {
             if (this.options.hot || this.options.liveReload) {
               this.createSocketServer();
             }
@@ -615,7 +615,7 @@ class Server {
             this.showStatus();
 
             if (fn) {
-              fn.call(this.listeningApp, err);
+              fn.call(this.server, err);
             }
 
             if (typeof this.options.onListening === 'function') {
@@ -625,7 +625,7 @@ class Server {
         })
         .catch((err) => {
           if (fn) {
-            fn.call(this.listeningApp, err);
+            fn.call(this.server, err);
           }
         })
     );
@@ -643,7 +643,7 @@ class Server {
     );
     this.staticWatchers = [];
 
-    this.listeningApp.kill(() => {
+    this.server.kill(() => {
       // watchers must be closed before closing middleware
       prom.then(() => {
         this.middleware.close(cb);

lib/servers/SockJSServer.js

@@ -48,7 +48,7 @@ module.exports = class SockJSServer extends (
       },
     });
 
-    this.socket.installHandlers(this.server.listeningApp, {
+    this.socket.installHandlers(this.server.server, {
       prefix: this.server.options.client.path,
     });
   }

lib/servers/WebsocketServer.js

@@ -17,7 +17,7 @@ module.exports = class WebsocketServer extends (
       path: this.server.options.client.path,
     });
 
-    this.server.listeningApp.on('upgrade', (req, sock, head) => {
+    this.server.server.on('upgrade', (req, sock, head) => {
       if (!this.wsServer.shouldHandle(req)) {
         return;
       }

test/client/clients/SockJSClient.test.js

@@ -16,18 +16,18 @@ describe('SockJSClient', () => {
   const { log } = require('../../../client-src/default/utils/log');
   let consoleMock;
   let socketServer;
-  let listeningApp;
+  let server;
 
   beforeAll((done) => {
     consoleMock = jest.spyOn(console, 'log').mockImplementation();
 
     // eslint-disable-next-line new-cap
     const app = new express();
 
-    listeningApp = http.createServer(app);
-    listeningApp.listen(port, 'localhost', () => {
+    server = http.createServer(app);
+    server.listen(port, 'localhost', () => {
       socketServer = sockjs.createServer();
-      socketServer.installHandlers(listeningApp, {
+      socketServer.installHandlers(server, {
         prefix: '/ws',
       });
       done();
@@ -75,7 +75,7 @@ describe('SockJSClient', () => {
   });
 
   afterAll((done) => {
-    listeningApp.close(() => {
+    server.close(() => {
       done();
     });
   });

test/client/clients/WebsocketClient.test.js

@@ -15,16 +15,16 @@ describe('WebsocketClient', () => {
   const WebsocketClient = require('../../../client-src/clients/WebsocketClient');
   const { log } = require('../../../client-src/default/utils/log');
   let socketServer;
-  let listeningApp;
+  let server;
 
   beforeAll((done) => {
     // eslint-disable-next-line new-cap
     const app = new express();
 
-    listeningApp = http.createServer(app);
-    listeningApp.listen(port, 'localhost', () => {
+    server = http.createServer(app);
+    server.listen(port, 'localhost', () => {
       socketServer = new ws.Server({
-        server: listeningApp,
+        server,
         path: '/ws-server',
       });
       done();
@@ -68,7 +68,7 @@ describe('WebsocketClient', () => {
   });
 
   afterAll((done) => {
-    listeningApp.close(() => {
+    server.close(() => {
       done();
     });
   });

test/server/Server.test.js

@@ -85,12 +85,11 @@ describe('Server', () => {
     });
   });
 
-  it('test listeningApp error reporting', () => {
+  it('test server error reporting', () => {
     const compiler = webpack(config);
     const server = new Server(compiler, baseDevConfig);
 
-    const emitError = () =>
-      server.listeningApp.emit('error', new Error('Error !!!'));
+    const emitError = () => server.server.emit('error', new Error('Error !!!'));
 
     expect(emitError).toThrowError();
   });

test/server/host-option.test.js

@@ -25,7 +25,7 @@ describe('host option', () => {
     });
 
     it('server address', () => {
-      const address = server.listeningApp.address();
+      const address = server.server.address();
 
       expect(address.address).toBe('127.0.0.1');
       expect(address.port).toBe(port);
@@ -56,7 +56,7 @@ describe('host option', () => {
     });
 
     it('server address', () => {
-      const address = server.listeningApp.address();
+      const address = server.server.address();
 
       expect(address.address).toBe('::');
       expect(address.port).toBe(port);
@@ -86,7 +86,7 @@ describe('host option', () => {
     });
 
     it('server address', () => {
-      const address = server.listeningApp.address();
+      const address = server.server.address();
 
       expect(address.address).toBe('::');
       expect(address.port).toBe(port);
@@ -116,7 +116,7 @@ describe('host option', () => {
     });
 
     it('server address', () => {
-      const address = server.listeningApp.address();
+      const address = server.server.address();
 
       expect(address.address).toBe('127.0.0.1');
       expect(address.port).toBe(port);
@@ -146,7 +146,7 @@ describe('host option', () => {
     });
 
     it('server address', () => {
-      const address = server.listeningApp.address();
+      const address = server.server.address();
 
       expect(address.address).toBe('127.0.0.1');
       expect(address.port).toBe(port);
@@ -176,7 +176,7 @@ describe('host option', () => {
     });
 
     it('server address', () => {
-      const address = server.listeningApp.address();
+      const address = server.server.address();
 
       expect(address.address).toBe('0.0.0.0');
       expect(address.port).toBe(port);

test/server/port-option.test.js

@@ -25,7 +25,7 @@ describe('port', () => {
     });
 
     it('server address', () => {
-      const address = server.listeningApp.address();
+      const address = server.server.address();
 
       expect(address.address).toBe('127.0.0.1');
       // Random port
@@ -56,7 +56,7 @@ describe('port', () => {
     });
 
     it('server address', () => {
-      const address = server.listeningApp.address();
+      const address = server.server.address();
 
       expect(address.address).toBe('127.0.0.1');
       // Random port
@@ -86,7 +86,7 @@ describe('port', () => {
     });
 
     it('server address', () => {
-      const address = server.listeningApp.address();
+      const address = server.server.address();
 
       expect(address.address).toBe('127.0.0.1');
       // Random port
@@ -116,7 +116,7 @@ describe('port', () => {
     });
 
     it('server address', () => {
-      const address = server.listeningApp.address();
+      const address = server.server.address();
 
       expect(address.address).toBe('127.0.0.1');
       expect(address.port).toBe(33333);
@@ -145,7 +145,7 @@ describe('port', () => {
     });
 
     it('server address', () => {
-      const address = server.listeningApp.address();
+      const address = server.server.address();
 
       expect(address.address).toBe('127.0.0.1');
       expect(address.port).toBe(33333);

test/server/servers/SockJSServer.test.js

@@ -8,15 +8,15 @@ const port = require('../../ports-map').SockJSServer;
 
 describe('SockJSServer', () => {
   let socketServer;
-  let listeningApp;
+  let server;
 
   beforeEach((done) => {
     // eslint-disable-next-line new-cap
     const app = new express();
 
-    listeningApp = http.createServer(app);
-    listeningApp.listen(port, 'localhost', () => {
-      const server = {
+    server = http.createServer(app);
+    server.listen(port, 'localhost', () => {
+      socketServer = new SockJSServer({
         logger: {
           error: () => {},
           log: () => {},
@@ -27,10 +27,8 @@ describe('SockJSServer', () => {
             path: '/ws',
           },
         },
-        listeningApp,
-      };
-
-      socketServer = new SockJSServer(server);
+        server,
+      });
 
       done();
     });
@@ -103,6 +101,6 @@ describe('SockJSServer', () => {
   });
 
   afterEach((done) => {
-    listeningApp.close(done);
+    server.close(done);
   });
 });

test/server/servers/WebsocketServer.test.js

@@ -7,26 +7,24 @@ const WebsocketServer = require('../../../lib/servers/WebsocketServer');
 const port = require('../../ports-map').WebsocketServer;
 
 describe('WebsocketServer', () => {
-  let server;
   let socketServer;
-  let listeningApp;
+  let server;
 
   beforeEach((done) => {
     // eslint-disable-next-line new-cap
     const app = new express();
 
-    listeningApp = http.createServer(app);
-    listeningApp.listen(port, 'localhost', () => {
-      server = {
+    server = http.createServer(app);
+    server.listen(port, 'localhost', () => {
+      socketServer = new WebsocketServer({
         options: {
           client: {
             path: '/ws-server',
           },
         },
-        listeningApp,
+        server,
         wsHeartbeatInterval: 800,
-      };
-      socketServer = new WebsocketServer(server);
+      });
       done();
     });
   });
@@ -112,6 +110,6 @@ describe('WebsocketServer', () => {
   });
 
   afterEach((done) => {
-    listeningApp.close(done);
+    server.close(done);
   });
 });