@opentap/runner-client 2.2.3 → 2.2.4-alpha.1.2

package/lib/BaseClient.d.ts

@@ -31,7 +31,7 @@ export declare class BaseClient {
      * 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): Promise<T>;
     /**
      * Handle the error
      * @param error
@@ -52,21 +52,32 @@ 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
+     * Make a request to the runner with a chunked payload. The response will be received in chunks.
+     * @param subject The request subject.
+     * @param payload The request body which will be chunked
+     * @param options Optional request options
+     * @param rawResponse If true, the response will not be decoded
+     * @returns
      */
-    protected sendChunked<T>(subject: string, payload?: any, options?: RequestOptions): Promise<T>;
+    protected sendChunked<T>(subject: string, payload: any, options?: RequestOptions, rawResponse?: boolean): 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
+     */
+    private downloadChunkedRequest;
+    /**
+     * Make a request to the runner whose response will be sent in chunked
+     * @param subject The request subject
+     * @param payload Optional request body
+     * @param options Optional request options
+     * @param rawResponse If true, the return value will not be decoded
+     * @param fullSubject If true, the base subject will not be prepended
+     * @returns
      */
-    protected requestChunked<T>(subject: string, replySubject: string, payload: any, options?: RequestOptions, isFullSubject?: boolean, rawResponse?: boolean): Promise<T>;
+    protected requestChunked<T>(subject: string, payload?: any, options?: RequestOptions, rawResponse?: boolean, fullSubject?: boolean): Promise<T>;
     /**
      * Check if the the response is an error from the server.
      * @param {any} response

package/lib/BaseClient.js

@@ -45,15 +45,6 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
-var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
-    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-        if (ar || !(i in from)) {
-            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-            ar[i] = from[i];
-        }
-    }
-    return to.concat(ar || Array.prototype.slice.call(from));
-};
 import { ComponentSettingsBase, ComponentSettingsIdentifier, ComponentSettingsListItem, DataGridControl, ErrorResponse, FileDescriptor, ListItemType, ProfileGroup, } from './DTOs';
 import { Empty, ErrorCode, JSONCodec, StringCodec, connect, headers, } from 'nats.ws';
 import { EventEmitter } from 'events';
@@ -116,14 +107,14 @@ var BaseClient = /** @class */ (function () {
      * 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) {
         return __awaiter(this, void 0, void 0, function () {
             var stringCodec, data, headers, timeout, opts;
             var _this = this;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        subject = isFullSubject ? subject : "".concat(this.baseSubject, ".Request.").concat(subject);
+                        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())
@@ -198,16 +189,16 @@ 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
+     * Make a request to the runner with a chunked payload. The response will be received in chunks.
+     * @param subject The request subject.
+     * @param payload The request body which will be chunked
+     * @param options Optional request options
+     * @param rawResponse If true, the response will not be decoded
+     * @returns
      */
-    BaseClient.prototype.sendChunked = function (subject, payload, options) {
+    BaseClient.prototype.sendChunked = function (subject, payload, options, rawResponse) {
         return __awaiter(this, void 0, void 0, function () {
-            var stringCodec, data, headers, opts, fileDescriptor, getChunk, dataSubject, i;
-            var _this = this;
+            var stringCodec, data, headers, opts, fileDescriptor, requestResponse, jsonCodec, response, error, getChunk, dataSubject, i;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -215,126 +206,164 @@ var BaseClient = /** @class */ (function () {
                             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!"))];
+                        subject = "".concat(this.baseSubject, ".Request.").concat(subject);
                         stringCodec = StringCodec();
-                        data = payload ? stringCodec.encode(JSON.stringify(payload)) : Empty;
+                        if (payload) {
+                            data = payload instanceof Uint8Array ? payload : stringCodec.encode(JSON.stringify(payload));
+                        }
+                        else {
+                            data = 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!"))];
+                        return [4 /*yield*/, this.connection.request(subject, stringCodec.encode(JSON.stringify(fileDescriptor)), opts)];
+                    case 1:
+                        requestResponse = _a.sent();
+                        if (requestResponse.data.length > 0) {
+                            jsonCodec = JSONCodec();
+                            response = jsonCodec.decode(requestResponse.data);
+                            if (this.isErrorResponse(response)) {
+                                error = ErrorResponse.fromJS(response);
+                                this.eventEmitter.emit(Events.ERROR, error);
+                                return [2 /*return*/, Promise.reject(error)];
+                            }
+                        }
+                        // This should never happen. If it does happen, it likely means we are targetting an incompatible Runner version.
+                        if (!requestResponse.reply) {
+                            return [2 /*return*/, Promise.reject('Send chunks: Runner did not return a reply subject.')];
+                        }
                         getChunk = function (chunk) {
                             var offset = chunk * fileDescriptor.chunkSize;
                             return data.slice(offset, offset + fileDescriptor.chunkSize);
                         };
-                        return [4 /*yield*/, this.request(subject, fileDescriptor, opts)];
+                        dataSubject = requestResponse.reply;
+                        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 runner must acknowledge that it has received each chunk.
+                        // Likewise, we must wait for the runner to acknowledge each chunk
+                        // before sending the next one, because the acknowledge from the runner
+                        // contains the subject where we should send the next chunk.
+                        requestResponse = _a.sent();
+                        dataSubject = requestResponse.reply;
+                        _a.label = 4;
+                    case 4:
+                        i++;
+                        return [3 /*break*/, 2];
+                    case 5: 
+                    // The response to any chunked request is itself a chunked response.
+                    // The last acknowledge from the runner indicates the subject where the response can be downloaded from.
+                    return [2 /*return*/, this.downloadChunkedRequest(requestResponse, rawResponse, opts)];
+                }
+            });
+        });
+    };
+    /**
+     * 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.downloadChunkedRequest = function (requestResponse, rawResponse, opts) {
+        return __awaiter(this, void 0, void 0, function () {
+            var jsonCodec, responseBody, error, fileDescriptor, dataSubject, result, bytesReceived, i, j, resultCodec;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!this.connection)
+                            return [2 /*return*/, Promise.reject('Chunking: Connection is down! Please try again!')];
+                        if (this.connection.isClosed())
+                            return [2 /*return*/, Promise.reject("Chunking: Connection has been closed! Please reconnect!")];
+                        jsonCodec = JSONCodec();
+                        responseBody = jsonCodec.decode(requestResponse.data);
+                        if (this.isErrorResponse(responseBody)) {
+                            error = ErrorResponse.fromJS(responseBody);
+                            this.eventEmitter.emit(Events.ERROR, error);
+                            return [2 /*return*/, Promise.reject(error)];
+                        }
+                        fileDescriptor = FileDescriptor.fromJS(responseBody);
+                        if (!requestResponse.reply || !fileDescriptor || fileDescriptor.numberOfChunks === 0) {
+                            return [2 /*return*/, Promise.reject('Chunking: Response payload does not indicate a chunked response.')];
+                        }
+                        dataSubject = requestResponse.reply;
+                        result = new Uint8Array(fileDescriptor.fileSize);
+                        bytesReceived = 0;
+                        i = 0;
+                        _a.label = 1;
                     case 1:
-                        dataSubject = _a.sent();
-                        for (i = 0; i < fileDescriptor.numberOfChunks; i++) {
-                            this.connection.publish(dataSubject, getChunk(i), opts);
+                        if (!(i < fileDescriptor.numberOfChunks)) return [3 /*break*/, 4];
+                        return [4 /*yield*/, this.connection.request(dataSubject, Empty, opts)];
+                    case 2:
+                        // Send a request with an empty payload to acknowledge that we received the previous chunk
+                        // The response body contains the current chunk.
+                        // The reply subject of the response indicates where we can get the next chunk
+                        requestResponse = _a.sent();
+                        dataSubject = requestResponse.reply;
+                        for (j = 0; j < requestResponse.data.length; j++) {
+                            result[bytesReceived++] = requestResponse.data[j];
                         }
-                        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);
-                            })];
+                        _a.label = 3;
+                    case 3:
+                        i++;
+                        return [3 /*break*/, 1];
+                    case 4:
+                        // Send an empty message to acknowledge that the final chunk was received
+                        this.connection.publish(dataSubject, Empty);
+                        if (bytesReceived !== fileDescriptor.fileSize) {
+                            return [2 /*return*/, Promise.reject("Unexpected repsonse size. Got ".concat(bytesReceived, " bytes, but expected ").concat(fileDescriptor.fileSize, "."))];
+                        }
+                        // 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)];
                 }
             });
         });
     };
     /**
-     * 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
+     * Make a request to the runner whose response will be sent in chunked
+     * @param subject The request subject
+     * @param payload Optional request body
+     * @param options Optional request options
+     * @param rawResponse If true, the return value will not be decoded
+     * @param fullSubject If true, the base subject will not be prepended
+     * @returns
      */
