@opentap/runner-client 2.0.0-alpha.2.17 → 2.0.0-alpha.2.19

package/lib/BaseClient.d.ts

@@ -65,7 +65,7 @@ export declare class BaseClient {
      * @param options (optional)
      * @returns Promise of an object
      */
-    protected requestChunked<T>(subject: string, options?: RequestOptions, isFullSubject?: boolean): 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) {
@@ -199,7 +198,8 @@ var BaseClient = /** @class */ (function () {
      */
     BaseClient.prototype.sendChunked = function (subject, payload, options) {
         return __awaiter(this, void 0, void 0, function () {
-            var stringCodec, data, headers, opts, fileDescriptor, getChunk, dataSubject, 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:
@@ -218,28 +218,36 @@ var BaseClient = /** @class */ (function () {
                             var offset = chunk * fileDescriptor.chunkSize;
                             return data.slice(offset, offset + fileDescriptor.chunkSize);
                         };
-                        return [4 /*yield*/, this.request(subject, fileDescriptor)];
+                        return [4 /*yield*/, this.request(subject, fileDescriptor, opts)];
                     case 1:
                         dataSubject = _a.sent();
-                        i = 0;
-                        _a.label = 2;
-                    case 2:
-                        if (!(i < fileDescriptor.numberOfChunks)) return [3 /*break*/, 5];
-                        return [4 /*yield*/, this.connection.request(dataSubject, getChunk(i), opts)];
-                    case 3:
-                        // The main response will be received after the last chunk is sent, the intermediate ones
-                        // are empty acknowledgement messages
-                        message = _a.sent();
-                        _a.label = 4;
-                    case 4:
-                        i++;
-                        return [3 /*break*/, 2];
-                    case 5:
-                        if (message && message.data.length !== 0) {
-                            jsonCodec = JSONCodec();
-                            response = jsonCodec.decode(message.data);
+                        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)];
+                        return [2 /*return*/, new Promise(function (resolve, reject) {
+                                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) {
+                                    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));
+                                    // We shouldn't resolve after the first message since this is going to be the empty message we just sent
+                                    // We should resolve after the server terminates the message with an empty message
+                                    if (first === false && (message === null || message === void 0 ? void 0 : message.data.length) === 0) {
+                                        resolve(combinedResult);
+                                    }
+                                    first = false;
+                                };
+                            }).then(function (byteArray) {
+                                var jsonCodec = JSONCodec();
+                                var response = jsonCodec.decode(byteArray);
+                                return _this.isErrorResponse(response) ? Promise.reject(ErrorResponse.fromJS(response)) : Promise.resolve(response);
+                            })];
                 }
             });
         });
@@ -251,49 +259,49 @@ var BaseClient = /** @class */ (function () {
      * @param options (optional)
      * @returns Promise of an object
      */
-    BaseClient.prototype.requestChunked = function (subject, options, isFullSubject) {
+    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 numberOfChunks = -1;
-                        var received = 0;
                         var combinedResult = new Uint8Array([]);
-                        // Resolves the promise if the all of the chunks are received
-                        var resolveIfComplete = function () {
-                            if (received === numberOfChunks) {
+                        // 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);
                             }
                         };
-                        // Generate a unique subject where the Runner will publish the chunks
-                        var replySubject = "_INBOX.".concat(uuidv4());
-                        // Subscribe to the subject before starting the process
-                        var subscription = _this.connection.subscribe(replySubject);
                         subscription.callback = function (error, message) {
                             if (error) {
                                 reject(error);
                             }
-                            // Combine each chunk
                             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); // Respond acknowledgement
-                            resolveIfComplete();
+                            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, replySubject, opts, isFullSubject)
+                        return _this.request(subject, payload, opts, isFullSubject)
                             .then(function (fileDescriptor) { return FileDescriptor.fromJS(fileDescriptor); })
                             .then(function (fileDescriptor) {
-                            numberOfChunks = fileDescriptor.numberOfChunks;
-                            // Check if the chunks are already received
-                            resolveIfComplete();
+                            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);

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;

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;

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, undefined, true).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.17",
+  "version": "2.0.0-alpha.2.19",
   "description": "This is the web client for the OpenTAP Runner.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",