@wdio/browserstack-service 8.0.14 → 8.1.1

package/build/constants.d.ts

@@ -1,5 +1,14 @@
-import type { BrowserstackConfig } from './types';
+import type { BrowserstackConfig } from './types.js';
 export declare const BROWSER_DESCRIPTION: readonly ["device", "os", "osVersion", "os_version", "browserName", "browser", "browserVersion", "browser_version"];
 export declare const VALID_APP_EXTENSION: string[];
 export declare const DEFAULT_OPTIONS: Partial<BrowserstackConfig>;
+export declare const DATA_ENDPOINT = "https://collector-observability.browserstack.com";
+export declare const DATA_EVENT_ENDPOINT = "api/v1/event";
+export declare const DATA_BATCH_ENDPOINT = "api/v1/batch";
+export declare const DATA_SCREENSHOT_ENDPOINT = "api/v1/screenshots";
+export declare const DATA_BATCH_SIZE = 1000;
+export declare const DATA_BATCH_INTERVAL = 2000;
+export declare const BATCH_EVENT_TYPES: string[];
+export declare const DEFAULT_WAIT_TIMEOUT_FOR_PENDING_UPLOADS = 5000;
+export declare const DEFAULT_WAIT_INTERVAL_FOR_PENDING_UPLOADS = 100;
 //# sourceMappingURL=constants.d.ts.map

package/build/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAEjD,eAAO,MAAM,mBAAmB,qHAStB,CAAA;AAEV,eAAO,MAAM,mBAAmB,UAI/B,CAAA;AAED,eAAO,MAAM,eAAe,EAAE,OAAO,CAAC,kBAAkB,CAGvD,CAAA"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAEpD,eAAO,MAAM,mBAAmB,qHAStB,CAAA;AAEV,eAAO,MAAM,mBAAmB,UAI/B,CAAA;AAED,eAAO,MAAM,eAAe,EAAE,OAAO,CAAC,kBAAkB,CAIvD,CAAA;AAED,eAAO,MAAM,aAAa,qDAAqD,CAAA;AAC/E,eAAO,MAAM,mBAAmB,iBAAiB,CAAA;AACjD,eAAO,MAAM,mBAAmB,iBAAiB,CAAA;AACjD,eAAO,MAAM,wBAAwB,uBAAuB,CAAA;AAC5D,eAAO,MAAM,eAAe,OAAO,CAAA;AACnC,eAAO,MAAM,mBAAmB,OAAO,CAAA;AACvC,eAAO,MAAM,iBAAiB,UAAgH,CAAA;AAC9I,eAAO,MAAM,wCAAwC,OAAO,CAAA;AAC5D,eAAO,MAAM,yCAAyC,MAAM,CAAA"}

package/build/constants.js

@@ -15,5 +15,15 @@ export const VALID_APP_EXTENSION = [
 ];
 export const DEFAULT_OPTIONS = {
     setSessionName: true,
-    setSessionStatus: true
+    setSessionStatus: true,
+    testObservability: true
 };
+export const DATA_ENDPOINT = 'https://collector-observability.browserstack.com';
+export const DATA_EVENT_ENDPOINT = 'api/v1/event';
+export const DATA_BATCH_ENDPOINT = 'api/v1/batch';
+export const DATA_SCREENSHOT_ENDPOINT = 'api/v1/screenshots';
+export const DATA_BATCH_SIZE = 1000;
+export const DATA_BATCH_INTERVAL = 2000;
+export const BATCH_EVENT_TYPES = ['LogCreated', 'TestRunStarted', 'TestRunFinished', 'HookRunFinished', 'HookRunStarted', 'ScreenshotCreated'];
+export const DEFAULT_WAIT_TIMEOUT_FOR_PENDING_UPLOADS = 5000; // 5s
+export const DEFAULT_WAIT_INTERVAL_FOR_PENDING_UPLOADS = 100; // 100ms

package/build/cucumber-types.d.ts

