@wdio/browserstack-service 7.35.0 → 7.37.0

package/build/util.js

@@ -26,7 +26,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ObjectsAreEqual = exports.isObject = exports.isTrue = exports.isUndefined = exports.getBrowserStackKey = exports.getBrowserStackUser = exports.stopAccessibilityTestRun = exports.getA11yResultsSummary = exports.getA11yResults = exports.createAccessibilityTestRun = exports.isAccessibilityAutomationSession = exports.shouldScanTestForAccessibility = exports.validateCapsWithA11y = exports.pushDataToQueue = exports.sleep = exports.patchConsoleLogs = exports.getFailureObject = exports.frameworkSupportsHook = exports.getObservabilityBuildTags = exports.getObservabilityBuild = exports.getObservabilityProject = exports.getObservabilityKey = exports.getObservabilityUser = exports.batchAndPostEvents = exports.shouldAddServiceVersion = exports.isBStackSession = exports.isScreenshotCommand = exports.getHookType = exports.getHierarchy = exports.uploadEventData = exports.getLogTag = exports.removeAnsiColors = exports.getScenarioExamples = exports.isBrowserstackSession = exports.getCloudProvider = exports.getUniqueIdentifierForCucumber = exports.getUniqueIdentifier = exports.getGitMetaData = exports.nodeRequest = exports.getCiInfo = exports.stopBuildUpstream = exports.launchTestSession = exports.o11yClassErrorHandler = exports.o11yErrorHandler = exports.errorHandler = exports.getParentSuiteName = exports.isBrowserstackCapability = exports.getBrowserCapabilities = exports.getBrowserDescription = exports.DEFAULT_REQUEST_CONFIG = void 0;
+exports.getPlatformVersion = exports.ObjectsAreEqual = exports.isObject = exports.isTrue = exports.isUndefined = exports.getBrowserStackKey = exports.getBrowserStackUser = exports.stopAccessibilityTestRun = exports.getA11yResultsSummary = exports.getA11yResults = exports.performA11yScan = exports.createAccessibilityTestRun = exports.isAccessibilityAutomationSession = exports.shouldScanTestForAccessibility = exports.validateCapsWithA11y = exports.sleep = exports.patchConsoleLogs = exports.getFailureObject = exports.frameworkSupportsHook = exports.getObservabilityBuildTags = exports.getObservabilityBuild = exports.getObservabilityProject = exports.getObservabilityKey = exports.getObservabilityUser = exports.batchAndPostEvents = exports.shouldAddServiceVersion = exports.isBStackSession = exports.isScreenshotCommand = exports.getHookType = exports.getHierarchy = exports.getLogTag = exports.removeAnsiColors = exports.getScenarioExamples = exports.isBrowserstackSession = exports.getCloudProvider = exports.getUniqueIdentifierForCucumber = exports.getUniqueIdentifier = exports.getGitMetaData = exports.nodeRequest = exports.getCiInfo = exports.stopBuildUpstream = exports.launchTestSession = exports.o11yClassErrorHandler = exports.o11yErrorHandler = exports.errorHandler = exports.getParentSuiteName = exports.isBrowserstackCapability = exports.getBrowserCapabilities = exports.getBrowserDescription = exports.DEFAULT_REQUEST_CONFIG = void 0;
+exports.getErrorString = exports.isObjectEmpty = void 0;
 const os_1 = require("os");
 const util_1 = require("util");
 const http_1 = __importDefault(require("http"));
@@ -40,9 +41,10 @@ const gitconfiglocal_1 = __importDefault(require("gitconfiglocal"));
 const crash_reporter_1 = __importDefault(require("./crash-reporter"));
 const logPatcher_1 = __importDefault(require("./logPatcher"));
 const constants_1 = require("./constants");
-const request_handler_1 = __importDefault(require("./request-handler"));
 const performance_tester_1 = __importDefault(require("./performance-tester"));
