fix!: rename methods (#3381)

BRAKING CHANGE: `sockWrite` was renamed to `sendMessage`
webpack · Jun 3, 2021 · e3f366f · e3f366f
1 parent 59196e8
commit e3f366f
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 40 deletions.
diff --git a/lib/Server.js b/lib/Server.js
@@ -53,7 +53,7 @@ class Server {
 
     this.setupHooks();
     this.setupApp();
-    this.setupCheckHostRoute();
+    this.setupHostHeaderCheck();
     this.setupDevMiddleware();
 
     // Should be after `webpack-dev-middleware`, otherwise other middlewares might rewrite response
@@ -99,7 +99,7 @@ class Server {
         msg = `${msg} (${addInfo})`;
       }
 
-      this.sockWrite(this.sockets, 'progress-update', {
+      this.sendMessage(this.sockets, 'progress-update', {
         percent,
         msg,
         pluginName,
@@ -120,7 +120,7 @@ class Server {
   setupHooks() {
     // Listening for events
     const invalidPlugin = () => {
-      this.sockWrite(this.sockets, 'invalid');
+      this.sendMessage(this.sockets, 'invalid');
     };
 
     const addHooks = (compiler) => {
@@ -141,9 +141,9 @@ class Server {
     }
   }
 
-  setupCheckHostRoute() {
+  setupHostHeaderCheck() {
     this.app.all('*', (req, res, next) => {
-      if (this.checkHost(req.headers)) {
+      if (this.checkHostHeader(req.headers)) {
         return next();
       }
 
@@ -464,7 +464,7 @@ class Server {
     });
   }
 
-  createSocketServer() {
+  createWebSocketServer() {
     this.socketServer = new this.SocketServerImplementation(this);
 
     this.socketServer.onConnection((connection, headers) => {
@@ -479,8 +479,12 @@ class Server {
         );
       }
 
-      if (!headers || !this.checkHost(headers) || !this.checkOrigin(headers)) {
-        this.sockWrite([connection], 'error', 'Invalid Host/Origin header');
+      if (
+        !headers ||
+        !this.checkHostHeader(headers) ||
+        !this.checkOriginHeader(headers)
+      ) {
+        this.sendMessage([connection], 'error', 'Invalid Host/Origin header');
 
         this.socketServer.close(connection);
 
@@ -498,19 +502,23 @@ class Server {
       });
 
       if (this.options.hot === true || this.options.hot === 'only') {
-        this.sockWrite([connection], 'hot');
+        this.sendMessage([connection], 'hot');
       }
 
       if (this.options.liveReload) {
-        this.sockWrite([connection], 'liveReload');
+        this.sendMessage([connection], 'liveReload');
       }
 
       if (this.options.client.progress) {
-        this.sockWrite([connection], 'progress', this.options.client.progress);
+        this.sendMessage(
+          [connection],
+          'progress',
+          this.options.client.progress
+        );
       }
 
       if (this.options.client.overlay) {
-        this.sockWrite([connection], 'overlay', this.options.client.overlay);
+        this.sendMessage([connection], 'overlay', this.options.client.overlay);
       }
 
       if (!this.stats) {
@@ -521,7 +529,7 @@ class Server {
     });
   }
 
-  showStatus() {
+  logStatus() {
     const useColor = getColorsOption(getCompilerConfigArray(this.compiler));
     const protocol = this.options.https ? 'https' : 'http';
     const { address, port } = this.server.address();
@@ -702,7 +710,7 @@ class Server {
           this.options.host,
           (error) => {
             if (this.options.hot || this.options.liveReload) {
-              this.createSocketServer();
+              this.createWebSocketServer();
             }
 
             if (this.options.bonjour) {
@@ -711,7 +719,7 @@ class Server {
               runBonjour(this.options);
             }
 
-            this.showStatus();
+            this.logStatus();
 
             if (fn) {
               fn.call(this.server, error);
@@ -823,15 +831,15 @@ class Server {
     next();
   }
 
-  checkHost(headers) {
-    return this.checkHeaders(headers, 'host');
+  checkHostHeader(headers) {
+    return this.checkHeader(headers, 'host');
   }
 
-  checkOrigin(headers) {
-    return this.checkHeaders(headers, 'origin');
+  checkOriginHeader(headers) {
+    return this.checkHeader(headers, 'origin');
   }
 
-  checkHeaders(headers, headerToCheck) {
+  checkHeader(headers, headerToCheck) {
     // allow user to opt out of this security check, at their own risk
     // by explicitly enabling allowedHosts
     if (this.options.allowedHosts === 'all') {
@@ -912,7 +920,7 @@ class Server {
     return false;
   }
 
-  sockWrite(sockets, type, data) {
+  sendMessage(sockets, type, data) {
     sockets.forEach((socket) => {
       this.socketServer.send(socket, JSON.stringify({ type, data }));
     });
@@ -952,19 +960,19 @@ class Server {
       stats.assets.every((asset) => !asset.emitted);
 
     if (shouldEmit) {
-      this.sockWrite(sockets, 'still-ok');
+      this.sendMessage(sockets, 'still-ok');
 
       return;
     }
 
-    this.sockWrite(sockets, 'hash', stats.hash);
+    this.sendMessage(sockets, 'hash', stats.hash);
 
     if (stats.errors.length > 0) {
-      this.sockWrite(sockets, 'errors', stats.errors);
+      this.sendMessage(sockets, 'errors', stats.errors);
     } else if (stats.warnings.length > 0) {
-      this.sockWrite(sockets, 'warnings', stats.warnings);
+      this.sendMessage(sockets, 'warnings', stats.warnings);
     } else {
-      this.sockWrite(sockets, 'ok');
+      this.sendMessage(sockets, 'ok');
     }
   }
 
@@ -1005,7 +1013,7 @@ class Server {
     // disabling refreshing on changing the content
     if (this.options.liveReload) {
       watcher.on('change', () => {
-        this.sockWrite(this.sockets, 'static-changed', watchPath);
+        this.sendMessage(this.sockets, 'static-changed', watchPath);
       });
     }
 

diff --git a/test/server/Server.test.js b/test/server/Server.test.js
@@ -287,7 +287,7 @@ describe('Server', () => {
     });
   });
 
-  describe('checkHost', () => {
+  describe('checkHostHeader', () => {
     let compiler;
     let server;
 
@@ -311,7 +311,7 @@ describe('Server', () => {
         host: 'localhost',
       };
       server = createServer(compiler, options);
-      if (!server.checkHost(headers)) {
+      if (!server.checkHostHeader(headers)) {
         throw new Error("Validation didn't fail");
       }
     });
@@ -329,7 +329,7 @@ describe('Server', () => {
 
       server = createServer(compiler, options);
 
-      if (!server.checkHost(headers)) {
+      if (!server.checkHostHeader(headers)) {
         throw new Error("Validation didn't fail");
       }
     });
@@ -351,7 +351,7 @@ describe('Server', () => {
       tests.forEach((test) => {
         const headers = { host: test };
 
-        if (!server.checkHost(headers)) {
+        if (!server.checkHostHeader(headers)) {
           throw new Error("Validation didn't pass");
         }
       });
@@ -370,7 +370,7 @@ describe('Server', () => {
 
       server = createServer(compiler, options);
 
-      if (server.checkHost(headers)) {
+      if (server.checkHostHeader(headers)) {
         throw new Error("Validation didn't fail");
       }
     });
@@ -387,7 +387,7 @@ describe('Server', () => {
 
       server = createServer(compiler, options);
 
-      if (!server.checkOrigin(headers)) {
+      if (!server.checkOriginHeader(headers)) {
         throw new Error("Validation didn't fail");
       }
     });
@@ -406,7 +406,7 @@ describe('Server', () => {
 
       server = createServer(compiler, options);
 
-      if (!server.checkOrigin(headers)) {
+      if (!server.checkOriginHeader(headers)) {
         throw new Error("Validation didn't fail");
       }
     });

diff --git a/test/server/allowedHosts-option.test.js b/test/server/allowedHosts-option.test.js
@@ -31,7 +31,7 @@ describe('allowedHosts', () => {
 
     server = createServer(compiler, options);
 
-    if (!server.checkHost(headers)) {
+    if (!server.checkHostHeader(headers)) {
       throw new Error("Validation didn't fail");
     }
   });
@@ -47,7 +47,7 @@ describe('allowedHosts', () => {
 
     server = createServer(compiler, options);
 
-    if (!server.checkHost(headers)) {
+    if (!server.checkHostHeader(headers)) {
       throw new Error("Validation didn't fail");
     }
   });
@@ -65,7 +65,7 @@ describe('allowedHosts', () => {
 
     server = createServer(compiler, options);
 
-    if (!server.checkHost(headers)) {
+    if (!server.checkHostHeader(headers)) {
       throw new Error("Validation didn't fail");
     }
   });
@@ -80,7 +80,7 @@ describe('allowedHosts', () => {
 
     server = createServer(compiler, options);
 
-    if (!server.checkHost(headers)) {
+    if (!server.checkHostHeader(headers)) {
       throw new Error("Validation didn't fail");
     }
   });
@@ -93,7 +93,7 @@ describe('allowedHosts', () => {
     tests.forEach((test) => {
       const headers = { host: test };
 
-      if (!server.checkHost(headers)) {
+      if (!server.checkHostHeader(headers)) {
         throw new Error("Validation didn't fail");
       }
     });
@@ -116,7 +116,7 @@ describe('allowedHosts', () => {
     tests.forEach((test) => {
       const headers = { host: test };
 
-      if (!server.checkHost(headers)) {
+      if (!server.checkHostHeader(headers)) {
         throw new Error("Validation didn't fail");
       }
     });