Add path matching support to the websocket rule builder

Author: pimterry

src/mockttp.ts

@@ -330,11 +330,15 @@ export interface Mockttp {
     forJsonRpcRequest(match?: { method?: string, params?: any }): RequestRuleBuilder;
 
     /**
-     * Get a builder for a mock rule that will match all websocket connections.
+     * Get a builder for a mock rule that will match websocket connections.
+     *
+     * This can optionally include a path to match: either a string, or a regular
+     * expression. Path matching always ignores query parameters. To match query
+     * parameters, use .withQuery({ a: 'b' }) or withExactQuery('?a=b').
      *
      * @category Mock websockets
      */
-    forAnyWebSocket(): WebSocketRuleBuilder;
+    forAnyWebSocket(url?: string | RegExp): WebSocketRuleBuilder;
 
     /**
      * Subscribe to hear about request details as soon as the initial request details
@@ -1033,8 +1037,8 @@ export abstract class AbstractMockttp {
             });
     }
 
-    forAnyWebSocket(): WebSocketRuleBuilder {
-        return new WebSocketRuleBuilder(this.addWebSocketRule);
+    forAnyWebSocket(url?: string | RegExp): WebSocketRuleBuilder {
+        return new WebSocketRuleBuilder(url, this.addWebSocketRule);
     }
 
 }

src/rules/requests/request-rule-builder.ts

@@ -81,6 +81,10 @@ export class RequestRuleBuilder extends BaseRuleBuilder {
                 this.matchers.push(new RegexPathMatcher(path));
             } else if (typeof path === 'string') {
                 this.matchers.push(new FlexiblePathMatcher(path));
+            } else if (path === undefined) {
+                this.matchers.push(new WildcardMatcher());
+            } else {
+                throw new Error('Invalid path argument');
             }
         }
 

src/rules/websockets/websocket-rule-builder.ts

@@ -16,7 +16,7 @@ import {
 } from './websocket-step-definitions';
 
 import { BaseRuleBuilder } from "../base-rule-builder";
-import { WildcardMatcher } from "../matchers";
+import { FlexiblePathMatcher, RegexPathMatcher, WildcardMatcher } from "../matchers";
 
 /**
  * @class WebSocketRuleBuilder
@@ -43,12 +43,25 @@ export class WebSocketRuleBuilder extends BaseRuleBuilder {
      * using, not directly. You shouldn't ever need to call this constructor.
      */
     constructor(
+        path: string | RegExp | undefined,
         private addRule: (rule: WebSocketRuleData) => Promise<MockedEndpoint>
     ) {
         super();
 
-        // By default, websockets just match everything:
-        this.matchers.push(new WildcardMatcher());
+        if (path) {
+            if (path instanceof RegExp) {
+                this.matchers.push(new RegexPathMatcher(path));
+            } else if (typeof path === 'string') {
+                this.matchers.push(new FlexiblePathMatcher(path));
+            } else if (path === undefined) {
+                this.matchers.push(new WildcardMatcher());
+            } else {
+                throw new Error('Invalid path argument');
+            }
+        } else {
+            // By default, websockets just match everything:
+            this.matchers.push(new WildcardMatcher());
+        }
     }
 
     private steps: Array<WebSocketStepDefinition> = [];