@wdio/browserstack-service 8.48.0 → 8.48.3

package/build/util.js

@@ -1,29 +1,29 @@
-import { hostname, platform, type, version, arch } from 'node:os';
 import fs from 'node:fs';
-import zlib from 'node:zlib';
-import { promisify } from 'node:util';
 import http from 'node:http';
 import https from 'node:https';
+import { arch, hostname, platform, type, version } from 'node:os';
 import path from 'node:path';
-import util from 'node:util';
-import got, { HTTPError } from 'got';
+import util, { promisify } from 'node:util';
+import zlib from 'node:zlib';
+import { FormData } from 'formdata-node';
+import { fileFromPath } from 'formdata-node/file-from-path';
 import gitRepoInfo from 'git-repo-info';
 import gitconfig from 'gitconfiglocal';
-import { FormData } from 'formdata-node';
+import got, { HTTPError } from 'got';
 import { performance } from 'node:perf_hooks';
-import logPatcher from './logPatcher.js';
-import PerformanceTester from './instrumentation/performance/performance-tester.js';
-import * as PERFORMANCE_SDK_EVENTS from './instrumentation/performance/constants.js';
-import { logBuildError, handleErrorForObservability, handleErrorForAccessibility, getProductMapForBuildStartCall } from './testHub/utils.js';
-import { BROWSER_DESCRIPTION, UPLOAD_LOGS_ENDPOINT, consoleHolder, BSTACK_A11Y_POLLING_TIMEOUT, TESTOPS_SCREENSHOT_ENV, BROWSERSTACK_TESTHUB_UUID, PERF_MEASUREMENT_ENV, RERUN_ENV, TESTOPS_BUILD_COMPLETED_ENV, BROWSERSTACK_TESTHUB_JWT, BROWSERSTACK_OBSERVABILITY, BROWSERSTACK_TEST_REPORTING, BROWSERSTACK_ACCESSIBILITY, MAX_GIT_META_DATA_SIZE_IN_BYTES, GIT_META_DATA_TRUNCATED, APP_ALLY_ISSUES_SUMMARY_ENDPOINT, APP_ALLY_ISSUES_ENDPOINT, TEST_REPORTING_PROJECT_NAME, CLI_DEBUG_LOGS_FILE, WDIO_NAMING_PREFIX } from './constants.js';
-import CrashReporter from './crash-reporter.js';
+import tar from 'tar';
 import { BStackLogger } from './bstackLogger.js';
+import APIUtils from './cli/apiUtils.js';
+import { APP_ALLY_ISSUES_ENDPOINT, APP_ALLY_ISSUES_SUMMARY_ENDPOINT, BROWSERSTACK_ACCESSIBILITY, BROWSERSTACK_OBSERVABILITY, BROWSERSTACK_TESTHUB_JWT, BROWSERSTACK_TESTHUB_UUID, BROWSERSTACK_TEST_PLAN_ID, BROWSERSTACK_TEST_REPORTING, BROWSER_DESCRIPTION, BSTACK_A11Y_POLLING_TIMEOUT, CLI_DEBUG_LOGS_FILE, GIT_META_DATA_TRUNCATED, MAX_GIT_META_DATA_SIZE_IN_BYTES, PERF_MEASUREMENT_ENV, RERUN_ENV, TESTOPS_BUILD_COMPLETED_ENV, TESTOPS_SCREENSHOT_ENV, TEST_REPORTING_PROJECT_NAME, UPLOAD_LOGS_ENDPOINT, WDIO_NAMING_PREFIX, consoleHolder } from './constants.js';
+import CrashReporter from './crash-reporter.js';
+import * as PERFORMANCE_SDK_EVENTS from './instrumentation/performance/constants.js';
+import PerformanceTester from './instrumentation/performance/performance-tester.js';
+import logPatcher from './logPatcher.js';
 import AccessibilityScripts from './scripts/accessibility-scripts.js';
-import UsageStats from './testOps/usageStats.js';
+import { getProductMapForBuildStartCall, handleErrorForAccessibility, handleErrorForObservability, logBuildError } from './testHub/utils.js';
 import TestOpsConfig from './testOps/testOpsConfig.js';