@@ -0,0 +1,177 @@
+export interface ITestCaseHookParameter {
+    gherkinDocument: GherkinDocument;
+    pickle: Pickle;
+    result?: TestStepResult;
+    willBeRetried?: boolean;
+    testCaseStartedId: string;
+}
+export declare class Duration {
+    seconds: number;
+    nanos: number;
+}
+export declare class GherkinDocument {
+    uri?: string;
+    feature?: Feature;
+    comments: readonly Comment[];
+}
+export declare class Background {
+    location: Location;
+    keyword: string;
+    name: string;
+    description: string;
+    steps: readonly Step[];
+    id: string;
+}
+export declare class DataTable {
+    location: Location;
+    rows: readonly TableRow[];
+}
+export declare class DocString {
+    location: Location;
+    mediaType?: string;
+    content: string;
+    delimiter: string;
+}
+export declare class Examples {
+    location: Location;
+    tags: readonly Tag[];
+    keyword: string;
+    name: string;
+    description: string;
+    tableHeader?: TableRow;
+    tableBody: readonly TableRow[];
+    id: string;
+}
+export declare class Feature {
+    location: Location;
+    tags: readonly Tag[];
+    language: string;
+    keyword: string;
+    name: string;
+    description: string;
+    children: readonly FeatureChild[];
+}
+export declare class FeatureChild {
+    rule?: Rule;
+    background?: Background;
+    scenario?: Scenario;
+}
+export declare class Rule {
+    location: Location;
+    tags: readonly Tag[];
+    keyword: string;
+    name: string;
+    description: string;
+    children: readonly RuleChild[];
+    id: string;
+}
+export declare class RuleChild {
+    background?: Background;
+    scenario?: Scenario;
+}
+export declare class Scenario {
+    location: Location;
+    tags: readonly Tag[];
+    keyword: string;
+    name: string;
+    description: string;
+    steps: readonly Step[];
+    examples: readonly Examples[];
+    id: string;
+}
+export declare class Step {
+    location: Location;
+    keyword: string;
+    keywordType?: StepKeywordType;
+    text: string;
+    docString?: DocString;
+    dataTable?: DataTable;
+    id: string;
+}
+export declare class TableCell {
+    location: Location;
+    value: string;
+}
+export declare class TableRow {
+    location: Location;
+    cells: readonly TableCell[];
+    id: string;
+}
+export declare class Tag {
+    location: Location;
+    name: string;
+    id: string;
+}
+export declare class Pickle {
+    id: string;
+    uri: string;
+    name: string;
+    language: string;
+    steps: readonly PickleStep[];
+    tags: readonly PickleTag[];
+    astNodeIds: readonly string[];
+}
+export declare class PickleDocString {
+    mediaType?: string;
+    content: string;
+}
+export declare class PickleStep {
+    argument?: PickleStepArgument;
+    astNodeIds: readonly string[];
+    id: string;
+    type?: PickleStepType;
+    text: string;
+}
+export declare class PickleStepArgument {
+    docString?: PickleDocString;
+    dataTable?: PickleTable;
+}
+export declare class PickleTable {
+    rows: readonly PickleTableRow[];
+}
+export declare class PickleTableCell {
+    value: string;
+}
+export declare class PickleTableRow {
+    cells: readonly PickleTableCell[];
+}
+export declare class PickleTag {
+    name: string;
+    astNodeId: string;
+}
+export declare class TestStepResult {
+    duration: Duration;
+    message?: string;
+    status: TestStepResultStatus;
+}
+export declare enum PickleStepType {
+    UNKNOWN = "Unknown",
+    CONTEXT = "Context",
+    ACTION = "Action",
+    OUTCOME = "Outcome"
+}
+export declare enum StepKeywordType {
+    UNKNOWN = "Unknown",
+    CONTEXT = "Context",
+    ACTION = "Action",
+    OUTCOME = "Outcome",
+    CONJUNCTION = "Conjunction"
+}
+export declare enum TestStepResultStatus {
+    UNKNOWN = "UNKNOWN",
+    PASSED = "PASSED",
+    SKIPPED = "SKIPPED",
+    PENDING = "PENDING",
+    UNDEFINED = "UNDEFINED",
+    AMBIGUOUS = "AMBIGUOUS",
+    FAILED = "FAILED"
+}
+export declare class Location {
+    line: number;
+    column?: number;
+}
+export declare class Comment {
+    location: Location;
+    text: string;
+}
+//# sourceMappingURL=cucumber-types.d.ts.map

