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

package/lib/BaseClient.d.ts

@@ -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): Promise<T>;
+    protected request<T>(subject: string, payload?: any, options?: RequestOptions, rawResponse?: boolean, fullSubject?: boolean): Promise<T>;
     /**
      * Handle the error
      * @param error
@@ -51,15 +50,6 @@ export declare class BaseClient {
      * @returns Subscription object
      */
     protected subscribe(subject: string, options: SubscriptionOptions): Subscription;
-    /**
-     * 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, rawResponse?: boolean): Promise<T>;
     /**
      * 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
@@ -68,16 +58,7 @@ export declare class BaseClient {
      * @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, payload?: any, options?: RequestOptions, rawResponse?: boolean, fullSubject?: boolean): Promise<T>;
+    protected encode(payload: any): Uint8Array;
     /**
      * Check if the the response is an error from the server.
      * @param {any} response

package/lib/BaseClient.js

@@ -45,6 +45,15 @@ 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';
@@ -57,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;
@@ -103,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) {
+    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 = "".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];
                 }
             });
         });
@@ -188,82 +219,6 @@ var BaseClient = /** @class */ (function () {
         var natsSubject = "".concat(this.baseSubject, ".").concat(subject);
         return this.connection.subscribe(natsSubject, options);
     };
-    /**
-     * 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, rawResponse) {
-        return __awaiter(this, void 0, void 0, function () {
-            var stringCodec, data, headers, opts, fileDescriptor, requestResponse, jsonCodec, response, error, getChunk, dataSubject, i;
-            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!"))];
-                        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();
-                        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);
-                        };
-                        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
@@ -273,7 +228,7 @@ var BaseClient = /** @class */ (function () {
      */
     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;
+            var result, resultCodec;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -281,91 +236,41 @@ var BaseClient = /** @class */ (function () {
                             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;
+                        result = new Uint8Array([]);
                         _a.label = 1;
                     case 1:
-                        if (!(i < fileDescriptor.numberOfChunks)) return [3 /*break*/, 4];
-                        return [4 /*yield*/, this.connection.request(dataSubject, Empty, 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:
-                        // 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];
-                        }
                         _a.label = 3;
-                    case 3:
-                        i++;
-                        return [3 /*break*/, 1];
+                    case 3: 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, "."))];
+                        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)];
                         }
-                        // 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*/];
                 }
             });
         });
     };
-    /**
-     * 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, payload, options, rawResponse, fullSubject) {
-        return __awaiter(this, void 0, void 0, function () {
-            var data, stringCodec, headers, opts, requestResponse;
-            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!"))];
-                        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;
-                        }
-                        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)];
-                }
-            });
-        });
+    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.

package/lib/DTOs.d.ts

@@ -446,8 +446,7 @@ 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

@@ -1306,12 +1306,11 @@ export { Resource };
 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) {
@@ -1323,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

@@ -197,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
@@ -205,7 +205,7 @@ var SessionClient = /** @class */ (function (_super) {
      */
     SessionClient.prototype.getTestPlanXML = function () {
         // Generate a unique subject where the Runner will publish the chunks
-        return this.requestChunked('GetTestPlanXML').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
@@ -218,7 +218,7 @@ var SessionClient = /** @class */ (function (_super) {
             return Promise.reject('The source of the provided resource is not a nats subject.');
         }
         var subject = resource.source.slice(runnerResourcePrefix.length);
-        return this.requestChunked(subject, undefined, 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
@@ -241,7 +241,7 @@ var SessionClient = /** @class */ (function (_super) {
      * @return Test plan resources opened.
      */
     SessionClient.prototype.resourcesOpen = function () {
-        return this.requestChunked('ResourcesOpen')
+        return this.request('ResourcesOpen')
             .then(function (testPlanJs) { return TestPlan.fromJS(testPlanJs); })
             .then(this.success())
             .catch(this.error());
@@ -251,7 +251,7 @@ var SessionClient = /** @class */ (function (_super) {
      * @return Test plan resources closed.
      */
     SessionClient.prototype.resourcesClose = function () {
-        return this.requestChunked('ResourcesClose')
+        return this.request('ResourcesClose')
             .then(function (testPlanJs) { return TestPlan.fromJS(testPlanJs); })
             .then(this.success())
             .catch(this.error());
@@ -286,7 +286,7 @@ var SessionClient = /** @class */ (function (_super) {
      * @return Test plan retrieved
      */
     SessionClient.prototype.getTestPlan = function (properties) {
-        return this.requestChunked('GetTestPlan', properties)
+        return this.request('GetTestPlan', properties)
             .then(function (testPlanJs) { return TestPlan.fromJS(testPlanJs); })
             .then(this.success())
             .catch(this.error());
@@ -297,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.2.4",
+  "version": "2.3.0-alpha.1.2",
   "description": "This is the web client for the OpenTAP Runner.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",