-import APIUtils from './cli/apiUtils.js';
-import tar from 'tar';
-import { fileFromPath } from 'formdata-node/file-from-path';
+import UsageStats from './testOps/usageStats.js';
+import { OrchestrationUtils } from './testorchestration/testorcherstrationutils.js';
 const pGitconfig = promisify(gitconfig);
 export const DEFAULT_REQUEST_CONFIG = {
     agent: {
@@ -317,7 +317,11 @@ export const launchTestSession = PerformanceTester.measureWrapper(PERFORMANCE_SD
             }
         },
         product_map: getProductMapForBuildStartCall(bStackConfig, accessibilityAutomation),
-        config: {}
+        config: {},
+        test_orchestration: OrchestrationUtils.getInstance(config)?.getBuildStartData() || {},
+        test_management: {
+            test_plan_id: getTestPlanId(options)
+        }
     };
     if (accessibilityAutomation && (isTurboScale(options) || data.browserstackAutomation === false)) {
         data.accessibility.settings ??= {};
@@ -342,6 +346,7 @@ export const launchTestSession = PerformanceTester.measureWrapper(PERFORMANCE_SD
         }).json();
         delete data?.accessibility?.settings?.includeEncodedExtension;
         BStackLogger.debug(`[Start_Build] Success response: ${JSON.stringify(response)}`);
