@wdio/browserstack-service 8.27.2 → 8.28.4

package/build/Percy/PercyLogger.js

@@ -0,0 +1,67 @@
+import path from 'node:path';
+import fs from 'node:fs';
+import chalk from 'chalk';
+import logger from '@wdio/logger';
+import { PERCY_LOGS_FILE } from '../constants.js';
+import { COLORS } from '../util.js';
+const log = logger('@wdio/browserstack-service');
+export class PercyLogger {
+    static logFilePath = path.join(process.cwd(), PERCY_LOGS_FILE);
+    static logFolderPath = path.join(process.cwd(), 'logs');
+    static logFileStream;
+    static logToFile(logMessage, logLevel) {
+        try {
+            if (!this.logFileStream) {
+                if (!fs.existsSync(this.logFolderPath)) {
+                    fs.mkdirSync(this.logFolderPath);
+                }
+                this.logFileStream = fs.createWriteStream(this.logFilePath, { flags: 'a' });
+            }
+            if (this.logFileStream && this.logFileStream.writable) {
+                this.logFileStream.write(this.formatLog(logMessage, logLevel));
+            }
+        }
+        catch (error) {
+            log.debug(`Failed to log to file. Error ${error}`);
+        }
+    }
+    static formatLog(logMessage, level) {
+        return `${chalk.gray(new Date().toISOString())} ${chalk[COLORS[level]](level.toUpperCase())} ${chalk.whiteBright('@wdio/browserstack-service')} ${logMessage}\n`;
+    }
+    static info(message) {
+        this.logToFile(message, 'info');
+        log.info(message);
+    }
+    static error(message) {
+        this.logToFile(message, 'error');
+        log.error(message);
+    }
+    static debug(message, param) {
+        this.logToFile(message, 'debug');
+        if (param) {
+            log.debug(message, param);
+        }
+        else {
+            log.debug(message);
+        }
+    }
+    static warn(message) {
+        this.logToFile(message, 'warn');
+        log.warn(message);
+    }
+    static trace(message) {
+        this.logToFile(message, 'trace');
+        log.trace(message);
+    }
+    static clearLogger() {
+        if (this.logFileStream) {
+            this.logFileStream.end();
+        }
+        this.logFileStream = null;
+    }
+    static clearLogFile() {
+        if (fs.existsSync(this.logFilePath)) {
+            fs.truncateSync(this.logFilePath);
+        }
+    }
+}

package/build/Percy/PercySDK.d.ts

@@ -0,0 +1,4 @@
+export declare const snapshot: (...args: any[]) => void;
+export declare const screenshot: (...args: any[]) => Promise<void>;
+export declare const screenshotApp: (...args: any[]) => Promise<void>;
+//# sourceMappingURL=PercySDK.d.ts.map

package/build/Percy/PercySDK.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PercySDK.d.ts","sourceRoot":"","sources":["../../src/Percy/PercySDK.ts"],"names":[],"mappings":"AAyBA,eAAO,MAAM,QAAQ,YAVW,GAAG,EAAE,SAUE,CAAA;AASvC,eAAO,MAAM,UAAU,YANiB,GAAG,EAAE,kBAMF,CAAA;AAS3C,eAAO,MAAM,aAAa,YANiB,GAAG,EAAE,kBAMC,CAAA"}

package/build/Percy/PercySDK.js

@@ -0,0 +1,39 @@
+import { PercyLogger } from './PercyLogger.js';
+const tryRequire = async function (pkg, fallback) {
+    try {
+        return (await import(pkg)).default;
+    }
+    catch {
+        return fallback;
+    }
+};
+const percySnapshot = await tryRequire('@percy/selenium-webdriver', null);
+const percyAppScreenshot = await tryRequire('@percy/appium-app', {});
+/* eslint-disable @typescript-eslint/no-unused-vars */
+let snapshotHandler = (...args) => {
+    PercyLogger.error('Unsupported driver for percy');
+};
+if (percySnapshot) {
+    snapshotHandler = (browser, name) => {
+        if (process.env.PERCY_SNAPSHOT === 'true') {
+            return percySnapshot(browser, name);
+        }
+    };
+}
+export const snapshot = snapshotHandler;
+/* eslint-disable @typescript-eslint/no-unused-vars */
+let screenshotHandler = async (...args) => {
+    PercyLogger.error('Unsupported driver for percy');
+};
+if (percySnapshot && percySnapshot.percyScreenshot) {
+    screenshotHandler = percySnapshot.percyScreenshot;
+}
+export const screenshot = screenshotHandler;
+/* eslint-disable @typescript-eslint/no-unused-vars */
+let screenshotAppHandler = async (...args) => {
+    PercyLogger.error('Unsupported driver for percy');
+};
+if (percyAppScreenshot) {
+    screenshotAppHandler = percyAppScreenshot;
+}
+export const screenshotApp = screenshotAppHandler;

package/build/bstackLogger.d.ts

