Change how step definitions for manual rule building are exposed

If you're using the rule chaining API this won't affect you. If you're
building custom rules though (set/addRulesFromDefinitions()) then you'll
need to migrate.

Steps and matchers are now exposed as 'steps' and 'matchers' (instead of
HandleStepDefinitions and MatcherDefinitions) and the individual classes
have all lost their Definition suffix (e.g. EchoStepDefinition is now
just EchoStep). This aligns with equivalent changes in Mockttp v4.

Author: pimterry

src/handling/handler-builder.ts

@@ -5,17 +5,17 @@
 
 import {
     type HandlerStepDefinition,
-    PeerProxyStepDefinition,
-    CreateChannelStepDefinition,
-    SendStepDefinition,
-    DynamicProxyStepDefinition,
-    WaitForChannelStepDefinition,
-    WaitForMessageStepDefinition,
-    WaitForDurationStepDefinition,
-    CloseStepDefinition,
-    EchoStepDefinition,
-    WaitForTrackStepDefinition,
-    WaitForMediaStepDefinition
+    PeerProxyStep,
+    CreateChannelStep,
+    SendStep,
+    DynamicProxyStep,
+    WaitForChannelStep,
+    WaitForMessageStep,
+    WaitForDurationStep,
+    CloseStep,
+    EchoStep,
+    WaitForTrackStep,
+    WaitForMediaStep
 } from "./handler-step-definitions";
 
 /**
@@ -37,7 +37,7 @@ export class MockRTCHandlerBuilder<R> {
      * @category Steps
      */
     sleep(duration: number): MockRTCHandlerBuilder<R> {
-        this.handlerSteps.push(new WaitForDurationStepDefinition(duration));
+        this.handlerSteps.push(new WaitForDurationStep(duration));
         return this;
     }
 