package/build/cucumber-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cucumber-types.d.ts","sourceRoot":"","sources":["../src/cucumber-types.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,sBAAsB;IACnC,eAAe,EAAE,eAAe,CAAC;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,iBAAiB,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,CAAC,OAAO,OAAO,QAAQ;IACzB,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,CAAC,OAAO,OAAO,eAAe;IAChC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,QAAQ,EAAE,SAAS,OAAO,EAAE,CAAA;CAC/B;AAED,MAAM,CAAC,OAAO,OAAO,UAAU;IAC3B,QAAQ,EAAE,QAAQ,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,SAAS,IAAI,EAAE,CAAA;IACtB,EAAE,EAAE,MAAM,CAAA;CACb;AAED,MAAM,CAAC,OAAO,OAAO,SAAS;IAC1B,QAAQ,EAAE,QAAQ,CAAA;IAClB,IAAI,EAAE,SAAS,QAAQ,EAAE,CAAA;CAC5B;AAED,MAAM,CAAC,OAAO,OAAO,SAAS;IAC1B,QAAQ,EAAE,QAAQ,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,CAAC,OAAO,OAAO,QAAQ;IACzB,QAAQ,EAAE,QAAQ,CAAA;IAClB,IAAI,EAAE,SAAS,GAAG,EAAE,CAAA;IACpB,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,CAAC,EAAE,QAAQ,CAAA;IACtB,SAAS,EAAE,SAAS,QAAQ,EAAE,CAAA;IAC9B,EAAE,EAAE,MAAM,CAAA;CACb;AAED,MAAM,CAAC,OAAO,OAAO,OAAO;IACxB,QAAQ,EAAE,QAAQ,CAAA;IAClB,IAAI,EAAE,SAAS,GAAG,EAAE,CAAA;IACpB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,SAAS,YAAY,EAAE,CAAA;CACpC;AAED,MAAM,CAAC,OAAO,OAAO,YAAY;IAC7B,IAAI,CAAC,EAAE,IAAI,CAAA;IACX,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,QAAQ,CAAC,EAAE,QAAQ,CAAA;CACtB;AAED,MAAM,CAAC,OAAO,OAAO,IAAI;IACrB,QAAQ,EAAE,QAAQ,CAAA;IAClB,IAAI,EAAE,SAAS,GAAG,EAAE,CAAA;IACpB,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,SAAS,SAAS,EAAE,CAAA;IAC9B,EAAE,EAAE,MAAM,CAAA;CACb;AAED,MAAM,CAAC,OAAO,OAAO,SAAS;IAC1B,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,QAAQ,CAAC,EAAE,QAAQ,CAAA;CACtB;AAED,MAAM,CAAC,OAAO,OAAO,QAAQ;IACzB,QAAQ,EAAE,QAAQ,CAAA;IAClB,IAAI,EAAE,SAAS,GAAG,EAAE,CAAA;IACpB,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,SAAS,IAAI,EAAE,CAAA;IACtB,QAAQ,EAAE,SAAS,QAAQ,EAAE,CAAA;IAC7B,EAAE,EAAE,MAAM,CAAA;CACb;AAED,MAAM,CAAC,OAAO,OAAO,IAAI;IACrB,QAAQ,EAAE,QAAQ,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,eAAe,CAAA;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,CAAC,EAAE,SAAS,CAAA;IACrB,SAAS,CAAC,EAAE,SAAS,CAAA;IACrB,EAAE,EAAE,MAAM,CAAA;CACb;AAED,MAAM,CAAC,OAAO,OAAO,SAAS;IAC1B,QAAQ,EAAE,QAAQ,CAAA;IAClB,KAAK,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,CAAC,OAAO,OAAO,QAAQ;IACzB,QAAQ,EAAE,QAAQ,CAAA;IAClB,KAAK,EAAE,SAAS,SAAS,EAAE,CAAA;IAC3B,EAAE,EAAE,MAAM,CAAA;CACb;AAED,MAAM,CAAC,OAAO,OAAO,GAAG;IACpB,QAAQ,EAAE,QAAQ,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;CACb;AAED,MAAM,CAAC,OAAO,OAAO,MAAM;IACvB,EAAE,EAAE,MAAM,CAAA;IACV,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,SAAS,UAAU,EAAE,CAAA;IAC5B,IAAI,EAAE,SAAS,SAAS,EAAE,CAAA;IAC1B,UAAU,EAAE,SAAS,MAAM,EAAE,CAAA;CAChC;AAED,MAAM,CAAC,OAAO,OAAO,eAAe;IAChC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,CAAC,OAAO,OAAO,UAAU;IAC3B,QAAQ,CAAC,EAAE,kBAAkB,CAAA;IAC7B,UAAU,EAAE,SAAS,MAAM,EAAE,CAAA;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,CAAC,EAAE,cAAc,CAAA;IACrB,IAAI,EAAE,MAAM,CAAA;CACf;AAED,MAAM,CAAC,OAAO,OAAO,kBAAkB;IACnC,SAAS,CAAC,EAAE,eAAe,CAAA;IAC3B,SAAS,CAAC,EAAE,WAAW,CAAA;CAC1B;AAED,MAAM,CAAC,OAAO,OAAO,WAAW;IAC5B,IAAI,EAAE,SAAS,cAAc,EAAE,CAAA;CAClC;AAED,MAAM,CAAC,OAAO,OAAO,eAAe;IAChC,KAAK,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,CAAC,OAAO,OAAO,cAAc;IAC/B,KAAK,EAAE,SAAS,eAAe,EAAE,CAAA;CACpC;AAED,MAAM,CAAC,OAAO,OAAO,SAAS;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,CAAC,OAAO,OAAO,cAAc;IAC/B,QAAQ,EAAE,QAAQ,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,oBAAoB,CAAA;CAC/B;AAED,MAAM,CAAC,OAAO,MAAM,cAAc;IAC9B,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,OAAO,YAAY;CACtB;AAED,MAAM,CAAC,OAAO,MAAM,eAAe;IAC/B,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,WAAW,gBAAgB;CAC9B;AAED,MAAM,CAAC,OAAO,MAAM,oBAAoB;IACpC,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,SAAS,cAAc;IACvB,MAAM,WAAW;CACpB;AAED,MAAM,CAAC,OAAO,OAAO,QAAQ;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,CAAC,OAAO,OAAO,OAAO;IACxB,QAAQ,EAAE,QAAQ,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;CACf"}

