Merge pull request #231 from LambdaTest/stage

Release 28th Feb

Author: sushobhit-lt

.github/workflows/release.yaml

@@ -27,9 +27,23 @@ jobs:
     - name: Install dependencies
       run: pnpm install
 
-    - name: Release the package
-      run: pnpm run release
+    - name: Check if beta release
+      id: check-beta
+      run: |
+        if [[ ${{ github.ref_name }} =~ -beta ]]; then
+          echo "IS_BETA=true" >> $GITHUB_OUTPUT
+        else
+          echo "IS_BETA=false" >> $GITHUB_OUTPUT
+        fi
+
+    - name: Release beta package
+      if: steps.check-beta.outputs.IS_BETA == 'true'
+      run: pnpm run release:beta
       env:
         NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
-
+    - name: Release stable package
+      if: steps.check-beta.outputs.IS_BETA == 'false'
+      run: pnpm run release
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lambdatest/smartui-cli",
-  "version": "4.1.1",
+  "version": "4.1.2-beta.0",
   "description": "A command line interface (CLI) to run SmartUI tests on LambdaTest",
   "files": [
     "dist/**/*"
@@ -38,6 +38,7 @@
     "fastify": "^4.24.3",
     "form-data": "^4.0.0",
     "listr2": "^7.0.1",
+    "node-cache": "^5.1.2",
     "sharp": "^0.33.4",
     "tsup": "^7.2.0",
     "uuid": "^11.0.3",

src/commander/uploadFigma.ts

@@ -72,6 +72,7 @@ uploadWebFigmaCommand
     .argument('<file>', 'figma config config file')
     .option('--markBaseline', 'Mark the uploaded images as baseline')
     .option('--buildName <buildName>', 'Name of the build')
+    .option('--fetch-results [filename]', 'Fetch results and optionally specify an output file, e.g., <filename>.json')
     .action(async function (file, _, command) {
         let ctx: Context = ctxInit(command.optsWithGlobals());
 

src/index.ts

@@ -6,12 +6,16 @@ import httpClient from './lib/httpClient.js'
 import logger from './lib/logger.js'
 import chalk from 'chalk'
 import pkgJSON from './../package.json'
+import constants from './lib/constants.js';
+import fs from 'fs';
 
 (async function() {
     let client = new httpClient(getEnv());
     let log = logger;
 
     try {
+        // Delete log file
+        fs.unlinkSync(constants.LOG_FILE_PATH);
         let { data: { latestVersion, deprecated, additionalDescription } } = await client.checkUpdate(log);
         log.info(`\nLambdaTest SmartUI CLI v${pkgJSON.version}`);
         log.info(chalk.yellow(`${additionalDescription}`));

src/lib/ctx.ts

@@ -88,13 +88,16 @@ export default (options: Record<string, string>): Context => {
             mobile: mobileConfig,
             waitForPageRender: config.waitForPageRender || 0,
             waitForTimeout: config.waitForTimeout || 0,
+            waitForDiscovery: config.waitForDiscovery || 30000,
             enableJavaScript: config.enableJavaScript ?? false,
             cliEnableJavaScript: config.cliEnableJavaScript ?? true,
             scrollTime: config.scrollTime || constants.DEFAULT_SCROLL_TIME,
             allowedHostnames: config.allowedHostnames || [],
             basicAuthorization: basicAuthObj,
             smartIgnore: config.smartIgnore ?? false,
-            delayedUpload: config.delayedUpload ?? false
+            delayedUpload: config.delayedUpload ?? false,
+            useGlobalCache: config.useGlobalCache ?? false,
+            ignoreHTTPSErrors: config.ignoreHTTPSErrors ?? false,
         },
         uploadFilePath: '',
         webStaticConfig: [],

src/lib/httpClient.ts

@@ -22,9 +22,9 @@ export default class httpClient {
 
         let proxyUrl = null;
         try {
-        // Handle URL with or without protocol
-        const urlStr = SMARTUI_API_PROXY?.startsWith('http') ? 
-            SMARTUI_API_PROXY : `http://${SMARTUI_API_PROXY}`;
+            // Handle URL with or without protocol
+            const urlStr = SMARTUI_API_PROXY?.startsWith('http') ?
+                SMARTUI_API_PROXY : `http://${SMARTUI_API_PROXY}`;
             proxyUrl = SMARTUI_API_PROXY ? new URL(urlStr) : null;
         } catch (error) {
             console.error('Invalid proxy URL:', error);
@@ -36,7 +36,7 @@ export default class httpClient {
                 port: proxyUrl.port ? Number(proxyUrl.port) : 80
             } : false
         };
-     
+
         if (SMARTUI_API_SKIP_CERTIFICATES) {
             axiosConfig.httpsAgent = new https.Agent({
                 rejectUnauthorized: false
@@ -45,29 +45,63 @@ export default class httpClient {
 
         this.axiosInstance = axios.create(axiosConfig);
 
-        
+
         this.axiosInstance.interceptors.request.use((config) => {
             config.headers['projectToken'] = this.projectToken;
             config.headers['projectName'] = this.projectName;
             config.headers['username'] = this.username;
             config.headers['accessKey'] = this.accessKey;
             return config;
         });
+
+        //  Add a request interceptor for retry logic
+        this.axiosInstance.interceptors.response.use(
+            (response) => response,
+            async (error) => {
+                const { config } = error;
+                if (config && config.url === '/screenshot' && config.method === 'post') {
+                    // Set default retry count and delay if not already defined
+                    if (!config.retryCount) {
+                        config.retryCount = 0;
+                        config.retry = 2;
+                        config.retryDelay = 5000;
+                    }
+
+                    // Check if we should retry the request
+                    if (config.retryCount < config.retry) {
+                        config.retryCount += 1;
+                        await new Promise(resolve => setTimeout(resolve, config.retryDelay));
+                        config.timeout = 30000;
+                        return this.axiosInstance(config);
+                    }
+
+                    // If we've reached max retries, reject with the error
+                    return Promise.reject(error);
+                }
+            }
+        );
     }
 
+
+
     async request(config: AxiosRequestConfig, log: Logger): Promise<Record<string, any>> {
         log.debug(`http request: ${config.method} ${config.url}`);
-        if(config && config.data && !config.data.name) {
+        if (config && config.data && !config.data.name) {
             log.debug(config.data);
         }
         return this.axiosInstance.request(config)
             .then(resp => {
-                log.debug(`http response: ${JSON.stringify({
-                    status: resp.status,
-                    headers: resp.headers,
-                    body: resp.data
-                })}`)
-                return resp.data;
+                if (resp) {
+                    log.debug(`http response: ${JSON.stringify({
+                        status: resp.status,
+                        headers: resp.headers,
+                        body: resp.data
+                    })}`)
+                    return resp.data;
+                } else {
+                    log.debug(`empty response: ${JSON.stringify(resp)}`)
+                    return {};
+                }
             })
             .catch(error => {
                 if (error.response) {
@@ -107,7 +141,7 @@ export default class httpClient {
             throw new Error('Authentication failed, project token not received');
         }
     }
-    
+
     createBuild(git: Git, config: any, log: Logger, buildName: string, isStartExec: boolean) {
         return this.request({
             url: '/build',
@@ -128,7 +162,7 @@ export default class httpClient {
             params: { buildId, baseline }
         }, log);
     }
-    
+
     ping(buildId: string, log: Logger) {
         return this.request({
             url: '/build/ping',
@@ -138,10 +172,10 @@ export default class httpClient {
             }
         }, log);
     }
-    
+
 
     finalizeBuild(buildId: string, totalSnapshots: number, log: Logger) {
-        let params: Record<string, string | number> = {buildId};
+        let params: Record<string, string | number> = { buildId };
         if (totalSnapshots > -1) params.totalSnapshots = totalSnapshots;
 
         return this.request({
@@ -156,7 +190,7 @@ export default class httpClient {
             url: `/builds/${ctx.build.id}/snapshot`,
             method: 'POST',
             headers: { 'Content-Type': 'application/json' },
-            data: { 
+            data: {
                 snapshot,
                 test: {
                     type: ctx.testType,
@@ -171,7 +205,7 @@ export default class httpClient {
             url: `/build/${ctx.build.id}/snapshot`,
             method: 'POST',
             headers: { 'Content-Type': 'application/json' },
-            data: { 
+            data: {
                 name: snapshot.name,
                 url: snapshot.url,
                 snapshotUuid: snapshotUuid,
@@ -185,13 +219,13 @@ export default class httpClient {
     }
 
     uploadScreenshot(
-        { id: buildId, name: buildName, baseline }: Build, 
-        ssPath: string, ssName: string, browserName :string, viewport: string, log: Logger
+        { id: buildId, name: buildName, baseline }: Build,
+        ssPath: string, ssName: string, browserName: string, viewport: string, log: Logger
     ) {
         browserName = browserName === constants.SAFARI ? constants.WEBKIT : browserName;
         const file = fs.readFileSync(ssPath);
         const form = new FormData();
-        form.append('screenshot', file, { filename: `${ssName}.png`, contentType: 'image/png'});
+        form.append('screenshot', file, { filename: `${ssName}.png`, contentType: 'image/png' });
         form.append('browser', browserName);
         form.append('viewport', viewport);
         form.append('buildId', buildId);
@@ -204,19 +238,20 @@ export default class httpClient {
             method: 'POST',
             headers: form.getHeaders(),
             data: form,
+            timeout: 30000
         })
-        .then(() => {
-            log.debug(`${ssName} for ${browserName} ${viewport} uploaded successfully`);
-        })
-        .catch(error => {
-            log.error(`Unable to upload screenshot ${JSON.stringify(error)}`)
-            if (error && error.response && error.response.data && error.response.data.error) {
-                throw new Error(error.response.data.error.message);
-            }
-            if (error) {
-                throw new Error(JSON.stringify(error));
-            }
-        })
+            .then(() => {
+                log.debug(`${ssName} for ${browserName} ${viewport} uploaded successfully`);
+            })
+            .catch(error => {
+                log.error(`Unable to upload screenshot ${JSON.stringify(error)}`)
+                if (error && error.response && error.response.data && error.response.data.error) {
+                    throw new Error(error.response.data.error.message);
+                }
+                if (error) {
+                    throw new Error(JSON.stringify(error));
+                }
+            })
     }
 
     checkUpdate(log: Logger) {
@@ -232,15 +267,15 @@ export default class httpClient {
     }
 
     getFigmaFilesAndImages(figmaFileToken: string, figmaToken: String | undefined, queryParams: string, authToken: string, depth: number, markBaseline: boolean, buildName: string, log: Logger) {
-    const requestBody = {
-        figma_file_token: figmaFileToken,
-        figma_token: figmaToken,
-        query_params: queryParams,
-        auth: authToken,
-        depth: depth,
-        mark_base_line: markBaseline,
-        build_name: buildName
-    };
+        const requestBody = {
+            figma_file_token: figmaFileToken,
+            figma_token: figmaToken,
+            query_params: queryParams,
+            auth: authToken,
+            depth: depth,
+            mark_base_line: markBaseline,
+            build_name: buildName
+        };
 
         return this.request({
             url: "/uploadfigma",
@@ -297,34 +332,34 @@ export default class httpClient {
         return this.request({
             url: uploadURL,
             method: 'PUT',
-            headers:{
+            headers: {
                 'Content-Type': 'application/json',
             },
             data: snapshot,
             maxBodyLength: Infinity, // prevent axios from limiting the body size
             maxContentLength: Infinity, // prevent axios from limiting the content size
         }, ctx.log)
     }
-  
+
     processWebFigma(requestBody: any, log: Logger) {
-            return this.request({
-                url: "figma-web/upload",
-                method: "POST",
-                headers: {
-                    "Content-Type": "application/json",
-                },
-                data: JSON.stringify(requestBody)
-            }, log);
-        }
+        return this.request({
+            url: "figma-web/upload",
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            data: JSON.stringify(requestBody)
+        }, log);
+    }
 
     fetchWebFigma(buildId: any, log: Logger) {
-            return this.request({
-                url: "figma-web/fetch",
-                method: "GET",
-                headers: {
-                    "Content-Type": "application/json",
-                },
-                params: { buildId }
-            }, log);
-        }
+        return this.request({
+            url: "figma-web/fetch",
+            method: "GET",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            params: { buildId }
+        }, log);
+    }
 }