@opentap/runner-client 2.3.0-alpha.1.1 → 2.3.0

package/lib/BaseClient.d.ts

@@ -1,5 +1,5 @@
 import { ComponentSettingsBase, ComponentSettingsIdentifier, ComponentSettingsListItem, DataGridControl, ErrorResponse, FileParameter, FileResponse, ListItemType, ProfileGroup, RepositoryPackageReference, RepositorySettingsPackageDefinition, SettingsTapPackage } from './DTOs';
-import { ConnectionOptions, NatsConnection, RequestOptions, Subscription, SubscriptionOptions } from 'nats.ws';
+import { ConnectionOptions, RequestOptions, Subscription, SubscriptionOptions } from 'nats.ws';
 export declare class BaseClient {
     private connection;
     private baseSubject;
@@ -9,6 +9,7 @@ export declare class BaseClient {
     private _accessToken;
     private _headers;
     private _timeout;
+    private _chunkSize;
     /** Get request access token */
     get accessToken(): string;
     /** Set request access token */
@@ -27,11 +28,9 @@ export declare class BaseClient {
      * @param subject The subject to request
      * @param payload (optional)
      * @param options (optional)
-     * @param isFullSubject (optional) If true, use the subject as request subject
-     * without appending it to the baseSubject
      * @returns Promise of an object
      */
-    protected request<T>(subject: string, payload?: any, options?: RequestOptions, isFullSubject?: boolean): Promise<T>;
+    protected request<T>(subject: string, payload?: any, options?: RequestOptions, rawResponse?: boolean, fullSubject?: boolean): Promise<T>;
     /**
      * Handle the error
      * @param error
@@ -52,21 +51,14 @@ export declare class BaseClient {
      */
     protected subscribe(subject: string, options: SubscriptionOptions): Subscription;
     /**
-     * Send an object to the nats server with chunks.
-     * @param subject The subject to request
-     * @param payload (optional)
-     * @param options (optional)
-     * @returns Promise of an object
-     */
-    protected sendChunked<T>(subject: string, payload?: any, options?: RequestOptions): Promise<T>;
-    /**
-     * Request an object to the nats server with chunks.
-     * @param subject The subject to request
-     * @param payload (optional)
-     * @param options (optional)
-     * @returns Promise of an object
+     * Receive a chunked file specified by a request response
+     * @param requestResponse Contains a reply subject and a file descriptor which can be used to download chunks
+     * @param rawResponse If true, the response should not be decoded
+     * @param opts Request options
+     * @returns
      */
-    protected requestChunked<T>(subject: string, replySubject: string, payload: any, options?: RequestOptions, isFullSubject?: boolean, rawResponse?: boolean): Promise<T>;
+    private downloadChunkedRequest;
+    protected encode(payload: any): Uint8Array;
     /**
      * Check if the the response is an error from the server.
      * @param {any} response
@@ -77,7 +69,7 @@ export declare class BaseClient {
      * Create a connection to the nats server.
      * @param {ConnectionOptions} options
      */
-    connect(): Promise<NatsConnection>;
+    connect(): Promise<void>;
     /**
      * Close the connection.
      */

package/lib/BaseClient.js

@@ -66,6 +66,7 @@ var BaseClient = /** @class */ (function () {
     function BaseClient(baseSubject, options) {
         this.domainAccess = new Map();
         this._headers = new Headers();
+        this._chunkSize = 512000;
         this.baseSubject = baseSubject;
         this.connectionOptions = __assign({}, options) || {};
         this.connectionOptions.timeout = (options === null || options === void 0 ? void 0 : options.timeout) || DEFAULT_TIMEOUT;
@@ -112,39 +113,60 @@ var BaseClient = /** @class */ (function () {
      * @param subject The subject to request
      * @param payload (optional)
      * @param options (optional)
-     * @param isFullSubject (optional) If true, use the subject as request subject
-     * without appending it to the baseSubject
      * @returns Promise of an object
      */
-    BaseClient.prototype.request = function (subject, payload, options, isFullSubject) {
+    BaseClient.prototype.request = function (subject, payload, options, rawResponse, fullSubject) {
         return __awaiter(this, void 0, void 0, function () {
-            var stringCodec, data, headers, timeout, opts;
-            var _this = this;
+            var data, headers, timeout, opts, fileDescriptor, getChunk, requestResponse, dataSubject, i, result, error;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        subject = isFullSubject ? subject : "".concat(this.baseSubject, ".Request.").concat(subject);
+                        // Prepend the base subject if the given subject does not start with that
+                        if (!fullSubject) {
+                            subject = "".concat(this.baseSubject, ".Request.").concat(subject);
+                        }
                         if (!this.connection)
                             return [2 /*return*/, Promise.reject("".concat(subject, ": Connection is down! Please try again!"))];
                         if (this.connection.isClosed())
                             return [2 /*return*/, Promise.reject("".concat(subject, ": Connection has been closed! Please reconnect!"))];
-                        stringCodec = StringCodec();
-                        data = payload ? stringCodec.encode(JSON.stringify(payload)) : Empty;
+                        data = this.encode(payload);
                         headers = this.buildHeaders();
+                        headers.append('ChunkSize', this._chunkSize.toString());
                         timeout = (options === null || options === void 0 ? void 0 : options.timeout) || this.timeout;
                         opts = __assign(__assign({}, options), { timeout: timeout, headers: headers });
-                        return [4 /*yield*/, this.connection
-                                .request(subject, data, opts)
-                                .then(function (message) {
-                                var response;
-                                if ((message === null || message === void 0 ? void 0 : message.data.length) !== 0) {
-                                    var jsonCodec = JSONCodec();
-                                    response = jsonCodec.decode(message.data);
-                                }
-                                return _this.isErrorResponse(response) ? Promise.reject(ErrorResponse.fromJS(response)) : Promise.resolve(response);
-                            })
-                                .catch(function (error) { return Promise.reject(_this.natsErrorHandler(error, subject)); })];
-                    case 1: return [2 /*return*/, _a.sent()];
+                        fileDescriptor = new FileDescriptor(data.length, this._chunkSize);
+                        getChunk = function (chunk) {
+                            var offset = chunk * fileDescriptor.chunkSize;
+                            return data.slice(offset, offset + fileDescriptor.chunkSize);
+                        };
+                        dataSubject = subject;
+                        i = 0;
+                        _a.label = 1;
+                    case 1:
+                        if (!(i < fileDescriptor.numberOfChunks)) return [3 /*break*/, 4];
+                        return [4 /*yield*/, this.connection.request(dataSubject, getChunk(i), opts)];
+                    case 2:
+                        requestResponse = _a.sent();
+                        dataSubject = requestResponse.reply;
+                        _a.label = 3;
+                    case 3:
+                        i++;
+                        return [3 /*break*/, 1];
+                    case 4:
+                        if (!(fileDescriptor.fileSize % fileDescriptor.chunkSize === 0)) return [3 /*break*/, 6];
+                        return [4 /*yield*/, this.connection.request(dataSubject, Empty, opts)];
+                    case 5:
+                        requestResponse = _a.sent();
+                        _a.label = 6;
+                    case 6: return [4 /*yield*/, this.downloadChunkedRequest(requestResponse, rawResponse, opts)];
+                    case 7:
+                        result = _a.sent();
+                        if (this.isErrorResponse(result)) {
+                            error = ErrorResponse.fromJS(result);
+                            this.eventEmitter.emit(Events.ERROR, error);
+                            return [2 /*return*/, Promise.reject(error)];
+                        }
+                        return [2 /*return*/, result];
                 }
             });
         });
@@ -198,145 +220,57 @@ var BaseClient = /** @class */ (function () {
         return this.connection.subscribe(natsSubject, options);
     };
     /**
-     * Send an object to the nats server with chunks.
-     * @param subject The subject to request
-     * @param payload (optional)
-     * @param options (optional)
-     * @returns Promise of an object
+     * Receive a chunked file specified by a request response
+     * @param requestResponse Contains a reply subject and a file descriptor which can be used to download chunks
+     * @param rawResponse If true, the response should not be decoded
+     * @param opts Request options
+     * @returns
      */
-    BaseClient.prototype.sendChunked = function (subject, payload, options) {
+    BaseClient.prototype.downloadChunkedRequest = function (requestResponse, rawResponse, opts) {
         return __awaiter(this, void 0, void 0, function () {
-            var stringCodec, data, headers, opts, fileDescriptor, getChunk, dataSubject, i;
-            var _this = this;
+            var result, resultCodec;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         if (!this.connection)
-                            return [2 /*return*/, Promise.reject("".concat(subject, ": Connection is down! Please try again!"))];
+                            return [2 /*return*/, Promise.reject('Chunking: Connection is down! Please try again!')];
                         if (this.connection.isClosed())
-                            return [2 /*return*/, Promise.reject("".concat(subject, ": Connection has been closed! Please reconnect!"))];
-                        stringCodec = StringCodec();
-                        data = payload ? stringCodec.encode(JSON.stringify(payload)) : Empty;
-                        headers = this.buildHeaders();
-                        opts = __assign(__assign({}, options), { timeout: this.timeout, headers: headers });
-                        fileDescriptor = new FileDescriptor(data.length);
-                        if (!fileDescriptor.numberOfChunks)
-                            return [2 /*return*/, Promise.reject("".concat(subject, ": File is empty!"))];
-                        getChunk = function (chunk) {
-                            var offset = chunk * fileDescriptor.chunkSize;
-                            return data.slice(offset, offset + fileDescriptor.chunkSize);
-                        };
-                        return [4 /*yield*/, this.request(subject, fileDescriptor, opts)];
+                            return [2 /*return*/, Promise.reject("Chunking: Connection has been closed! Please reconnect!")];
+                        result = new Uint8Array([]);
+                        _a.label = 1;
                     case 1:
-                        dataSubject = _a.sent();
-                        for (i = 0; i < fileDescriptor.numberOfChunks; i++) {
-                            this.connection.publish(dataSubject, getChunk(i), opts);
+                        result = new Uint8Array(__spreadArray(__spreadArray([], Array.from(result), true), Array.from(requestResponse.data), true));
+                        // Acknowledge that the final chunk was received
+                        if (requestResponse.data.length < this._chunkSize) {
+                            this.connection.publish(requestResponse.reply, Empty);
+                            return [3 /*break*/, 4];
+                        }
+                        return [4 /*yield*/, this.connection.request(requestResponse.reply, Empty, opts)];
+                    case 2:
+                        requestResponse = _a.sent();
+                        _a.label = 3;
+                    case 3: return [3 /*break*/, 1];
+                    case 4:
+                        if (result.length !== 0) {
+                            // The runner skips the encoding step if the return type is a byte array, so we must also skip the decoding step in this case.
+                            if (rawResponse)
+                                return [2 /*return*/, Promise.resolve(result)];
+                            resultCodec = JSONCodec();
+                            return [2 /*return*/, resultCodec.decode(result)];
                         }
-                        return [2 /*return*/, new Promise(function (resolve, reject) {
-                                if (!_this.connection) {
-                                    return Promise.reject('No nats connection.');
-                                }
-                                var combinedResult = new Uint8Array([]);
-                                // Subscribe to dataSubject before sending the terminating message to ensure we are listening before the server starts responding
-                                var subscription = _this.connection.subscribe(dataSubject);
-                                // Publish an empty message to indicate that we are ready to listen
-                                _this.connection.publish(dataSubject, Empty, opts);
-                                var first = true;
-                                subscription.callback = function (error, message) {
-                                    // The first message is the empty message we published above.
-                                    // We should discard this message before we proceed
-                                    if (first === true) {
-                                        first = false;
-                                        return;
-                                    }
-                                    if (error) {
-                                        reject(error);
-                                    }
-                                    combinedResult = new Uint8Array(__spreadArray(__spreadArray([], Array.from(combinedResult), true), Array.from(message === null || message === void 0 ? void 0 : message.data), true));
-                                    if ((message === null || message === void 0 ? void 0 : message.data.length) === 0) {
-                                        resolve(combinedResult);
-                                    }
-                                };
-                            }).then(function (byteArray) {
-                                var jsonCodec = JSONCodec();
-                                var response = jsonCodec.decode(byteArray);
-                                if (_this.isErrorResponse(response)) {
-                                    var error = ErrorResponse.fromJS(response);
-                                    _this.eventEmitter.emit(Events.ERROR, error);
-                                    return Promise.reject(error);
-                                }
-                                return Promise.resolve(response);
-                            })];
+                        return [2 /*return*/];
                 }
             });
         });
     };
-    /**
-     * Request an object to the nats server with chunks.
-     * @param subject The subject to request
-     * @param payload (optional)
-     * @param options (optional)
-     * @returns Promise of an object
-     */
-    BaseClient.prototype.requestChunked = function (subject, replySubject, payload, options, isFullSubject, rawResponse) {
-        return __awaiter(this, void 0, void 0, function () {
-            var fileSize;
-            var _this = this;
-            return __generator(this, function (_a) {
-                if (!this.connection)
-                    return [2 /*return*/, Promise.reject("".concat(subject, ": Connection is down! Please try again!"))];
-                if (this.connection.isClosed())
-                    return [2 /*return*/, Promise.reject("".concat(subject, ": Connection has been closed! Please reconnect!"))];
-                fileSize = -1;
-                return [2 /*return*/, new Promise(function (resolve, reject) {
-                        if (!_this.connection)
-                            return Promise.reject("".concat(subject, ": Connection is down! Please try again!"));
-                        var combinedResult = new Uint8Array([]);
-                        // Subscribe to the subject before starting the process
-                        var subscription = _this.connection.subscribe(replySubject);
-                        var resolveIfCompleted = function () {
-                            if (combinedResult.length === fileSize) {
-                                subscription.unsubscribe();
-                                resolve(combinedResult);
-                            }
-                        };
-                        subscription.callback = function (error, message) {
-                            if (error) {
-                                reject(error);
-                            }
-                            combinedResult = new Uint8Array(__spreadArray(__spreadArray([], Array.from(combinedResult), true), Array.from(message === null || message === void 0 ? void 0 : message.data), true));
-                            resolveIfCompleted();
-                        };
-                        var headers = _this.buildHeaders();
-                        var opts = __assign(__assign({}, options), { timeout: _this.timeout, headers: headers });
-                        // Request the file descriptor from the runner by posting the reply subject
-                        return _this.request(subject, payload, opts, isFullSubject)
-                            .then(function (fileDescriptor) { return FileDescriptor.fromJS(fileDescriptor); })
-                            .then(function (fileDescriptor) {
-                            fileSize = fileDescriptor.fileSize;
-                            resolveIfCompleted();
-                        })
-                            .catch(function (error) {
-                            subscription.unsubscribe();
-                            throw error;
-                        });
-                    }).then(function (byteArray) {
-                        if (byteArray.length !== fileSize)
-                            return Promise.reject("Unexpected response size. Expected ".concat(fileSize, " bytes, but got ").concat(byteArray.length, "."));
-                        // Avoid decoding the response if the expected response is bytearray
-                        if (rawResponse)
-                            return Promise.resolve(byteArray);
-                        var jsonCodec = JSONCodec();
-                        var response = jsonCodec.decode(byteArray);
-                        if (_this.isErrorResponse(response)) {
-                            var error = ErrorResponse.fromJS(response);
-                            _this.eventEmitter.emit(Events.ERROR, error);
-                            return Promise.reject(error);
-                        }
-                        return Promise.resolve(response);
-                    })];
-            });
-        });
+    BaseClient.prototype.encode = function (payload) {
+        if (!payload) {
+            return Empty;
+        }
+        if (payload instanceof Uint8Array) {
+            return payload;
+        }
+        return StringCodec().encode(JSON.stringify(payload));
     };
     /**
      * Check if the the response is an error from the server.
@@ -360,14 +294,14 @@ var BaseClient = /** @class */ (function () {
                         if (!this.baseSubject)
                             return [2 /*return*/, Promise.reject('Subject must be given')];
                         if (this.connection)
-                            return [2 /*return*/, Promise.resolve(this.connection)];
+                            return [2 /*return*/, Promise.resolve()];
                         _a.label = 1;
                     case 1:
                         _a.trys.push([1, 3, , 4]);
                         return [4 /*yield*/, connect(this.connectionOptions)
                                 .then(function (connection) {
                                 _this.connection = connection;
-                                return _this.connection;
+                                return Promise.resolve();
                             })
                                 .catch(function (error) { return Promise.reject("Failed to connect to ".concat(_this.connectionOptions.servers, " with ").concat(error)); })];
                     case 2: return [2 /*return*/, _a.sent()];

package/lib/DTOs.d.ts

@@ -442,20 +442,11 @@ export declare class Resource implements IResource {
 export interface IResource {
     source?: string | undefined;
 }
-export declare class TestPlanRequest implements ITestPlanRequest {
-    properties?: string[] | null | undefined;
-    subject?: string | undefined;
-}
-export interface ITestPlanRequest {
-    properties?: string[] | null | undefined;
-    subject?: string | undefined;
-}
 export declare class FileDescriptor implements IFileDescriptor {
     numberOfChunks: number;
     fileSize: number;
     chunkSize: number;
-    private readonly defaultChunkSize;
-    constructor(fileSize: number, chunkSize?: number);
+    constructor(fileSize: number, chunkSize: number);
     init(_data?: any): void;
     static fromJS(data: any): FileDescriptor;
     toJSON(data?: any): any;

package/lib/DTOs.js

@@ -1303,21 +1303,14 @@ var Resource = /** @class */ (function () {
     return Resource;
 }());
 export { Resource };
-var TestPlanRequest = /** @class */ (function () {
-    function TestPlanRequest() {
-    }
-    return TestPlanRequest;
-}());
-export { TestPlanRequest };
 var FileDescriptor = /** @class */ (function () {
     function FileDescriptor(fileSize, chunkSize) {
         var _a;
-        this.defaultChunkSize = 512000;
         if (chunkSize === 0) {
             throw Error('chunkSize cannot set to 0');
         }
         this.fileSize = fileSize;
-        this.chunkSize = chunkSize !== null && chunkSize !== void 0 ? chunkSize : this.defaultChunkSize;
+        this.chunkSize = chunkSize;
         this.numberOfChunks = Math.floor((((_a = this.fileSize) !== null && _a !== void 0 ? _a : 0) + this.chunkSize - 1) / this.chunkSize);
     }
     FileDescriptor.prototype.init = function (_data) {
@@ -1329,7 +1322,7 @@ var FileDescriptor = /** @class */ (function () {
     };
     FileDescriptor.fromJS = function (data) {
         data = typeof data === 'object' ? data : {};
-        var result = new FileDescriptor(0);
+        var result = new FileDescriptor(0, 512000);
         result.init(data);
         return result;
     };

package/lib/SessionClient.js

@@ -27,7 +27,6 @@ var __assign = (this && this.__assign) || function () {
 import { BreakPoints, CommonContext, CommonSettings, DataGridControl, Image, Interaction, ListItemType, LogList, Result, RunStatus, SessionEvent, Setting, TestPlan, TestRun, TestStepType, TestStepValidationError, WatchDog, } from './DTOs';
 import { JSONCodec } from 'nats.ws';
 import { BaseClient } from './BaseClient';
-import { v4 as uuidv4 } from 'uuid';
 var SessionClient = /** @class */ (function (_super) {
     __extends(SessionClient, _super);
     function SessionClient(baseSubject, options) {
@@ -198,7 +197,7 @@ var SessionClient = /** @class */ (function (_super) {
      * @return Test plan loaded. List of load errors is returned.
      */
     SessionClient.prototype.setTestPlanXML = function (xml) {
-        return this.sendChunked('SetTestPlanXML', xml).then(this.success()).catch(this.error());
+        return this.request('SetTestPlanXML', xml).then(this.success()).catch(this.error());
     };
     /**
      * Retrieve loaded test plan XML
@@ -206,8 +205,7 @@ var SessionClient = /** @class */ (function (_super) {
      */
     SessionClient.prototype.getTestPlanXML = function () {
         // Generate a unique subject where the Runner will publish the chunks
-        var replySubject = "_INBOX.".concat(uuidv4());
-        return this.requestChunked('GetTestPlanXML', replySubject, replySubject).then(this.success()).catch(this.error());
+        return this.request('GetTestPlanXML').then(this.success()).catch(this.error());
     };
     /**
      * Downloads the resource from the runner and returns it as raw bytes
@@ -219,11 +217,8 @@ var SessionClient = /** @class */ (function (_super) {
         if (!((_a = resource.source) === null || _a === void 0 ? void 0 : _a.startsWith(runnerResourcePrefix))) {
             return Promise.reject('The source of the provided resource is not a nats subject.');
         }
-        var replySubject = "_INBOX.".concat(uuidv4());
         var subject = resource.source.slice(runnerResourcePrefix.length);
-        return this.requestChunked(subject, replySubject, replySubject, undefined, true, true)
-            .then(this.success())
-            .catch(this.error());
+        return this.request(subject, undefined, undefined, true, true).then(this.success()).catch(this.error());
     };
     /**
      * Load test plan using a test plan TapPackage from a repository
@@ -246,8 +241,7 @@ var SessionClient = /** @class */ (function (_super) {
      * @return Test plan resources opened.
      */
     SessionClient.prototype.resourcesOpen = function () {
-        var replySubject = "_INBOX.".concat(uuidv4());
-        return this.requestChunked('ResourcesOpen', replySubject, replySubject)
+        return this.request('ResourcesOpen')
             .then(function (testPlanJs) { return TestPlan.fromJS(testPlanJs); })
             .then(this.success())
             .catch(this.error());
@@ -257,8 +251,7 @@ var SessionClient = /** @class */ (function (_super) {
      * @return Test plan resources closed.
      */
     SessionClient.prototype.resourcesClose = function () {
-        var replySubject = "_INBOX.".concat(uuidv4());
-        return this.requestChunked('ResourcesClose', replySubject, replySubject)
+        return this.request('ResourcesClose')
             .then(function (testPlanJs) { return TestPlan.fromJS(testPlanJs); })
             .then(this.success())
             .catch(this.error());
@@ -293,12 +286,7 @@ var SessionClient = /** @class */ (function (_super) {
      * @return Test plan retrieved
      */
     SessionClient.prototype.getTestPlan = function (properties) {
-        var replySubject = "_INBOX.".concat(uuidv4());
-        var payload = {
-            subject: replySubject,
-            properties: properties,
-        };
-        return this.requestChunked('GetTestPlan', replySubject, payload)
+        return this.request('GetTestPlan', properties)
             .then(function (testPlanJs) { return TestPlan.fromJS(testPlanJs); })
             .then(this.success())
             .catch(this.error());
@@ -309,7 +297,7 @@ var SessionClient = /** @class */ (function (_super) {
      * @return Test plan changed
      */
     SessionClient.prototype.setTestPlan = function (plan) {
-        return this.sendChunked('SetTestPlan', plan)
+        return this.request('SetTestPlan', plan)
             .then(function (testPlanJs) { return TestPlan.fromJS(testPlanJs); })
             .then(this.success())
             .catch(this.error());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentap/runner-client",
-  "version": "2.3.0-alpha.1.1",
+  "version": "2.3.0",
   "description": "This is the web client for the OpenTAP Runner.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -41,11 +41,12 @@
   },
   "dependencies": {
     "nats.ws": "^1.9.0",
-    "uuid": "^9.0.0"
+    "uuid": "^9.0.0",
+    "events": "^3.3.0"
   },
   "lint-staged": {
     "*.{ts,js,html}": [
       "npm run lint --fix"
     ]
   }
-}
+}