@wdio/browserstack-service 8.32.4 → 8.33.0

package/build/util.js

@@ -6,24 +6,20 @@ import http from 'node:http';
 import https from 'node:https';
 import path from 'node:path';
 import util from 'node:util';
-import { spawn } from 'node:child_process';
-import { fileURLToPath } from 'node:url';
 import got, { HTTPError } from 'got';
 import gitRepoInfo from 'git-repo-info';
 import gitconfig from 'gitconfiglocal';
 import { FormData } from 'formdata-node';
 import logPatcher from './logPatcher.js';
 import PerformanceTester from './performance-tester.js';
-import { ACCESSIBILITY_API_URL, BROWSER_DESCRIPTION, DATA_ENDPOINT, DATA_EVENT_ENDPOINT, DATA_SCREENSHOT_ENDPOINT, UPLOAD_LOGS_ADDRESS, UPLOAD_LOGS_ENDPOINT, consoleHolder } from './constants.js';
-import RequestQueueHandler from './request-handler.js';
+import { ACCESSIBILITY_API_URL, BROWSER_DESCRIPTION, DATA_ENDPOINT, UPLOAD_LOGS_ADDRESS, UPLOAD_LOGS_ENDPOINT, consoleHolder, TESTOPS_SCREENSHOT_ENV, TESTOPS_BUILD_ID_ENV, PERF_MEASUREMENT_ENV, RERUN_ENV, TESTOPS_BUILD_COMPLETED_ENV, TESTOPS_JWT_ENV } from './constants.js';
 import CrashReporter from './crash-reporter.js';
 import { accessibilityResults, accessibilityResultsSummary } from './scripts/test-event-scripts.js';
 import { BStackLogger } from './bstackLogger.js';
 import { FileStream } from './fileStream.js';
