Enhance build status management in LambdaTest service

Author: Meraj Ansari

package.json

@@ -1,6 +1,6 @@
 {
   "name": "wdio-lambdatest-service",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "A WebdriverIO service that manages tunnel and job metadata for LambdaTest.",
   "author": "LambdaTest <[email protected]>",
   "contributors": [
@@ -90,7 +90,7 @@
     "recursive-readdir": "^2.2.2",
     "rimraf": "^3.0.0",
     "tempy": "^0.3.0",
-    "typescript": "^3.6.3",
+    "typescript": "^5.9.3",
     "vitest": "^0.34.4"
   },
   "husky": {

src/launcher.js

@@ -6,6 +6,7 @@ import { performance, PerformanceObserver } from 'perf_hooks'
 import logger from '@wdio/logger'
 import LambdaTestTunnelLauncher from '@lambdatest/node-tunnel'
 import { TUNNEL_START_FAILED, TUNNEL_STOP_FAILED, TUNNEL_STOP_TIMEOUT } from './constants.js'
+import { updateBuildStatusForSession } from './util.js'
 const log = logger('@wdio/lambdatest-service')
 const colors = require('colors');
 export default class LambdaTestLauncher {
@@ -150,7 +151,21 @@ export default class LambdaTestLauncher {
         )
     }
 
-    onComplete() {
+    async onComplete(exitCode, config) {
+        try {
+            const updateBuildStatus = this.options?.updateBuildStatusOnRetry === true;
+            if (updateBuildStatus && exitCode === 0 && config?.product === 'appAutomation' && config?.sessionId) {
+                const lambdaCredentials = {
+                    username: config.user,
+                    accessKey: config.key,
+                    isApp: config?.product === 'appAutomation' ? true : false
+                };
+                await updateBuildStatusForSession(config.sessionId, lambdaCredentials, exitCode)
+            }
+        }catch(error){
+            console.error(error.message);
+        }
+
         if (
             !this.lambdatestTunnelProcess ||
             typeof this.lambdatestTunnelProcess.isRunning !== 'function' ||

src/util.d.ts

@@ -13,4 +13,30 @@ export declare function getParentSuiteName(fullTitle: string, testSuiteTitle: st
  * @param {any} lambdaCredentials
  * @returns 
  */
-export declare function updateSessionById(sessionId: string, data: any, lambdaCredentials: any, callback: any): Promise<void>;
+export declare function updateSessionById(sessionId: string, data: any, lambdaCredentials: any, callback: any): Promise<void>;
+
+/**
+ * Updates a build by id
+ * @param {string} buildId
+ * @param {('passed'|'failed')} status
+ * @param {any} lambdaCredentials
+ * @returns 
+ */
+export declare function updateBuildById(buildId: string, lambdaCredentials: any, status: string): Promise<void>;
+
+/**
+ * Get a session by id
+ * @param {string} sessionId
+ * @param {any} lambdaCredentials
+ * @returns 
+ */
+export declare function getSessionById(sessionId: string, lambdaCredentials: any): Promise<any>;
+
+/**
+ * Update a build status based on a session id and exitCode
+ * @param {string} sessionId
+ * @param {any} lambdaCredentials { username, accessKey, isApp? }
+ * @param {number} exitCode 0 => passed, >0 => failed
+ * @returns 
+ */
+export declare function updateBuildStatusForSession(sessionId: string, lambdaCredentials: any, exitCode: number): Promise<void>;

src/util.js

@@ -48,3 +48,83 @@ export async function updateSessionById(sessionId, data, lambdaCredentials){
         logger.error(error); 
     }
 }
+
+/**
+ * Updates a build by id
+ * @param {string} buildId
+ * @param {('passed'|'failed')} status
+ * @param {any} lambdaCredentials
+ */
+export async function updateBuildById(buildId, lambdaCredentials, status){
+    if (!buildId) return;
+    const buildsUrl = lambdaCredentials.isApp
+        ? `${baseUrlApp}${appVersion.latestVersion}/builds/${buildId}`
+        : `${baseUrl}${version.latestVersion}/builds/${buildId}`;
+    const body = { status };
+    try {
+        let config = {
+            method: 'patch',
+            maxBodyLength: Infinity,
+            url: buildsUrl,
+            headers: {
+                'accept': 'application/json',
+                'Authorization': `Basic ${Buffer.from(lambdaCredentials.username + ':' + lambdaCredentials.accessKey).toString('base64')}`,
+                'Content-Type': 'application/json'
+            },
+            data: body
+        };
+        let response = await axios.request(config);
+        logger.info(response?.data);
+    } catch (error) {
+        logger.error(error);
+    }
+}
+
+/**
+ * Get a session by id
+ * @param {string} sessionId
+ * @param {any} lambdaCredentials
+ */
+export async function getSessionById(sessionId, lambdaCredentials){
+    if (!sessionId) return undefined;
+    const sessionUrl = lambdaCredentials?.isApp
+        ? `${baseUrlApp}${appVersion.latestVersion}/sessions/${sessionId}`
+        : `${baseUrl}${version.latestVersion}/sessions/${sessionId}`;
+    try {
+        const config = {
+            method: 'get',
+            maxBodyLength: Infinity,
+            url: sessionUrl,
+            headers: {
+                'accept': 'application/json',
+                'Authorization': `Basic ${Buffer.from(lambdaCredentials.username + ':' + lambdaCredentials.accessKey).toString('base64')}`
+            }
+        };
+        const response = await axios.request(config);
+        return response?.data;
+    } catch (error) {
+        logger.error(error);
+        return undefined;
+    }
+}
+
+/**
+ * Update a build status based on a session id and exitCode
+ * @param {string} sessionId
+ * @param {any} lambdaCredentials
+ * @param {number} exitCode 0 => passed, >0 => failed
+ */
+export async function updateBuildStatusForSession(sessionId, lambdaCredentials, exitCode) {
+    try {
+        const session = await getSessionById(sessionId, lambdaCredentials);
+        const buildId = session?.data?.build_id;
+        if (!buildId) {
+            logger.error('Could not determine build_id from session');
+            return;
+        }
+        const status = exitCode === 0 ? 'passed' : 'failed';
+        await updateBuildById(buildId, lambdaCredentials, status);
+    } catch (error) {
+        logger.error(error);
+    }
+}