@opentap/runner-client 2.38.1 → 2.39.0

package/dist/mjs/SessionClient.d.ts

@@ -1,9 +1,10 @@
-import { BreakPoints, CommonContext, CommonSettings, DataGridControl, IMetricsConfiguration, Image, Interaction, ListItemType, LogList, MetricsConfiguration, OnTestPlanRun, OnTestStepRun, Parameter, RepositoryPackageDefinition, RepositoryPackageReference, Resource, Result, RunStatus, SessionEvent, Setting, TestPlan, TestStepType, TestStepValidationError, WatchDog } from './DTOs';
+import { BreakPoints, CommonContext, CommonSettings, DataGridControl, IMetricsConfiguration, Image, Interaction, ListItemType, LogList, MetricsConfiguration, OnTestPlanRun, OnTestStepRun, Parameter, RepositoryPackageDefinition, RepositoryPackageReference, Resource, Result, RunStatus, SessionEvent, SessionEventName, Setting, TestPlan, TestStepType, TestStepValidationError, WatchDog } from './DTOs';
 import { ConnectionOptions, NatsError, Subscription, SubscriptionOptions } from 'nats.ws';
 import { BaseClient } from './BaseClient';
 export declare class SessionClient extends BaseClient {
     private _sessionId;
     private subscriptions;
+    private static readonly sessionEventFactories;
     get sessionId(): string | undefined;
     constructor(baseSubject: string, options: ConnectionOptions);
     /**
@@ -18,6 +19,14 @@ export declare class SessionClient extends BaseClient {
      * @returns Subscription object
      */
     connectSessionLogs(sessionLogsHandler: (logList: LogList | undefined, err: NatsError | Error | null) => void, options?: SubscriptionOptions): Subscription;
+    /**
+     * Connect to a specific session event
+     * @param eventName The name of the session event to connect to
+     * @param eventHandler Function to be called when session event or error is received
+     * @param options (optional) Subscription options
+     * @returns Subscription object
+     */
+    connectSessionEvent(eventName: SessionEventName, eventHandler: (sessionEvent: SessionEvent | undefined, err: NatsError | Error | null) => void, options?: SubscriptionOptions): Subscription;
     /**
      * @param eventHandler Function to be called when session event or error is received
      * @param options (optional) Subscription options

package/dist/mjs/SessionClient.js

@@ -1,6 +1,6 @@
-import { BreakPoints, CommonContext, CommonSettings, DataGridControl, Image, Interaction, ListItemType, LogList, MetricsConfiguration, OnTestPlanRun, OnTestStepRun, Result, RunStatus, SessionEvent, Setting, TestPlan, TestStepType, TestStepValidationError, WatchDog, } from './DTOs';
-import { JSONCodec } from 'nats.ws';
+import { BreakEvent, BreakPoints, CommonContext, CommonSettings, DataGridControl, HeartbeatEvent, Image, Interaction, ListItemType, LogList, MetricsConfiguration, OnTestPlanRun, OnTestStepRun, Result, RunStatus, SessionEventName, SessionStateChangedEvent, SessionTimeoutEvent, Setting, SettingsChangedEvent, StartingEvent, StartedEvent, StoppedEvent, StoppingEvent, TestPlan, TestPlanChangedEvent, TestPlanSettingsChangedEvent, TestStepChangedEvent, TestStepType, TestStepValidationError, TypeCacheInvalidatedEvent, UserInputRequestCompletedEvent, UserInputRequestedEvent, WatchDog, } from './DTOs';
 import { BaseClient } from './BaseClient';
+import { jsonCodec } from './encoders';
 export class SessionClient extends BaseClient {
     constructor(baseSubject, options) {
         super(baseSubject, options);
@@ -34,7 +34,6 @@ export class SessionClient extends BaseClient {
                     return;
                 }
                 try {
-                    const jsonCodec = JSONCodec();
                     const logListJson = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
                     const logList = LogList.fromJS(logListJson);
                     sessionLogsHandler(logList, error);
@@ -44,29 +43,47 @@ export class SessionClient extends BaseClient {
                 }
             } }));
     }
+    /**
+     * Connect to a specific session event
+     * @param eventName The name of the session event to connect to
+     * @param eventHandler Function to be called when session event or error is received
+     * @param options (optional) Subscription options
+     * @returns Subscription object
+     */
+    connectSessionEvent(eventName, eventHandler, options) {
+        const factory = SessionClient.sessionEventFactories[eventName];
+        return this.subscribe(`Events.${eventName}`, Object.assign(Object.assign({}, options), { callback: (error, encodedMessage) => {
+                var _a;
+                if (error) {
+                    eventHandler(undefined, error);
+                    return;
+                }
+                try {
+                    if (((_a = encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data) === null || _a === void 0 ? void 0 : _a.length) > 0) {
+                        const payload = jsonCodec.decode(encodedMessage.data);
+                        const sessionEvent = factory(payload);
+                        sessionEvent.sessionId = this._sessionId;
+                        eventHandler(sessionEvent, null);
+                    }
+                }
+                catch (err) {
+                    eventHandler(undefined, err);
+                }
+            } }));
+    }
     /**
      * @param eventHandler Function to be called when session event or error is received
      * @param options (optional) Subscription options
      * @returns Subscription object
      */
     connectSessionEvents(eventHandler, options) {
-        const callback = (error, encodedMessage) => {
-            if (error) {
-                eventHandler(undefined, error);
-                return;
-            }
-            try {
-                const jsonCodec = JSONCodec();
-                const sessionEventJs = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
-                const sessionEvent = SessionEvent.fromJS(sessionEventJs);
-                eventHandler(sessionEvent, error);
-            }
-            catch (error) {
-                eventHandler(undefined, error);
-            }
-        };
-        this.subscriptions.push(this.subscribe('Events', Object.assign(Object.assign({}, options), { callback })));
-        this.subscriptions.push(this.subscribe('Events.*', Object.assign(Object.assign({}, options), { callback })));
+        this.unsubscribeSessionEvents();
+        this.subscriptions = [];
+        // Subscribe to all session events using the new connectSessionEvent method
+        Object.keys(SessionClient.sessionEventFactories).forEach(eventName => {
+            const subscription = this.connectSessionEvent(eventName, eventHandler, options);
+            this.subscriptions.push(subscription);
+        });
     }
     /**
      * Connect to listen to the TestPlanRun events for the given test plan run ID.
@@ -83,7 +100,6 @@ export class SessionClient extends BaseClient {
                     return;
                 }
                 try {
-                    const jsonCodec = JSONCodec();
                     const onTestPlanRunJs = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
                     const onTestPlanRun = OnTestPlanRun.fromJS(onTestPlanRunJs);
                     const planRunId = (_a = encodedMessage.subject.match(/\.PlanRun\.(.+)$/)) === null || _a === void 0 ? void 0 : _a[1];
@@ -115,7 +131,6 @@ export class SessionClient extends BaseClient {
                     return;
                 }
                 try {
-                    const jsonCodec = JSONCodec();
                     const logListJson = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
                     const logList = LogList.fromJS(logListJson);
                     handler(logList, error);
@@ -141,7 +156,6 @@ export class SessionClient extends BaseClient {
                     return;
                 }
                 try {
-                    const jsonCodec = JSONCodec();
                     const onTestStepRunJs = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
                     const onTestStepRun = OnTestStepRun.fromJS(onTestStepRunJs);
                     const [, planRunId, stepRunId] = (_a = encodedMessage.subject.match(/\.PlanRun\.(.+)\.StepRun\.(.+)$/)) !== null && _a !== void 0 ? _a : [
@@ -179,7 +193,6 @@ export class SessionClient extends BaseClient {
                     return;
                 }
                 try {
-                    const jsonCodec = JSONCodec();
                     const resultJs = jsonCodec.decode(encodedMessage === null || encodedMessage === void 0 ? void 0 : encodedMessage.data);
                     const result = Result.fromJS(resultJs);
                     handler(result, error);
@@ -193,8 +206,8 @@ export class SessionClient extends BaseClient {
      * Unsubscibe from session events
      */
     unsubscribeSessionEvents() {
-        var _a;
-        (_a = this.subscriptions) === null || _a === void 0 ? void 0 : _a.forEach(subscription => subscription.unsubscribe());
+        this.subscriptions.forEach(subscription => subscription.unsubscribe());
+        this.subscriptions = [];
     }
     /**
      * Retrieve session logs
@@ -680,3 +693,20 @@ export class SessionClient extends BaseClient {
         return this.request('SetMetricsConfiguration', metricsRequest).then(this.success()).catch(this.error());
     }
 }
+SessionClient.sessionEventFactories = {
+    [SessionEventName.TypeCacheInvalidated]: () => TypeCacheInvalidatedEvent.fromJS(),
+    [SessionEventName.TestPlanSettingsChanged]: () => TestPlanSettingsChangedEvent.fromJS(),
+    [SessionEventName.SessionTimeout]: () => SessionTimeoutEvent.fromJS(),
+    [SessionEventName.Starting]: () => StartingEvent.fromJS(),
+    [SessionEventName.Started]: () => StartedEvent.fromJS(),
+    [SessionEventName.Heartbeat]: payload => HeartbeatEvent.fromJS(payload),
+    [SessionEventName.Stopping]: () => StoppingEvent.fromJS(),
+    [SessionEventName.Stopped]: () => StoppedEvent.fromJS(),
+    [SessionEventName.TestPlanChanged]: () => TestPlanChangedEvent.fromJS(),
+    [SessionEventName.SessionStateChanged]: payload => SessionStateChangedEvent.fromJS(payload),
+    [SessionEventName.SettingsChanged]: payload => SettingsChangedEvent.fromJS(payload),
+    [SessionEventName.TestStepChanged]: payload => TestStepChangedEvent.fromJS(payload),
+    [SessionEventName.Break]: payload => BreakEvent.fromJS(payload),
+    [SessionEventName.UserInputRequested]: payload => UserInputRequestedEvent.fromJS(payload),
+    [SessionEventName.UserInputRequestCompleted]: payload => UserInputRequestCompletedEvent.fromJS(payload),
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentap/runner-client",
-  "version": "2.38.1",
+  "version": "2.39.0",
   "description": "This is the web client for the OpenTAP Runner.",
   "main": "./dist/cjs/index.js",
   "module": "./dist/mjs/index.js",