-import BrowserstackLauncherService from './launcher.js';
+import UsageStats from './testOps/usageStats.js';
+import TestOpsConfig from './testOps/testOpsConfig.js';
 const pGitconfig = promisify(gitconfig);
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
 export const DEFAULT_REQUEST_CONFIG = {
     agent: {
         http: new http.Agent({ keepAlive: true }),
@@ -112,7 +108,7 @@ export function o11yErrorHandler(fn) {
     return function (...args) {
         try {
             let functionToHandle = fn;
-            if (process.env.BROWSERSTACK_O11Y_PERF_MEASUREMENT) {
+            if (process.env[PERF_MEASUREMENT_ENV]) {
                 functionToHandle = PerformanceTester.getPerformance().timerify(functionToHandle);
             }
             const result = functionToHandle(...args);
@@ -191,7 +187,7 @@ export function o11yClassErrorHandler(errorClass) {
                 writable: true,
                 value: function (...args) {
                     try {
-                        const result = (process.env.BROWSERSTACK_O11Y_PERF_MEASUREMENT ? PerformanceTester.getPerformance().timerify(method) : method).call(this, ...args);
+                        const result = (process.env[PERF_MEASUREMENT_ENV] ? PerformanceTester.getPerformance().timerify(method) : method).call(this, ...args);
                         if (result instanceof Promise) {
                             return result.catch(error => processError(error, method, args));
                         }
@@ -207,6 +203,8 @@ export function o11yClassErrorHandler(errorClass) {
     return errorClass;
 }
 export const launchTestSession = o11yErrorHandler(async function launchTestSession(options, config, bsConfig) {
+    const launchBuildUsage = UsageStats.getInstance().launchBuildUsage;
+    launchBuildUsage.triggered();
     const data = {
         format: 'json',
         project_name: getObservabilityProject(options, bsConfig.projectName),
@@ -223,7 +221,7 @@ export const launchTestSession = o11yErrorHandler(async function launchTestSessi
         },
         ci_info: getCiInfo(),
         build_run_identifier: process.env.BROWSERSTACK_BUILD_RUN_IDENTIFIER,
-        failed_tests_rerun: process.env.BROWSERSTACK_RERUN || false,
+        failed_tests_rerun: process.env[RERUN_ENV] || false,
         version_control: await getGitMetaData(),
         observability_version: {
             frameworkName: 'WebdriverIO-' + config.framework,
@@ -249,18 +247,21 @@ export const launchTestSession = o11yErrorHandler(async function launchTestSessi
             json: data
         }).json();
         BStackLogger.debug(`[Start_Build] Success response: ${JSON.stringify(response)}`);
-        process.env.BS_TESTOPS_BUILD_COMPLETED = 'true';
+        process.env[TESTOPS_BUILD_COMPLETED_ENV] = 'true';
         if (response.jwt) {
-            process.env.BS_TESTOPS_JWT = response.jwt;
+            launchBuildUsage.success();
+            process.env[TESTOPS_JWT_ENV] = response.jwt;
         }
         if (response.build_hashed_id) {
-            process.env.BS_TESTOPS_BUILD_HASHED_ID = response.build_hashed_id;
+            process.env[TESTOPS_BUILD_ID_ENV] = response.build_hashed_id;
+            TestOpsConfig.getInstance().buildHashedId = response.build_hashed_id;
         }
         if (response.allow_screenshots) {
-            process.env.BS_TESTOPS_ALLOW_SCREENSHOTS = response.allow_screenshots.toString();
+            process.env[TESTOPS_SCREENSHOT_ENV] = response.allow_screenshots.toString();
         }
     }
     catch (error) {
+        launchBuildUsage.failed(error);
         if (error instanceof HTTPError && error.response) {
             const errorMessageJson = error.response.body ? JSON.parse(error.response.body.toString()) : null;
             const errorMessage = errorMessageJson ? errorMessageJson.message : null, errorType = errorMessageJson ? errorMessageJson.errorType : null;
@@ -486,10 +487,18 @@ export const stopAccessibilityTestRun = errorHandler(async function stopAccessib
     }
 });
 export const stopBuildUpstream = o11yErrorHandler(async function stopBuildUpstream() {
-    if (!process.env.BS_TESTOPS_BUILD_COMPLETED) {
-        return;
+    const stopBuildUsage = UsageStats.getInstance().stopBuildUsage;
+    stopBuildUsage.triggered();
+    if (!process.env[TESTOPS_BUILD_COMPLETED_ENV]) {
+        stopBuildUsage.failed('Build is not completed yet');
+        return {
+            status: 'error',
+            message: 'Build is not completed yet'
+        };
     }
-    if (!process.env.BS_TESTOPS_JWT) {
+    const jwtToken = process.env[TESTOPS_JWT_ENV];
+    if (!jwtToken) {
+        stopBuildUsage.failed('Token/buildID is undefined, build creation might have failed');
         BStackLogger.debug('[STOP_BUILD] Missing Authentication Token/ Build ID');
         return {
             status: 'error',
@@ -500,22 +509,24 @@ export const stopBuildUpstream = o11yErrorHandler(async function stopBuildUpstre
         'stop_time': (new Date()).toISOString()
     };
     try {
-        const url = `${DATA_ENDPOINT}/api/v1/builds/${process.env.BS_TESTOPS_BUILD_HASHED_ID}/stop`;
+        const url = `${DATA_ENDPOINT}/api/v1/builds/${process.env[TESTOPS_BUILD_ID_ENV]}/stop`;
         const response = await got.put(url, {
             agent: DEFAULT_REQUEST_CONFIG.agent,
             headers: {
                 ...DEFAULT_REQUEST_CONFIG.headers,
-                'Authorization': `Bearer ${process.env.BS_TESTOPS_JWT}`
+                'Authorization': `Bearer ${jwtToken}`
             },
             json: data
         }).json();
         BStackLogger.debug(`[STOP_BUILD] Success response: ${JSON.stringify(response)}`);
+        stopBuildUsage.success();
         return {
             status: 'success',
             message: ''
         };
     }
     catch (error) {
+        stopBuildUsage.failed(error);
         BStackLogger.debug(`[STOP_BUILD] Failed. Error: ${error}`);
         return {
             status: 'error',
@@ -848,43 +859,6 @@ export function getLogTag(eventType) {
     }
     return 'undefined';
 }
-export async function uploadEventData(eventData, eventUrl = DATA_EVENT_ENDPOINT) {
-    let logTag = 'BATCH_UPLOAD';
-    if (!Array.isArray(eventData)) {
-        logTag = getLogTag(eventData.event_type);
-    }
-    if (eventUrl === DATA_SCREENSHOT_ENDPOINT) {
-        logTag = 'screenshot_upload';
-    }
-    if (!process.env.BS_TESTOPS_BUILD_COMPLETED) {
-        return;
-    }
-    if (!process.env.BS_TESTOPS_JWT) {
-        BStackLogger.debug(`[${logTag}] Missing Authentication Token/ Build ID`);
-        return {
-            status: 'error',
-            message: 'Token/buildID is undefined, build creation might have failed'
-        };
-    }
-    try {
-        const url = `${DATA_ENDPOINT}/${eventUrl}`;
-        RequestQueueHandler.getInstance().pendingUploads += 1;
-        const data = await got.post(url, {
-            agent: DEFAULT_REQUEST_CONFIG.agent,
-            headers: {
-                ...DEFAULT_REQUEST_CONFIG.headers,
-                'Authorization': `Bearer ${process.env.BS_TESTOPS_JWT}`
-            },
-            json: eventData
-        }).json();
-        BStackLogger.debug(`[${logTag}] Success response: ${JSON.stringify(data)}`);
-        RequestQueueHandler.getInstance().pendingUploads -= 1;
-    }
-    catch (error) {
-        BStackLogger.debug(`[${logTag}] Failed. Error: ${error}`);
-        RequestQueueHandler.getInstance().pendingUploads -= 1;
-    }
-}
 // get hierarchy for a particular test (called by reporter for skipped tests)
 export function getHierarchy(fullTitle) {
     if (!fullTitle) {
@@ -923,8 +897,12 @@ export function shouldAddServiceVersion(config, testObservability) {
     return true;
 }
 export async function batchAndPostEvents(eventUrl, kind, data) {
-    if (!process.env.BS_TESTOPS_BUILD_COMPLETED || !process.env.BS_TESTOPS_JWT) {
-        return;
+    if (!process.env[TESTOPS_BUILD_COMPLETED_ENV]) {
+        throw new Error('Build not completed yet');
+    }
+    const jwtToken = process.env[TESTOPS_JWT_ENV];
+    if (!jwtToken) {
+        throw new Error('Missing authentication Token');
     }
     try {
         const url = `${DATA_ENDPOINT}/${eventUrl}`;
@@ -932,7 +910,7 @@ export async function batchAndPostEvents(eventUrl, kind, data) {
             agent: DEFAULT_REQUEST_CONFIG.agent,
             headers: {
                 ...DEFAULT_REQUEST_CONFIG.headers,
-                'Authorization': `Bearer ${process.env.BS_TESTOPS_JWT}`
+                'Authorization': `Bearer ${jwtToken}`
             },
             json: data
         }).json();
@@ -940,6 +918,7 @@ export async function batchAndPostEvents(eventUrl, kind, data) {
     }
     catch (error) {
         BStackLogger.debug(`[${kind}] EXCEPTION IN ${kind} REQUEST TO TEST OBSERVABILITY : ${error}`);
+        throw new Error('Exception in request ' + error);
     }
 }
 export function getObservabilityUser(options, config) {
@@ -1008,6 +987,9 @@ export function isUndefined(value) {
 export function isTrue(value) {
     return (value + '').toLowerCase() === 'true';
 }
+export function isFalse(value) {
+    return (value + '').toLowerCase() === 'false';
+}
 export function frameworkSupportsHook(hook, framework) {
     if (framework === 'mocha' && (hook === 'before' || hook === 'after' || hook === 'beforeEach' || hook === 'afterEach')) {
         return true;
@@ -1042,15 +1024,6 @@ export function getFailureObject(error) {
         failure_type: message ? (message.toString().match(/AssertionError/) ? 'AssertionError' : 'UnhandledError') : null
     };
 }
-export async function pushDataToQueue(data, requestQueueHandler = undefined) {
-    if (!requestQueueHandler) {
-        requestQueueHandler = RequestQueueHandler.getInstance();
-    }
-    const req = requestQueueHandler.add(data);
-    if (req.proceed && req.data) {
-        await uploadEventData(req.data, req.url);
-    }
-}
 export const sleep = (ms = 100) => new Promise((resolve) => setTimeout(resolve, ms));
 export async function uploadLogs(user, key, clientBuildUuid) {
     if (!user || !key) {
@@ -1090,15 +1063,6 @@ export const ObjectsAreEqual = (object1, object2) => {
     }
     return true;
 };
-export function setupExitHandlers() {
-    process.on('exit', (code) => {
-        if (!!process.env.BS_TESTOPS_JWT && !BrowserstackLauncherService._testOpsBuildStopped) {
-            const childProcess = spawn('node', [`${path.join(__dirname, 'cleanup.js')}`], { detached: true, stdio: 'inherit', env: { ...process.env } });
-            childProcess.unref();
-            process.exit(code);
-        }
-    });
-}
 export const getPlatformVersion = o11yErrorHandler(function getPlatformVersion(caps) {
     if (!caps) {
         return undefined;
@@ -1115,3 +1079,19 @@ export const getPlatformVersion = o11yErrorHandler(function getPlatformVersion(c
     }
     return undefined;
 });
+export const isObjectEmpty = (objectName) => {
+    return (objectName &&
+        Object.keys(objectName).length === 0 &&
+        objectName.constructor === Object);
+};
+export const getErrorString = (err) => {
+    if (!err) {
+        return undefined;
+    }
+    if (typeof err === 'string') {
+        return err; // works, `e` narrowed to string
+    }
+    else if (err instanceof Error) {
+        return err.message; // works, `e` narrowed to Error
+    }
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/browserstack-service",
-  "version": "8.32.4",
+  "version": "8.33.0",
   "description": "WebdriverIO service for better Browserstack integration",
   "author": "Adam Bjerstedt <abjerstedt@gmail.com>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-browserstack-service",
@@ -44,7 +44,7 @@
     "gitconfiglocal": "^2.1.0",
     "got": "^12.6.1",
     "uuid": "^9.0.0",
-    "webdriverio": "8.32.4",
+    "webdriverio": "8.33.0",
     "winston-transport": "^4.5.0",
     "yauzl": "^3.0.0"
   },
@@ -53,10 +53,10 @@
   },
   "devDependencies": {
     "@types/node": "^20.1.0",
-    "@wdio/globals": "8.32.4"
+    "@wdio/globals": "8.33.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f8d2d051d1331f4c24521a3c3b0e830ff3e45282"
+  "gitHead": "b00f5062e9ca87d6b2d01b1e9fa66ab15d8636b4"
 }