@skyramp/skyramp 1.3.9 → 1.3.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyramp/skyramp",
-  "version": "1.3.9",
+  "version": "1.3.10",
   "description": "module for leveraging skyramp cli functionality",
   "scripts": {
     "lint": "eslint 'src/**/*.js' 'src/**/*.ts' --fix",

package/src/classes/SkyrampClient.d.ts

@@ -126,6 +126,8 @@ interface GenerateRestTestOptions {
   playwrightViewportSize?: string;
   playwrightStoragePath?: string;
   playwrightSaveStoragePath?: string;
+  browser?: string;
+  device?: string;
   loadCount?: string;
   loadDuration?: string;
   loadNumThreads?: string;

package/src/classes/SkyrampClient.js

@@ -51,7 +51,7 @@ const initTargetWrapper = lib.func('initTargetWrapper', 'string', ['string']);
 const deployTargetWrapper = lib.func('deployTargetWrapper', 'string', ['string', 'string', 'string', 'string', 'string', 'string', 'bool']);
 const deleteTargetWrapper = lib.func('deleteTargetWrapper', 'string', ['string', 'string', 'string', 'string', 'string']);
 
-const generateRestTestWrapper = lib.func('generateRestTestWrapper', 'string', ['string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'bool', 'bool', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'bool', 'string', 'bool', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'bool', 'string', 'string']);
+const generateRestTestWrapper = lib.func('generateRestTestWrapper', 'string', ['string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'bool', 'bool', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'bool', 'string', 'bool', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'bool', 'string', 'string']);
 const generateRestMockWrapper = lib.func('generateRestMockWrapper', 'string', ['string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'string', 'bool', 'bool', 'string', 'string', 'string', 'string', 'string', 'string']);
 const traceCollectWrapper = lib.func('traceCollectWrapper', 'string', ['string', 'string', 'bool', 'string', 'string']);
 const analyzeOpenapiWrapper = lib.func('analyzeOpenapiWrapper', 'string', ['string', 'string']);
@@ -98,8 +98,6 @@ class SkyrampClient {
     this.local_image = false;
     this.timestamp = Date.now();
 
-    checkForUpdate("npm")
-
     if (typeof kubeconfigPathOrOptions === 'object') {
       const options = kubeconfigPathOrOptions;
       this.workerNamespaces = [];
@@ -827,6 +825,8 @@ class SkyrampClient {
         options.playwrightViewportSize || "",
         options.playwrightStoragePath || "",
         options.playwrightSaveStoragePath || "",
+        options.browser || "",
+        options.device || "",
         options.loadCount || "0",
         options.loadDuration || "0",
         options.loadNumThreads || "0",
@@ -1013,6 +1013,7 @@ class SkyrampClient {
    * @returns {Promise<string>} A promise that resolves with the initialization output message.
    */
   async initAgent(options) {
+    await checkForUpdate("npm");
     return new Promise((resolve, reject) => {
       initAgentWrapper.async(
         options.version || "",

package/src/classes/SmartPlaywright.js

@@ -290,13 +290,30 @@ class SkyrampPlaywrightLocator {
         });
     }
 
-    async execute() {
+    /**
+     * execute locator's actions
+     *
+     * @param {bool} reducedTimeout - it forces 3sec timeout when set to true
+     */
+    async execute(reducedTimeout) {
         debug(`    execute ${ this._locator}.${this.execFname} ${this.execParam ?? ''} ${this.execArgs ?? ''}`)
+        var newArgs = this.execArgs
+        if (reducedTimeout !== undefined && reducedTimeout) {
+            if (this.execArgs !== null && this.execArgs !== undefined) {
+                // we can safetly assume option is the first element in the execArgs
+                newArgs = [ { ...this.execArgs[0], timeout: 3000}, ...this.execArgs.slice(1)];
+                debug('    reduce timeout', this.execArgs, newArgs)
+            } else {
+                newArgs = [{ timeout: 3000 }];
+                debug('    reduce timeout', newArgs)
+            }
+        }
+
         const func = this._locator[this.execFname];
         if (this.execParam !== null && this.execParam !== undefined) {
-            return func.call(this._locator, this.execParam, ...this.execArgs);
+            return func.call(this._locator, this.execParam, ...newArgs);
         } else {
-            return func.call(this._locator, ...this.execArgs);
+            return func.call(this._locator, ...newArgs);
         }
     }
 
@@ -339,7 +356,7 @@ class SkyrampPlaywrightLocator {
 
     newPrevHydrationErrorMsg() {
         return `Cannot find locator ${this._locator} and likely a hydration issue on ${this._previousLocator._locator}.\n` +
-               `Please add enough waitForTimeout() on ${this._previoousLocator._locator}`;
+               `Please add enough waitForTimeout() on ${this._previousLocator._locator}`;
     }
 
     newMultiLocatorErrorMsg() {
@@ -392,16 +409,16 @@ class SkyrampPlaywrightLocator {
                     await this.wait(defaultWaitForTimeout);
 
                     // Is this really necessary?
-                    await this.execute().then(result => {
+                    await this.execute(true).then(result => {
                         return this._skyrampPage.checkNavigation(currentUrl, result);
                     }).catch(() => {
                         debug(`  failed second time and execute previous locator ${this._previousLocator._locator} again`);
-                        this._previousLocator.execute();
+                        this._previousLocator.execute(true);
                     }).catch(() => {
                         debug(`  failed to execute previous locator ${this._previousLocator._locator} again, continue`);
                     });
 
-                    return this.execute().catch(newError => {
+                    return this.execute(true).catch(newError => {
                         debug(`  third attempt on ${this._locator} failed ${newError.name}`);
                         if (newError.name == "TimeoutError") {
                             // this hadn't happened yet. we need to validate if this is indeed hydration case
@@ -455,7 +472,7 @@ class SkyrampPlaywrightLocator {
                 const previousCount = await this._previousLocator.count();
                 debug(`  re-execute the previous one ${this._previousLocator._locator}, new locator count = ${previousCount}, ${currentUrl}`);
                 // re-execute the previous locator
-                await this._previousLocator.execute().catch(() => {
+                await this._previousLocator.execute(true).catch(() => {
                     // log the failure but continues to the current one
                     debug(`  failed to execute previous locator ${this._previousLocator._locator} again, continue`);
                 });
@@ -470,7 +487,7 @@ class SkyrampPlaywrightLocator {
                         debug(`  ${this._locator} failed at first try. attempting again with some timeout`);
                         // wait for some time and re execute
                         await this.wait(defaultWaitForTimeout);
-                        return this.execute().then(result => {
+                        return this.execute(true).then(result => {
                             return this._skyrampPage.checkNavigation(currentUrl, result);
                         }).catch(newError => {
                             return this._retryWithLLM(newError, this.newPrevHydrationErrorMsg());
@@ -504,7 +521,7 @@ class SkyrampPlaywrightLocator {
                     if (error.name == "TimeoutError") {
                         debug(`${this._locator} failed at first try. attempting again with some timeout`);
                         await this.wait(defaultWaitForTimeout);
-                        return this.execute().then(result=> {
+                        return this.execute(true).then(result=> {
                             return this._skyrampPage.checkNavigation(currentUrl, result);
                         }).catch(newError => {
                             if (newError.name == "TimeoutError") {
@@ -717,7 +734,9 @@ class SkyrampPlaywrightLocator {
 
 class SkyrampPlaywrightPage {
     constructor(page, testInfo) {
-        checkForUpdate("npm")
+        checkForUpdate("npm").catch((error) => {
+            console.error('checkForUpdate("npm") failed:', error);
+        });
 
         this._page = page;
         this._testInfo = testInfo; // Store testInfo for screenshot auto-baseline
@@ -822,6 +841,17 @@ class SkyrampPlaywrightPage {
         return this.newSkyrampPlaywrightLocator(originalLocator, alt, options);
     }
 
+    async waitForResponse(arg, options) {
+        // we increase timeout for waitForResponse to 30 sec
+        // so that in case smart selector is required
+        var newOptions = { timeout: 60000 }
+        if (options !== null && options !== undefined) {
+            newOptions = { ...options, timeout: 60000 }
+        }
+        debug(` waitforresponse`, newOptions)
+        return this._page.waitForResponse(arg, newOptions)
+    }
+
     async goto(url, options) {
         const transformedUrl = transformUrlForDocker(url);
         const result = await this._page.goto(transformedUrl, options);

package/src/utils.d.ts

@@ -93,12 +93,12 @@ export function iterate(jsonInput: object): object;
  * @param {string} error - error message if it failed
  * @param {Object} params - any parameters associated with the tool call. Disctionary
  */
-export function pushToolEvent(entryPoint: string, toolName: string, err: string, params: object): void;
+export function pushToolEvent(entryPoint: string, toolName: string, err: string, params: object): Promise<void>;
 
 /**
  * check for update
  */
-export function checkForUpdate(component: string): void;
+export function checkForUpdate(component: string): Promise<void>;
 
 /**
  * The Skyramp YAML version constant.

package/src/utils.js

@@ -234,16 +234,27 @@ function iterate(fuzz_body) {
 function pushToolEvent(entryPoint, toolName, err, params) {
     const paramsStr = JSON.stringify(params);
 
-    pushToolEventWrapper(entryPoint, toolName, err, paramsStr);
+    return new Promise((resolve, reject) => {
+        pushToolEventWrapper.async(entryPoint, toolName, err, paramsStr, (err) => {
+            if (err) reject(err);
+            else resolve();
+        });
+    });
 }
 
 /**
  * check if new library is available
  *
- * @param {string} component - NAme of component
+ * @param {string} component - Name of component
+ * @returns {Promise<void>}
  */
 function checkForUpdate(component) {
-    checkForUpdateWrapper(component)
+    return new Promise((resolve, reject) => {
+        checkForUpdateWrapper.async(component, (err) => {
+            if (err) reject(err);
+            else resolve();
+        });
+    });
 }
 
 module.exports = {