allowSynchronousEvents

dimdenGD · Oct 5, 2024 · 279b8c2 · 279b8c2
1 parent 2484d65
commit 279b8c2
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -145,7 +145,7 @@ Below is the list of supported features and their compatibility:
 `ws` options:
 
 - ✅ autoPong (maps to uWS `sendPingsAutomatically`, default `true`)
-- ❌ allowSynchronousEvents 
+- ✅ allowSynchronousEvents (low performance when `false`, default `true`)
 - ❌ backlog
 - ✅ clientTracking
 - ✅ handleProtocols

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ultimate-ws",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "The Ultimate WebSocket server. ws-compatible server, based on uWebSockets.",
   "main": "src/index.js",
   "directories": {

diff --git a/src/server.js b/src/server.js
@@ -50,6 +50,9 @@ module.exports = class WebSocketServer extends EventEmitter {
         if(typeof options.WebSocket === 'undefined') {
             options.WebSocket = WebSocket;
         }
+        if(typeof options.allowSynchronousEvents === 'undefined') {
+            options.allowSynchronousEvents = true;
+        }
         if(typeof options.closeOnBackpressureLimit === 'undefined') {
             options.closeOnBackpressureLimit = false;
         }
@@ -167,13 +170,31 @@ module.exports = class WebSocketServer extends EventEmitter {
                     ws.client.bufferIncomingMessage(message, isBinary);
                     return;
                 }
-                ws.client.emit("message", ws.client.parseMessage(message, isBinary), isBinary);
+                if(this.options.allowSynchronousEvents) {
+                    ws.client.emit("message", ws.client.parseMessage(message, isBinary), isBinary);
+                } else {
+                    setImmediate(() => {
+                        ws.client.emit("message", ws.client.parseMessage(message, isBinary), isBinary);
+                    });
+                }
             },
             ping: (ws, message) => {
-                ws.client.emit("ping", ws.client.parseMessage(message));
+                if(this.options.allowSynchronousEvents) {
+                    ws.client.emit("ping", ws.client.parseMessage(message));
+                } else {
+                    setImmediate(() => {
+                        ws.client.emit("ping", ws.client.parseMessage(message));
+                    });
+                }
             },
             pong: (ws, message) => {
-                ws.client.emit("pong", ws.client.parseMessage(message));
+                if(this.options.allowSynchronousEvents) {
+                    ws.client.emit("pong", ws.client.parseMessage(message));
+                } else {
+                    setImmediate(() => {
+                        ws.client.emit("pong", ws.client.parseMessage(message));
+                    });
+                }
             },
             dropped: (ws, message, isBinary) => {
                 ws.client.emit("dropped", ws.client.parseMessage(message), isBinary);