@@ -1,4 +1,4 @@
-export declare abstract class BStackLogger {
+export declare class BStackLogger {
     static logFilePath: string;
     private static logFolderPath;
     private static logFileStream;

package/build/bstackLogger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bstackLogger.d.ts","sourceRoot":"","sources":["../src/bstackLogger.ts"],"names":[],"mappings":"AAWA,8BAAsB,YAAY;IAC9B,OAAc,WAAW,SAAsC;IAC/D,OAAO,CAAC,MAAM,CAAC,aAAa,CAAmC;IAC/D,OAAO,CAAC,MAAM,CAAC,aAAa,CAAuB;IAEnD,MAAM,CAAC,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAgBrD,OAAO,CAAC,MAAM,CAAC,SAAS;WAIV,IAAI,CAAC,OAAO,EAAE,MAAM;WAKpB,KAAK,CAAC,OAAO,EAAE,MAAM;WAKrB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG;WASlC,IAAI,CAAC,OAAO,EAAE,MAAM;WAKpB,KAAK,CAAC,OAAO,EAAE,MAAM;WAKrB,WAAW;WAOX,YAAY;CAK7B"}
+{"version":3,"file":"bstackLogger.d.ts","sourceRoot":"","sources":["../src/bstackLogger.ts"],"names":[],"mappings":"AAWA,qBAAa,YAAY;IACrB,OAAc,WAAW,SAAsC;IAC/D,OAAO,CAAC,MAAM,CAAC,aAAa,CAAmC;IAC/D,OAAO,CAAC,MAAM,CAAC,aAAa,CAAuB;IAEnD,MAAM,CAAC,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAgBrD,OAAO,CAAC,MAAM,CAAC,SAAS;WAIV,IAAI,CAAC,OAAO,EAAE,MAAM;WAKpB,KAAK,CAAC,OAAO,EAAE,MAAM;WAKrB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG;WASlC,IAAI,CAAC,OAAO,EAAE,MAAM;WAKpB,KAAK,CAAC,OAAO,EAAE,MAAM;WAKrB,WAAW;WAOX,YAAY;CAK7B"}

package/build/constants.d.ts

@@ -18,4 +18,7 @@ export declare const NOT_ALLOWED_KEYS_IN_CAPS: string[];
 export declare const LOGS_FILE = "logs/bstack-wdio-service.log";
 export declare const UPLOAD_LOGS_ADDRESS = "https://upload-observability.browserstack.com";
 export declare const UPLOAD_LOGS_ENDPOINT = "client-logs/upload";
+export declare const PERCY_LOGS_FILE = "logs/percy.log";
+export declare const PERCY_DOM_CHANGING_COMMANDS_ENDPOINTS: string[];
+export declare const CAPTURE_MODES: string[];
 //# 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,YAAY,CAAA;AAKpD,eAAO,MAAM,mBAAmB,qHAStB,CAAA;AAEV,eAAO,MAAM,mBAAmB,UAI/B,CAAA;AAED,eAAO,MAAM,eAAe,EAAE,OAAO,CAAC,kBAAkB,CAKvD,CAAA;AAED,eAAO,MAAM,aAAa,EAAE,OAAO,OAAoC,CAAA;AAEvE,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;AAC5D,eAAO,MAAM,sBAAsB,KAAuB,CAAA;AAE1D,eAAO,MAAM,qBAAqB,+CAA+C,CAAA;AACjF,eAAO,MAAM,wBAAwB,UAA6D,CAAA;AAElG,eAAO,MAAM,SAAS,iCAAiC,CAAA;AACvD,eAAO,MAAM,mBAAmB,kDAAkD,CAAA;AAClF,eAAO,MAAM,oBAAoB,uBAAuB,CAAA"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAKpD,eAAO,MAAM,mBAAmB,qHAStB,CAAA;AAEV,eAAO,MAAM,mBAAmB,UAI/B,CAAA;AAED,eAAO,MAAM,eAAe,EAAE,OAAO,CAAC,kBAAkB,CAKvD,CAAA;AAED,eAAO,MAAM,aAAa,EAAE,OAAO,OAAoC,CAAA;AAEvE,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;AAC5D,eAAO,MAAM,sBAAsB,KAAuB,CAAA;AAE1D,eAAO,MAAM,qBAAqB,+CAA+C,CAAA;AACjF,eAAO,MAAM,wBAAwB,UAA6D,CAAA;AAElG,eAAO,MAAM,SAAS,iCAAiC,CAAA;AACvD,eAAO,MAAM,mBAAmB,kDAAkD,CAAA;AAClF,eAAO,MAAM,oBAAoB,uBAAuB,CAAA;AAExD,eAAO,MAAM,eAAe,mBAAmB,CAAA;AAE/C,eAAO,MAAM,qCAAqC,UAQjD,CAAA;AAED,eAAO,MAAM,aAAa,UAAwD,CAAA"}

package/build/constants.js

@@ -38,3 +38,14 @@ export const NOT_ALLOWED_KEYS_IN_CAPS = ['includeTagsInTestingScope', 'excludeTa
 export const LOGS_FILE = 'logs/bstack-wdio-service.log';
 export const UPLOAD_LOGS_ADDRESS = 'https://upload-observability.browserstack.com';
 export const UPLOAD_LOGS_ENDPOINT = 'client-logs/upload';
+export const PERCY_LOGS_FILE = 'logs/percy.log';
+export const PERCY_DOM_CHANGING_COMMANDS_ENDPOINTS = [
+    '/session/:sessionId/url',
+    '/session/:sessionId/forward',
+    '/session/:sessionId/back',
+    '/session/:sessionId/refresh',
+    '/session/:sessionId/screenshot',
+    '/session/:sessionId/actions',
+    '/session/:sessionId/appium/device/shake'
+];
+export const CAPTURE_MODES = ['click', 'auto', 'screenshot', 'manual', 'testcase'];

package/build/index.d.ts

@@ -8,6 +8,8 @@ export declare const log4jsAppender: {
     configure: (config: any, layouts: any) => Function;
 };
 export declare const BStackTestOpsLogger: typeof logReportingAPI;
+import * as Percy from './Percy/PercySDK.js';
+export declare const PercySDK: typeof Percy;
 export * from './types.js';
 declare global {
     namespace WebdriverIO {

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,YAAY,CAAA;AAEpD,OAAO,eAAe,MAAM,sBAAsB,CAAA;AAElD,eAAe,mBAAmB,CAAA;AAClC,eAAO,MAAM,QAAQ,6BAAuB,CAAA;AAC5C,eAAO,MAAM,cAAc;;CAAgB,CAAA;AAC3C,eAAO,MAAM,mBAAmB,wBAAkB,CAAA;AAElD,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,OAAO,eAAe,MAAM,sBAAsB,CAAA;AAElD,eAAe,mBAAmB,CAAA;AAClC,eAAO,MAAM,QAAQ,6BAAuB,CAAA;AAC5C,eAAO,MAAM,cAAc;;CAAgB,CAAA;AAC3C,eAAO,MAAM,mBAAmB,wBAAkB,CAAA;AAElD,OAAO,KAAK,KAAK,MAAM,qBAAqB,CAAA;AAC5C,eAAO,MAAM,QAAQ,cAAQ,CAAA;AAE7B,cAAc,YAAY,CAAA;AAE1B,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,WAAW,CAAC;QAClB,UAAU,aAAc,SAAQ,kBAAkB;SAAG;KACxD;CACJ"}

package/build/index.js

@@ -7,4 +7,6 @@ export default BrowserstackService;
 export const launcher = BrowserstackLauncher;
 export const log4jsAppender = { configure };
 export const BStackTestOpsLogger = logReportingAPI;
+import * as Percy from './Percy/PercySDK.js';
+export const PercySDK = Percy;
 export * from './types.js';

package/build/insights-handler.d.ts

@@ -57,7 +57,6 @@ declare class _InsightsHandler {
     private getTestRunIdFromSuite;
     private sendTestRunEventForCucumber;
     private getIntegrationsObject;
-    private getPlatformVersion;
     private getIdentifier;
 }
 declare const InsightsHandler: typeof _InsightsHandler;

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

@@ -1 +1 @@
-{"version":3,"file":"insights-handler.d.ts","sourceRoot":"","sources":["../src/insights-handler.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAGzE,OAAO,KAAK,EAAiB,OAAO,EAAE,QAAQ,EAAsB,YAAY,EAAE,kBAAkB,EAAE,MAAM,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAA;AAkBjK,OAAO,KAAK,EAER,QAAQ,EAER,UAAU,EACV,cAAc,EACd,MAAM,EACT,MAAM,YAAY,CAAA;AAInB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE/C,cAAM,gBAAgB;IAiBL,OAAO,CAAC,QAAQ;IAAiF,OAAO,CAAC,UAAU,CAAC;IAhBjI,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,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,oBAAoB,CAAoC;IAChE,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,aAAa,CAIpB;IACD,OAAO,CAAC,SAAS,CAAC,CAAoC;gBAEjC,QAAQ,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,kBAAkB,EAAE,aAAa,CAAC,EAAE,OAAO,EAAU,UAAU,CAAC,oBAAQ,EAAE,SAAS,CAAC,EAAE,YAAY,CAAC,gBAAgB;IAmBpL,iBAAiB;IAQjB,YAAY,CAAC,QAAQ,EAAE,MAAM;IAIvB,MAAM;IAiBZ,mBAAmB,CAAC,IAAI,EAAE,YAAY,GAAC,SAAS;IAchD,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAC,SAAS,GAAG,MAAM;IAYvD,uBAAuB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,GAAC,SAAS,GAAG,MAAM,GAAC,IAAI;IAapF,0BAA0B;IAK1B,cAAc,CAAC,WAAW,EAAE,cAAc;IAapC,yBAAyB,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM;IAyB3E,mBAAmB,CAAC,IAAI,EAAE,YAAY,GAAC,SAAS,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,CAAC,EAAE,UAAU,CAAC,UAAU;IA+C5G,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,GAAC,YAAY,GAAC,SAAS,EAAE,OAAO,EAAE,GAAG;IAwBtE,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,GAAC,YAAY,GAAC,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC,UAAU;IA2D/E,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,UAAU,CAAC,UAAU;IAoD7F,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI;IAgBjC,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,UAAU;IAYrE;;QAEI;IAEE,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IAM3C,cAAc,CAAE,KAAK,EAAE,sBAAsB;IAmC7C,aAAa,CAAE,KAAK,EAAE,sBAAsB;IAK5C,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM;IAoBzD,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,YAAY;IA4BzF,aAAa,CACf,WAAW,SAA2C,EACtD,YAAY,SAA4C,GACzD,OAAO,CAAC,OAAO,CAAC;IASb,QAAQ;IAKd;;OAEG;IAEH,iBAAiB,WAAkB,MAAM,mBAgBxC;IAEK,QAAQ,CAAC,IAAI,EAAE,UAAU;IAOzB,cAAc,CAAE,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,GAAG,gBAAgB,EAAE,IAAI,CAAC,EAAE,UAAU,CAAC,IAAI,GAAG,sBAAsB;IA8DtI,OAAO,CAAC,cAAc;IActB,OAAO,CAAC,iBAAiB;IA0BzB,OAAO,CAAC,YAAY;YAiBN,gBAAgB;IA8E9B,OAAO,CAAC,YAAY;IAgBpB,OAAO,CAAC,qBAAqB;YAoBf,2BAA2B;IA8FzC,OAAO,CAAC,qBAAqB;IAY7B,OAAO,CAAC,kBAAkB;IAe1B,OAAO,CAAC,aAAa;CAMxB;AAGD,QAAA,MAAM,eAAe,EAAE,OAAO,gBAA0D,CAAA;AACxF,KAAK,eAAe,GAAG,gBAAgB,CAAA;AAEvC,eAAe,eAAe,CAAA"}
+{"version":3,"file":"insights-handler.d.ts","sourceRoot":"","sources":["../src/insights-handler.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAGzE,OAAO,KAAK,EAAiB,OAAO,EAAE,QAAQ,EAAsB,YAAY,EAAE,kBAAkB,EAAE,MAAM,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAA;AAkBjK,OAAO,KAAK,EAER,QAAQ,EAER,UAAU,EACV,cAAc,EACd,MAAM,EACT,MAAM,YAAY,CAAA;AAInB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE/C,cAAM,gBAAgB;IAiBL,OAAO,CAAC,QAAQ;IAAiF,OAAO,CAAC,UAAU,CAAC;IAhBjI,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,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,oBAAoB,CAAoC;IAChE,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,aAAa,CAIpB;IACD,OAAO,CAAC,SAAS,CAAC,CAAoC;gBAEjC,QAAQ,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,kBAAkB,EAAE,aAAa,CAAC,EAAE,OAAO,EAAU,UAAU,CAAC,oBAAQ,EAAE,SAAS,CAAC,EAAE,YAAY,CAAC,gBAAgB;IAmBpL,iBAAiB;IAQjB,YAAY,CAAC,QAAQ,EAAE,MAAM;IAIvB,MAAM;IAiBZ,mBAAmB,CAAC,IAAI,EAAE,YAAY,GAAC,SAAS;IAchD,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAC,SAAS,GAAG,MAAM;IAYvD,uBAAuB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,GAAC,SAAS,GAAG,MAAM,GAAC,IAAI;IAapF,0BAA0B;IAK1B,cAAc,CAAC,WAAW,EAAE,cAAc;IAapC,yBAAyB,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM;IAyB3E,mBAAmB,CAAC,IAAI,EAAE,YAAY,GAAC,SAAS,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,CAAC,EAAE,UAAU,CAAC,UAAU;IA+C5G,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,GAAC,YAAY,GAAC,SAAS,EAAE,OAAO,EAAE,GAAG;IAwBtE,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,GAAC,YAAY,GAAC,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC,UAAU;IA2D/E,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,UAAU,CAAC,UAAU;IAoD7F,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI;IAgBjC,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,UAAU;IAYrE;;QAEI;IAEE,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IAM3C,cAAc,CAAE,KAAK,EAAE,sBAAsB;IAmC7C,aAAa,CAAE,KAAK,EAAE,sBAAsB;IAK5C,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM;IAoBzD,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,YAAY;IA4BzF,aAAa,CACf,WAAW,SAA2C,EACtD,YAAY,SAA4C,GACzD,OAAO,CAAC,OAAO,CAAC;IASb,QAAQ;IAKd;;OAEG;IAEH,iBAAiB,WAAkB,MAAM,mBAgBxC;IAEK,QAAQ,CAAC,IAAI,EAAE,UAAU;IAOzB,cAAc,CAAE,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,GAAG,gBAAgB,EAAE,IAAI,CAAC,EAAE,UAAU,CAAC,IAAI,GAAG,sBAAsB;IA8DtI,OAAO,CAAC,cAAc;IActB,OAAO,CAAC,iBAAiB;IA0BzB,OAAO,CAAC,YAAY;YAiBN,gBAAgB;IA8E9B,OAAO,CAAC,YAAY;IAgBpB,OAAO,CAAC,qBAAqB;YAoBf,2BAA2B;IA8FzC,OAAO,CAAC,qBAAqB;IAY7B,OAAO,CAAC,aAAa;CAMxB;AAGD,QAAA,MAAM,eAAe,EAAE,OAAO,gBAA0D,CAAA;AACxF,KAAK,eAAe,GAAG,gBAAgB,CAAA;AAEvC,eAAe,eAAe,CAAA"}

package/build/insights-handler.js

@@ -1,7 +1,7 @@
 import path from 'node:path';
 import { v4 as uuidv4 } from 'uuid';
 import TestReporter from './reporter.js';
-import { frameworkSupportsHook, getCloudProvider, getFailureObject, getGitMetaData, getHookType, getScenarioExamples, getUniqueIdentifier, getUniqueIdentifierForCucumber, isBrowserstackSession, isScreenshotCommand, o11yClassErrorHandler, pushDataToQueue, removeAnsiColors, sleep, uploadEventData } from './util.js';
+import { frameworkSupportsHook, getCloudProvider, getFailureObject, getGitMetaData, getHookType, getPlatformVersion, getScenarioExamples, getUniqueIdentifier, getUniqueIdentifierForCucumber, isBrowserstackSession, isScreenshotCommand, o11yClassErrorHandler, pushDataToQueue, 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';
 import { BStackLogger } from './bstackLogger.js';
@@ -757,23 +757,9 @@ class _InsightsHandler {
             browser_version: this._platformMeta?.browserVersion,
             platform: this._platformMeta?.platformName,
             product: this._platformMeta?.product,
-            platform_version: this.getPlatformVersion()
+            platform_version: getPlatformVersion(this._userCaps)
         };
     }
-    getPlatformVersion() {
-        const caps = this._userCaps;
-        const bstackOptions = this._userCaps?.['bstack:options'];
-        const keys = ['platformVersion', 'platform_version', 'osVersion', 'os_version'];
-        for (const key of keys) {
-            if (bstackOptions && bstackOptions?.[key]) {
-                return bstackOptions?.[key];
-            }
-            else if (caps[key]) {
-                return caps[key];
-            }
-        }
-        return null;
-    }
     getIdentifier(test) {
         if ('pickle' in test) {
             return getUniqueIdentifierForCucumber(test);

package/build/launcher.d.ts

@@ -1,9 +1,9 @@
 import * as BrowserstackLocalLauncher from 'browserstack-local';
 import type { Capabilities, Services, Options } from '@wdio/types';
-import type { BrowserstackConfig, App, AppConfig, AppUploadResponse } from './types.js';
+import type { BrowserstackConfig, App, AppConfig, AppUploadResponse, UserConfig } from './types.js';
 type BrowserstackLocal = BrowserstackLocalLauncher.Local & {
     pid?: number;
-    stop(callback: (err?: any) => void): void;
+    stop(callback: (err?: Error) => void): void;
 };
 export default class BrowserstackLauncherService implements Services.ServiceInstance {
     private _options;
@@ -14,10 +14,15 @@ export default class BrowserstackLauncherService implements Services.ServiceInst
     private _buildTag?;
     private _buildIdentifier?;
     private _accessibilityAutomation?;
+    private _percy?;
+    private _percyBestPlatformCaps?;
     static _testOpsBuildStopped?: boolean;
     constructor(_options: BrowserstackConfig & Options.Testrunner, capabilities: Capabilities.RemoteCapability, _config: Options.Testrunner);
+    onWorkerStart(cid: any, caps: any): Promise<void>;
     onPrepare(config?: Options.Testrunner, capabilities?: Capabilities.RemoteCapabilities): Promise<unknown>;
     onComplete(): Promise<unknown>;
+    setupPercy(options: BrowserstackConfig & Options.Testrunner, config: Options.Testrunner, bsConfig: UserConfig): Promise<void>;
+    stopPercy(): Promise<void>;
     _uploadApp(app: App): Promise<AppUploadResponse>;
     /**
      * @param  {String | AppConfig}  appConfig    <string>: should be "app file path" or "app_url" or "custom_id" or "shareable_id".

package/build/launcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,yBAAyB,MAAM,oBAAoB,CAAA;AAE/D,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAGlE,OAAO,KAAK,EAAE,kBAAkB,EAAE,GAAG,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAsBvF,KAAK,iBAAiB,GAAG,yBAAyB,CAAC,KAAK,GAAG;IACvD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;CAC7C,CAAA;AAED,MAAM,CAAC,OAAO,OAAO,2BAA4B,YAAW,QAAQ,CAAC,eAAe;IAU5E,OAAO,CAAC,QAAQ;IAEhB,OAAO,CAAC,OAAO;IAXnB,iBAAiB,CAAC,EAAE,iBAAiB,CAAA;IACrC,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,YAAY,CAAC,CAAQ;IAC7B,OAAO,CAAC,SAAS,CAAC,CAAQ;IAC1B,OAAO,CAAC,gBAAgB,CAAC,CAAQ;IACjC,OAAO,CAAC,wBAAwB,CAAC,CAAS;IAC1C,OAAc,oBAAoB,CAAC,EAAE,OAAO,CAAA;gBAGhC,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EACzD,YAAY,EAAE,YAAY,CAAC,gBAAgB,EACnC,OAAO,EAAE,OAAO,CAAC,UAAU;IA0GjC,SAAS,CAAE,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB;IA4ItF,UAAU;IAsEV,UAAU,CAAC,GAAG,EAAC,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAsBrD;;;OAGG;IACG,YAAY,CAAE,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAyB1D,kBAAkB;IAOxB,qBAAqB,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE;IAiFvH,WAAW,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM;IA4F5F,sBAAsB,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB;IAyCrE;;;OAGG;IACH,oBAAoB;IA6BpB,sBAAsB,CAAC,QAAQ,CAAC,EAAC,MAAM,EAAE,SAAS,CAAC,EAAC,MAAM,EAAE,eAAe,CAAC,EAAC,MAAM;IASnF,mBAAmB;CAQtB"}
+{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,yBAAyB,MAAM,oBAAoB,CAAA;AAE/D,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAKlE,OAAO,KAAK,EAAE,kBAAkB,EAAE,GAAG,EAAE,SAAS,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAyBnG,KAAK,iBAAiB,GAAG,yBAAyB,CAAC,KAAK,GAAG;IACvD,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,KAAK,IAAI,GAAG,IAAI,CAAA;CAC9C,CAAA;AAED,MAAM,CAAC,OAAO,OAAO,2BAA4B,YAAW,QAAQ,CAAC,eAAe;IAY5E,OAAO,CAAC,QAAQ;IAEhB,OAAO,CAAC,OAAO;IAbnB,iBAAiB,CAAC,EAAE,iBAAiB,CAAA;IACrC,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,YAAY,CAAC,CAAQ;IAC7B,OAAO,CAAC,SAAS,CAAC,CAAQ;IAC1B,OAAO,CAAC,gBAAgB,CAAC,CAAQ;IACjC,OAAO,CAAC,wBAAwB,CAAC,CAAS;IAC1C,OAAO,CAAC,MAAM,CAAC,CAAO;IACtB,OAAO,CAAC,sBAAsB,CAAC,CAAkC;IACjE,OAAc,oBAAoB,CAAC,EAAE,OAAO,CAAA;gBAGhC,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EACzD,YAAY,EAAE,YAAY,CAAC,gBAAgB,EACnC,OAAO,EAAE,OAAO,CAAC,UAAU;IA2GjC,aAAa,CAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG;IAalC,SAAS,CAAE,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB;IAwJtF,UAAU;IA4EV,UAAU,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,UAAU,EAAE,QAAQ,EAAE,UAAU;IAwB7G,SAAS;IAYT,UAAU,CAAC,GAAG,EAAC,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAsBrD;;;OAGG;IACG,YAAY,CAAE,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAyB1D,kBAAkB;IAOxB,qBAAqB,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE;IAiFtH,WAAW,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM;IA4F5F,sBAAsB,CAAC,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB;IAyCrE;;;OAGG;IACH,oBAAoB;IA6BpB,sBAAsB,CAAC,QAAQ,CAAC,EAAC,MAAM,EAAE,SAAS,CAAC,EAAC,MAAM,EAAE,eAAe,CAAC,EAAC,MAAM;IASnF,mBAAmB;CAQtB"}

package/build/launcher.js

@@ -9,10 +9,12 @@ import os from 'node:os';
 import { SevereServiceError } from 'webdriverio';
 import * as BrowserstackLocalLauncher from 'browserstack-local';
 import PerformanceTester from './performance-tester.js';
+import { startPercy, stopPercy, getBestPlatformForPercySnapshot } from './Percy/PercyHelper.js';
 import { BSTACK_SERVICE_VERSION, NOT_ALLOWED_KEYS_IN_CAPS, VALID_APP_EXTENSION } from './constants.js';
-import { launchTestSession, createAccessibilityTestRun, shouldAddServiceVersion, stopBuildUpstream, getCiInfo, isBStackSession, isUndefined, isAccessibilityAutomationSession, stopAccessibilityTestRun, isTrue, getBrowserStackUser, getBrowserStackKey, uploadLogs, setupExitHandlers } from './util.js';
+import { launchTestSession, createAccessibilityTestRun, shouldAddServiceVersion, stopBuildUpstream, getCiInfo, isBStackSession, isUndefined, isAccessibilityAutomationSession, stopAccessibilityTestRun, isTrue, getBrowserStackUser, getBrowserStackKey, uploadLogs, ObjectsAreEqual, setupExitHandlers } from './util.js';
 import CrashReporter from './crash-reporter.js';
 import { BStackLogger } from './bstackLogger.js';
+import { PercyLogger } from './Percy/PercyLogger.js';
 import { FileStream } from './fileStream.js';
 export default class BrowserstackLauncherService {
     _options;
@@ -23,11 +25,14 @@ export default class BrowserstackLauncherService {
     _buildTag;
     _buildIdentifier;
     _accessibilityAutomation;
+    _percy;
+    _percyBestPlatformCaps;
     static _testOpsBuildStopped;
     constructor(_options, capabilities, _config) {
         this._options = _options;
         this._config = _config;
         BStackLogger.clearLogFile();
+        PercyLogger.clearLogFile();
         setupExitHandlers();
         // added to maintain backward compatibility with webdriverIO v5
         this._config || (this._config = _options);
@@ -132,6 +137,19 @@ export default class BrowserstackLauncherService {
             BStackLogger.error(`[Crash_Report_Upload] Config processing failed due to ${error}`);
         }
     }
+    async onWorkerStart(cid, caps) {
+        try {
+            if (this._options.percy && this._percyBestPlatformCaps) {
+                const isThisBestPercyPlatform = ObjectsAreEqual(caps, this._percyBestPlatformCaps);
+                if (isThisBestPercyPlatform) {
+                    process.env.BEST_PLATFORM_CID = cid;
+                }
+            }
+        }
+        catch (err) {
+            PercyLogger.error(`Error while setting best platform for Percy snapshot at worker start ${err}`);
+        }
+    }
     async onPrepare(config, capabilities) {
         /**
          * Upload app to BrowserStack if valid file path to app is given.
@@ -217,6 +235,18 @@ export default class BrowserstackLauncherService {
                 buildIdentifier: this._buildIdentifier
             });
         }
+        if (this._options.percy) {
+            try {
+                const bestPlatformPercyCaps = getBestPlatformForPercySnapshot(capabilities);
+                this._percyBestPlatformCaps = bestPlatformPercyCaps;
+                await this.setupPercy(this._options, this._config, {
+                    projectName: this._projectName
+                });
+            }
+            catch (err) {
+                PercyLogger.error(`Error while setting up Percy ${err}`);
+            }
+        }
         if (!this._options.browserstackLocal) {
             return BStackLogger.info('browserstackLocal is not enabled - skipping...');
         }
@@ -288,6 +318,10 @@ export default class BrowserstackLauncherService {
             BStackLogger.debug(`Failed to upload BrowserStack WDIO Service logs ${error}`);
         }
         BStackLogger.clearLogger();
+        if (this._options.percy) {
+            await this.stopPercy();
+        }
+        PercyLogger.clearLogger();
         if (!this.browserstackLocal || !this.browserstackLocal.isRunning()) {
             return;
         }
@@ -316,6 +350,41 @@ export default class BrowserstackLauncherService {
             return Promise.reject(err);
         });
     }
+    async setupPercy(options, config, bsConfig) {
+        if (this._percy?.isRunning()) {
+            return;
+        }
+        try {
+            this._percy = await startPercy(options, config, bsConfig);
+            if (!this._percy) {
+                throw new Error('Could not start percy, check percy logs for info.');
+            }
+            PercyLogger.info('Percy started successfully');
+            let signal = 0;
+            const handler = async () => {
+                signal++;
+                signal === 1 && await this.stopPercy();
+            };
+            process.on('beforeExit', handler);
+            process.on('SIGINT', handler);
+            process.on('SIGTERM', handler);
+        }
+        catch (err) {
+            PercyLogger.debug(`Error in percy setup ${err}`);
+        }
+    }
+    async stopPercy() {
+        if (!this._percy || !this._percy.isRunning()) {
+            return;
+        }
+        try {
+            await stopPercy(this._percy);
+            PercyLogger.info('Percy stopped');
+        }
+        catch (err) {
+            PercyLogger.error('Error occured while stopping percy : ' + err);
+        }
+    }
     async _uploadApp(app) {
         BStackLogger.info(`uploading app ${app.app} ${app.customId ? `and custom_id: ${app.customId}` : ''} to browserstack`);
         const form = new FormData();

package/build/reporter.d.ts

@@ -15,7 +15,9 @@ declare class _TestReporter extends WDIOReporter {
     private _gitConfigured;
     private _currentHook;
     private _currentTest;
+    private _userCaps?;
     onRunnerStart(runnerStats: RunnerStats): Promise<void>;
+    private getUserCaps;
     registerListeners(): void;
     appendTestItemLog(stdLog: StdLog): Promise<void>;
     setCurrentHook(hookDetails: CurrentRunInfo): void;

package/build/reporter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reporter.d.ts","sourceRoot":"","sources":["../src/reporter.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AACnF,OAAO,YAAY,MAAM,gBAAgB,CAAA;AAKzC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAExD,OAAO,KAAK,EAAgC,QAAQ,EAAc,MAAM,YAAY,CAAA;AAapF,cAAM,aAAc,SAAQ,YAAY;IACpC,OAAO,CAAC,aAAa,CAA+B;IACpD,OAAO,CAAC,OAAO,CAAC,CAAyC;IACzD,OAAO,CAAC,cAAc,CAAO;IAC7B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,oBAAoB,CAAoC;IAChE,OAAO,CAAC,OAAO,CAAmB;IAClC,OAAO,CAAC,MAAM,CAAC,MAAM,CAA+B;IACpD,OAAO,CAAC,cAAc,CAAC,CAAQ;IAC/B,OAAO,CAAC,cAAc,CAAiB;IACvC,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,YAAY,CAAqB;IAEnC,aAAa,CAAE,WAAW,EAAE,WAAW;IAW7C,iBAAiB;IAQJ,iBAAiB,CAAC,MAAM,EAAE,MAAM;IAc7C,cAAc,CAAC,WAAW,EAAE,cAAc;IAapC,YAAY;IAWlB,MAAM,CAAC,QAAQ;IAIf,YAAY,CAAE,UAAU,EAAE,UAAU;IAoBpC,UAAU;IAIV,cAAc,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM;IAe1C,SAAS,CAAC,SAAS,EAAE,SAAS;IAY9B,WAAW,CAAC,SAAS,EAAE,SAAS;IAgBhC,WAAW,CAAC,SAAS,EAAE,SAAS;IAehC,SAAS,CAAC,SAAS,EAAE,SAAS;IAoBpC,iBAAiB,CAAC,SAAS,EAAE,SAAS;IAIhC,UAAU,CAAE,SAAS,EAAE,SAAS;IAWhC,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,EAAE,SAAS,EAAE,MAAM;CA+E7E;AAED,QAAA,MAAM,YAAY,EAAE,OAAO,aAAoD,CAAA;AAC/E,KAAK,YAAY,GAAG,aAAa,CAAA;AACjC,eAAe,YAAY,CAAA"}
+{"version":3,"file":"reporter.d.ts","sourceRoot":"","sources":["../src/reporter.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AACnF,OAAO,YAAY,MAAM,gBAAgB,CAAA;AAKzC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAExD,OAAO,KAAK,EAAgC,QAAQ,EAAc,MAAM,YAAY,CAAA;AAcpF,cAAM,aAAc,SAAQ,YAAY;IACpC,OAAO,CAAC,aAAa,CAA+B;IACpD,OAAO,CAAC,OAAO,CAAC,CAAyC;IACzD,OAAO,CAAC,cAAc,CAAO;IAC7B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,oBAAoB,CAAoC;IAChE,OAAO,CAAC,OAAO,CAAmB;IAClC,OAAO,CAAC,MAAM,CAAC,MAAM,CAA+B;IACpD,OAAO,CAAC,cAAc,CAAC,CAAQ;IAC/B,OAAO,CAAC,cAAc,CAAiB;IACvC,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,SAAS,CAAC,CAAoC;IAEhD,aAAa,CAAE,WAAW,EAAE,WAAW;IAY7C,OAAO,CAAC,WAAW;IAInB,iBAAiB;IAQJ,iBAAiB,CAAC,MAAM,EAAE,MAAM;IAc7C,cAAc,CAAC,WAAW,EAAE,cAAc;IAapC,YAAY;IAWlB,MAAM,CAAC,QAAQ;IAIf,YAAY,CAAE,UAAU,EAAE,UAAU;IAoBpC,UAAU;IAIV,cAAc,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM;IAe1C,SAAS,CAAC,SAAS,EAAE,SAAS;IAY9B,WAAW,CAAC,SAAS,EAAE,SAAS;IAgBhC,WAAW,CAAC,SAAS,EAAE,SAAS;IAehC,SAAS,CAAC,SAAS,EAAE,SAAS;IAoBpC,iBAAiB,CAAC,SAAS,EAAE,SAAS;IAIhC,UAAU,CAAE,SAAS,EAAE,SAAS;IAWhC,gBAAgB,CAAC,SAAS,EAAE,SAAS,GAAG,SAAS,EAAE,SAAS,EAAE,MAAM;CAgF7E;AAED,QAAA,MAAM,YAAY,EAAE,OAAO,aAAoD,CAAA;AAC/E,KAAK,YAAY,GAAG,aAAa,CAAA;AACjC,eAAe,YAAY,CAAA"}

package/build/reporter.js

@@ -2,7 +2,7 @@ import path from 'node:path';
 import WDIOReporter from '@wdio/reporter';
 import * as url from 'node:url';
 import { v4 as uuidv4 } from 'uuid';
-import { getCloudProvider, uploadEventData, o11yClassErrorHandler, getGitMetaData, removeAnsiColors, getHookType, pushDataToQueue } from './util.js';
+import { getCloudProvider, uploadEventData, o11yClassErrorHandler, getGitMetaData, removeAnsiColors, getHookType, pushDataToQueue, getPlatformVersion } from './util.js';
 import RequestQueueHandler from './request-handler.js';
 import { BStackLogger } from './bstackLogger.js';
 class _TestReporter extends WDIOReporter {
@@ -18,8 +18,10 @@ class _TestReporter extends WDIOReporter {
     _gitConfigured = false;
     _currentHook = {};
     _currentTest = {};
+    _userCaps = {};
     async onRunnerStart(runnerStats) {
         this._capabilities = runnerStats.capabilities;
+        this._userCaps = this.getUserCaps(runnerStats);
         this._config = runnerStats.config;
         this._sessionId = runnerStats.sessionId;
         if (typeof this._config.testObservability !== 'undefined') {
@@ -28,6 +30,9 @@ class _TestReporter extends WDIOReporter {
         await this.configureGit();
         this.registerListeners();
     }
+    getUserCaps(runnerStats) {
+        return runnerStats.instanceOptions[runnerStats.sessionId].capabilities;
+    }
     registerListeners() {
         if (this._config?.framework !== 'jasmine') {
             return;
@@ -220,6 +225,7 @@ class _TestReporter extends WDIOReporter {
                 browser: this._capabilities?.browserName,
                 browser_version: this._capabilities?.browserVersion,
                 platform: this._capabilities?.platformName,
+                platform_version: getPlatformVersion(this._userCaps)
             };
         }
         if (eventType === 'TestRunFinished' || eventType === 'HookRunFinished') {

package/build/service.d.ts

@@ -19,6 +19,8 @@ export default class BrowserstackService implements Services.ServiceInstance {
     private _insightsHandler?;
     private _accessibility;
     private _accessibilityHandler?;
+    private _percy;
+    private _percyHandler?;
     private _turboScale;
     constructor(options: BrowserstackConfig & Options.Testrunner, _caps: Capabilities.RemoteCapability, _config: Options.Testrunner);
     _updateCaps(fn: (caps: WebdriverIO.Capabilities | Capabilities.DesiredCapabilities) => void): void;

package/build/service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAW9E,OAAO,KAAK,EAAE,kBAAkB,EAAE,iBAAiB,EAA8C,MAAM,YAAY,CAAA;AACnH,OAAO,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAQhG,MAAM,CAAC,OAAO,OAAO,mBAAoB,YAAW,QAAQ,CAAC,eAAe;IAoBpE,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,OAAO;IApBnB,OAAO,CAAC,eAAe,CAAmD;IAC1E,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,iBAAiB,CAAe;IACxC,OAAO,CAAC,gBAAgB,CAA4D;IACpF,OAAO,CAAC,QAAQ,CAAC,CAAqB;IACtC,OAAO,CAAC,WAAW,CAAC,CAAQ;IAC5B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,QAAQ,CAAyC;IACzD,OAAO,CAAC,SAAS,CAAiB;IAClC,OAAO,CAAC,cAAc,CAAA;IACtB,OAAO,CAAC,YAAY,CAAC,CAA0C;IAC/D,OAAO,CAAC,gBAAgB,CAAC,CAAiB;IAC1C,OAAO,CAAC,cAAc,CAAA;IACtB,OAAO,CAAC,qBAAqB,CAAC,CAAsB;IACpD,OAAO,CAAC,WAAW,CAAA;gBAGf,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EACxC,KAAK,EAAE,YAAY,CAAC,gBAAgB,EACpC,OAAO,EAAE,OAAO,CAAC,UAAU;IA4BvC,WAAW,CAAE,EAAE,EAAE,CAAC,IAAI,EAAE,WAAW,CAAC,YAAY,GAAG,YAAY,CAAC,mBAAmB,KAAK,IAAI;IAU5F,aAAa,CAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,cAAc,CAAC;IAgBzD,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,gBAAgB,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,WAAW,CAAC,OAAO;IAqE/F;;;;;;OAMG;IACG,WAAW,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IAUpC,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,GAAC,YAAY,EAAE,OAAO,EAAE,GAAG;IAO5D,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,GAAG,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,UAAU;IAI/F,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI;IAqBjC,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU;IAU/E,KAAK,CAAE,MAAM,EAAE,MAAM;IA+B3B;;OAEG;IAEG,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IAOjD;;;OAGG;IACG,cAAc,CAAE,KAAK,EAAE,sBAAsB;IAQ7C,aAAa,CAAE,KAAK,EAAE,sBAAsB;IAuB5C,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM;IAKzD,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,YAAY;IAIzF,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAgCzD,cAAc,IAAI,OAAO;IAMzB,UAAU,CAAE,WAAW,EAAE,GAAG;IAU5B,kBAAkB,CAAE,MAAM,EAAE,iBAAiB;IAqB7C,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG;IAoBrC,gBAAgB;YAiCR,eAAe;IA0B7B,OAAO,CAAC,cAAc;YAIR,eAAe;CAqBhC"}
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAW9E,OAAO,KAAK,EAAE,kBAAkB,EAAE,iBAAiB,EAA8C,MAAM,YAAY,CAAA;AACnH,OAAO,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAShG,MAAM,CAAC,OAAO,OAAO,mBAAoB,YAAW,QAAQ,CAAC,eAAe;IAsBpE,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,OAAO;IAtBnB,OAAO,CAAC,eAAe,CAAmD;IAC1E,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,iBAAiB,CAAe;IACxC,OAAO,CAAC,gBAAgB,CAA4D;IACpF,OAAO,CAAC,QAAQ,CAAC,CAAqB;IACtC,OAAO,CAAC,WAAW,CAAC,CAAQ;IAC5B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,QAAQ,CAAyC;IACzD,OAAO,CAAC,SAAS,CAAiB;IAClC,OAAO,CAAC,cAAc,CAAA;IACtB,OAAO,CAAC,YAAY,CAAC,CAA0C;IAC/D,OAAO,CAAC,gBAAgB,CAAC,CAAiB;IAC1C,OAAO,CAAC,cAAc,CAAA;IACtB,OAAO,CAAC,qBAAqB,CAAC,CAAsB;IACpD,OAAO,CAAC,MAAM,CAAA;IACd,OAAO,CAAC,aAAa,CAAC,CAAc;IACpC,OAAO,CAAC,WAAW,CAAA;gBAGf,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EACxC,KAAK,EAAE,YAAY,CAAC,gBAAgB,EACpC,OAAO,EAAE,OAAO,CAAC,UAAU;IAiCvC,WAAW,CAAE,EAAE,EAAE,CAAC,IAAI,EAAE,WAAW,CAAC,YAAY,GAAG,YAAY,CAAC,mBAAmB,KAAK,IAAI;IAU5F,aAAa,CAAE,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,cAAc,CAAC;IAgBzD,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,gBAAgB,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,WAAW,CAAC,OAAO;IAmG/F;;;;;;OAMG;IACG,WAAW,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IAUpC,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,GAAC,YAAY,EAAE,OAAO,EAAE,GAAG;IAO5D,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,GAAG,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,UAAU;IAI/F,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI;IAqBjC,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU;IAW/E,KAAK,CAAE,MAAM,EAAE,MAAM;IAiC3B;;OAEG;IAEG,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IAOjD;;;OAGG;IACG,cAAc,CAAE,KAAK,EAAE,sBAAsB;IAQ7C,aAAa,CAAE,KAAK,EAAE,sBAAsB;IAwB5C,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM;IAKzD,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,YAAY;IAIzF,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAgCzD,cAAc,IAAI,OAAO;IAMzB,UAAU,CAAE,WAAW,EAAE,GAAG;IAU5B,kBAAkB,CAAE,MAAM,EAAE,iBAAiB;IAqB7C,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG;IAoBrC,gBAAgB;YAiCR,eAAe;IA4B7B,OAAO,CAAC,cAAc;YAIR,eAAe;CAqBhC"}

package/build/service.js

@@ -7,6 +7,7 @@ import { DEFAULT_OPTIONS } from './constants.js';
 import CrashReporter from './crash-reporter.js';
 import AccessibilityHandler from './accessibility-handler.js';
 import { BStackLogger } from './bstackLogger.js';
+import PercyHandler from './Percy/Percy-Handler.js';
 export default class BrowserstackService {
     _caps;
     _config;
@@ -25,6 +26,8 @@ export default class BrowserstackService {
     _insightsHandler;
     _accessibility;
     _accessibilityHandler;
+    _percy;
+    _percyHandler;
     _turboScale;
     constructor(options, _caps, _config) {
         this._caps = _caps;
@@ -34,6 +37,7 @@ export default class BrowserstackService {
         this._config || (this._config = this._options);
         this._observability = this._options.testObservability;
         this._accessibility = this._options.accessibility;
+        this._percy = this._options.percy;
         this._turboScale = this._options.turboScale;
         if (this._observability) {
             this._config.reporters?.push(TestReporter);
@@ -50,6 +54,9 @@ export default class BrowserstackService {
         if (strict) {
             this._failureStatuses.push('pending');
         }
+        if (process.env.WDIO_WORKER_ID === process.env.BEST_PLATFORM_CID) {
+            process.env.PERCY_SNAPSHOT = 'true';
+        }
     }
     _updateCaps(fn) {
         const multiRemoteCap = this._caps;
@@ -83,24 +90,42 @@ export default class BrowserstackService {
             this._sessionBaseUrl = 'https://api.browserstack.com/automate-turboscale/v1/sessions';
         }
         this._scenariosThatRan = [];
-        if (this._observability && this._browser) {
-            patchConsoleLogs();
+        if (this._browser) {
+            if (this._percy) {
+                this._percyHandler = new PercyHandler(this._options.percyCaptureMode, this._browser, this._caps, this._isAppAutomate(), this._config.framework);
+                this._percyHandler.before();
+            }
             try {
-                this._insightsHandler = new InsightsHandler(this._browser, this._isAppAutomate(), this._config.framework, this._caps);
-                await this._insightsHandler.before();
+                const sessionId = this._browser.sessionId;
+                if (this._observability) {
+                    patchConsoleLogs();
+                    this._insightsHandler = new InsightsHandler(this._browser, this._isAppAutomate(), this._config.framework, this._caps);
+                    await this._insightsHandler.before();
+                }
                 /**
                  * register command event
                  */
-                const sessionId = this._browser.sessionId;
-                this._browser.on('command', (command) => this._insightsHandler?.browserCommand('client:beforeCommand', Object.assign(command, { sessionId }), this._currentTest));
+                this._browser.on('command', async (command) => {
+                    if (this._observability) {
+                        this._insightsHandler?.browserCommand('client:beforeCommand', Object.assign(command, { sessionId }), this._currentTest);
+                    }
+                    await this._percyHandler?.browserBeforeCommand(Object.assign(command, { sessionId }));
+                });
                 /**
                  * register result event
                  */
-                this._browser.on('result', (result) => this._insightsHandler?.browserCommand('client:afterCommand', Object.assign(result, { sessionId }), this._currentTest));
+                this._browser.on('result', (result) => {
+                    if (this._observability) {
+                        this._insightsHandler?.browserCommand('client:afterCommand', Object.assign(result, { sessionId }), this._currentTest);
+                    }
+                    this._percyHandler?.browserAfterCommand(Object.assign(result, { sessionId }));
+                });
             }
             catch (err) {
                 BStackLogger.error(`Error in service class before function: ${err}`);
-                CrashReporter.uploadCrashReport(`Error in service class before function: ${err}`, err && err.stack);
+                if (this._observability) {
+                    CrashReporter.uploadCrashReport(`Error in service class before function: ${err}`, err && err.stack);
+                }
             }
         }
         if (this._browser && isBrowserstackSession(this._browser)) {
@@ -164,6 +189,7 @@ export default class BrowserstackService {
             this._failReasons.push((error && error.message) || 'Unknown Error');
         }
         await this._insightsHandler?.afterTest(test, results);
+        await this._percyHandler?.afterTest();
         await this._accessibilityHandler?.afterTest(this._suiteTitle, test);
     }
     async after(result) {
@@ -183,6 +209,7 @@ export default class BrowserstackService {
         }
         await this._insightsHandler?.uploadPending();
         await this._insightsHandler?.teardown();
+        await this._percyHandler?.teardown();
         if (process.env.BROWSERSTACK_O11Y_PERF_MEASUREMENT) {
             await PerformanceTester.stopAndGenerate('performance-service.html');
             PerformanceTester.calculateTimes([
@@ -227,6 +254,7 @@ export default class BrowserstackService {
             this._failReasons.push(exception);
         }
         await this._insightsHandler?.afterScenario(world);
+        await this._percyHandler?.afterScenario();
         await this._accessibilityHandler?.afterScenario(world);
     }
     async beforeStep(step, scenario) {
@@ -353,6 +381,7 @@ export default class BrowserstackService {
             const post = !this._options.sessionNameOmitTestTitle ? ` - ${test.title}` : '';
             name = `${pre}${test.parent}${post}`;
         }
+        this._percyHandler?._setSessionName(name);
         if (name !== this._fullTitle) {
             this._fullTitle = name;
             await this._updateJob({ name });

package/build/types.d.ts

@@ -51,6 +51,21 @@ export interface BrowserstackConfig {
      * For e.g. buildName, projectName, BrowserStack access credentials, etc.
      */
     testObservabilityOptions?: TestObservabilityOptions;
+    /**
+     * Set this to true to enable BrowserStack Percy which will take screenshots
+     * and snapshots for your tests run on Browserstack
+     * @default false
+     */
+    percy?: boolean;
+    /**
+     * Accepts mode as a string to auto capture screenshots at different execution points
+     * Accepted values are auto, click, testcase, screenshot & manual
+     */
+    percyCaptureMode?: string;
+    /**
+     * Set the Percy related config options under this key.
+    */
+    percyOptions?: any;
     /**
     * Set this to true to enable BrowserStack Accessibility Automation which will
     * automically conduct accessibility testing on your pre-existing test builds
@@ -253,6 +268,7 @@ interface IntegrationObject {
     browser_version?: string;
     platform?: string;
     product?: string;
+    platform_version?: string;
 }
 interface TestCodeBody {
     lang: string;