package/build/cucumber-types.js

@@ -0,0 +1,2 @@
+// mimic types from @cucumber/@cucumber such that users don't install that dependency when not needed
+export {};

package/build/index.d.ts

@@ -1,6 +1,6 @@
 import BrowserstackLauncher from './launcher.js';
 import BrowserstackService from './service.js';
-import type { BrowserstackConfig } from './types';
+import type { BrowserstackConfig } from './types.js';
 export default BrowserstackService;
 export declare const launcher: typeof BrowserstackLauncher;
 export * from './types.js';

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,oBAAoB,MAAM,eAAe,CAAA;AAChD,OAAO,mBAAmB,MAAM,cAAc,CAAA;AAC9C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAEjD,eAAe,mBAAmB,CAAA;AAClC,eAAO,MAAM,QAAQ,6BAAuB,CAAA;AAC5C,cAAc,YAAY,CAAA;AAE1B,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,WAAW,CAAC;QAClB,UAAU,aAAc,SAAQ,kBAAkB;SAAG;KACxD;CACJ"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,oBAAoB,MAAM,eAAe,CAAA;AAChD,OAAO,mBAAmB,MAAM,cAAc,CAAA;AAC9C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAEpD,eAAe,mBAAmB,CAAA;AAClC,eAAO,MAAM,QAAQ,6BAAuB,CAAA;AAC5C,cAAc,YAAY,CAAA;AAE1B,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,WAAW,CAAC;QAClB,UAAU,aAAc,SAAQ,kBAAkB;SAAG;KACxD;CACJ"}

package/build/insights-handler.d.ts

@@ -0,0 +1,40 @@
+import type { Capabilities, Frameworks } from '@wdio/types';
+import type { Browser, MultiRemoteBrowser } from 'webdriverio';
+import type { BeforeCommandArgs, AfterCommandArgs } from '@wdio/reporter';
+import type { Pickle, ITestCaseHookParameter } from './cucumber-types.js';
+export default class InsightsHandler {
+    private _browser;
+    private _framework?;
+    private _tests;
+    private _hooks;
+    private _platformMeta;
+    private _commands;
+    private _gitConfigPath?;
+    private _requestQueueHandler;
+    constructor(_browser: Browser<'async'> | MultiRemoteBrowser<'async'>, browserCaps?: Capabilities.Capabilities, isAppAutomate?: boolean, sessionId?: string, _framework?: string | undefined);
+    before(): Promise<void>;
+    beforeHook(test: Frameworks.Test, context: any): Promise<void>;
+    afterHook(test: Frameworks.Test, result: Frameworks.TestResult): Promise<void>;
+    beforeTest(test: Frameworks.Test): Promise<void>;
+    afterTest(test: Frameworks.Test, result: Frameworks.TestResult): Promise<void>;
+    /**
+      * Cucumber Only
+      */
+    beforeScenario(world: ITestCaseHookParameter): Promise<void>;
+    afterScenario(world: ITestCaseHookParameter): Promise<void>;
+    beforeStep(step: Frameworks.PickleStep, scenario: Pickle): Promise<void>;
+    afterStep(step: Frameworks.PickleStep, scenario: Pickle, result: Frameworks.PickleResult): Promise<void>;
+    uploadPending(waitTimeout?: number, waitInterval?: number): Promise<unknown>;
+    teardown(): Promise<void>;
+    /**
+     * misc methods
+     */
+    browserCommand(commandType: string, args: BeforeCommandArgs & AfterCommandArgs, test?: Frameworks.Test | ITestCaseHookParameter): Promise<void>;
+    private attachHookData;
+    private getHierarchy;
+    private sendTestRunEvent;
+    private sendTestRunEventForCucumber;
+    private getIntegrationsObject;
+    private getIdentifier;
+}
+//# sourceMappingURL=insights-handler.d.ts.map

