@opentap/runner-client 1.2.3-alpha.1.3 → 2.0.0-alpha.1.1

package/README.md

@@ -11,6 +11,9 @@ This is the web client for the OpenTAP Runner.
 
 ## How to install the client
 
+- For Angular < 11 or webpack < 5, use version < 2
+- For Angular >= 11 or webpack >= 5, use version >= 2.x.x
+
 Install with npm
 
 ```bash

package/lib/BaseClient.d.ts

@@ -1,5 +1,5 @@
 import { ComponentSettingsBase, ComponentSettingsIdentifier, ComponentSettingsListItem, DataGridControl, ErrorResponse, FileParameter, FileResponse, ListItemType, ProfileGroup, RepositoryPackageReference, RepositorySettingsPackageDefinition, SettingsTapPackage } from './DTOs';
-import { ConnectionOptions, RequestOptions, Subscription, SubscriptionOptions } from 'nats.ws/cjs/nats.js';
+import { ConnectionOptions, RequestOptions, Subscription, SubscriptionOptions } from 'nats.ws';
 export declare class BaseClient {
     private connection;
     private baseSubject;
@@ -26,9 +26,11 @@ 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, isFullSubject?: boolean): Promise<T>;
     /**
      * Handle the error
      * @param error
@@ -48,6 +50,22 @@ export declare class BaseClient {
      * @returns Subscription object
      */
     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
+     */
+    protected sendChunked<T>(subject: string, payload?: any, options?: RequestOptions): 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
+     */
+    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

@@ -45,8 +45,17 @@ 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 };
     }
 };
-import { ComponentSettingsBase, ComponentSettingsIdentifier, ComponentSettingsListItem, DataGridControl, ErrorResponse, ListItemType, ProfileGroup, } from './DTOs';
-import { Empty, ErrorCode, JSONCodec, StringCodec, connect, headers, } from 'nats.ws/cjs/nats.js';
+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';
 var DEFAULT_TIMEOUT = 6000;
 var BaseClient = /** @class */ (function () {
     function BaseClient(baseSubject, options) {
@@ -97,16 +106,18 @@ 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, isFullSubject) {
         return __awaiter(this, void 0, void 0, function () {
             var stringCodec, data, headers, opts;
             var _this = this;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        subject = "".concat(this.baseSubject, ".Request.").concat(subject);
+                        subject = isFullSubject ? 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())
@@ -178,6 +189,132 @@ var BaseClient = /** @class */ (function () {
         var natsSubject = "".concat(this.baseSubject, ".").concat(subject);
         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
+     */
+    BaseClient.prototype.sendChunked = function (subject, payload, options) {
+        return __awaiter(this, void 0, void 0, function () {
+            var stringCodec, data, headers, opts, fileDescriptor, getChunk, dataSubject, i;
+            var _this = this;
+            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!"))];
+                        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(subject, ": File is empty!"))];
+                        getChunk = function (chunk) {
+                            var offset = chunk * fileDescriptor.chunkSize;
+                            return data.slice(offset, offset + fileDescriptor.chunkSize);
+                        };
+                        return [4 /*yield*/, this.request(subject, fileDescriptor, opts)];
+                    case 1:
+                        dataSubject = _a.sent();
+                        for (i = 0; i < fileDescriptor.numberOfChunks; i++) {
+                            this.connection.publish(dataSubject, getChunk(i), opts);
+                        }
+                        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);
+                                return _this.isErrorResponse(response) ? Promise.reject(ErrorResponse.fromJS(response)) : Promise.resolve(response);
+                            })];
+                }
+            });
+        });
+    };
+    /**
+     * 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
+     */
+    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 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, "."));
+                        var jsonCodec = JSONCodec();
+                        var response = jsonCodec.decode(byteArray);
+                        return _this.isErrorResponse(response) ? Promise.reject(ErrorResponse.fromJS(response)) : Promise.resolve(response);
+                    })];
+            });
+        });
+    };
     /**
      * Check if the the response is an error from the server.
      * @param {any} response

package/lib/DTOs.d.ts

@@ -418,6 +418,29 @@ export declare class PasswordControl extends Setting implements IPasswordControl
 export interface IPasswordControl extends ISetting {
     password?: 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;
+    chunkSize: number;
+    private readonly defaultChunkSize;
+    constructor(fileSize: number, chunkSize?: number);
+    init(_data?: any): void;
+    static fromJS(data: any): FileDescriptor;
+    toJSON(data?: any): any;
+}
+export interface IFileDescriptor {
+    numberOfChunks: number;
+    fileSize: number;
+    chunkSize: number;
+}
 export declare class ComponentSettings extends ComponentSettingsBase implements IComponentSettings {
     settings?: Setting[] | undefined;
     constructor(data?: IComponentSettings);

package/lib/DTOs.js

@@ -1238,6 +1238,46 @@ var PasswordControl = /** @class */ (function (_super) {
     return PasswordControl;
 }(Setting));
 export { PasswordControl };
+var TestPlanRequest = /** @class */ (function () {
+    function TestPlanRequest() {
+    }
+    return TestPlanRequest;
+}());
+export { TestPlanRequest };
+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.numberOfChunks = Math.floor((((_a = this.fileSize) !== null && _a !== void 0 ? _a : 0) + this.chunkSize - 1) / this.chunkSize);
+    }
+    FileDescriptor.prototype.init = function (_data) {
+        if (_data) {
+            this.numberOfChunks = _data['NumberOfChunks'];
+            this.fileSize = _data['FileSize'];
+            this.chunkSize = _data['ChunkSize'];
+        }
+    };
+    FileDescriptor.fromJS = function (data) {
+        data = typeof data === 'object' ? data : {};
+        var result = new FileDescriptor(0);
+        result.init(data);
+        return result;
+    };
+    FileDescriptor.prototype.toJSON = function (data) {
+        data = typeof data === 'object' ? data : {};
+        data['NumberOfChunks'] = this.numberOfChunks;
+        data['FileSize'] = this.fileSize;
+        data['ChunkSize'] = this.chunkSize;
+        return data;
+    };
+    return FileDescriptor;
+}());
+export { FileDescriptor };
 var ComponentSettings = /** @class */ (function (_super) {
     __extends(ComponentSettings, _super);
     function ComponentSettings(data) {

package/lib/RunnerClient.d.ts

@@ -2,9 +2,6 @@ import { Image, Session } from './DTOs';
 import { BaseClient } from './BaseClient';
 import { ConnectionOptions } from 'nats.ws';
 export declare class RunnerClient extends BaseClient {
-    private http;
-    private baseUrl;
-    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
     constructor(baseSubject: string, options: ConnectionOptions);
     /**
      * Get the created image with the specified ID.

package/lib/RunnerClient.js

@@ -18,9 +18,7 @@ import { BaseClient } from './BaseClient';
 var RunnerClient = /** @class */ (function (_super) {
     __extends(RunnerClient, _super);
     function RunnerClient(baseSubject, options) {
-        var _this = _super.call(this, baseSubject, options) || this;
-        _this.jsonParseReviver = undefined;
-        return _this;
+        return _super.call(this, baseSubject, options) || this;
     }
     /**
      * Get the created image with the specified ID.

package/lib/SessionClient.d.ts

@@ -1,9 +1,8 @@
 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/cjs/nats.js';
+import { ConnectionOptions, NatsError, Subscription, SubscriptionOptions } from 'nats.ws';
 import { BaseClient } from './BaseClient';
 export declare class SessionClient extends BaseClient {
-    private eventsSubscription;
-    private eventsWildcardSubscription;
+    private subscriptions;
     constructor(baseSubject: string, options: ConnectionOptions);
     /**
      * @param sessionLogsHandler Function to be called when log list or error is received

package/lib/SessionClient.js

@@ -25,12 +25,15 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 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/cjs/nats.js';
+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) {
-        return _super.call(this, baseSubject, options) || this;
+        var _this = _super.call(this, baseSubject, options) || this;
+        _this.subscriptions = [];
+        return _this;
     }
     /**
      * @param sessionLogsHandler Function to be called when log list or error is received
@@ -75,8 +78,8 @@ var SessionClient = /** @class */ (function (_super) {
                 eventHandler(undefined, error);
             }
         };
-        this.eventsSubscription = this.subscribe('Events', __assign(__assign({}, options), { callback: callback }));
-        this.eventsWildcardSubscription = this.subscribe('Events.*', __assign(__assign({}, options), { callback: callback }));
+        this.subscriptions.push(this.subscribe('Events', __assign(__assign({}, options), { callback: callback })));
+        this.subscriptions.push(this.subscribe('Events.*', __assign(__assign({}, options), { callback: callback })));
     };
     /**
      * @param resultHandler Function to be called when result or error is received
@@ -122,12 +125,8 @@ var SessionClient = /** @class */ (function (_super) {
      * Unsubscibe from session events
      */
     SessionClient.prototype.unsubscribeSessionEvents = function () {
-        if (this.eventsSubscription) {
-            this.eventsSubscription.unsubscribe();
-        }
-        if (this.eventsWildcardSubscription) {
-            this.eventsWildcardSubscription.unsubscribe();
-        }
+        var _a;
+        (_a = this.subscriptions) === null || _a === void 0 ? void 0 : _a.forEach(function (subscription) { return subscription.unsubscribe(); });
     };
     /**
      * Retrieve session logs
@@ -199,14 +198,16 @@ var SessionClient = /** @class */ (function (_super) {
      * @return Test plan loaded. List of load errors is returned.
      */
     SessionClient.prototype.setTestPlanXML = function (xml) {
-        return this.request('SetTestPlanXML', xml).then(this.success()).catch(this.error());
+        return this.sendChunked('SetTestPlanXML', xml).then(this.success()).catch(this.error());
     };
     /**
      * Retrieve loaded test plan XML
      * @return Test plan retrieved
      */
     SessionClient.prototype.getTestPlanXML = function () {
-        return this.request('GetTestPlanXML').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
@@ -229,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());
@@ -239,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());
@@ -274,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());
@@ -285,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/lib/index.d.ts

@@ -1,6 +1,4 @@
 export { RunnerClient } from './RunnerClient';
 export { SessionClient } from './SessionClient';
 export * from './DTOs';
-export * from 'nats.ws/lib/nats-base-client/types';
-export * from 'nats.ws/lib/nats-base-client/authenticator';
-export * from 'nats.ws/lib/nats-base-client/error';
+export * from 'nats.ws';

package/lib/index.js

@@ -1,6 +1,4 @@
 export { RunnerClient } from './RunnerClient';
 export { SessionClient } from './SessionClient';
 export * from './DTOs';
-export * from 'nats.ws/lib/nats-base-client/types'; // TODO: Delete this line if you are consuming this library in angular > v11. The types export will be done automatically.
-export * from 'nats.ws/lib/nats-base-client/authenticator';
-export * from 'nats.ws/lib/nats-base-client/error';
+export * from 'nats.ws';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opentap/runner-client",
-  "version": "1.2.3-alpha.1.3",
+  "version": "2.0.0-alpha.1.1",
   "description": "This is the web client for the OpenTAP Runner.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -12,7 +12,7 @@
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "author": "OpenTap.io",
-  "license": "ISC",
+  "license": "MIT",
   "files": [
     "lib/**/*"
   ],
@@ -26,6 +26,7 @@
     "url": "git://github.com/opentap/runner-client-web.git"
   },
   "devDependencies": {
+    "@types/uuid": "^8.3.4",
     "@typescript-eslint/eslint-plugin": "^5.36.1",
     "@typescript-eslint/parser": "^5.36.1",
     "eslint": "^8.23.0",
@@ -38,7 +39,8 @@
     "typescript": "^4.8.2"
   },
   "dependencies": {
-    "nats.ws": "^1.9.0"
+    "nats.ws": "^1.9.0",
+    "uuid": "^9.0.0"
   },
   "lint-staged": {
     "*.{ts,js,html}": [