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

package/lib/BaseClient.d.ts

@@ -26,6 +26,8 @@ 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, isFullSubject?: boolean): Promise<T>;
@@ -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,7 +59,7 @@ 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)

package/lib/BaseClient.js

@@ -107,6 +107,8 @@ 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, isFullSubject) {
@@ -189,7 +191,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,22 +199,21 @@ 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, dataSubject, message, i, response, jsonCodec;
+            var stringCodec, data, headers, opts, fileDescriptor, getChunk, dataSubject, message, i, response, jsonCodec;
             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);
@@ -226,6 +227,8 @@ var BaseClient = /** @class */ (function () {
                         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:
@@ -242,7 +245,7 @@ var BaseClient = /** @class */ (function () {
         });
     };
     /**
-     * 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)
@@ -250,41 +253,44 @@ var BaseClient = /** @class */ (function () {
      */
     BaseClient.prototype.requestChunked = function (subject, options, isFullSubject) {
         return __awaiter(this, void 0, void 0, function () {
-            var replySubject, requestSubject, headers, opts;
             var _this = this;
             return __generator(this, function (_a) {
-                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!"))];
+                    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!"))];
-                headers = this.buildHeaders();
-                opts = __assign(__assign({}, options), { timeout: this.timeout, headers: headers });
-                // eslint-disable-next-line @typescript-eslint/no-unused-vars
+                    return [2 /*return*/, Promise.reject("".concat(subject, ": Connection has been closed! Please reconnect!"))];
                 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) {
                                 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);
+                            message.respond(Empty); // Respond acknowledgement
                             resolveIfComplete();
                         };
+                        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)
                             .then(function (fileDescriptor) { return FileDescriptor.fromJS(fileDescriptor); })
                             .then(function (fileDescriptor) {
                             numberOfChunks = fileDescriptor.numberOfChunks;
+                            // Check if the chunks are already received
                             resolveIfComplete();
                         });
                     }).then(function (byteArray) {

package/package.json

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