@@ -47,7 +47,7 @@ export class MockRTCHandlerBuilder<R> {
      * @category Steps
      */
     waitForChannel(channelLabel?: string): MockRTCHandlerBuilder<R> {
-        this.handlerSteps.push(new WaitForChannelStepDefinition(channelLabel));
+        this.handlerSteps.push(new WaitForChannelStep(channelLabel));
         return this;
     }
 
@@ -57,7 +57,7 @@ export class MockRTCHandlerBuilder<R> {
      * @category Steps
      */
     waitForTrack(): MockRTCHandlerBuilder<R> {
-        this.handlerSteps.push(new WaitForTrackStepDefinition());
+        this.handlerSteps.push(new WaitForTrackStep());
         return this;
     }
 
@@ -70,7 +70,7 @@ export class MockRTCHandlerBuilder<R> {
      * @category Steps
      */
     waitForNextMessage(): MockRTCHandlerBuilder<R> {
-        this.handlerSteps.push(new WaitForMessageStepDefinition());
+        this.handlerSteps.push(new WaitForMessageStep());
         return this;
     }
 
@@ -82,7 +82,7 @@ export class MockRTCHandlerBuilder<R> {
      * @category Steps
      */
     waitForNextMedia(): MockRTCHandlerBuilder<R> {
-        this.handlerSteps.push(new WaitForMediaStepDefinition());
+        this.handlerSteps.push(new WaitForMediaStep());
         return this;
     }
 
@@ -95,7 +95,7 @@ export class MockRTCHandlerBuilder<R> {
      * @category Steps
      */
     waitForNextMessageOnChannel(channelLabel: string): MockRTCHandlerBuilder<R> {
-        this.handlerSteps.push(new WaitForMessageStepDefinition(channelLabel));
+        this.handlerSteps.push(new WaitForMessageStep(channelLabel));
         return this;
     }
 
@@ -106,7 +106,7 @@ export class MockRTCHandlerBuilder<R> {
      * @category Steps
      */
     createDataChannel(channelLabel: string): MockRTCHandlerBuilder<R> {
-        this.handlerSteps.push(new CreateChannelStepDefinition(channelLabel));
+        this.handlerSteps.push(new CreateChannelStep(channelLabel));
         return this;
     }
 
@@ -128,10 +128,10 @@ export class MockRTCHandlerBuilder<R> {
     send(...args: [string | undefined, string | Buffer] | [string | Buffer]): MockRTCHandlerBuilder<R> {
         if (args[1] !== undefined) {
             const [channel, message] = args as [string, string | Buffer];
-            this.handlerSteps.push(new SendStepDefinition(channel, message));
+            this.handlerSteps.push(new SendStep(channel, message));
         } else {
             const [message] = args as [string | Buffer];
-            this.handlerSteps.push(new SendStepDefinition(undefined, message));
+            this.handlerSteps.push(new SendStep(undefined, message));
         }
         return this;
     }
@@ -146,7 +146,7 @@ export class MockRTCHandlerBuilder<R> {
      * @category Final Steps
      */
     thenClose(): Promise<R> {
-        this.handlerSteps.push(new CloseStepDefinition());
+        this.handlerSteps.push(new CloseStep());
         return this.buildCallback(this.handlerSteps);
     }
 
@@ -179,7 +179,7 @@ export class MockRTCHandlerBuilder<R> {
      * @category Final Steps
      */
     thenEcho(): Promise<R> {
-        this.handlerSteps.push(new EchoStepDefinition());
+        this.handlerSteps.push(new EchoStep());
         return this.buildCallback(this.handlerSteps);
     }
 
@@ -195,7 +195,7 @@ export class MockRTCHandlerBuilder<R> {
      * @category Final Steps
      */
     thenForwardTo(peer: RTCPeerConnection): Promise<R> {
-        this.handlerSteps.push(new PeerProxyStepDefinition(peer));
+        this.handlerSteps.push(new PeerProxyStep(peer));
         return this.buildCallback(this.handlerSteps);
     }
 
@@ -220,7 +220,7 @@ export class MockRTCHandlerBuilder<R> {
      * @category Final Steps
      */
     thenPassThrough(): Promise<R> {
-        this.handlerSteps.push(new DynamicProxyStepDefinition());
+        this.handlerSteps.push(new DynamicProxyStep());
         return this.buildCallback(this.handlerSteps);
     }
 

src/handling/handler-step-definitions.ts

@@ -6,6 +6,7 @@
 import * as PluggableAdmin from 'mockttp/dist/pluggable-admin-api/pluggable-admin.browser';
 
 import { MockRTCSessionDescription } from '../mockrtc';
+import type { RTCConnection } from '../webrtc/rtc-connection';
 
 export type Serializable = PluggableAdmin.Serialization.Serializable;
 export const { Serializable } = PluggableAdmin.Serialization;
@@ -15,7 +16,7 @@ export interface HandlerStepDefinition extends Serializable {
     readonly type: keyof typeof StepDefinitionLookup;
 }
 
-export class WaitForDurationStepDefinition extends Serializable implements HandlerStepDefinition {
+export class WaitForDurationStep extends Serializable implements HandlerStepDefinition {
 
     readonly type = 'wait-for-duration';
     static readonly isFinal = false;
@@ -32,7 +33,7 @@ export class WaitForDurationStepDefinition extends Serializable implements Handl
 
 }
 
-export class WaitForChannelStepDefinition extends Serializable implements HandlerStepDefinition {
+export class WaitForChannelStep extends Serializable implements HandlerStepDefinition {
 
     readonly type = 'wait-for-rtc-data-channel';
     static readonly isFinal = false;
@@ -49,7 +50,7 @@ export class WaitForChannelStepDefinition extends Serializable implements Handle
 
 }
 
-export class WaitForMessageStepDefinition extends Serializable implements HandlerStepDefinition {
+export class WaitForMessageStep extends Serializable implements HandlerStepDefinition {
 
     readonly type = 'wait-for-rtc-message';
     static readonly isFinal = false;
@@ -66,7 +67,7 @@ export class WaitForMessageStepDefinition extends Serializable implements Handle
 
 }
 
-export class WaitForTrackStepDefinition extends Serializable implements HandlerStepDefinition {
+export class WaitForTrackStep extends Serializable implements HandlerStepDefinition {
 
     readonly type = 'wait-for-rtc-track';
     static readonly isFinal = false;
@@ -77,7 +78,7 @@ export class WaitForTrackStepDefinition extends Serializable implements HandlerS
 
 }
 
-export class WaitForMediaStepDefinition extends Serializable implements HandlerStepDefinition {
+export class WaitForMediaStep extends Serializable implements HandlerStepDefinition {
 
     readonly type = 'wait-for-rtc-media';
     static readonly isFinal = false;
@@ -88,7 +89,7 @@ export class WaitForMediaStepDefinition extends Serializable implements HandlerS
 
 }
 
-export class CreateChannelStepDefinition extends Serializable implements HandlerStepDefinition {
+export class CreateChannelStep extends Serializable implements HandlerStepDefinition {
 
     readonly type = 'create-rtc-data-channel';
     static readonly isFinal = false;
@@ -105,7 +106,7 @@ export class CreateChannelStepDefinition extends Serializable implements Handler
 
 }
 
-export class SendStepDefinition extends Serializable implements HandlerStepDefinition {
+export class SendStep extends Serializable implements HandlerStepDefinition {
 
     readonly type = 'send-rtc-data-message';
     static readonly isFinal = false;
@@ -123,7 +124,7 @@ export class SendStepDefinition extends Serializable implements HandlerStepDefin
 
 }
 
-export class CloseStepDefinition extends Serializable implements HandlerStepDefinition {
+export class CloseStep extends Serializable implements HandlerStepDefinition {
 
     readonly type = 'close-rtc-connection';
     static readonly isFinal = true;
@@ -134,7 +135,7 @@ export class CloseStepDefinition extends Serializable implements HandlerStepDefi
 
 }
 
-export class EchoStepDefinition extends Serializable implements HandlerStepDefinition {
+export class EchoStep extends Serializable implements HandlerStepDefinition {
 
     readonly type = 'echo-rtc';
     static readonly isFinal = true;
@@ -145,11 +146,13 @@ export class EchoStepDefinition extends Serializable implements HandlerStepDefin
 
 }
 
-export class PeerProxyStepDefinition extends Serializable implements HandlerStepDefinition {
+export class PeerProxyStep extends Serializable implements HandlerStepDefinition {
 
     readonly type = 'rtc-peer-proxy';
     static readonly isFinal = true;
 
+    protected externalConnections: RTCConnection[] = []; // Set here so it can be used in impl subclass
+
     protected getAnswer: (offer: MockRTCSessionDescription) => Promise<RTCSessionDescriptionInit>;
 
     constructor(
@@ -187,27 +190,29 @@ export class PeerProxyStepDefinition extends Serializable implements HandlerStep
 
 }
 
-export class DynamicProxyStepDefinition extends Serializable implements HandlerStepDefinition {
+export class DynamicProxyStep extends Serializable implements HandlerStepDefinition {
 
     readonly type = 'rtc-dynamic-proxy';
     static readonly isFinal = true;
 
+    protected externalConnections: RTCConnection[] = []; // Set here so it can be used in impl subclass
+
     explain() {
         return `proxy the RTC connection to a remote peer`;
     }
 
 }
 
 export const StepDefinitionLookup = {
-    'wait-for-duration': WaitForDurationStepDefinition,
-    'wait-for-rtc-data-channel': WaitForChannelStepDefinition,
-    'wait-for-rtc-track': WaitForTrackStepDefinition,
-    'wait-for-rtc-media': WaitForMediaStepDefinition,
-    'wait-for-rtc-message': WaitForMessageStepDefinition,
-    'create-rtc-data-channel': CreateChannelStepDefinition,
-    'send-rtc-data-message': SendStepDefinition,
-    'close-rtc-connection': CloseStepDefinition,
-    'echo-rtc': EchoStepDefinition,
-    'rtc-peer-proxy': PeerProxyStepDefinition,
-    'rtc-dynamic-proxy': DynamicProxyStepDefinition
+    'wait-for-duration': WaitForDurationStep,
+    'wait-for-rtc-data-channel': WaitForChannelStep,
+    'wait-for-rtc-track': WaitForTrackStep,
+    'wait-for-rtc-media': WaitForMediaStep,
+    'wait-for-rtc-message': WaitForMessageStep,
+    'create-rtc-data-channel': CreateChannelStep,
+    'send-rtc-data-message': SendStep,
+    'close-rtc-connection': CloseStep,
+    'echo-rtc': EchoStep,
+    'rtc-peer-proxy': PeerProxyStep,
+    'rtc-dynamic-proxy': DynamicProxyStep
 };