@opentap/runner-client 2.23.0-alpha.5.5.10792848470 → 2.23.0

package/dist/cjs/BaseClient.js

@@ -275,6 +275,26 @@ var BaseClient = /** @class */ (function () {
         var natsSubject = "".concat(this.baseSubject, ".").concat(subject);
         return this.connection.subscribe(natsSubject, options);
     };
+    /**
+     * Subscribes to given subject.
+     * @param subject The subject to subscribe
+     * @param options Subscription options
+     * @returns Subscription object
+     */
+    BaseClient.prototype.createJetStreamConsumer = function (stream, subject, options) {
+        var _this = this;
+        if (!this.connection) {
+            throw Error('Connection is not established');
+        }
+        return this.connection.jetstreamManager(__assign({}, options)).then(function (jetStreamManager) {
+            return jetStreamManager.consumers
+                .add(stream, {
+                filter_subject: subject,
+                ack_policy: nats_ws_1.AckPolicy.None,
+            })
+                .then(function (consumerInfo) { return _this.connection.jetstream(options).consumers.get(consumerInfo.stream_name, consumerInfo.name); });
+        });
+    };
     BaseClient.prototype.encode = function (payload) {
         if (!payload) {
             return nats_ws_1.Empty;

package/dist/cjs/SessionClient.js

@@ -31,11 +31,13 @@ var DTOs_1 = require("./DTOs");
 var nats_ws_1 = require("nats.ws");
 var encoders_1 = require("./encoders");
 var BaseClient_1 = require("./BaseClient");
+var utils_1 = require("./utils");
 var SessionClient = /** @class */ (function (_super) {
     __extends(SessionClient, _super);
     function SessionClient(baseSubject, options) {
         var _this = _super.call(this, baseSubject, options) || this;
         _this.subscriptions = [];
+        _this.runnerId = (0, utils_1.getSubjectParts)(baseSubject).runnerId;
         return _this;
     }
     /**
@@ -303,46 +305,45 @@ var SessionClient = /** @class */ (function (_super) {
      * @param  {SubscriptionOptions} options?
      * @returns Subscription
      */
-    SessionClient.prototype.connectMetric = function (metricInfo, handler) {
-        var _this = this;
-        return this.connection.jetstreamManager({ checkAPI: false }).then(function (jetStreamManager) {
-            var stream = "".concat(_this.baseSubject, ".Events.Metrics.").concat(metricInfo.subjectPostfix);
-            return jetStreamManager.consumers
-                .add(stream, {
-                name: "runner-web-client-metric-consumer-".concat(nats_ws_1.nuid.next()),
-            })
-                .then(function (consumerInfo) { var _a; return (_a = _this.connection) === null || _a === void 0 ? void 0 : _a.jetstream().consumers.get(consumerInfo.stream_name, consumerInfo.name); })
-                .then(function (consumer) {
-                consumer === null || consumer === void 0 ? void 0 : consumer.consume({
-                    callback: function (encodedMessage) {
-                        var _a, _b;
-                        try {
-                            var time = Number.parseInt((_b = (_a = encodedMessage.headers) === null || _a === void 0 ? void 0 : _a.get('timestamp')) !== null && _b !== void 0 ? _b : '');
-                            var value = void 0;
-                            // Decode the value based on the metric value type given in the metric info
-                            switch (metricInfo.type) {
-                                case DTOs_1.SessionMetricType.Boolean:
-                                    value = encoders_1.booleanCodec.decode(encodedMessage.data);
-                                    break;
-                                case DTOs_1.SessionMetricType.Double:
-                                    value = encoders_1.numberCodec.decode(encodedMessage.data);
-                                    break;
-                                case DTOs_1.SessionMetricType.String:
-                                    value = encoders_1.stringCodec.decode(encodedMessage.data);
-                                    break;
-                                default:
-                                    value = encoders_1.jsonCodec.decode(encodedMessage.data);
-                                    break;
-                            }
-                            handler(new DTOs_1.MetricValue({ value: value, time: time }), null);
-                        }
-                        catch (error) {
-                            handler(undefined, error);
+    SessionClient.prototype.connectMetric = function (metricInfo, handler, sessionId) {
+        var baseSubject = sessionId
+            ? this.baseSubject
+                .split('.')
+                .map(function (part, index) { return (index === 4 ? sessionId : part); })
+                .join('.')
+            : this.baseSubject;
+        return this.createJetStreamConsumer('Metrics', "".concat(baseSubject, ".Events.Metrics.").concat(metricInfo.subjectPostfix), {
+            domain: this.runnerId,
+        }).then(function (consumer) {
+            consumer === null || consumer === void 0 ? void 0 : consumer.consume({
+                callback: function (encodedMessage) {
+                    var _a, _b;
+                    try {
+                        var time = Number.parseInt((_b = (_a = encodedMessage.headers) === null || _a === void 0 ? void 0 : _a.get('timestamp')) !== null && _b !== void 0 ? _b : '');
+                        var value = void 0;
+                        // Decode the value based on the metric value type given in the metric info
+                        switch (metricInfo.type) {
+                            case DTOs_1.SessionMetricType.Boolean:
+                                value = encoders_1.booleanCodec.decode(encodedMessage.data);
+                                break;
+                            case DTOs_1.SessionMetricType.Double:
+                                value = encoders_1.numberCodec.decode(encodedMessage.data);
+                                break;
+                            case DTOs_1.SessionMetricType.String:
+                                value = encoders_1.stringCodec.decode(encodedMessage.data);
+                                break;
+                            default:
+                                value = encoders_1.jsonCodec.decode(encodedMessage.data);
+                                break;
                         }
-                    },
-                });
-                return consumer;
+                        handler(new DTOs_1.MetricValue({ value: value, time: time }), null);
+                    }
+                    catch (error) {
+                        handler(undefined, error);
+                    }
+                },
             });
+            return consumer;
         });
     };
     /**

package/dist/cjs/SystemClient.js

@@ -35,6 +35,13 @@ var SystemClient = /** @class */ (function (_super) {
     function SystemClient(baseSubject, options) {
         return _super.call(this, baseSubject, options) || this;
     }
+    SystemClient.prototype.changeIdleSession = function (request) {
+        return this.request("".concat(this.baseSubject, ".RunnerRegistry.Request.ChangeIdleSession"), request, {
+            fullSubject: true,
+        })
+            .then(this.success())
+            .catch(this.error());
+    };
     /**
      * Subscribe to the lifetime event.
      * @param listener

package/dist/cjs/utils.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSubjectParts = void 0;
+/**
+ * Get the runner ID and session ID from the subject as SubjectParts.
+ * @param  {string} subject
+ * @returns SubjectParts
+ */
+var getSubjectParts = function (subject) {
+    var parts = subject.split('.');
+    return {
+        runnerId: parts[2],
+        sessionId: parts[4],
+    };
+};
+exports.getSubjectParts = getSubjectParts;

package/dist/mjs/BaseClient.d.ts

@@ -1,6 +1,6 @@
 import { DownloadTapSettingsRequest } from './requestDTOs';
 import { ComponentSettingsBase, ComponentSettingsIdentifier, ComponentSettingsListItem, DataGridControl, ErrorResponse, FileParameter, ListItemType, ProfileGroup, RepositoryPackageReference, RepositorySettingsPackageDefinition } from './DTOs';
-import { ConnectionOptions, NatsConnection, NatsError, Subscription, SubscriptionOptions, PublishOptions } from 'nats.ws';
+import { ConnectionOptions, NatsError, Subscription, SubscriptionOptions, PublishOptions, JetStreamOptions, Consumer } from 'nats.ws';
 interface BaseClientRequestOptions {
     publishOptions?: PublishOptions;
     rawResponse?: boolean;
@@ -9,7 +9,7 @@ interface BaseClientRequestOptions {
 }
 export declare class BaseClient {
     readonly baseSubject: string;
-    protected connection: NatsConnection | null;
+    private connection;
     private connectionOptions;
     private domainAccess;
     private eventEmitter;
@@ -61,6 +61,13 @@ export declare class BaseClient {
      * @returns Subscription object
      */
     protected subscribe(subject: string, options: SubscriptionOptions): Subscription;
+    /**
+     * Subscribes to given subject.
+     * @param subject The subject to subscribe
+     * @param options Subscription options
+     * @returns Subscription object
+     */
+    protected createJetStreamConsumer(stream: string, subject: string, options: JetStreamOptions): Promise<Consumer>;
     protected encode(payload: any): Uint8Array;
     /**
      * Create a connection to the nats server.

package/dist/mjs/BaseClient.js

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { ComponentSettingsBase, ComponentSettingsIdentifier, ComponentSettingsListItem, DataGridControl, ErrorResponse, FileDescriptor, ListItemType, ProfileGroup, } from './DTOs';
-import { Empty, ErrorCode, JSONCodec, StringCodec, connect, headers, } from 'nats.ws';
+import { Empty, ErrorCode, JSONCodec, StringCodec, connect, headers, AckPolicy, } from 'nats.ws';
 import { EventEmitter } from 'events';
 import { v4 as uuidv4 } from 'uuid';
 const DEFAULT_TIMEOUT = 40000; // default timeout of 40 seconds
@@ -229,6 +229,23 @@ export class BaseClient {
         const natsSubject = `${this.baseSubject}.${subject}`;
         return this.connection.subscribe(natsSubject, options);
     }
+    /**
+     * Subscribes to given subject.
+     * @param subject The subject to subscribe
+     * @param options Subscription options
+     * @returns Subscription object
+     */
+    createJetStreamConsumer(stream, subject, options) {
+        if (!this.connection) {
+            throw Error('Connection is not established');
+        }
+        return this.connection.jetstreamManager(Object.assign({}, options)).then(jetStreamManager => jetStreamManager.consumers
+            .add(stream, {
+            filter_subject: subject,
+            ack_policy: AckPolicy.None,
+        })
+            .then(consumerInfo => this.connection.jetstream(options).consumers.get(consumerInfo.stream_name, consumerInfo.name)));
+    }
     encode(payload) {
         if (!payload) {
             return Empty;

package/dist/mjs/DTOs.d.ts

@@ -1145,6 +1145,10 @@ export interface IMetricValue {
     time: number;
     value: boolean | number | string | object;
 }
+export interface ChangeIdleSessionRequest {
+    runnerId: string;
+    sessionId: string;
+}
 export declare class SessionEvent implements ISessionEvent {
     eventType?: SessionEventType;
     sessionId?: string;

package/dist/mjs/SessionClient.d.ts

@@ -3,6 +3,7 @@ import { ConnectionOptions, Consumer, NatsError, Subscription, SubscriptionOptio
 import { BaseClient } from './BaseClient';
 export declare class SessionClient extends BaseClient {
     private subscriptions;
+    private runnerId;
     constructor(baseSubject: string, options: ConnectionOptions);
     /**
      * @param sessionLogsHandler Function to be called when log list or error is received
@@ -88,7 +89,7 @@ export declare class SessionClient extends BaseClient {
      * @param  {SubscriptionOptions} options?
      * @returns Subscription
      */
-    connectMetric(metricInfo: ISessionMetricInfo, handler: (result: IMetricValue | undefined, err: NatsError | Error | null) => void): Promise<Consumer | undefined>;
+    connectMetric(metricInfo: ISessionMetricInfo, handler: (result: IMetricValue | undefined, err: NatsError | Error | null) => void, sessionId?: string): Promise<Consumer>;
     /**
      * Unsubscibe from session events
      */

package/dist/mjs/SessionClient.js

@@ -1,11 +1,13 @@
 import { BreakPoints, CommonContext, CommonSettings, DataGridControl, Image, Interaction, ListItemType, LogList, MetricValue, MetricsConfiguration, OnTestPlanRun, OnTestStepRun, Parameter, Result, RunStatus, SessionEvent, SessionMetricType, Setting, TestPlan, TestRun, TestStepType, TestStepValidationError, WatchDog, } from './DTOs';
-import { JSONCodec, nuid } from 'nats.ws';
+import { JSONCodec } from 'nats.ws';
 import { booleanCodec, jsonCodec, numberCodec, stringCodec } from './encoders';
 import { BaseClient } from './BaseClient';
+import { getSubjectParts } from './utils';
 export class SessionClient extends BaseClient {
     constructor(baseSubject, options) {
         super(baseSubject, options);
         this.subscriptions = [];
+        this.runnerId = getSubjectParts(baseSubject).runnerId;
     }
     /**
      * @param sessionLogsHandler Function to be called when log list or error is received
@@ -272,45 +274,45 @@ export class SessionClient extends BaseClient {
      * @param  {SubscriptionOptions} options?
      * @returns Subscription
      */
-    connectMetric(metricInfo, handler) {
-        return this.connection.jetstreamManager({ checkAPI: false }).then(jetStreamManager => {
-            const stream = `${this.baseSubject}.Events.Metrics.${metricInfo.subjectPostfix}`;
-            return jetStreamManager.consumers
-                .add(stream, {
-                name: `runner-web-client-metric-consumer-${nuid.next()}`,
-            })
-                .then(consumerInfo => { var _a; return (_a = this.connection) === null || _a === void 0 ? void 0 : _a.jetstream().consumers.get(consumerInfo.stream_name, consumerInfo.name); })
-                .then(consumer => {
-                consumer === null || consumer === void 0 ? void 0 : consumer.consume({
-                    callback(encodedMessage) {
-                        var _a, _b;
-                        try {
-                            const time = Number.parseInt((_b = (_a = encodedMessage.headers) === null || _a === void 0 ? void 0 : _a.get('timestamp')) !== null && _b !== void 0 ? _b : '');
-                            let value;
-                            // Decode the value based on the metric value type given in the metric info
-                            switch (metricInfo.type) {
-                                case SessionMetricType.Boolean:
-                                    value = booleanCodec.decode(encodedMessage.data);
-                                    break;
-                                case SessionMetricType.Double:
-                                    value = numberCodec.decode(encodedMessage.data);
-                                    break;
-                                case SessionMetricType.String:
-                                    value = stringCodec.decode(encodedMessage.data);
-                                    break;
-                                default:
-                                    value = jsonCodec.decode(encodedMessage.data);
-                                    break;
-                            }
-                            handler(new MetricValue({ value, time }), null);
-                        }
-                        catch (error) {
-                            handler(undefined, error);
+    connectMetric(metricInfo, handler, sessionId) {
+        const baseSubject = sessionId
+            ? this.baseSubject
+                .split('.')
+                .map((part, index) => (index === 4 ? sessionId : part))
+                .join('.')
+            : this.baseSubject;
+        return this.createJetStreamConsumer('Metrics', `${baseSubject}.Events.Metrics.${metricInfo.subjectPostfix}`, {
+            domain: this.runnerId,
+        }).then(consumer => {
+            consumer === null || consumer === void 0 ? void 0 : consumer.consume({
+                callback(encodedMessage) {
+                    var _a, _b;
+                    try {
+                        const time = Number.parseInt((_b = (_a = encodedMessage.headers) === null || _a === void 0 ? void 0 : _a.get('timestamp')) !== null && _b !== void 0 ? _b : '');
+                        let value;
+                        // Decode the value based on the metric value type given in the metric info
+                        switch (metricInfo.type) {
+                            case SessionMetricType.Boolean:
+                                value = booleanCodec.decode(encodedMessage.data);
+                                break;
+                            case SessionMetricType.Double:
+                                value = numberCodec.decode(encodedMessage.data);
+                                break;
+                            case SessionMetricType.String:
+                                value = stringCodec.decode(encodedMessage.data);
+                                break;
+                            default:
+                                value = jsonCodec.decode(encodedMessage.data);
+                                break;
                         }
-                    },
-                });
-                return consumer;
+                        handler(new MetricValue({ value, time }), null);
+                    }
+                    catch (error) {
+                        handler(undefined, error);
+                    }
+                },
             });
+            return consumer;
         });
     }
     /**

package/dist/mjs/SystemClient.d.ts

@@ -1,5 +1,5 @@
 import { ConnectionOptions, Subscription, SubscriptionOptions } from 'nats.ws';
-import { ErrorResponse, RunnerEvent, TestPlanRunCompletedEventArgs, TestPlanRunStartEventArgs, TestStepRunCompletedEventArgs, TestStepRunStartEventArgs } from './DTOs';
+import { ChangeIdleSessionRequest, ErrorResponse, RunnerEvent, TestPlanRunCompletedEventArgs, TestPlanRunStartEventArgs, TestStepRunCompletedEventArgs, TestStepRunStartEventArgs } from './DTOs';
 import { BaseClient } from './BaseClient';
 export interface RunnerLifetimeEvent {
     RunnerId: string;
@@ -8,6 +8,7 @@ export interface RunnerLifetimeEvent {
 }
 export declare class SystemClient extends BaseClient {
     constructor(baseSubject: string, options: ConnectionOptions);
+    changeIdleSession(request: ChangeIdleSessionRequest): Promise<void>;
     /**
      * Subscribe to the lifetime event.
      * @param listener

package/dist/mjs/SystemClient.js

@@ -5,6 +5,13 @@ export class SystemClient extends BaseClient {
     constructor(baseSubject, options) {
         super(baseSubject, options);
     }
+    changeIdleSession(request) {
+        return this.request(`${this.baseSubject}.RunnerRegistry.Request.ChangeIdleSession`, request, {
+            fullSubject: true,
+        })
+            .then(this.success())
+            .catch(this.error());
+    }
     /**
      * Subscribe to the lifetime event.
      * @param listener

package/dist/mjs/utils.d.ts

@@ -0,0 +1,11 @@
+interface SubjectParts {
+    runnerId: string | undefined;
+    sessionId: string | undefined;
+}
+/**
+ * Get the runner ID and session ID from the subject as SubjectParts.
+ * @param  {string} subject
+ * @returns SubjectParts
+ */
+export declare const getSubjectParts: (subject: string) => SubjectParts;
+export {};

package/dist/mjs/utils.js

@@ -0,0 +1,12 @@
+/**
+ * Get the runner ID and session ID from the subject as SubjectParts.
+ * @param  {string} subject
+ * @returns SubjectParts
+ */
+export const getSubjectParts = (subject) => {
+    const parts = subject.split('.');
+    return {
+        runnerId: parts[2],
+        sessionId: parts[4],
+    };
+};

package/package.json

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