package/build/insights-handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"insights-handler.d.ts","sourceRoot":"","sources":["../src/insights-handler.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC3D,OAAO,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAC9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAGzE,OAAO,KAAK,EAAE,MAAM,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAA;AAOzE,MAAM,CAAC,OAAO,OAAO,eAAe;IASnB,OAAO,CAAC,QAAQ;IAAwI,OAAO,CAAC,UAAU,CAAC;IAPxL,OAAO,CAAC,MAAM,CAA+B;IAC7C,OAAO,CAAC,MAAM,CAA+B;IAC7C,OAAO,CAAC,aAAa,CAAc;IACnC,OAAO,CAAC,SAAS,CAA2D;IAC5E,OAAO,CAAC,cAAc,CAAC,CAAQ;IAC/B,OAAO,CAAC,oBAAoB,CAAoC;gBAE3C,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC,EAAE,YAAY,CAAC,YAAY,EAAE,aAAa,CAAC,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,MAAM,EAAU,UAAU,CAAC,oBAAQ;IAa1L,MAAM;IAkBN,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG;IAa/C,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,UAAU;IAc/D,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI;IASjC,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,UAAU;IASrE;;QAEI;IAEE,cAAc,CAAE,KAAK,EAAE,sBAAsB;IA4B7C,aAAa,CAAE,KAAK,EAAE,sBAAsB;IAI5C,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM;IAkBzD,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,YAAY;IA0BzF,aAAa,CACf,WAAW,SAA2C,EACtD,YAAY,SAA4C,GACzD,OAAO,CAAC,OAAO,CAAC;IASb,QAAQ;IAId;;OAEG;IACG,cAAc,CAAE,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,GAAG,gBAAgB,EAAE,IAAI,CAAC,EAAE,UAAU,CAAC,IAAI,GAAG,sBAAsB;IAoDtI,OAAO,CAAC,cAAc;IActB,OAAO,CAAC,YAAY;YAYN,gBAAgB;YAsEhB,2BAA2B;IAmFzC,OAAO,CAAC,qBAAqB;IAW7B,OAAO,CAAC,aAAa;CAMxB"}

package/build/insights-handler.js

