@opentap/runner-client 2.0.0-alpha.2.9 → 2.0.0

package/lib/BaseClient.d.ts

@@ -26,9 +26,11 @@ 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): Promise<T>;
+    protected request<T>(subject: string, payload?: any, options?: RequestOptions, isFullSubject?: boolean): Promise<T>;
     /**
      * Handle the error
      * @param error
@@ -49,7 +51,7 @@ export declare class BaseClient {
      */
     protected subscribe(subject: string, options: SubscriptionOptions): Subscription;
     /**
-     * Send a request to the nats server.
+     * Send an object to the nats server with chunks.
      * @param subject The subject to request
      * @param payload (optional)
      * @param options (optional)
@@ -57,13 +59,13 @@ export declare class BaseClient {
      */
     protected sendChunked<T>(subject: string, payload?: any, options?: RequestOptions): Promise<T>;
     /**
-     * Send a request to the nats server.
+     * 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
      */
-    protected requestChunked<T>(subject: string, options?: RequestOptions): Promise<T>;
+    protected requestChunked<T>(subject: string, replySubject: string, payload: any, options?: RequestOptions, isFullSubject?: boolean): Promise<T>;
     /**
      * Check if the the response is an error from the server.
      * @param {any} response

package/lib/BaseClient.js

@@ -56,7 +56,6 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
 };
 import { ComponentSettingsBase, ComponentSettingsIdentifier, ComponentSettingsListItem, DataGridControl, ErrorResponse, FileDescriptor, ListItemType, ProfileGroup, } from './DTOs';
 import { Empty, ErrorCode, JSONCodec, StringCodec, connect, headers, } from 'nats.ws';
-import { v4 as uuidv4 } from 'uuid';
 var DEFAULT_TIMEOUT = 6000;
 var BaseClient = /** @class */ (function () {
     function BaseClient(baseSubject, options) {
@@ -107,16 +106,18 @@ 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) {
+    BaseClient.prototype.request = function (subject, payload, options, isFullSubject) {
         return __awaiter(this, void 0, void 0, function () {
             var stringCodec, data, headers, opts;
             var _this = this;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        subject = "".concat(this.baseSubject, ".Request.").concat(subject);
+                        subject = isFullSubject ? 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())
@@ -189,7 +190,7 @@ var BaseClient = /** @class */ (function () {
         return this.connection.subscribe(natsSubject, options);
     };
     /**
-     * Send a request to the nats server.
+     * Send an object to the nats server with chunks.
      * @param subject The subject to request
      * @param payload (optional)
      * @param options (optional)
@@ -197,88 +198,54 @@ var BaseClient = /** @class */ (function () {
      */
     BaseClient.prototype.sendChunked = function (subject, payload, options) {
         return __awaiter(this, void 0, void 0, function () {
-            var requestSubject, stringCodec, data, headers, opts, fileDescriptor, getChunk, message, i, response, jsonCodec;
+            var stringCodec, data, headers, opts, fileDescriptor, getChunk, dataSubject, i;
+            var _this = this;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        requestSubject = "".concat(this.baseSubject, ".Request.").concat(subject);
                         if (!this.connection)
-                            return [2 /*return*/, Promise.reject("".concat(requestSubject, ": Connection is down! Please try again!"))];
+                            return [2 /*return*/, Promise.reject("".concat(subject, ": Connection is down! Please try again!"))];
                         if (this.connection.isClosed())
-                            return [2 /*return*/, Promise.reject("".concat(requestSubject, ": Connection has been closed! Please reconnect!"))];
+                            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(requestSubject, ": File is empty!"))];
+                            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);
                         };
-                        this.request(subject, fileDescriptor);
-                        i = 0;
-                        _a.label = 1;
+                        return [4 /*yield*/, this.request(subject, fileDescriptor, opts)];
                     case 1:
-                        if (!(i < fileDescriptor.numberOfChunks)) return [3 /*break*/, 4];
-                        return [4 /*yield*/, this.connection.request(requestSubject, getChunk(i), opts)];
-                    case 2:
-                        message = _a.sent();
-                        _a.label = 3;
-                    case 3:
-                        i++;
-                        return [3 /*break*/, 1];
-                    case 4:
-                        if (message && message.data.length !== 0) {
-                            jsonCodec = JSONCodec();
-                            response = jsonCodec.decode(message.data);
+                        dataSubject = _a.sent();
+                        for (i = 0; i < fileDescriptor.numberOfChunks; i++) {
+                            this.connection.publish(dataSubject, getChunk(i), opts);
                         }
-                        return [2 /*return*/, this.isErrorResponse(response) ? Promise.reject(ErrorResponse.fromJS(response)) : Promise.resolve(response)];
-                }
-            });
-        });
-    };
-    /**
-     * Send a request to the nats server.
-     * @param subject The subject to request
-     * @param payload (optional)
-     * @param options (optional)
-     * @returns Promise of an object
-     */
-    BaseClient.prototype.requestChunked = function (subject, options) {
-        return __awaiter(this, void 0, void 0, function () {
-            var replySubject, requestSubject, stringCodec, data, headers, opts, fileDescriptor;
-            var _this = this;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        replySubject = "_INBOX.".concat(uuidv4());
-                        requestSubject = "".concat(this.baseSubject, ".Request.").concat(subject);
-                        if (!this.connection)
-                            return [2 /*return*/, Promise.reject("".concat(requestSubject, ": Connection is down! Please try again!"))];
-                        if (this.connection.isClosed())
-                            return [2 /*return*/, Promise.reject("".concat(requestSubject, ": Connection has been closed! Please reconnect!"))];
-                        stringCodec = StringCodec();
-                        data = stringCodec.encode(JSON.stringify(replySubject));
-                        headers = this.buildHeaders();
-                        opts = __assign(__assign({}, options), { timeout: this.timeout, headers: headers });
-                        return [4 /*yield*/, this.request(subject, data, opts)];
-                    case 1:
-                        fileDescriptor = _a.sent();
-                        // eslint-disable-next-line @typescript-eslint/no-unused-vars
                         return [2 /*return*/, new Promise(function (resolve, reject) {
+                                if (!_this.connection) {
+                                    return Promise.reject('No nats connection.');
+                                }
                                 var combinedResult = new Uint8Array([]);
-                                var received = 0;
-                                var subscription = _this.connection.subscribe(replySubject);
+                                // 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));
-                                    received++;
-                                    message.respond(Empty);
-                                    if (received === fileDescriptor.numberOfChunks) {
+                                    if ((message === null || message === void 0 ? void 0 : message.data.length) === 0) {
                                         resolve(combinedResult);
                                     }
                                 };
@@ -291,6 +258,63 @@ var BaseClient = /** @class */ (function () {
             });
         });
     };
+    /**
+     * 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) {
+        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) {
+                        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, "."));
+                        var jsonCodec = JSONCodec();
+                        var response = jsonCodec.decode(byteArray);
+                        return _this.isErrorResponse(response) ? Promise.reject(ErrorResponse.fromJS(response)) : Promise.resolve(response);
+                    })];
+            });
+        });
+    };
     /**
      * Check if the the response is an error from the server.
      * @param {any} response

package/lib/DTOs.d.ts

@@ -418,29 +418,13 @@ export declare class PasswordControl extends Setting implements IPasswordControl
 export interface IPasswordControl extends ISetting {
     password?: string | undefined;
 }
-export declare class PictureControl extends Setting implements IPictureControl {
-    description?: string | undefined;
-    mimeType?: string | undefined;
-    resource?: Resource | undefined;
-    constructor(data?: IPictureControl);
-    init(_data?: any): void;
-    static fromJS(data: any): PictureControl;
-    toJSON(data?: any): any;
-}
-export interface IPictureControl extends ISetting {
-    description?: string | undefined;
-    mimeType?: string | undefined;
-    resource?: Resource | undefined;
-}
-export declare class Resource implements IResource {
-    source?: string | undefined;
-    constructor(data?: IResource);
-    init(_data?: any): void;
-    static fromJS(data: any): Resource;
-    toJSON(data?: any): any;
+export declare class TestPlanRequest implements ITestPlanRequest {
+    properties?: string[] | null | undefined;
+    subject?: string | undefined;
 }
-export interface IResource {
-    source?: string | undefined;
+export interface ITestPlanRequest {
+    properties?: string[] | null | undefined;
+    subject?: string | undefined;
 }
 export declare class FileDescriptor implements IFileDescriptor {
     numberOfChunks: number;
@@ -449,7 +433,7 @@ export declare class FileDescriptor implements IFileDescriptor {
     private readonly defaultChunkSize;
     constructor(fileSize: number, chunkSize?: number);
     init(_data?: any): void;
-    static fromJS(data: any): Resource;
+    static fromJS(data: any): FileDescriptor;
     toJSON(data?: any): any;
 }
 export interface IFileDescriptor {

package/lib/DTOs.js

@@ -1238,66 +1238,12 @@ var PasswordControl = /** @class */ (function (_super) {
     return PasswordControl;
 }(Setting));
 export { PasswordControl };
-var PictureControl = /** @class */ (function (_super) {
-    __extends(PictureControl, _super);
-    function PictureControl(data) {
-        var _this = _super.call(this, data) || this;
-        _this._discriminator = 'PictureControl';
-        return _this;
-    }
-    PictureControl.prototype.init = function (_data) {
-        _super.prototype.init.call(this, _data);
-        if (_data) {
-            this.description = _data['Description'];
-            this.mimeType = _data['MimeType'];
-            this.resource = _data['Resource'] ? Resource.fromJS(_data['Resource']) : undefined;
-        }
-    };
-    PictureControl.fromJS = function (data) {
-        data = typeof data === 'object' ? data : {};
-        var result = new PictureControl();
-        result.init(data);
-        return result;
-    };
-    PictureControl.prototype.toJSON = function (data) {
-        data = typeof data === 'object' ? data : {};
-        data['Description'] = this.description;
-        data['MimeType'] = this.mimeType;
-        data['Resource'] = this.resource ? this.resource.toJSON() : undefined;
-        _super.prototype.toJSON.call(this, data);
-        return data;
-    };
-    return PictureControl;
-}(Setting));
-export { PictureControl };
-var Resource = /** @class */ (function () {
-    function Resource(data) {
-        if (data) {
-            for (var property in data) {
-                if (Object.prototype.hasOwnProperty.call(data, property))
-                    this[property] = data[property];
-            }
-        }
+var TestPlanRequest = /** @class */ (function () {
+    function TestPlanRequest() {
     }
-    Resource.prototype.init = function (_data) {
-        if (_data) {
-            this.source = _data['Source'];
-        }
-    };
-    Resource.fromJS = function (data) {
-        data = typeof data === 'object' ? data : {};
-        var result = new Resource();
-        result.init(data);
-        return result;
-    };
-    Resource.prototype.toJSON = function (data) {
-        data = typeof data === 'object' ? data : {};
-        data['Source'] = this.source;
-        return data;
-    };
-    return Resource;
+    return TestPlanRequest;
 }());
-export { Resource };
+export { TestPlanRequest };
 var FileDescriptor = /** @class */ (function () {
     function FileDescriptor(fileSize, chunkSize) {
         var _a;
@@ -1318,7 +1264,7 @@ var FileDescriptor = /** @class */ (function () {
     };
     FileDescriptor.fromJS = function (data) {
         data = typeof data === 'object' ? data : {};
-        var result = new Resource();
+        var result = new FileDescriptor(0);
         result.init(data);
         return result;
     };

package/lib/SessionClient.d.ts

@@ -1,4 +1,4 @@
-import { BreakPoints, CommonContext, CommonSettings, DataGridControl, Image, Interaction, ListItemType, LogList, Parameter, RepositoryPackageDefinition, RepositoryPackageReference, Resource, Result, RunStatus, SessionEvent, Setting, TestPlan, TestRun, TestStepType, TestStepValidationError, WatchDog } from './DTOs';
+import { BreakPoints, CommonContext, CommonSettings, DataGridControl, Image, Interaction, ListItemType, LogList, Parameter, RepositoryPackageDefinition, RepositoryPackageReference, Result, RunStatus, SessionEvent, Setting, TestPlan, TestRun, TestStepType, TestStepValidationError, WatchDog } from './DTOs';
 import { ConnectionOptions, NatsError, Subscription, SubscriptionOptions } from 'nats.ws';
 import { BaseClient } from './BaseClient';
 export declare class SessionClient extends BaseClient {
@@ -86,11 +86,6 @@ export declare class SessionClient extends BaseClient {
      * @return Test plan retrieved
      */
     getTestPlanXML(): Promise<string>;
-    /**
-     * Retrieve loaded test plan XML
-     * @return Test plan retrieved
-     */
-    downloadResource(resource: Resource): Promise<Uint8Array>;
     /**
      * Load test plan using a test plan TapPackage from a repository
      * @param {RepositoryPackageDefinition} packageReference

package/lib/SessionClient.js

@@ -27,6 +27,7 @@ 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) {
@@ -204,20 +205,9 @@ var SessionClient = /** @class */ (function (_super) {
      * @return Test plan retrieved
      */
     SessionClient.prototype.getTestPlanXML = function () {
-        return this.requestChunked('GetTestPlanXML').then(this.success()).catch(this.error());
-    };
-    /**
-     * Retrieve loaded test plan XML
-     * @return Test plan retrieved
-     */
-    SessionClient.prototype.downloadResource = function (resource) {
-        var _a;
-        var runnerResourcePrefix = 'subject://';
-        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 subject = resource.source.replace(runnerResourcePrefix, '');
-        return this.requestChunked(subject).then(this.success()).catch(this.error());
+        // 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());
     };
     /**
      * Load test plan using a test plan TapPackage from a repository
@@ -240,7 +230,8 @@ var SessionClient = /** @class */ (function (_super) {
      * @return Test plan resources opened.
      */
     SessionClient.prototype.resourcesOpen = function () {
-        return this.request('ResourcesOpen')
+        var replySubject = "_INBOX.".concat(uuidv4());
+        return this.requestChunked('ResourcesOpen', replySubject, replySubject)
             .then(function (testPlanJs) { return TestPlan.fromJS(testPlanJs); })
             .then(this.success())
             .catch(this.error());
@@ -250,7 +241,8 @@ var SessionClient = /** @class */ (function (_super) {
      * @return Test plan resources closed.
      */
     SessionClient.prototype.resourcesClose = function () {
-        return this.request('ResourcesClose')
+        var replySubject = "_INBOX.".concat(uuidv4());
+        return this.requestChunked('ResourcesClose', replySubject, replySubject)
             .then(function (testPlanJs) { return TestPlan.fromJS(testPlanJs); })
             .then(this.success())
             .catch(this.error());
@@ -285,7 +277,12 @@ var SessionClient = /** @class */ (function (_super) {
      * @return Test plan retrieved
      */
     SessionClient.prototype.getTestPlan = function (properties) {
-        return this.request('GetTestPlan', properties)
+        var replySubject = "_INBOX.".concat(uuidv4());
+        var payload = {
+            subject: replySubject,
+            properties: properties,
+        };
+        return this.requestChunked('GetTestPlan', replySubject, payload)
             .then(function (testPlanJs) { return TestPlan.fromJS(testPlanJs); })
             .then(this.success())
             .catch(this.error());
@@ -296,7 +293,7 @@ var SessionClient = /** @class */ (function (_super) {
      * @return Test plan changed
      */
     SessionClient.prototype.setTestPlan = function (plan) {
-        return this.request('SetTestPlan', plan)
+        return this.sendChunked('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.0.0-alpha.2.9",
+  "version": "2.0.0",
   "description": "This is the web client for the OpenTAP Runner.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",