-const test_event_scripts_1 = require("./scripts/test-event-scripts");
+const accessibility_scripts_1 = __importDefault(require("./scripts/accessibility-scripts"));
+const usageStats_1 = __importDefault(require("./testOps/usageStats"));
+const testOpsConfig_1 = __importDefault(require("./testOps/testOpsConfig"));
 const pGitconfig = (0, util_1.promisify)(gitconfiglocal_1.default);
 const log = (0, logger_1.default)('@wdio/browserstack-service');
 exports.DEFAULT_REQUEST_CONFIG = {
@@ -145,7 +147,7 @@ function o11yErrorHandler(fn) {
     return function (...args) {
         try {
             let functionToHandle = fn;
-            if (process.env.BROWSERSTACK_O11Y_PERF_MEASUREMENT) {
+            if (process.env[constants_1.PERF_MEASUREMENT_ENV]) {
                 functionToHandle = performance_tester_1.default.getPerformance().timerify(functionToHandle);
             }
             const result = functionToHandle(...args);
@@ -173,7 +175,7 @@ function o11yClassErrorHandler(errorClass) {
                 writable: true,
                 value: function (...args) {
                     try {
-                        const result = (process.env.BROWSERSTACK_O11Y_PERF_MEASUREMENT ? performance_tester_1.default.getPerformance().timerify(method) : method).call(this, ...args);
+                        const result = (process.env[constants_1.PERF_MEASUREMENT_ENV] ? performance_tester_1.default.getPerformance().timerify(method) : method).call(this, ...args);
                         if (result instanceof Promise) {
                             return result.catch(error => processError(error, method, args));
                         }
@@ -190,6 +192,8 @@ function o11yClassErrorHandler(errorClass) {
 }
 exports.o11yClassErrorHandler = o11yClassErrorHandler;
 exports.launchTestSession = o11yErrorHandler(async function launchTestSession(options, config, bsConfig) {
+    const launchBuildUsage = usageStats_1.default.getInstance().launchBuildUsage;
+    launchBuildUsage.triggered();
     const data = {
         format: 'json',
         project_name: getObservabilityProject(options, bsConfig.projectName),
@@ -206,7 +210,7 @@ exports.launchTestSession = o11yErrorHandler(async function launchTestSession(op
         },
         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[constants_1.RERUN_ENV] || false,
         version_control: await getGitMetaData(),
         observability_version: {
             frameworkName: 'WebdriverIO-' + config.framework,
@@ -232,13 +236,17 @@ exports.launchTestSession = o11yErrorHandler(async function launchTestSession(op
             json: data
         }).json();
         log.debug(`[Start_Build] Success response: ${JSON.stringify(response)}`);
-        process.env.BS_TESTOPS_BUILD_COMPLETED = 'true';
-        if (response.jwt)
-            process.env.BS_TESTOPS_JWT = response.jwt;
-        if (response.build_hashed_id)
-            process.env.BS_TESTOPS_BUILD_HASHED_ID = response.build_hashed_id;
+        process.env[constants_1.TESTOPS_BUILD_COMPLETED_ENV] = 'true';
+        if (response.jwt) {
+            process.env[constants_1.TESTOPS_JWT_ENV] = response.jwt;
+            launchBuildUsage.success();
+        }
+        if (response.build_hashed_id) {
+            process.env[constants_1.TESTOPS_BUILD_ID_ENV] = response.build_hashed_id;
+            testOpsConfig_1.default.getInstance().buildHashedId = response.build_hashed_id;
+        }
         if (response.allow_screenshots)
-            process.env.BS_TESTOPS_ALLOW_SCREENSHOTS = response.allow_screenshots.toString();
+            process.env[constants_1.TESTOPS_SCREENSHOT_ENV] = response.allow_screenshots.toString();
     }
     catch (error) {
         if (error instanceof got_1.HTTPError && error.response) {
@@ -257,18 +265,27 @@ exports.launchTestSession = o11yErrorHandler(async function launchTestSession(op
                 default:
                     log.error(errorMessage);
             }
+            launchBuildUsage.failed(errorMessage || error);
         }
         else {
             log.error(`Data upload to BrowserStack Test Observability failed due to ${error}`);
+            launchBuildUsage.failed(error);
         }
     }
 });
 exports.stopBuildUpstream = o11yErrorHandler(async function stopBuildUpstream() {
-    if (!process.env.BS_TESTOPS_BUILD_COMPLETED) {
-        return;
+    const stopBuildUsage = usageStats_1.default.getInstance().stopBuildUsage;
+    stopBuildUsage.triggered();
+    if (!process.env[constants_1.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) {
+    if (!process.env[constants_1.TESTOPS_JWT_ENV]) {
         log.debug('[STOP_BUILD] Missing Authentication Token/ Build ID');
+        stopBuildUsage.failed('Token/buildID is undefined, build creation might have failed');
         return {
             status: 'error',
             message: 'Token/buildID is undefined, build creation might have failed'
@@ -278,22 +295,24 @@ exports.stopBuildUpstream = o11yErrorHandler(async function stopBuildUpstream()
         'stop_time': (new Date()).toISOString()
     };
     try {
-        const url = `${constants_1.DATA_ENDPOINT}/api/v1/builds/${process.env.BS_TESTOPS_BUILD_HASHED_ID}/stop`;
+        const url = `${constants_1.DATA_ENDPOINT}/api/v1/builds/${process.env[constants_1.TESTOPS_BUILD_ID_ENV]}/stop`;
         const response = await got_1.default.put(url, {
             agent: exports.DEFAULT_REQUEST_CONFIG.agent,
             headers: {
                 ...exports.DEFAULT_REQUEST_CONFIG.headers,
-                'Authorization': `Bearer ${process.env.BS_TESTOPS_JWT}`
+                'Authorization': `Bearer ${process.env[constants_1.TESTOPS_JWT_ENV]}`
             },
             json: data
         }).json();
         log.debug(`[STOP_BUILD] Success response: ${JSON.stringify(response)}`);
+        stopBuildUsage.success();
         return {
             status: 'success',
             message: ''
         };
     }
     catch (error) {
+        stopBuildUsage.failed(error);
         log.debug(`[STOP_BUILD] Failed. Error: ${error}`);
         return {
             status: 'error',
@@ -667,43 +686,6 @@ function getLogTag(eventType) {
     return 'undefined';
 }
 exports.getLogTag = getLogTag;
-async function uploadEventData(eventData, eventUrl = constants_1.DATA_EVENT_ENDPOINT) {
-    let logTag = 'BATCH_UPLOAD';
-    if (!Array.isArray(eventData)) {
-        logTag = getLogTag(eventData.event_type);
-    }
-    if (eventUrl == constants_1.DATA_SCREENSHOT_ENDPOINT)
-        logTag = 'screenshot_upload';
-    if (!process.env.BS_TESTOPS_BUILD_COMPLETED) {
-        return;
-    }
-    if (!process.env.BS_TESTOPS_JWT) {
-        log.debug(`[${logTag}] Missing Authentication Token/ Build ID`);
-        return {
-            status: 'error',
-            message: 'Token/buildID is undefined, build creation might have failed'
-        };
-    }
-    try {
-        const url = `${constants_1.DATA_ENDPOINT}/${eventUrl}`;
-        request_handler_1.default.getInstance().pendingUploads += 1;
-        const data = await got_1.default.post(url, {
-            agent: exports.DEFAULT_REQUEST_CONFIG.agent,
-            headers: {
-                ...exports.DEFAULT_REQUEST_CONFIG.headers,
-                'Authorization': `Bearer ${process.env.BS_TESTOPS_JWT}`
-            },
-            json: eventData
-        }).json();
-        log.debug(`[${logTag}] Success response: ${JSON.stringify(data)}`);
-        request_handler_1.default.getInstance().pendingUploads -= 1;
-    }
-    catch (error) {
-        log.debug(`[${logTag}] Failed. Error: ${error}`);
-        request_handler_1.default.getInstance().pendingUploads -= 1;
-    }
-}
-exports.uploadEventData = uploadEventData;
 // get hierarchy for a particular test (called by reporter for skipped tests)
 function getHierarchy(fullTitle) {
     if (!fullTitle)
@@ -746,8 +728,12 @@ function shouldAddServiceVersion(config, testObservability) {
 }
 exports.shouldAddServiceVersion = shouldAddServiceVersion;
 async function batchAndPostEvents(eventUrl, kind, data) {
-    if (!process.env.BS_TESTOPS_BUILD_COMPLETED || !process.env.BS_TESTOPS_JWT) {
-        return;
+    if (!process.env[constants_1.TESTOPS_BUILD_COMPLETED_ENV]) {
+        throw new Error('Build not completed yet');
+    }
+    const jwtToken = process.env[constants_1.TESTOPS_JWT_ENV];
+    if (!jwtToken) {
+        throw new Error('Missing authentication Token');
     }
     try {
         const url = `${constants_1.DATA_ENDPOINT}/${eventUrl}`;
@@ -755,7 +741,7 @@ async function batchAndPostEvents(eventUrl, kind, data) {
             agent: exports.DEFAULT_REQUEST_CONFIG.agent,
             headers: {
                 ...exports.DEFAULT_REQUEST_CONFIG.headers,
-                'Authorization': `Bearer ${process.env.BS_TESTOPS_JWT}`
+                'Authorization': `Bearer ${jwtToken}`
             },
             json: data
         }).json();
@@ -763,6 +749,7 @@ async function batchAndPostEvents(eventUrl, kind, data) {
     }
     catch (error) {
         log.debug(`[${kind}] EXCEPTION IN ${kind} REQUEST TO TEST OBSERVABILITY : ${error}`);
+        throw new Error('Exception in request ' + error);
     }
 }
 exports.batchAndPostEvents = batchAndPostEvents;
@@ -858,16 +845,6 @@ function patchConsoleLogs() {
 exports.patchConsoleLogs = patchConsoleLogs;
 const sleep = (ms = 100) => new Promise((resolve) => setTimeout(resolve, ms));
 exports.sleep = sleep;
-async function pushDataToQueue(data, requestQueueHandler = undefined) {
-    if (!requestQueueHandler) {
-        requestQueueHandler = request_handler_1.default.getInstance();
-    }
-    const req = requestQueueHandler.add(data);
-    if (req.proceed && req.data) {
-        await uploadEventData(req.data, req.url);
-    }
-}
-exports.pushDataToQueue = pushDataToQueue;
 const validateCapsWithA11y = (deviceName, platformMeta, chromeOptions) => {
     var _a, _b;
     try {
@@ -938,7 +915,10 @@ exports.createAccessibilityTestRun = errorHandler(async function createAccessibi
         'source': {
             frameworkName: 'WebdriverIO-' + config.framework,
             frameworkVersion: bsConfig.bstackServiceVersion,
-            sdkVersion: bsConfig.bstackServiceVersion
+            sdkVersion: bsConfig.bstackServiceVersion,
+            language: 'ECMAScript',
+            testFramework: 'webdriverIO',
+            testFrameworkVersion: bsConfig.bstackServiceVersion
         },
         'settings': bsConfig.accessibilityOptions || {},
         'versionControl': await getGitMetaData(),
@@ -958,7 +938,7 @@ exports.createAccessibilityTestRun = errorHandler(async function createAccessibi
         password: getBrowserStackKey(config),
     };
     try {
-        const response = await nodeRequest('POST', 'test_runs', requestOptions, constants_1.ACCESSIBILITY_API_URL);
+        const response = await nodeRequest('POST', 'v2/test_runs', requestOptions, constants_1.ACCESSIBILITY_API_URL);
         log.debug(`[Create Accessibility Test Run] Success response: ${JSON.stringify(response)}`);
         if (response.data.accessibilityToken) {
             process.env.BSTACK_A11Y_JWT = response.data.accessibilityToken;
@@ -967,6 +947,10 @@ exports.createAccessibilityTestRun = errorHandler(async function createAccessibi
             process.env.BS_A11Y_TEST_RUN_ID = response.data.id;
         }
         log.debug(`BrowserStack Accessibility Automation Test Run ID: ${response.data.id}`);
+        if (response.data) {
+            accessibility_scripts_1.default.update(response.data);
+            accessibility_scripts_1.default.store();
+        }
         return response.data.scannerVersion;
     }
     catch (error) {
@@ -988,6 +972,26 @@ exports.createAccessibilityTestRun = errorHandler(async function createAccessibi
         return null;
     }
 });
+const performA11yScan = async (browser, isBrowserStackSession, isAccessibility, commandName) => {
+    if (!isBrowserStackSession) {
+        log.warn('Not a BrowserStack Automate session, cannot perform Accessibility scan.');
+        return; // since we are running only on Automate as of now
+    }
+    if (!(0, exports.isAccessibilityAutomationSession)(isAccessibility)) {
+        log.warn('Not an Accessibility Automation session, cannot perform Accessibility scan.');
+        return;
+    }
+    try {
+        const results = await browser.executeAsync(accessibility_scripts_1.default.performScan, { 'method': commandName || '' });
+        log.debug(util_2.default.format(results));
+        return results;
+    }
+    catch (err) {
+        log.error('Accessibility Scan could not be performed : ' + err);
+        return;
+    }
+};
+exports.performA11yScan = performA11yScan;
 const getA11yResults = async (browser, isBrowserStackSession, isAccessibility) => {
     if (!isBrowserStackSession) {
         log.warn('Not a BrowserStack Automate session, cannot retrieve Accessibility results.');
@@ -998,7 +1002,9 @@ const getA11yResults = async (browser, isBrowserStackSession, isAccessibility) =
         return [];
     }
     try {
-        const results = await browser.execute(test_event_scripts_1.accessibilityResults);
+        log.debug('Performing scan before getting results');
+        await (0, exports.performA11yScan)(browser, isBrowserStackSession, isAccessibility);
+        const results = await browser.executeAsync(accessibility_scripts_1.default.getResults);
         return results;
     }
     catch {
@@ -1016,7 +1022,9 @@ const getA11yResultsSummary = async (browser, isBrowserStackSession, isAccessibi
         return {};
     }
     try {
-        const summaryResults = await browser.execute(test_event_scripts_1.accessibilityResultsSummary);
+        log.debug('Performing scan before getting results summary');
+        await (0, exports.performA11yScan)(browser, isBrowserStackSession, isAccessibility);
+        const summaryResults = await browser.executeAsync(accessibility_scripts_1.default.getResultsSummary);
         return summaryResults;
     }
     catch {
@@ -1112,3 +1120,38 @@ const ObjectsAreEqual = (object1, object2) => {
     return true;
 };
 exports.ObjectsAreEqual = ObjectsAreEqual;
+exports.getPlatformVersion = o11yErrorHandler(function getPlatformVersion(caps) {
+    var _a;
+    if (!caps) {
+        return undefined;
+    }
+    const bstackOptions = (_a = (caps)) === null || _a === void 0 ? void 0 : _a['bstack:options'];
+    const keys = ['platformVersion', 'platform_version', 'osVersion', 'os_version', 'appium:platformVersion'];
+    for (const key of keys) {
+        if (bstackOptions && (bstackOptions === null || bstackOptions === void 0 ? void 0 : bstackOptions[key])) {
+            return String(bstackOptions === null || bstackOptions === void 0 ? void 0 : bstackOptions[key]);
+        }
+        else if (caps[key]) {
+            return String(caps[key]);
+        }
+    }
+    return undefined;
+});
+const isObjectEmpty = (objectName) => {
+    return (objectName &&
+        Object.keys(objectName).length === 0 &&
+        objectName.constructor === Object);
+};
+exports.isObjectEmpty = isObjectEmpty;
+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
+    }
+};
+exports.getErrorString = getErrorString;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/browserstack-service",
-  "version": "7.35.0",
+  "version": "7.37.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",
@@ -36,7 +36,7 @@
     "gitconfiglocal": "^2.1.0",
     "got": "^11.0.2",
     "uuid": "^9.0.1",
-    "webdriverio": "7.35.0",
+    "webdriverio": "7.36.0",
     "winston-transport": "^4.5.0",
     "yauzl": "^2.10.0"
   },
@@ -47,5 +47,5 @@
     "access": "public"
   },
   "types": "./build/index.d.ts",
-  "gitHead": "56c8deab3787a0571c51bfbd940d1c6d87fbad6a"
+  "gitHead": "50c68b3ddd553afffe6d8379c4fbe9c6e90646bf"
 }