@@ -0,0 +1,389 @@
+import path from 'node:path';
+import { v4 as uuidv4 } from 'uuid';
+import { getCloudProvider, getGitMetaData, getHookType, getScenarioExamples, getUniqueIdentifier, getUniqueIdentifierForCucumber, isBrowserstackSession, isScreenshotCommand, removeAnsiColors, sleep, uploadEventData } from './util.js';
+import RequestQueueHandler from './request-handler.js';
+import { DATA_SCREENSHOT_ENDPOINT, DEFAULT_WAIT_INTERVAL_FOR_PENDING_UPLOADS, DEFAULT_WAIT_TIMEOUT_FOR_PENDING_UPLOADS } from './constants.js';
+export default class InsightsHandler {
+    _browser;
+    _framework;
+    _tests = {};
+    _hooks = {};
+    _platformMeta;
+    _commands = {};
+    _gitConfigPath;
+    _requestQueueHandler = RequestQueueHandler.getInstance();
+    constructor(_browser, browserCaps, isAppAutomate, sessionId, _framework) {
+        this._browser = _browser;
+        this._framework = _framework;
+        this._requestQueueHandler.start();
+        this._platformMeta = {
+            browserName: browserCaps?.browserName,
+            browserVersion: browserCaps?.browserVersion,
+            platformName: browserCaps?.platformName,
+            caps: browserCaps,
+            sessionId: sessionId,
+            product: isAppAutomate ? 'app-automate' : 'automate'
+        };
+    }
+    async before() {
+        if (isBrowserstackSession(this._browser)) {
+            // await this._browser.execute(`browserstack_executor: {"action": "annotate", "arguments": {"data": "ObservabilitySync:${Date.now()}","level": "debug"}}`)
+            await this._browser.execute(`browserstack_executor: ${JSON.stringify({
+                action: 'annotate',
+                arguments: {
+                    data: `ObservabilitySync:${Date.now()}`,
+                    level: 'debug'
+                }
+            })}`);
+        }
+        const gitMeta = await getGitMetaData();
+        if (gitMeta) {
+            this._gitConfigPath = gitMeta.root;
+        }
+    }
+    async beforeHook(test, context) {
+        const fullTitle = `${test.parent} - ${test.title}`;
+        const hookId = uuidv4();
+        this._tests[fullTitle] = {
+            uuid: hookId,
+            startedAt: (new Date()).toISOString()
+        };
+        this.attachHookData(context, hookId);
+        if (this._framework === 'mocha') {
+            await this.sendTestRunEvent(test, 'HookRunStarted');
+        }
+    }
+    async afterHook(test, result) {
+        const fullTitle = getUniqueIdentifier(test);
+        if (this._tests[fullTitle]) {
+            this._tests[fullTitle].finishedAt = (new Date()).toISOString();
+        }
+        else {
+            this._tests[fullTitle] = {
+                finishedAt: (new Date()).toISOString()
+            };
+        }
+        if (this._framework === 'mocha') {
+            await this.sendTestRunEvent(test, 'HookRunFinished', result);
+        }
+    }
+    async beforeTest(test) {
+        const fullTitle = getUniqueIdentifier(test);
+        this._tests[fullTitle] = {
+            uuid: uuidv4(),
+            startedAt: (new Date()).toISOString()
+        };
+        await this.sendTestRunEvent(test, 'TestRunStarted');
+    }
+    async afterTest(test, result) {
+        const fullTitle = getUniqueIdentifier(test);
+        this._tests[fullTitle] = {
+            ...(this._tests[fullTitle] || {}),
+            finishedAt: (new Date()).toISOString()
+        };
+        await this.sendTestRunEvent(test, 'TestRunFinished', result);
+    }
+    /**
+      * Cucumber Only
+      */
+    async beforeScenario(world) {
+        const pickleData = world.pickle;
+        const gherkinDocument = world.gherkinDocument;
+        const featureData = gherkinDocument.feature;
+        const uniqueId = getUniqueIdentifierForCucumber(world);
+        const testMetaData = {
+            uuid: uuidv4(),
+            startedAt: (new Date()).toISOString()
+        };
+        if (pickleData) {
+            testMetaData.scenario = {
+                name: pickleData.name,
+            };
+        }
+        if (gherkinDocument && featureData) {
+            testMetaData.feature = {
+                path: gherkinDocument.uri,
+                name: featureData.name,
+                description: featureData.description,
+            };
+        }
+        this._tests[uniqueId] = testMetaData;
+        await this.sendTestRunEventForCucumber(world, 'TestRunStarted');
+    }
+    async afterScenario(world) {
+        await this.sendTestRunEventForCucumber(world, 'TestRunFinished');
+    }
+    async beforeStep(step, scenario) {
+        const uniqueId = getUniqueIdentifierForCucumber({ pickle: scenario });
+        const testMetaData = this._tests[uniqueId] || { steps: [] };
+        if (testMetaData && !testMetaData.steps) {
+            testMetaData.steps = [];
+        }
+        testMetaData.steps?.push({
+            id: step.id,
+            text: step.text,
+            keyword: step.keyword,
+            started_at: (new Date()).toISOString()
+        });
+        this._tests[uniqueId] = testMetaData;
+    }
+    async afterStep(step, scenario, result) {
+        const uniqueId = getUniqueIdentifierForCucumber({ pickle: scenario });
+        const testMetaData = this._tests[uniqueId] || { steps: [] };
+        if (!testMetaData.steps) {
+            testMetaData.steps = [{
+                    id: step.id,
+                    text: step.text,
+                    keyword: step.keyword,
+                    finished_at: (new Date()).toISOString(),
+                    result: result.passed ? 'PASSED' : 'FAILED',
+                    duration: result.duration,
+                    failure: result.error ? removeAnsiColors(result.error) : result.error
+                }];
+        }
+        const stepDetails = testMetaData.steps?.find(item => item.id === step.id);
+        if (stepDetails) {
+            stepDetails.finished_at = (new Date()).toISOString();
+            stepDetails.result = result.passed ? 'PASSED' : 'FAILED';
+            stepDetails.duration = result.duration;
+            stepDetails.failure = result.error ? removeAnsiColors(result.error) : result.error;
+        }
+        this._tests[uniqueId] = testMetaData;
+    }
+    async uploadPending(waitTimeout = DEFAULT_WAIT_TIMEOUT_FOR_PENDING_UPLOADS, waitInterval = DEFAULT_WAIT_INTERVAL_FOR_PENDING_UPLOADS) {
+        if (this._requestQueueHandler.pendingUploads <= 0 || waitTimeout <= 0) {
+            return;
+        }
+        await sleep(waitInterval);
+        return this.uploadPending(waitTimeout - waitInterval);
+    }
+    async teardown() {
+        await this._requestQueueHandler.shutdown();
+    }
+    /**
+     * misc methods
+     */
+    async browserCommand(commandType, args, test) {
+        const dataKey = `${args.sessionId}_${args.method}_${args.endpoint}`;
+        if (commandType === 'client:beforeCommand') {
+            this._commands[dataKey] = args;
+            return;
+        }
+        if (!test) {
+            return;
+        }
+        const identifier = this.getIdentifier(test);
+        // log screenshot
+        if (Boolean(process.env.BS_TESTOPS_ALLOW_SCREENSHOTS) && isScreenshotCommand(args) && args.result.value) {
+            await uploadEventData([{
+                    event_type: 'LogCreated',
+                    logs: [{
+                            test_run_uuid: this._tests[identifier].uuid,
+                            timestamp: new Date().toISOString(),
+                            message: args.result.value,
+                            kind: 'TEST_SCREENSHOT'
+                        }]
+                }], DATA_SCREENSHOT_ENDPOINT);
+        }
+        const requestData = this._commands[dataKey];
+        // log http request
+        const req = this._requestQueueHandler.add({
+            event_type: 'LogCreated',
+            logs: [{
+                    test_run_uuid: this._tests[identifier].uuid,
+                    timestamp: new Date().toISOString(),
+                    kind: 'HTTP',
+                    http_response: {
+                        path: requestData.endpoint,
+                        method: requestData.method,
+                        body: requestData.body,
+                        response: args.result
+                    }
+                }]
+        });
+        if (req.proceed && req.data) {
+            await uploadEventData(req.data, req.url);
+        }
+    }
+    /*
+     * private methods
+     */
+    attachHookData(context, hookId) {
+        if (!context.currentTest || !context.currentTest.parent) {
+            return;
+        }
+        const parentTest = `${context.currentTest.parent.title} - ${context.currentTest.title}`;
+        if (!this._hooks[parentTest]) {
+            this._hooks[parentTest] = [];
+        }
+        this._hooks[parentTest].push(hookId);
+    }
+    /*
+     * Get hierarchy info
+     */
+    getHierarchy(test) {
+        const value = [];
+        if (test.ctx && test.ctx.test) {
+            let parent = test.ctx.test.parent;
+            while (parent && parent.title !== '') {
+                value.push(parent.title);
+                parent = parent.parent;
+            }
+        }
+        return value.reverse();
+    }
+    async sendTestRunEvent(test, eventType, results) {
+        const fullTitle = getUniqueIdentifier(test);
+        const testMetaData = this._tests[fullTitle];
+        const testData = {
+            uuid: testMetaData.uuid,
+            type: test.type,
+            name: test.title,
+            body: {
+                lang: 'webdriverio',
+                code: test.body
+            },
+            scope: fullTitle,
+            scopes: this.getHierarchy(test),
+            identifier: fullTitle,
+            file_name: test.file,
+            location: test.file,
+            vc_filepath: (this._gitConfigPath && test.file) ? path.relative(this._gitConfigPath, test.file) : undefined,
+            started_at: testMetaData.startedAt,
+            finished_at: testMetaData.finishedAt,
+            result: 'pending',
+            framework: this._framework
+        };
+        if ((eventType === 'TestRunFinished' || eventType === 'HookRunFinished') && results) {
+            const { error, passed } = results;
+            if (!passed) {
+                testData.result = (error && error.message && error.message.includes('sync skip; aborting execution')) ? 'ignore' : 'failed';
+                if (error && testData.result !== 'skipped') {
+                    testData.failure = [{ backtrace: [removeAnsiColors(error.message)] }]; // add all errors here
+                    testData.failure_reason = removeAnsiColors(error.message);
+                    testData.failure_type = error.message === null ? null : error.message.toString().match(/AssertionError/) ? 'AssertionError' : 'UnhandledError'; //verify if this is working
+                }
+            }
+            else {
+                testData.result = 'passed';
+            }
+            testData.retries = results.retries;
+            testData.duration_in_ms = results.duration;
+            if (this._hooks[fullTitle]) {
+                testData.hooks = this._hooks[fullTitle];
+            }
+        }
+        if (eventType === 'TestRunStarted') {
+            testData.integrations = {};
+            if (this._browser && this._platformMeta) {
+                const provider = getCloudProvider(this._browser);
+                testData.integrations[provider] = this.getIntegrationsObject();
+            }
+        }
+        const uploadData = {
+            event_type: eventType,
+        };
+        /* istanbul ignore if */
+        if (eventType.match(/HookRun/)) {
+            testData.hook_type = testData.name?.toLowerCase() ? getHookType(testData.name.toLowerCase()) : 'undefined';
+            uploadData.hook_run = testData;
+        }
+        else {
+            uploadData.test_run = testData;
+        }
+        const req = this._requestQueueHandler.add(uploadData);
+        if (req.proceed && req.data) {
+            await uploadEventData(req.data, req.url);
+        }
+    }
+    async sendTestRunEventForCucumber(world, eventType) {
+        const uniqueId = getUniqueIdentifierForCucumber(world);
+        const { feature, scenario, steps, uuid, startedAt, finishedAt } = this._tests[uniqueId] || {};
+        const examples = getScenarioExamples(world);
+        const fullNameWithExamples = examples
+            ? world.pickle.name + ' (' + examples.join(', ') + ')'
+            : world.pickle.name;
+        const testData = {
+            uuid: uuid,
+            started_at: startedAt,
+            finished_at: finishedAt,
+            type: 'test',
+            body: {
+                lang: 'webdriverio',
+                code: null
+            },
+            name: fullNameWithExamples,
+            scope: fullNameWithExamples,
+            scopes: [feature?.name || ''],
+            identifier: scenario?.name,
+            file_name: feature?.path,
+            vc_filepath: (this._gitConfigPath && feature?.path) ? path.relative(this._gitConfigPath, feature?.path) : undefined,
+            location: feature?.path,
+            framework: this._framework,
+            result: 'pending',
+            meta: {
+                feature: feature,
+                scenario: scenario,
+                steps: steps,
+                examples: examples
+            }
+        };
+        if (eventType === 'TestRunStarted') {
+            testData.integrations = {};
+            if (this._browser && this._platformMeta) {
+                const provider = getCloudProvider(this._browser);
+                testData.integrations[provider] = this.getIntegrationsObject();
+            }
+        }
+        /* istanbul ignore if */
+        if (world.result) {
+            let result = world.result.status.toLowerCase();
+            if (result !== 'passed' && result !== 'failed') {
+                result = 'skipped'; // mark UNKNOWN/UNDEFINED/AMBIGUOUS/PENDING as skipped
+            }
+            testData.finished_at = (new Date()).toISOString();
+            testData.result = result;
+            testData.duration_in_ms = world.result.duration.nanos / 1000000; // send duration in ms
+            if (result === 'failed') {
+                testData.failure = [
+                    {
+                        'backtrace': [world.result.message ? removeAnsiColors(world.result.message) : 'unknown']
+                    }
+                ],
+                    testData.failure_reason = world.result.message ? removeAnsiColors(world.result.message) : world.result.message;
+                if (world.result.message) {
+                    testData.failure_type = world.result.message.match(/AssertionError/)
+                        ? 'AssertionError'
+                        : 'UnhandledError';
+                }
+            }
+        }
+        if (world.pickle) {
+            testData.tags = world.pickle.tags.map(({ name }) => (name));
+        }
+        const uploadData = {
+            event_type: eventType,
+            test_run: testData
+        };
+        const req = this._requestQueueHandler.add(uploadData);
+        if (req.proceed && req.data) {
+            await uploadEventData(req.data, req.url);
+        }
+    }
+    getIntegrationsObject() {
+        return {
+            capabilities: this._platformMeta?.caps,
+            session_id: this._platformMeta?.sessionId,
+            browser: this._platformMeta?.browserName,
+            browser_version: this._platformMeta?.browserVersion,
+            platform: this._platformMeta?.platformName,
+            product: this._platformMeta?.product
+        };
+    }
+    getIdentifier(test) {
+        if ('pickle' in test) {
+            return getUniqueIdentifierForCucumber(test);
+        }
+        return getUniqueIdentifier(test);
+    }
+}