@opentap/runner-client 4.0.0 → 4.2.0

package/dist/cjs/BaseClient.d.ts

@@ -6,6 +6,9 @@ interface BaseClientRequestOptions {
     rawResponse?: boolean;
     fullSubject?: boolean;
     timeout?: number;
+    headers?: {
+        [key: string]: string;
+    };
 }
 export declare class BaseClient {
     readonly baseSubject: string;

package/dist/cjs/BaseClient.js

@@ -102,8 +102,13 @@ var BaseClient = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
-    BaseClient.prototype.withTimeout = function (promise, timeout) {
-        return Promise.race([promise, new Promise(function (_, reject) { return setTimeout(function () { return reject(new Error(nats_ws_1.ErrorCode.Timeout)); }, timeout); })]);
+    BaseClient.prototype.withTimeout = function (promise, timeout, subject) {
+        return Promise.race([
+            promise,
+            new Promise(function (_, reject) {
+                return setTimeout(function () { return reject(new Error("".concat(nats_ws_1.ErrorCode.Timeout, ": '").concat(subject, "' timed out after ").concat(timeout, "ms"))); }, timeout);
+            }),
+        ]);
     };
     /**
      * Send a request to the nats server.
@@ -128,6 +133,12 @@ var BaseClient = /** @class */ (function () {
                     return [2 /*return*/, Promise.reject("".concat(subject, ": Connection has been closed! Please reconnect!"))];
                 data = this.encode(payload);
                 headers = this.buildHeaders();
+                if (options === null || options === void 0 ? void 0 : options.headers) {
+                    Object.entries(options.headers).forEach(function (_a) {
+                        var key = _a[0], value = _a[1];
+                        return headers.append(key, value);
+                    });
+                }
                 timeout = (options === null || options === void 0 ? void 0 : options.timeout) || this.timeout;
                 replySubject = (_b = (_a = options === null || options === void 0 ? void 0 : options.publishOptions) === null || _a === void 0 ? void 0 : _a.reply) !== null && _b !== void 0 ? _b : "".concat(subject, ".Reply.").concat((0, uuid_1.v4)());
                 serverMaxPayload = (_d = (_c = this.connection) === null || _c === void 0 ? void 0 : _c.info) === null || _d === void 0 ? void 0 : _d.max_payload;
@@ -217,7 +228,7 @@ var BaseClient = /** @class */ (function () {
                     this.connection.publish(subject, nats_ws_1.Empty, opts);
                 }
                 // Now that we have sent the terminating chunk, the result should arrive on our promise.
-                return [2 /*return*/, this.withTimeout(responsePromise, timeout).catch(function (err) {
+                return [2 /*return*/, this.withTimeout(responsePromise, timeout, subject).catch(function (err) {
                         subscription.unsubscribe();
                         return Promise.reject(_this.natsErrorHandler(err, subject));
                     })];

package/dist/cjs/DTOs.d.ts

@@ -832,6 +832,7 @@ export declare class RunStatus implements IRunStatus {
     failedToStart?: boolean;
     sessionState?: SessionState;
     executingSteps?: string[] | undefined;
+    createdAt?: string | undefined;
     constructor(data?: IRunStatus);
     init(_data?: any): void;
     static fromJS(data: any): RunStatus;
@@ -844,6 +845,7 @@ export interface IRunStatus {
     failedToStart?: boolean;
     sessionState?: SessionState;
     executingSteps?: string[] | undefined;
+    createdAt?: string | undefined;
 }
 export declare class EditStatus implements IEditStatus {
     undoBufferSize?: number;

package/dist/cjs/DTOs.js

@@ -2350,7 +2350,7 @@ var RunStatus = /** @class */ (function () {
         }
     }
     RunStatus.prototype.init = function (_data) {
-        var _a;
+        var _a, _b;
         if (_data) {
             this.sessionId = _data['SessionId'];
             this.verdict = _data['Verdict'];
@@ -2359,11 +2359,12 @@ var RunStatus = /** @class */ (function () {
             this.sessionState = (_a = _data['SessionState']) !== null && _a !== void 0 ? _a : _data['sessionState'];
             if (Array.isArray(_data['ExecutingSteps'])) {
                 this.executingSteps = [];
-                for (var _i = 0, _b = _data['ExecutingSteps']; _i < _b.length; _i++) {
-                    var item = _b[_i];
+                for (var _i = 0, _c = _data['ExecutingSteps']; _i < _c.length; _i++) {
+                    var item = _c[_i];
                     this.executingSteps.push(item);
                 }
             }
+            this.createdAt = (_b = _data['CreatedAt']) !== null && _b !== void 0 ? _b : undefined;
         }
     };
     RunStatus.fromJS = function (data) {
@@ -2386,6 +2387,7 @@ var RunStatus = /** @class */ (function () {
                 data['ExecutingSteps'].push(item);
             }
         }
+        data['CreatedAt'] = this.createdAt;
         return data;
     };
     return RunStatus;

package/dist/cjs/RunnerClient.d.ts

@@ -54,9 +54,10 @@ export declare class RunnerClient extends BaseClient {
     /**
      * Shut down a session
      * @param sessionId the ID of the session to shut down
+     * @param force When true, the Runner terminates the session subprocess immediately without attempting a graceful shutdown.
      * @returns {{Promise<void>}}
      */
-    shutdownSession(sessionId: string): Promise<void>;
+    shutdownSession(sessionId: string, force?: boolean): Promise<void>;
     /**
      * Start a session
      * @returns {{Promise<Session>}}

package/dist/cjs/RunnerClient.js

@@ -221,11 +221,15 @@ var RunnerClient = /** @class */ (function (_super) {
     /**
      * Shut down a session
      * @param sessionId the ID of the session to shut down
+     * @param force When true, the Runner terminates the session subprocess immediately without attempting a graceful shutdown.
      * @returns {{Promise<void>}}
      */
-    RunnerClient.prototype.shutdownSession = function (sessionId) {
+    RunnerClient.prototype.shutdownSession = function (sessionId, force) {
+        if (force === void 0) { force = false; }
         return (sessionId === null || sessionId === void 0 ? void 0 : sessionId.length) > 0
-            ? this.request('ShutdownSession', sessionId).then(this.success()).catch(this.error())
+            ? this.request('ShutdownSession', sessionId, force ? { headers: { Force: 'true' } } : undefined)
+                .then(this.success())
+                .catch(this.error())
             : Promise.reject('sessionId is not defined');
     };
     /**

package/dist/mjs/BaseClient.d.ts

@@ -6,6 +6,9 @@ interface BaseClientRequestOptions {
     rawResponse?: boolean;
     fullSubject?: boolean;
     timeout?: number;
+    headers?: {
+        [key: string]: string;
+    };
 }
 export declare class BaseClient {
     readonly baseSubject: string;

package/dist/mjs/BaseClient.js

@@ -49,8 +49,11 @@ export class BaseClient {
         this.connectionOptions.timeout = (options === null || options === void 0 ? void 0 : options.timeout) || DEFAULT_TIMEOUT;
         this.eventEmitter = new EventEmitter();
     }
-    withTimeout(promise, timeout) {
-        return Promise.race([promise, new Promise((_, reject) => setTimeout(() => reject(new Error(ErrorCode.Timeout)), timeout))]);
+    withTimeout(promise, timeout, subject) {
+        return Promise.race([
+            promise,
+            new Promise((_, reject) => setTimeout(() => reject(new Error(`${ErrorCode.Timeout}: '${subject}' timed out after ${timeout}ms`)), timeout)),
+        ]);
     }
     /**
      * Send a request to the nats server.
@@ -72,6 +75,9 @@ export class BaseClient {
                 return Promise.reject(`${subject}: Connection has been closed! Please reconnect!`);
             const data = this.encode(payload);
             const headers = this.buildHeaders();
+            if (options === null || options === void 0 ? void 0 : options.headers) {
+                Object.entries(options.headers).forEach(([key, value]) => headers.append(key, value));
+            }
             const timeout = (options === null || options === void 0 ? void 0 : options.timeout) || this.timeout;
             // Generate a unique reply subject that we can subscribe to
             const replySubject = (_b = (_a = options === null || options === void 0 ? void 0 : options.publishOptions) === null || _a === void 0 ? void 0 : _a.reply) !== null && _b !== void 0 ? _b : `${subject}.Reply.${uuidv4()}`;
@@ -175,7 +181,7 @@ export class BaseClient {
                 this.connection.publish(subject, Empty, opts);
             }
             // Now that we have sent the terminating chunk, the result should arrive on our promise.
-            return this.withTimeout(responsePromise, timeout).catch(err => {
+            return this.withTimeout(responsePromise, timeout, subject).catch(err => {
                 subscription.unsubscribe();
                 return Promise.reject(this.natsErrorHandler(err, subject));
             });

package/dist/mjs/DTOs.d.ts

@@ -832,6 +832,7 @@ export declare class RunStatus implements IRunStatus {
     failedToStart?: boolean;
     sessionState?: SessionState;
     executingSteps?: string[] | undefined;
+    createdAt?: string | undefined;
     constructor(data?: IRunStatus);
     init(_data?: any): void;
     static fromJS(data: any): RunStatus;
@@ -844,6 +845,7 @@ export interface IRunStatus {
     failedToStart?: boolean;
     sessionState?: SessionState;
     executingSteps?: string[] | undefined;
+    createdAt?: string | undefined;
 }
 export declare class EditStatus implements IEditStatus {
     undoBufferSize?: number;

package/dist/mjs/DTOs.js

@@ -2057,7 +2057,7 @@ export class RunStatus {
         }
     }
     init(_data) {
-        var _a;
+        var _a, _b;
         if (_data) {
             this.sessionId = _data['SessionId'];
             this.verdict = _data['Verdict'];
@@ -2069,6 +2069,7 @@ export class RunStatus {
                 for (const item of _data['ExecutingSteps'])
                     this.executingSteps.push(item);
             }
+            this.createdAt = (_b = _data['CreatedAt']) !== null && _b !== void 0 ? _b : undefined;
         }
     }
     static fromJS(data) {
@@ -2089,6 +2090,7 @@ export class RunStatus {
             for (const item of this.executingSteps)
                 data['ExecutingSteps'].push(item);
         }
+        data['CreatedAt'] = this.createdAt;
         return data;
     }
 }

package/dist/mjs/RunnerClient.d.ts

@@ -54,9 +54,10 @@ export declare class RunnerClient extends BaseClient {
     /**
      * Shut down a session
      * @param sessionId the ID of the session to shut down
+     * @param force When true, the Runner terminates the session subprocess immediately without attempting a graceful shutdown.
      * @returns {{Promise<void>}}
      */
-    shutdownSession(sessionId: string): Promise<void>;
+    shutdownSession(sessionId: string, force?: boolean): Promise<void>;
     /**
      * Start a session
      * @returns {{Promise<Session>}}

package/dist/mjs/RunnerClient.js

@@ -161,11 +161,14 @@ export class RunnerClient extends BaseClient {
     /**
      * Shut down a session
      * @param sessionId the ID of the session to shut down
+     * @param force When true, the Runner terminates the session subprocess immediately without attempting a graceful shutdown.
      * @returns {{Promise<void>}}
      */
-    shutdownSession(sessionId) {
+    shutdownSession(sessionId, force = false) {
         return (sessionId === null || sessionId === void 0 ? void 0 : sessionId.length) > 0
-            ? this.request('ShutdownSession', sessionId).then(this.success()).catch(this.error())
+            ? this.request('ShutdownSession', sessionId, force ? { headers: { Force: 'true' } } : undefined)
+                .then(this.success())
+                .catch(this.error())
             : Promise.reject('sessionId is not defined');
     }
     /**

package/package.json

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