+        BStackLogger.debug(`Test Plan Id sent in request: ${getTestPlanId(options)}`);
         process.env[TESTOPS_BUILD_COMPLETED_ENV] = 'true';
         if (response.jwt) {
             process.env[BROWSERSTACK_TESTHUB_JWT] = response.jwt;
@@ -897,7 +902,16 @@ export function getUniqueIdentifierForCucumber(world) {
     return world.pickle.uri + '_' + world.pickle.astNodeIds.join(',');
 }
 export function getCloudProvider(browser) {
-    if (browser.options && browser.options.hostname && browser.options.hostname.includes('browserstack')) {
+    if (browser && 'instances' in browser) {
+        // Loop through all instances
+        for (const instanceName of browser.instances) {
+            const instance = browser[instanceName];
+            if (instance.options && instance.options.hostname && instance.options.hostname.includes('browserstack')) {
+                return 'browserstack';
+            }
+        }
+    }
+    else if (browser.options && browser.options.hostname && browser.options.hostname.includes('browserstack')) { // Single browser instance
         return 'browserstack';
     }
     return 'unknown_grid';
@@ -905,6 +919,23 @@ export function getCloudProvider(browser) {
 export function isBrowserstackSession(browser) {
     return browser && getCloudProvider(browser).toLowerCase() === 'browserstack';
 }
+/**
+ * Sets a BrowserStack annotation with the provided message
+ * @param browser - The WebDriver browser instance
+ * @param message - The annotation message to set
+ * @param isAccessibilityEnabled - Whether accessibility is enabled for the session
+ */
+export async function setBrowserstackAnnotation(browser, message, isAccessibilityEnabled) {
+    if (isAccessibilityEnabled && isBrowserstackSession(browser)) {
+        await browser.execute(`browserstack_executor: ${JSON.stringify({
+            action: 'annotate',
+            arguments: {
+                data: message,
+                level: 'info'
+            }
+        })}`);
+    }
+}
 export function getScenarioExamples(world) {
     const scenario = world.pickle;
     // no examples present
@@ -1149,6 +1180,25 @@ export function getObservabilityBuildTags(options, bstackBuildTag) {
     }
     return [];
 }
+export function getTestPlanId(options) {
+    if (process.env[BROWSERSTACK_TEST_PLAN_ID]) {
+        return process.env[BROWSERSTACK_TEST_PLAN_ID];
+    }
+    const CLI_ARG = '--browserstack.testManagementOptions.testPlanId';
+    const argIndex = process.argv.indexOf(CLI_ARG);
+    if (argIndex !== -1 && process.argv[argIndex + 1]) {
+        return process.argv[argIndex + 1];
+    }
+    const argWithEquals = process.argv.find((arg) => arg.startsWith(`${CLI_ARG}=`));
+    if (argWithEquals) {
+        return argWithEquals.split('=')[1];
+    }
+    const testPlanId = options.testManagementOptions?.testPlanId;
+    if (typeof testPlanId === 'string' && testPlanId.trim().length > 0) {
+        return testPlanId.trim();
+    }
+    return undefined;
+}
 export function getBrowserStackUser(config) {
     if (process.env.BROWSERSTACK_USERNAME) {
         return process.env.BROWSERSTACK_USERNAME;
@@ -1460,6 +1510,22 @@ export function getBooleanValueFromString(value) {
     }
     return ['true'].includes(value.trim().toLowerCase());
 }
+/**
+ * Validate boolean value from mixed types (boolean or string)
+ * Only accepts true boolean or string "true" (case insensitive)
+ */
+export function isValidEnabledValue(value) {
+    if (value === undefined || value === null) {
+        return false;
+    }
+    if (typeof value === 'boolean') {
+        return value === true;
+    }
+    if (typeof value === 'string') {
+        return getBooleanValueFromString(value);
+    }
+    return false;
+}
 export function mergeDeep(target, ...sources) {
     if (!sources.length) {
         return target;
@@ -1564,3 +1630,31 @@ export function getMochaTestHierarchy(test) {
     }
     return value.reverse();
 }
+/**
+ * Checks if the capabilities represent a multiremote configuration
+ * @param capabilities - The capabilities to check
+ * @returns true if capabilities represent any multiremote configuration (regular or parallel)
+ *
+ * @example
+ * Regular multiremote (object):
+ * { browserA: { capabilities: {...} }, browserB: { capabilities: {...} } }
+ *
+ * Parallel multiremote (array with nested structure):
+ * [{ browserA: { capabilities: {...} }, browserB: { capabilities: {...} } }]
+ *
+ * Regular capabilities (array):
+ * [{ browserName: 'chrome', ... }]
+ */
+export function isMultiRemoteCaps(capabilities) {
+    // Regular multiremote is an object (not array)
+    if (!Array.isArray(capabilities)) {
+        return true;
+    }
+    // Empty array is not multiremote
+    if (capabilities.length === 0) {
+        return false;
+    }
+    // Parallel multiremote is an array with nested capabilities structure
+    return capabilities.every(cap => Object.values(cap).length > 0 &&
+        Object.values(cap).every(c => c !== null && typeof c === 'object' && c.capabilities));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/browserstack-service",
-  "version": "8.48.0",
+  "version": "8.48.3",
   "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,6 +44,7 @@
     "formdata-node": "5.0.1",
     "git-repo-info": "^2.1.1",
     "gitconfiglocal": "^2.1.0",
+    "glob": "^10.3.10",
     "got": "^12.6.1",
     "tar": "^6.1.15",
     "uuid": "^10.0.0",
@@ -62,5 +63,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9a4aeb53bad8f86e8caa232f67a5b51fcde1fdf2"
+  "gitHead": "fe872d88706a42cd9653abfc99079d5ab80197dc"
 }

package/tsconfig.prod.tsbuildinfo

@@ -1 +1 @@
-{"root":["./src/accessibility-handler.ts","./src/ai-handler.ts","./src/bstackLogger.ts","./src/cleanup.ts","./src/config.ts","./src/constants.ts","./src/crash-reporter.ts","./src/cucumber-types.ts","./src/data-store.ts","./src/exitHandler.ts","./src/fileStream.ts","./src/index.ts","./src/insights-handler.ts","./src/launcher.ts","./src/log4jsAppender.ts","./src/logPatcher.ts","./src/logReportingAPI.ts","./src/reporter.ts","./src/request-handler.ts","./src/service.ts","./src/types.ts","./src/util.ts","./src/@types/bstack-service-types.d.ts","./src/@types/cucumber-framework.d.ts","./src/Percy/Percy-Handler.ts","./src/Percy/Percy.ts","./src/Percy/PercyBinary.ts","./src/Percy/PercyCaptureMap.ts","./src/Percy/PercyHelper.ts","./src/Percy/PercyLogger.ts","./src/Percy/PercySDK.ts","./src/cli/apiUtils.ts","./src/cli/cliLogger.ts","./src/cli/cliUtils.ts","./src/cli/eventDispatcher.ts","./src/cli/grpcClient.ts","./src/cli/index.ts","./src/cli/frameworks/automationFramework.ts","./src/cli/frameworks/testFramework.ts","./src/cli/frameworks/wdioAutomationFramework.ts","./src/cli/frameworks/wdioMochaTestFramework.ts","./src/cli/frameworks/constants/automationFrameworkConstants.ts","./src/cli/frameworks/constants/testFrameworkConstants.ts","./src/cli/instances/automationFrameworkInstance.ts","./src/cli/instances/testFrameworkInstance.ts","./src/cli/instances/trackedContext.ts","./src/cli/instances/trackedInstance.ts","./src/cli/modules/accessibilityModule.ts","./src/cli/modules/automateModule.ts","./src/cli/modules/baseModule.ts","./src/cli/modules/observabilityModule.ts","./src/cli/modules/percyModule.ts","./src/cli/modules/testHubModule.ts","./src/cli/modules/webdriverIOModule.ts","./src/cli/states/automationFrameworkState.ts","./src/cli/states/hookState.ts","./src/cli/states/testFrameworkState.ts","./src/instrumentation/funnelInstrumentation.ts","./src/instrumentation/performance/constants.ts","./src/instrumentation/performance/performance-tester.ts","./src/scripts/accessibility-scripts.ts","./src/testHub/utils.ts","./src/testOps/featureStats.ts","./src/testOps/featureUsage.ts","./src/testOps/listener.ts","./src/testOps/requestUtils.ts","./src/testOps/testOpsConfig.ts","./src/testOps/usageStats.ts","../../@types/css-shorthand-properties.d.ts","../../@types/css-value.d.ts","../../@types/custom.d.ts","../../@types/junit-report-builder.d.ts","../../@types/lerna-changelog.d.ts","../../@types/query-selector-shadow-dom.d.ts"],"version":"5.6.2"}
+{"root":["./src/accessibility-handler.ts","./src/ai-handler.ts","./src/bstackLogger.ts","./src/cleanup.ts","./src/config.ts","./src/constants.ts","./src/crash-reporter.ts","./src/cucumber-types.ts","./src/data-store.ts","./src/exitHandler.ts","./src/fileStream.ts","./src/index.ts","./src/insights-handler.ts","./src/launcher.ts","./src/log4jsAppender.ts","./src/logPatcher.ts","./src/logReportingAPI.ts","./src/reporter.ts","./src/request-handler.ts","./src/service.ts","./src/types.ts","./src/util.ts","./src/@types/bstack-service-types.d.ts","./src/@types/cucumber-framework.d.ts","./src/Percy/Percy-Handler.ts","./src/Percy/Percy.ts","./src/Percy/PercyBinary.ts","./src/Percy/PercyCaptureMap.ts","./src/Percy/PercyHelper.ts","./src/Percy/PercyLogger.ts","./src/Percy/PercySDK.ts","./src/cli/apiUtils.ts","./src/cli/cliLogger.ts","./src/cli/cliUtils.ts","./src/cli/eventDispatcher.ts","./src/cli/grpcClient.ts","./src/cli/index.ts","./src/cli/frameworks/automationFramework.ts","./src/cli/frameworks/testFramework.ts","./src/cli/frameworks/wdioAutomationFramework.ts","./src/cli/frameworks/wdioMochaTestFramework.ts","./src/cli/frameworks/constants/automationFrameworkConstants.ts","./src/cli/frameworks/constants/testFrameworkConstants.ts","./src/cli/instances/automationFrameworkInstance.ts","./src/cli/instances/testFrameworkInstance.ts","./src/cli/instances/trackedContext.ts","./src/cli/instances/trackedInstance.ts","./src/cli/modules/accessibilityModule.ts","./src/cli/modules/automateModule.ts","./src/cli/modules/baseModule.ts","./src/cli/modules/observabilityModule.ts","./src/cli/modules/percyModule.ts","./src/cli/modules/testHubModule.ts","./src/cli/modules/webdriverIOModule.ts","./src/cli/states/automationFrameworkState.ts","./src/cli/states/hookState.ts","./src/cli/states/testFrameworkState.ts","./src/instrumentation/funnelInstrumentation.ts","./src/instrumentation/performance/constants.ts","./src/instrumentation/performance/performance-tester.ts","./src/scripts/accessibility-scripts.ts","./src/testHub/utils.ts","./src/testOps/featureStats.ts","./src/testOps/featureUsage.ts","./src/testOps/listener.ts","./src/testOps/requestUtils.ts","./src/testOps/testOpsConfig.ts","./src/testOps/usageStats.ts","./src/testorchestration/apply-orchestration.ts","./src/testorchestration/helpers.ts","./src/testorchestration/request-utils.ts","./src/testorchestration/test-ordering-server.ts","./src/testorchestration/testorcherstrationhandler.ts","./src/testorchestration/testorcherstrationutils.ts","../../@types/css-shorthand-properties.d.ts","../../@types/css-value.d.ts","../../@types/custom.d.ts","../../@types/junit-report-builder.d.ts","../../@types/lerna-changelog.d.ts","../../@types/query-selector-shadow-dom.d.ts"],"version":"5.6.2"}