feat(v8): platformise CucumberJS on the CLI/binary flow

.changeset/pr-207.md

@@ -0,0 +1,7 @@
+---
+"@wdio/browserstack-service": minor
+---
+
+- Cucumber tests on WebdriverIO now report through the BrowserStack CLI, matching the behaviour of Mocha.
+- Fixed `sessionNameFormat` being ignored, so custom session names now apply on the CLI flow.
+- Fixed Observability losing a feature's file path when a session-name update failed.

packages/browserstack-service/src/cli/cliUtils.ts

@@ -39,7 +39,7 @@ import APIUtils from './apiUtils.js'
 export class CLIUtils {
     static automationFrameworkDetail = {}
     static testFrameworkDetail = {}
-    static CLISupportedFrameworks = ['mocha']
+    static CLISupportedFrameworks = ['mocha', 'cucumber']
 
     static isDevelopmentEnv() {
         return process.env.BROWSERSTACK_CLI_ENV === 'development'

packages/browserstack-service/src/cli/eventDispatcher.ts

@@ -1,3 +1,7 @@
+import util from 'node:util'
+
+import { BStackLogger } from './cliLogger.js'
+
 /**
  * EventDispatcher - Singleton class for event handling
  */
@@ -42,7 +46,14 @@ class EventDispatcher {
     async notifyObserver(event: string, args: unknown) {
         if (this.observers[event]) {
             for (const callback of this.observers[event]) {
-                await callback(args)
+                // Per-observer boundary. Without it one product module's failure aborts the loop,
+                // so every module registered after it silently stops receiving that state, and the
+                // exception escapes into whatever framework hook raised it.
+                try {
+                    await callback(args)
+                } catch (error) {
+                    BStackLogger.error(`notifyObserver: observer failed for ${event}, continuing: ${util.format(error)}`)
+                }
             }
             return
         }

packages/browserstack-service/src/cli/frameworks/constants/testFrameworkConstants.ts

@@ -29,6 +29,7 @@ export const TestFrameworkConstants = {
     KEY_EVENT_STARTED_AT : 'event_started_at',
     KEY_EVENT_ENDED_AT : 'event_ended_at',
     KEY_HOOK_ID : 'hook_id',
+    KEY_HOOK_STATE : 'hook_state',
     KEY_HOOK_RESULT : 'hook_result',
     KEY_HOOK_LOGS : 'hook_logs',
     KEY_HOOK_NAME : 'hook_name',

packages/browserstack-service/src/cli/index.ts

@@ -16,6 +16,8 @@ import { BROWSERSTACK_ACCESSIBILITY, BROWSERSTACK_OBSERVABILITY, BROWSERSTACK_TE
 import type { Options } from '@wdio/types'
 import TestOpsConfig from '../testOps/testOpsConfig.js'
 import WdioMochaTestFramework from './frameworks/wdioMochaTestFramework.js'
+import WdioCucumberTestFramework from './frameworks/wdioCucumberTestFramework.js'
+import type TestFramework from './frameworks/testFramework.js'
 import WdioAutomationFramework from './frameworks/wdioAutomationFramework.js'
 import WebdriverIOModule from './modules/webdriverIOModule.js'
 import AccessibilityModule from './modules/accessibilityModule.js'
@@ -44,7 +46,7 @@ export class BrowserstackCLI {
     isChildConnected = false
     binSessionId: string | null = null
     modules: Record<string, BaseModule> = {}
-    testFramework: WdioMochaTestFramework|null = null
+    testFramework: TestFramework|null = null
     cliParams: Record<string, string> | null = null
     automationFramework: WdioAutomationFramework|null = null
     SDK_CLI_BIN_PATH: string | null = null
@@ -134,7 +136,7 @@ export class BrowserstackCLI {
         this.setupAutomationFramework()
 
         this.modules[WebdriverIOModule.MODULE_NAME] = new WebdriverIOModule()
-        this.modules[AutomateModule.MODULE_NAME] = new AutomateModule(this.browserstackConfig as Options.Testrunner)
+        this.modules[AutomateModule.MODULE_NAME] = new AutomateModule(this.browserstackConfig as Options.Testrunner, this.options as Record<string, any>)
 
         if (startBinResponse.testhub) {
             this.logBuildStartErrors(startBinResponse.testhub)
@@ -488,8 +490,15 @@ export class BrowserstackCLI {
      */
     setupTestFramework() {
         const testFrameworkDetail = CLIUtils.getTestFrameworkDetail()
-        if (testFrameworkDetail.name.toLowerCase() === 'webdriverio-mocha') {
+        switch (testFrameworkDetail.name.toLowerCase()) {
+        case 'webdriverio-mocha':
             this.testFramework = new WdioMochaTestFramework([testFrameworkDetail.name], testFrameworkDetail.version, this.binSessionId as string)
+            break
+        case 'webdriverio-cucumber':
+            this.testFramework = new WdioCucumberTestFramework([testFrameworkDetail.name], testFrameworkDetail.version, this.binSessionId as string)
+            break
+        default:
+            this.logger.debug(`setupTestFramework: no CLI test framework for name=${testFrameworkDetail.name}`)
         }
     }
 

packages/browserstack-service/src/cli/modules/accessibilityModule.ts

@@ -203,7 +203,11 @@ export default class AccessibilityModule extends BaseModule {
 
             const sessionId = AutomationFramework.getState(autoInstance, AutomationFrameworkConstants.KEY_FRAMEWORK_SESSION_ID)
             const accessibilityOptions = this.config.accessibilityOptions
-            const shouldScanTest = this.autoScanning && shouldScanTestForAccessibility(suiteTitle, test.title, accessibilityOptions as { [key: string]: any } | undefined) && this.accessibility
+            // `world` is set only by service.beforeScenario, so this stays the 3-arg substring
+            // form for mocha. Without it a cucumber scenario has no test.title and the tag-aware
+            // branch is never entered, so include/excludeTagsInTestingScope are ignored (row 48).
+            const world = args.world
+            const shouldScanTest = this.autoScanning && shouldScanTestForAccessibility(suiteTitle, test.title, accessibilityOptions as { [key: string]: any } | undefined, world, Boolean(world)) && this.accessibility
 
             this.accessibilityMap.set(sessionId, shouldScanTest)
             // Create test metadata similar to accessibility-handler