Improved web socket user connect handling

docs/script-injector.md

@@ -73,7 +73,7 @@ interface Script {
     | undefined;
   setup?(ctx: ScriptContextData): void;
   teardown?(ctx: ScriptContextData): void;
-  connected?(ctx: ScriptContextData, e: KrasWebSocketEvent): void;
+  connected?(ctx: ScriptContextData, e: KrasWebSocketEvent): void | boolean;
   disconnected?(ctx: ScriptContextData, e: KrasWebSocketEvent): void;
 }
 ```
@@ -208,6 +208,6 @@ export interface KrasAnswer {
 }
 ```
 
-This allows also specifying `connected` and `disconnected` functions to handle WebSocket connections.
+This allows also specifying `connected` and `disconnected` functions to handle WebSocket connections. If `connected` returns a truthy value then other scripts won't be bothered with `connected`.
 
 The `setup` and `teardown` functions are used to properly initialize or dispose relevant resources. They are called when the script is first discovered or removed / replaced, e.g., in case of a file change.

src/server/injectors/proxy-injector.ts

@@ -63,25 +63,27 @@ export default class ProxyInjector implements KrasInjector {
     this.core = core;
 
     core.on('user-connected', (e: KrasWebSocketEvent) => {
-      const [target] = this.connectors.filter((m) => m.target === e.target);
-
-      if (target) {
-        const { id, ws, req } = e;
-        const url = target.address + e.url;
-        const details = {
-          headers: req.headers,
-          remoteAddress: req.connection.remoteAddress || req.socket.remoteAddress,
-          port: getPort(req),
-          encrypted: isEncrypted(req),
-        };
-        const headers = this.makeHeaders(details, 'ws');
-        this.sessions[e.id] = proxyWebSocket({
-          id,
-          ws,
-          headers,
-          url,
-          core,
-        });
+      if (!e.handled) {
+        const [target] = this.connectors.filter((m) => m.target === e.target);
+
+        if (target) {
+          const { id, ws, req } = e;
+          const url = target.address + e.url;
+          const details = {
+            headers: req.headers,
+            remoteAddress: req.connection.remoteAddress || req.socket.remoteAddress,
+            port: getPort(req),
+            encrypted: isEncrypted(req),
+          };
+          const headers = this.makeHeaders(details, 'ws');
+          this.sessions[e.id] = proxyWebSocket({
+            id,
+            ws,
+            headers,
+            url,
+            core,
+          });
+        }
       }
     });
 

src/server/injectors/script-injector.ts

@@ -41,7 +41,7 @@ export interface ScriptExports {
   ): KrasAnswer | Promise<KrasAnswer> | undefined;
   setup?(ctx: ScriptContextData): void;
   teardown?(ctx: ScriptContextData): void;
-  connected?(ctx: ScriptContextData, e: KrasWebSocketEvent): void;
+  connected?(ctx: ScriptContextData, e: KrasWebSocketEvent): void | boolean;
   disconnected?(ctx: ScriptContextData, e: KrasWebSocketEvent): void;
 }
 
@@ -99,14 +99,19 @@ export default class ScriptInjector implements KrasInjector {
     });
 
     core.on('user-connected', (e: KrasWebSocketEvent) => {
-      for (const { handler } of this.files) {
-        if (handler && typeof handler.connected === 'function') {
-          const ctx = this.getContext();
-
-          try {
-            handler.connected(ctx, e);
-          } catch (err) {
-            core.emit('error', err);
+      if (!e.handled) {
+        for (const { handler } of this.files) {
+          if (handler && typeof handler.connected === 'function') {
+            const ctx = this.getContext();
+
+            try {
+              if (handler.connected(ctx, e)) {
+                e.handled = true;
+                break;
+              }
+            } catch (err) {
+              core.emit('error', err);
+            }
           }
         }
       }

src/server/types/kras-express.ts

@@ -43,4 +43,5 @@ export interface KrasWebSocketEvent {
   target: string;
   url: string;
   req: Request;
+  handled?: boolean;
 }