@wdio/browserstack-service 8.0.11 → 8.1.0

package/build/types.d.ts

@@ -1,4 +1,5 @@
 import type { Capabilities, Options } from '@wdio/types';
+import type { Options as BSOptions } from 'browserstack-local';
 export interface SessionResponse {
     automation_session: {
         browser_url: string;
@@ -20,7 +21,26 @@ export interface App {
     app?: string;
     customId?: string;
 }
+export interface TestObservabilityOptions {
+    buildName?: string;
+    projectName?: string;
+    buildTag?: string[];
+    user?: string;
+    key?: string;
+}
 export interface BrowserstackConfig {
+    /**
+     * Set this to true to enable BrowserStack Test Observability which will collect test related data
+     * (name, hierarchy, status, error stack trace, file name and hierarchy), test commands, etc.
+     * and show all the data in a meaningful manner in BrowserStack Test Observability dashboards for faster test debugging and better insights.
+     * @default true
+     */
+    testObservability?: boolean;
+    /**
+     * Set the Test Observability related config options under this key.
+     * For e.g. buildName, projectName, BrowserStack access credentials, etc.
+     */
+    testObservabilityOptions?: TestObservabilityOptions;
     /**
      * Set this with app file path present locally on your device or
      * app hashed id returned after uploading app to BrowserStack or
@@ -54,7 +74,7 @@ export interface BrowserstackConfig {
      * ```
      * @default {}
      */
-    opts?: Partial<import('browserstack-local').Options>;
+    opts?: Partial<BSOptions>;
     /**
      * Cucumber only. Set the BrowserStack Automate session name to the Scenario name if only a single Scenario ran.
      * Useful when running in parallel with [wdio-cucumber-parallel-execution](https://github.com/SimitTomar/wdio-cucumber-parallel-execution).
@@ -87,4 +107,104 @@ export interface BrowserstackConfig {
      */
     setSessionStatus?: boolean;
 }
+/**
+ * Observability types
+ */
+export interface PlatformMeta {
+    sessionId?: string;
+    browserName?: string;
+    browserVersion?: string;
+    platformName?: string;
+    caps?: Capabilities.Capabilities;
+    product?: string;
+}
+export interface TestMeta {
+    uuid?: string;
+    startedAt?: string;
+    finishedAt?: string;
+    steps?: StepData[];
+    feature?: {
+        name: string;
+        path?: string;
+        description: string | null;
+    };
+    scenario?: {
+        name: string;
+    };
+    examples?: string[];
+}
+export interface TestData {
+    uuid?: string;
+    type?: string;
+    name?: string;
+    scope?: string;
+    scopes?: string[];
+    identifier?: string;
+    file_name?: string;
+    vc_filepath?: string;
+    location?: string;
+    started_at?: string;
+    finished_at?: string;
+    framework?: string;
+    body?: TestCodeBody;
+    result?: string;
+    failure?: Failure[];
+    failure_reason?: string;
+    failure_type?: string | null;
+    retries?: {
+        limit: number;
+        attempts: number;
+    };
+    duration_in_ms?: number;
+    integrations?: {
+        [index: string]: IntegrationObject;
+    };
+    hook_type?: string;
+    hooks?: string[];
+    meta?: TestMeta;
+    tags?: string[];
+}
+export interface UserConfig {
+    buildName?: string;
+    projectName?: string;
+    buildTag?: string;
+    bstackServiceVersion?: string;
+}
+export interface UploadType {
+    event_type: string;
+    hook_run?: TestData;
+    test_run?: TestData;
+    logs?: any[];
+}
+export interface LaunchResponse {
+    jwt: string;
+    build_hashed_id: string;
+    allow_screenshots?: boolean;
+}
+interface IntegrationObject {
+    capabilities?: Capabilities.Capabilities;
+    session_id?: string;
+    browser?: string;
+    browser_version?: string;
+    platform?: string;
+    product?: string;
+}
+interface TestCodeBody {
+    lang: string;
+    code?: string | null;
+}
+interface StepData {
+    id?: string;
+    text?: string;
+    keyword?: string;
+    started_at?: string;
+    finished_at?: string;
+    result?: string;
+    duration?: number;
+    failure?: string;
+}
+interface Failure {
+    backtrace: string[];
+}
+export {};
 //# sourceMappingURL=types.d.ts.map

package/build/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAExD,MAAM,WAAW,eAAe;IAE5B,kBAAkB,EAAE;QAEhB,WAAW,EAAE,MAAM,CAAA;KACtB,CAAA;CACJ;AAED,MAAM,MAAM,iBAAiB,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;AAE1F,MAAM,MAAM,SAAS,GAAG;IACpB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,MAAM,WAAW,iBAAiB;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,GAAG;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,kBAAkB;IAC/B;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC,OAAO,oBAAoB,EAAE,OAAO,CAAC,CAAA;IACpD;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,CAChB,MAAM,EAAE,OAAO,CAAC,UAAU,EAC1B,YAAY,EAAE,YAAY,CAAC,gBAAgB,EAC3C,UAAU,EAAE,MAAM,EAClB,SAAS,CAAC,EAAE,MAAM,KACjB,MAAM,CAAA;IACX;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;OAGG;IACH,oCAAoC,CAAC,EAAE,OAAO,CAAC;IAC/C;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC7B"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AACxD,OAAO,KAAK,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAE9D,MAAM,WAAW,eAAe;IAE5B,kBAAkB,EAAE;QAEhB,WAAW,EAAE,MAAM,CAAA;KACtB,CAAA;CACJ;AAED,MAAM,MAAM,iBAAiB,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;AAE1F,MAAM,MAAM,SAAS,GAAG;IACpB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,MAAM,WAAW,iBAAiB;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;CACxB;AAED,MAAM,WAAW,GAAG;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,wBAAwB;IACrC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,kBAAkB;IAC/B;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,wBAAwB,CAAC,EAAE,wBAAwB,CAAC;IACpD;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAA;IACzB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,CAChB,MAAM,EAAE,OAAO,CAAC,UAAU,EAC1B,YAAY,EAAE,YAAY,CAAC,gBAAgB,EAC3C,UAAU,EAAE,MAAM,EAClB,SAAS,CAAC,EAAE,MAAM,KACjB,MAAM,CAAA;IACX;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;OAGG;IACH,oCAAoC,CAAC,EAAE,OAAO,CAAC;IAC/C;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,YAAY,CAAC,YAAY,CAAC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,QAAQ;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IACtE,QAAQ,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CACtB;AAED,MAAM,WAAW,QAAQ;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,OAAO,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;IAC9C,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,iBAAiB,CAAA;KAAE,CAAC;IACtD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,MAAM,WAAW,UAAU;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oBAAoB,CAAC,EAAE,MAAM,CAAA;CAChC;AAED,MAAM,WAAW,UAAU;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;CACf;AAED,MAAM,WAAW,cAAc;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,eAAe,EAAE,MAAM,CAAC;IACxB,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAC9B;AAED,UAAU,iBAAiB;IACvB,YAAY,CAAC,EAAE,YAAY,CAAC,YAAY,CAAC;IACzC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,UAAU,YAAY;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACvB;AAED,UAAU,QAAQ;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,UAAU,OAAO;IACb,SAAS,EAAE,MAAM,EAAE,CAAA;CACtB"}

package/build/util.d.ts

@@ -1,5 +1,8 @@
 import type { Browser, MultiRemoteBrowser } from 'webdriverio';
-import type { Capabilities } from '@wdio/types';
+import type { Capabilities, Frameworks, Options } from '@wdio/types';
+import type { BeforeCommandArgs, AfterCommandArgs } from '@wdio/reporter';
+import type { UserConfig, UploadType, BrowserstackConfig } from './types.js';
+import type { ITestCaseHookParameter } from './cucumber-types.js';
 /**
  * get browser description for Browserstack service
  * @param cap browser capablities
@@ -18,4 +21,68 @@ export declare function getBrowserCapabilities(browser: Browser<'async'> | Multi
  */
 export declare function isBrowserstackCapability(cap?: Capabilities.Capabilities): boolean;
 export declare function getParentSuiteName(fullTitle: string, testSuiteTitle: string): string;
+export declare function launchTestSession(options: BrowserstackConfig & Options.Testrunner, config: Options.Testrunner, bsConfig: UserConfig): Promise<void>;
+export declare function stopBuildUpstream(): Promise<{
+    status: string;
+    message: any;
+} | undefined>;
+export declare function getCiInfo(): {
+    name: string;
+    build_url: string | undefined;
+    job_name: string | undefined;
+    build_number: string | undefined;
+} | {
+    name: string;
+    build_url: null;
+    job_name: null;
+    build_number: null;
+} | {
+    name: string;
+    build_url: string | undefined;
+    job_name: null;
+    build_number: string | undefined;
+} | null;
+export declare function getGitMetaData(): Promise<{
+    name: string;
+    sha: string;
+    short_sha: string;
+    branch: string;
+    tag: string | null;
+    committer: string;
+    committer_date: string;
+    author: string;
+    author_date: string;
+    commit_message: string;
+    root: string;
+    common_git_dir: string;
+    worktree_git_dir: string;
+    last_tag: string | null;
+    commits_since_last_tag: number;
+    remotes: {
+        name: string;
+        url: any;
+    }[];
+} | undefined>;
+export declare function getUniqueIdentifier(test: Frameworks.Test): string;
+export declare function getUniqueIdentifierForCucumber(world: ITestCaseHookParameter): string;
+export declare function getCloudProvider(browser: Browser<'async'> | MultiRemoteBrowser<'async'>): string;
+export declare function isBrowserstackSession(browser?: Browser<'async'> | MultiRemoteBrowser<'async'>): boolean | undefined;
+export declare function getScenarioExamples(world: ITestCaseHookParameter): string[] | undefined;
+export declare function removeAnsiColors(message: string): string;
+export declare function getLogTag(eventType: string): string;
+export declare function uploadEventData(eventData: UploadType | Array<UploadType>, eventUrl?: string): Promise<{
+    status: string;
+    message: string;
+} | undefined>;
+export declare function getHierarchy(fullTitle?: string): string[];
+export declare function getHookType(hookName: string): string;
+export declare function isScreenshotCommand(args: BeforeCommandArgs & AfterCommandArgs): boolean | "" | undefined;
+export declare function shouldAddServiceVersion(config: Options.Testrunner, testObservability?: boolean): boolean;
+export declare function batchAndPostEvents(eventUrl: string, kind: string, data: UploadType[]): Promise<void>;
+export declare function getObservabilityUser(options: BrowserstackConfig & Options.Testrunner, config: Options.Testrunner): string | undefined;
+export declare function getObservabilityKey(options: BrowserstackConfig & Options.Testrunner, config: Options.Testrunner): string | undefined;
+export declare function getObservabilityProject(options: BrowserstackConfig & Options.Testrunner, bstackProjectName?: string): string | undefined;
+export declare function getObservabilityBuild(options: BrowserstackConfig & Options.Testrunner, bstackBuildName?: string): string;
+export declare function getObservabilityBuildTags(options: BrowserstackConfig & Options.Testrunner, bstackBuildTag?: string): string[];
+export declare const sleep: (ms?: number) => Promise<unknown>;
 //# sourceMappingURL=util.d.ts.map

package/build/util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAI/C;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,YAAY,CAAC,mBAAmB,UAa1E;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,EAAE,YAAY,CAAC,gBAAgB,EAAE,WAAW,CAAC,EAAE,MAAM,6BASzJ;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,GAAG,CAAC,EAAE,YAAY,CAAC,YAAY,WAWvE;AAED,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,MAAM,CAUpF"}
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAC9D,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AACpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAQzE,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAkB,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAC5F,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAA;AAkBjE;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,YAAY,CAAC,mBAAmB,UAa1E;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,EAAE,YAAY,CAAC,gBAAgB,EAAE,WAAW,CAAC,EAAE,MAAM,6BASzJ;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,GAAG,CAAC,EAAE,YAAY,CAAC,YAAY,WAWvE;AAED,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,MAAM,CAUpF;AAED,wBAAsB,iBAAiB,CAAE,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,UAAU,EAAE,QAAQ,EAAE,UAAU,iBAiD1I;AAED,wBAAsB,iBAAiB;;;eAqCtC;AAED,wBAAgB,SAAS;;;;;;;;;;;;;;;SA8FxB;AAED,wBAAsB,cAAc;;;;;;;;;;;;;;;;;;;;eAyBnC;AAED,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,GAAG,MAAM,CAEjE;AAED,wBAAgB,8BAA8B,CAAC,KAAK,EAAE,sBAAsB,GAAG,MAAM,CAEpF;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC,GAAG,MAAM,CAKhG;AAED,wBAAgB,qBAAqB,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC,uBAE7F;AAED,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,sBAAsB,wBAsChE;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAIxD;AAED,wBAAgB,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAWnD;AAED,wBAAsB,eAAe,CAAE,SAAS,EAAE,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,EAAE,QAAQ,GAAE,MAA4B;;;eAuCvH;AAGD,wBAAgB,YAAY,CAAC,SAAS,CAAC,EAAE,MAAM,YAK9C;AAED,wBAAgB,WAAW,CAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAWrD;AAED,wBAAgB,mBAAmB,CAAE,IAAI,EAAE,iBAAiB,GAAG,gBAAgB,4BAE9E;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,OAAO,CAAC,UAAU,EAAE,iBAAiB,CAAC,EAAE,OAAO,GAAG,OAAO,CAKxG;AAED,wBAAsB,kBAAkB,CAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,iBAmB3F;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,UAAU,sBAQhH;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,UAAU,sBAQ/G;AAED,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,iBAAiB,CAAC,EAAE,MAAM,sBAQnH;AAED,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,eAAe,CAAC,EAAE,MAAM,UAQ/G;AAED,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAW7H;AAED,eAAO,MAAM,KAAK,mCAAkE,CAAA"}

package/build/util.js

@@ -1,4 +1,26 @@
-import { BROWSER_DESCRIPTION } from './constants.js';
+import { hostname, platform, type, version, arch } from 'node:os';
+import { promisify } from 'node:util';
+import http from 'node:http';
+import https from 'node:https';
+import path from 'node:path';
+import logger from '@wdio/logger';
+import got, { HTTPError } from 'got';
+import gitRepoInfo from 'git-repo-info';
+import gitconfig from 'gitconfiglocal';
+import { BROWSER_DESCRIPTION, DATA_ENDPOINT, DATA_EVENT_ENDPOINT, DATA_SCREENSHOT_ENDPOINT } from './constants.js';
+import RequestQueueHandler from './request-handler.js';
+const pGitconfig = promisify(gitconfig);
+const log = logger('@wdio/browserstack-service');
+const DEFAULT_REQUEST_CONFIG = {
+    agent: {
+        http: new http.Agent({ keepAlive: true }),
+        https: new https.Agent({ keepAlive: true }),
+    },
+    headers: {
+        'Content-Type': 'application/json',
+        'X-BSTACK-OBS': 'true'
+    },
+};
 /**
  * get browser description for Browserstack service
  * @param cap browser capablities
@@ -54,3 +76,421 @@ export function getParentSuiteName(fullTitle, testSuiteTitle) {
     }
     return parentSuiteName.trim();
 }
+export async function launchTestSession(options, config, bsConfig) {
+    const data = {
+        format: 'json',
+        project_name: getObservabilityProject(options, bsConfig.projectName),
+        name: getObservabilityBuild(options, bsConfig.buildName),
+        start_time: (new Date()).toISOString(),
+        tags: getObservabilityBuildTags(options, bsConfig.buildTag),
+        host_info: {
+            hostname: hostname(),
+            platform: platform(),
+            type: type(),
+            version: version(),
+            arch: arch()
+        },
+        ci_info: getCiInfo(),
+        build_run_identifier: process.env.BROWSERSTACK_BUILD_RUN_IDENTIFIER,
+        failed_tests_rerun: process.env.BROWSERSTACK_RERUN || false,
+        version_control: await getGitMetaData(),
+        observability_version: {
+            frameworkName: config.framework,
+            sdkVersion: bsConfig.bstackServiceVersion
+        }
+    };
+    try {
+        const url = `${DATA_ENDPOINT}/api/v1/builds`;
+        const response = await got.post(url, {
+            ...DEFAULT_REQUEST_CONFIG,
+            username: getObservabilityUser(options, config),
+            password: getObservabilityKey(options, config),
+            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;
+        }
+        if (response.allow_screenshots) {
+            process.env.BS_TESTOPS_ALLOW_SCREENSHOTS = response.allow_screenshots.toString();
+        }
+    }
+    catch (error) {
+        if (error instanceof HTTPError && error.response && error.response.statusCode === 401) {
+            log.debug('Data upload to BrowserStack Test Observability failed either due to incorrect credentials or an unsupported SDK version or because you do not have access to the product.');
+        }
+        else {
+            log.debug(`[Start_Build] Failed. Error: ${error}`);
+        }
+    }
+}
+export async function stopBuildUpstream() {
+    if (!process.env.BS_TESTOPS_BUILD_COMPLETED) {
+        return;
+    }
+    if (!process.env.BS_TESTOPS_JWT) {
+        log.debug('[STOP_BUILD] Missing Authentication Token/ Build ID');
+        return {
+            status: 'error',
+            message: 'Token/buildID is undefined, build creation might have failed'
+        };
+    }
+    const data = {
+        'stop_time': (new Date()).toISOString()
+    };
+    try {
+        const url = `${DATA_ENDPOINT}/api/v1/builds/${process.env.BS_TESTOPS_BUILD_HASHED_ID}/stop`;
+        const response = await got.put(url, {
+            agent: DEFAULT_REQUEST_CONFIG.agent,
+            headers: {
+                ...DEFAULT_REQUEST_CONFIG.headers,
+                'Authorization': `Bearer ${process.env.BS_TESTOPS_JWT}`
+            },
+            json: data
+        }).json();
+        log.debug(`[STOP_BUILD] Success response: ${JSON.stringify(response)}`);
+        return {
+            status: 'success',
+            message: ''
+        };
+    }
+    catch (error) {
+        log.debug(`[STOP_BUILD] Failed. Error: ${error}`);
+        return {
+            status: 'error',
+            message: error.message
+        };
+    }
+}
+export function getCiInfo() {
+    const env = process.env;
+    // Jenkins
+    if ((typeof env.JENKINS_URL === 'string' && env.JENKINS_URL.length > 0) || (typeof env.JENKINS_HOME === 'string' && env.JENKINS_HOME.length > 0)) {
+        return {
+            name: 'Jenkins',
+            build_url: env.BUILD_URL,
+            job_name: env.JOB_NAME,
+            build_number: env.BUILD_NUMBER
+        };
+    }
+    // CircleCI
+    if (env.CI === 'true' && env.CIRCLECI === 'true') {
+        return {
+            name: 'CircleCI',
+            build_url: env.CIRCLE_BUILD_URL,
+            job_name: env.CIRCLE_JOB,
+            build_number: env.CIRCLE_BUILD_NUM
+        };
+    }
+    // Travis CI
+    if (env.CI === 'true' && env.TRAVIS === 'true') {
+        return {
+            name: 'Travis CI',
+            build_url: env.TRAVIS_BUILD_WEB_URL,
+            job_name: env.TRAVIS_JOB_NAME,
+            build_number: env.TRAVIS_BUILD_NUMBER
+        };
+    }
+    // Codeship
+    if (env.CI === 'true' && env.CI_NAME === 'codeship') {
+        return {
+            name: 'Codeship',
+            build_url: null,
+            job_name: null,
+            build_number: null
+        };
+    }
+    // Bitbucket
+    if (env.BITBUCKET_BRANCH && env.BITBUCKET_COMMIT) {
+        return {
+            name: 'Bitbucket',
+            build_url: env.BITBUCKET_GIT_HTTP_ORIGIN,
+            job_name: null,
+            build_number: env.BITBUCKET_BUILD_NUMBER
+        };
+    }
+    // Drone
+    if (env.CI === 'true' && env.DRONE === 'true') {
+        return {
+            name: 'Drone',
+            build_url: env.DRONE_BUILD_LINK,
+            job_name: null,
+            build_number: env.DRONE_BUILD_NUMBER
+        };
+    }
+    // Semaphore
+    if (env.CI === 'true' && env.SEMAPHORE === 'true') {
+        return {
+            name: 'Semaphore',
+            build_url: env.SEMAPHORE_ORGANIZATION_URL,
+            job_name: env.SEMAPHORE_JOB_NAME,
+            build_number: env.SEMAPHORE_JOB_ID
+        };
+    }
+    // GitLab
+    if (env.CI === 'true' && env.GITLAB_CI === 'true') {
+        return {
+            name: 'GitLab',
+            build_url: env.CI_JOB_URL,
+            job_name: env.CI_JOB_NAME,
+            build_number: env.CI_JOB_ID
+        };
+    }
+    // Buildkite
+    if (env.CI === 'true' && env.BUILDKITE === 'true') {
+        return {
+            name: 'Buildkite',
+            build_url: env.BUILDKITE_BUILD_URL,
+            job_name: env.BUILDKITE_LABEL || env.BUILDKITE_PIPELINE_NAME,
+            build_number: env.BUILDKITE_BUILD_NUMBER
+        };
+    }
+    // Visual Studio Team Services
+    if (env.TF_BUILD === 'True') {
+        return {
+            name: 'Visual Studio Team Services',
+            build_url: `${env.SYSTEM_TEAMFOUNDATIONSERVERURI}${env.SYSTEM_TEAMPROJECTID}`,
+            job_name: env.SYSTEM_DEFINITIONID,
+            build_number: env.BUILD_BUILDID
+        };
+    }
+    // if no matches, return null
+    return null;
+}
+export async function getGitMetaData() {
+    const info = gitRepoInfo();
+    if (!info.commonGitDir) {
+        return;
+    }
+    const { remote } = await pGitconfig(info.commonGitDir);
+    const remotes = Object.keys(remote).map(remoteName => ({ name: remoteName, url: remote[remoteName].url }));
+    return {
+        name: 'git',
+        sha: info.sha,
+        short_sha: info.abbreviatedSha,
+        branch: info.branch,
+        tag: info.tag,
+        committer: info.committer,
+        committer_date: info.committerDate,
+        author: info.author,
+        author_date: info.authorDate,
+        commit_message: info.commitMessage,
+        root: info.root,
+        common_git_dir: info.commonGitDir,
+        worktree_git_dir: info.worktreeGitDir,
+        last_tag: info.lastTag,
+        commits_since_last_tag: info.commitsSinceLastTag,
+        remotes: remotes
+    };
+}
+export function getUniqueIdentifier(test) {
+    return `${test.parent} - ${test.title}`;
+}
+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')) {
+        return 'browserstack';
+    }
+    return 'unknown_grid';
+}
+export function isBrowserstackSession(browser) {
+    return browser && getCloudProvider(browser).toLowerCase() === 'browserstack';
+}
+export function getScenarioExamples(world) {
+    const scenario = world.pickle;
+    // no examples present
+    if ((scenario.astNodeIds && scenario.astNodeIds.length <= 1) || scenario.astNodeIds === undefined) {
+        return;
+    }
+    const pickleId = scenario.astNodeIds[0];
+    const examplesId = scenario.astNodeIds[1];
+    const gherkinDocumentChildren = world.gherkinDocument.feature?.children;
+    let examples = [];
+    gherkinDocumentChildren?.forEach(child => {
+        if (child.rule) {
+            // handle if rule is present
+            child.rule.children.forEach(childLevel2 => {
+                if (childLevel2.scenario && childLevel2.scenario.id === pickleId && childLevel2.scenario.examples) {
+                    const passedExamples = childLevel2.scenario.examples.flatMap((val) => (val.tableBody)).find((item) => item.id === examplesId)?.cells.map((val) => (val.value));
+                    if (passedExamples) {
+                        examples = passedExamples;
+                    }
+                }
+            });
+        }
+        else if (child.scenario && child.scenario.id === pickleId && child.scenario.examples) {
+            // handle if scenario outside rule
+            const passedExamples = child.scenario.examples.flatMap((val) => (val.tableBody)).find((item) => item.id === examplesId)?.cells.map((val) => (val.value));
+            if (passedExamples) {
+                examples = passedExamples;
+            }
+        }
+    });
+    if (examples.length) {
+        return examples;
+    }
+    return;
+}
+export function removeAnsiColors(message) {
+    // https://stackoverflow.com/a/29497680
+    // eslint-disable-next-line no-control-regex
+    return message.replace(/[\u001b\u009b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g, '');
+}
+export function getLogTag(eventType) {
+    if (eventType === 'TestRunStarted' || eventType === 'TestRunFinished') {
+        return 'Test_Upload';
+    }
+    else if (eventType === 'HookRunStarted' || eventType === 'HookRunFinished') {
+        return 'Hook_Upload';
+    }
+    else if (eventType === 'ScreenshotCreated') {
+        return 'Screenshot_Upload';
+    }
+    else if (eventType === 'LogCreated') {
+        return 'Log_Upload';
+    }
+    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) {
+        log.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();
+        log.debug(`[${logTag}] Success response: ${JSON.stringify(data)}`);
+        RequestQueueHandler.getInstance().pendingUploads -= 1;
+    }
+    catch (error) {
+        log.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) {
+        return [];
+    }
+    return fullTitle.split('.').slice(0, -1);
+}
+export function getHookType(hookName) {
+    if (hookName.includes('before each')) {
+        return 'BEFORE_EACH';
+    }
+    else if (hookName.includes('before all')) {
+        return 'BEFORE_ALL';
+    }
+    else if (hookName.includes('after each')) {
+        return 'AFTER_EACH';
+    }
+    else if (hookName.includes('after all')) {
+        return 'AFTER_ALL';
+    }
+    return 'unknown';
+}
+export function isScreenshotCommand(args) {
+    return args.endpoint && args.endpoint.includes('/screenshot');
+}
+export function shouldAddServiceVersion(config, testObservability) {
+    if (config.services && config.services.toString().includes('chromedriver') && testObservability !== false) {
+        return false;
+    }
+    return true;
+}
+export async function batchAndPostEvents(eventUrl, kind, data) {
+    if (!process.env.BS_TESTOPS_BUILD_COMPLETED || !process.env.BS_TESTOPS_JWT) {
+        return;
+    }
+    try {
+        const url = `${DATA_ENDPOINT}/${eventUrl}`;
+        const response = await got.post(url, {
+            agent: DEFAULT_REQUEST_CONFIG.agent,
+            headers: {
+                ...DEFAULT_REQUEST_CONFIG.headers,
+                'Authorization': `Bearer ${process.env.BS_TESTOPS_JWT}`
+            },
+            json: data
+        }).json();
+        log.debug(`[${kind}] Success response: ${JSON.stringify(response)}`);
+    }
+    catch (error) {
+        log.debug(`[${kind}] EXCEPTION IN ${kind} REQUEST TO TEST OBSERVABILITY : ${error}`);
+    }
+}
+export function getObservabilityUser(options, config) {
+    if (process.env.BROWSERSTACK_USERNAME) {
+        return process.env.BROWSERSTACK_USERNAME;
+    }
+    if (options.testObservabilityOptions && options.testObservabilityOptions.user) {
+        return options.testObservabilityOptions.user;
+    }
+    return config.user;
+}
+export function getObservabilityKey(options, config) {
+    if (process.env.BROWSERSTACK_ACCESS_KEY) {
+        return process.env.BROWSERSTACK_ACCESS_KEY;
+    }
+    if (options.testObservabilityOptions && options.testObservabilityOptions.key) {
+        return options.testObservabilityOptions.key;
+    }
+    return config.key;
+}
+export function getObservabilityProject(options, bstackProjectName) {
+    if (process.env.TEST_OBSERVABILITY_PROJECT_NAME) {
+        return process.env.TEST_OBSERVABILITY_PROJECT_NAME;
+    }
+    if (options.testObservabilityOptions && options.testObservabilityOptions.projectName) {
+        return options.testObservabilityOptions.projectName;
+    }
+    return bstackProjectName;
+}
+export function getObservabilityBuild(options, bstackBuildName) {
+    if (process.env.TEST_OBSERVABILITY_BUILD_NAME) {
+        return process.env.TEST_OBSERVABILITY_BUILD_NAME;
+    }
+    if (options.testObservabilityOptions && options.testObservabilityOptions.buildName) {
+        return options.testObservabilityOptions.buildName;
+    }
+    return bstackBuildName || path.basename(path.resolve(process.cwd()));
+}
+export function getObservabilityBuildTags(options, bstackBuildTag) {
+    if (process.env.TEST_OBSERVABILITY_BUILD_TAG) {
+        return process.env.TEST_OBSERVABILITY_BUILD_TAG.split(',');
+    }
+    if (options.testObservabilityOptions && options.testObservabilityOptions.buildTag) {
+        return options.testObservabilityOptions.buildTag;
+    }
+    if (bstackBuildTag) {
+        return [bstackBuildTag];
+    }
+    return [];
+}
+export const sleep = (ms = 100) => new Promise((resolve) => setTimeout(resolve, ms));