-    BaseClient.prototype.requestChunked = function (subject, replySubject, payload, options, isFullSubject, rawResponse) {
+    BaseClient.prototype.requestChunked = function (subject, payload, options, rawResponse, fullSubject) {
         return __awaiter(this, void 0, void 0, function () {
-            var fileSize;
-            var _this = this;
+            var data, stringCodec, headers, opts, requestResponse;
             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);
+                switch (_a.label) {
+                    case 0:
+                        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!"))];
+                        if (!fullSubject) {
+                            subject = "".concat(this.baseSubject, ".Request.").concat(subject);
+                        }
+                        if (payload instanceof Uint8Array) {
+                            data = payload;
                         }
-                        return Promise.resolve(response);
-                    })];
+                        else {
+                            stringCodec = StringCodec();
+                            data = payload ? stringCodec.encode(JSON.stringify(payload)) : Empty;
+                        }
+                        headers = this.buildHeaders();
+                        opts = __assign(__assign({}, options), { timeout: this.timeout, headers: headers });
+                        return [4 /*yield*/, this.connection.request(subject, data, opts)];
+                    case 1:
+                        requestResponse = _a.sent();
+                        return [2 /*return*/, this.downloadChunkedRequest(requestResponse, rawResponse, opts)];
+                }
             });
         });
     };

package/lib/DTOs.d.ts

@@ -442,14 +442,6 @@ 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;

package/lib/DTOs.js

@@ -1303,12 +1303,6 @@ 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;

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) {
@@ -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.requestChunked('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.requestChunked(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.requestChunked('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.requestChunked('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.requestChunked('GetTestPlan', properties)
             .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.2.3",
+  "version": "2.2.4-alpha.1.2",
   "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"
     ]
   }
-}
+}