@opentap/runner-client 2.3.2-alpha.1.5 → 2.3.2-alpha.1.6

package/lib/BaseClient.d.ts

@@ -1,7 +1,7 @@
 import { ComponentSettingsBase, ComponentSettingsIdentifier, ComponentSettingsListItem, DataGridControl, ErrorResponse, FileParameter, FileResponse, ListItemType, ProfileGroup, RepositoryPackageReference, RepositorySettingsPackageDefinition, SettingsTapPackage } from './DTOs';
 import { ConnectionOptions, Subscription, SubscriptionOptions, PublishOptions } from 'nats.ws';
 interface BaseClientRequestOptions {
-    options?: PublishOptions;
+    publishOptions?: PublishOptions;
     rawResponse?: boolean;
     fullSubject?: boolean;
     timeout?: number;

package/lib/BaseClient.js

@@ -109,10 +109,11 @@ var BaseClient = /** @class */ (function () {
      * @returns Promise of an object
      */
     BaseClient.prototype.request = function (subject, payload, options) {
+        var _a, _b, _c;
         return __awaiter(this, void 0, void 0, function () {
-            var data, headers, replySubject, serverMaxPayload, requestId, opts, fileDescriptor, chunkNumber, subscription, getChunk, jsonCodec, responsePromise, chunk, i;
+            var data, headers, replySubject, chunkSize, requestId, opts, fileDescriptor, chunkNumber, getChunk, subscription, responsePromise, chunk, i;
             var _this = this;
-            return __generator(this, function (_a) {
+            return __generator(this, function (_d) {
                 // Prepend the base subject if the given subject does not start with that
                 if (!(options === null || options === void 0 ? void 0 : options.fullSubject)) {
                     subject = "".concat(this.baseSubject, ".Request.").concat(subject);
@@ -124,20 +125,20 @@ var BaseClient = /** @class */ (function () {
                 data = this.encode(payload);
                 headers = this.buildHeaders();
                 replySubject = crypto.randomUUID();
-                serverMaxPayload = 10;
-                headers.append('ChunkSize', serverMaxPayload.toString());
+                chunkSize = ((_c = (_b = (_a = this.connection) === null || _a === void 0 ? void 0 : _a.info) === null || _b === void 0 ? void 0 : _b.max_payload) !== null && _c !== void 0 ? _c : 512000) - 2000;
+                // The Session and the Client need to agree on the chunk size. Put it in a header.
+                headers.append('ChunkSize', chunkSize.toString());
                 requestId = crypto.randomUUID();
                 headers.append('RequestId', requestId);
-                opts = __assign(__assign({}, options === null || options === void 0 ? void 0 : options.options), { headers: headers, reply: replySubject });
-                fileDescriptor = new FileDescriptor(data.length, serverMaxPayload);
+                opts = __assign(__assign({}, options === null || options === void 0 ? void 0 : options.publishOptions), { headers: headers, reply: replySubject });
+                fileDescriptor = new FileDescriptor(data.length, chunkSize);
                 chunkNumber = 1;
                 headers.set('ChunkNumber', chunkNumber.toString());
-                subscription = this.connection.subscribe(replySubject);
                 getChunk = function (chunk) {
                     var offset = chunk * fileDescriptor.chunkSize;
                     return data.slice(offset, offset + fileDescriptor.chunkSize);
                 };
-                jsonCodec = JSONCodec();
+                subscription = this.connection.subscribe(replySubject);
                 responsePromise = new Promise(function (resolve, reject) {
                     var messages = [];
                     subscription.callback = function (error, message) {
@@ -145,9 +146,15 @@ var BaseClient = /** @class */ (function () {
                         if (error) {
                             reject(error);
                         }
+                        // Put all the response chunks in an array in the order they are received
                         messages.push(message);
-                        if (message.data.length === 0 || message.data.length < serverMaxPayload) {
+                        // If the chunk has a length smaller than the chunkSize, the message is complete
+                        if (message.data.length < chunkSize) {
+                            // If the final message was received, we can safely unsubscribe
                             subscription.unsubscribe();
+                            // Check if the number of the final message is equal to the number of
+                            // messages we received. If this is not the case, we dropped a chunk,
+                            // likely due to a network error. In this case, the entire message is invalid.
                             var finalMessage = messages[messages.length - 1];
                             var finalMessageNumber = (_a = finalMessage.headers) === null || _a === void 0 ? void 0 : _a.get('ChunkNumber');
                             if (!finalMessageNumber) {
@@ -158,9 +165,11 @@ var BaseClient = /** @class */ (function () {
                                     "The connection may have been interrupted.");
                             }
                             // Concatenate the payloads
+                            // When there are many chunks, doing a single allocation
+                            // is significantly faster than concatenating arrays in sequence
                             var dataArrays = messages.map(function (m) { return m.data; });
-                            var totalSize = dataArrays.reduce(function (total, current) { return total + current.length; }, 0);
-                            var flattenedArray_1 = new Uint8Array(totalSize);
+                            var flattenedSize = dataArrays.reduce(function (sum, array) { return sum + array.length; }, 0);
+                            var flattenedArray_1 = new Uint8Array(flattenedSize);
                             var k_1 = 0;
                             dataArrays.map(function (m) {
                                 for (var i = 0; i < m.length; i++) {
@@ -172,6 +181,8 @@ var BaseClient = /** @class */ (function () {
                     };
                 })
                     .then(function (byteArray) {
+                    var jsonCodec = JSONCodec();
+                    // If a raw response is requested, we should avoid decoding the bytes.
                     var response = (options === null || options === void 0 ? void 0 : options.rawResponse) ? byteArray : jsonCodec.decode(byteArray);
                     return _this.isErrorResponse(response) ? Promise.reject(ErrorResponse.fromJS(response)) : Promise.resolve(response);
                 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentap/runner-client",
-  "version": "2.3.2-alpha.1.5",
+  "version": "2.3.2-alpha.1.6",
   "description": "This is the web client for the OpenTAP Runner.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",