@wdio/browserstack-service 7.34.0 → 7.35.0

package/build/Percy/PercyHelper.js

@@ -0,0 +1,78 @@
+"use strict";
+// ======= Percy helper methods start =======
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBestPlatformForPercySnapshot = exports.stopPercy = exports.startPercy = void 0;
+const PercyLogger_1 = require("./PercyLogger");
+const Percy_1 = __importDefault(require("./Percy"));
+const startPercy = async (options, config, bsConfig) => {
+    PercyLogger_1.PercyLogger.debug('Starting percy');
+    const percy = new Percy_1.default(options, config, bsConfig);
+    const response = await percy.start();
+    if (response) {
+        return percy;
+    }
+    return {};
+};
+exports.startPercy = startPercy;
+const stopPercy = async (percy) => {
+    PercyLogger_1.PercyLogger.debug('Stopping percy');
+    return percy.stop();
+};
+exports.stopPercy = stopPercy;
+const getBestPlatformForPercySnapshot = (capabilities) => {
+    try {
+        const percyBrowserPreference = { 'chrome': 0, 'firefox': 1, 'edge': 2, 'safari': 3 };
+        let bestPlatformCaps = null;
+        let bestBrowser = null;
+        if (Array.isArray(capabilities)) {
+            capabilities
+                .flatMap((c) => {
+                if (Object.values(c).length > 0 && Object.values(c).every(c => typeof c === 'object' && c.capabilities)) {
+                    return Object.values(c).map((o) => o.capabilities);
+                }
+                return c;
+            }).forEach((capability) => {
+                var _a;
+                let currBrowserName = capability.browserName;
+                if (capability['bstack:options']) {
+                    currBrowserName = capability['bstack:options'].browserName || currBrowserName;
+                }
+                if (!bestBrowser || !bestPlatformCaps || (bestPlatformCaps.deviceName || ((_a = bestPlatformCaps['bstack:options']) === null || _a === void 0 ? void 0 : _a.deviceName))) {
+                    bestBrowser = currBrowserName;
+                    bestPlatformCaps = capability;
+                }
+                else if (currBrowserName && percyBrowserPreference[currBrowserName.toLowerCase()] < percyBrowserPreference[bestBrowser.toLowerCase()]) {
+                    bestBrowser = currBrowserName;
+                    bestPlatformCaps = capability;
+                }
+            });
+            return bestPlatformCaps;
+        }
+        else if (typeof capabilities === 'object') {
+            Object.entries(capabilities).forEach(([, caps]) => {
+                var _a, _b;
+                let currBrowserName = caps.capabilities.browserName;
+                if (caps.capabilities['bstack:options']) {
+                    currBrowserName = ((_a = caps.capabilities['bstack:options']) === null || _a === void 0 ? void 0 : _a.browserName) || currBrowserName;
+                }
+                if (!bestBrowser || !bestPlatformCaps || (bestPlatformCaps.deviceName || ((_b = bestPlatformCaps['bstack:options']) === null || _b === void 0 ? void 0 : _b.deviceName))) {
+                    bestBrowser = currBrowserName;
+                    bestPlatformCaps = caps.capabilities;
+                }
+                else if (currBrowserName && percyBrowserPreference[currBrowserName.toLowerCase()] < percyBrowserPreference[bestBrowser.toLowerCase()]) {
+                    bestBrowser = currBrowserName;
+                    bestPlatformCaps = caps.capabilities;
+                }
+            });
+            return bestPlatformCaps;
+        }
+    }
+    catch (err) {
+        PercyLogger_1.PercyLogger.error(`Error while trying to determine best platform for Percy snapshot ${err}`);
+        return null;
+    }
+};
+exports.getBestPlatformForPercySnapshot = getBestPlatformForPercySnapshot;

package/build/Percy/PercyLogger.d.ts

@@ -0,0 +1,15 @@
+export declare class PercyLogger {
+    static logFilePath: string;
+    private static logFolderPath;
+    private static logFileStream;
+    static logToFile(logMessage: string, logLevel: string): void;
+    private static formatLog;
+    static info(message: string): void;
+    static error(message: string): void;
+    static debug(message: string, param?: any): void;
+    static warn(message: string): void;
+    static trace(message: string): void;
+    static clearLogger(): void;
+    static clearLogFile(): void;
+}
+//# sourceMappingURL=PercyLogger.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PercyLogger.d.ts","sourceRoot":"","sources":["../../src/Percy/PercyLogger.ts"],"names":[],"mappings":"AASA,qBAAa,WAAW;IACpB,OAAc,WAAW,SAA4C;IACrE,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;CAS7B"}

package/build/Percy/PercyLogger.js

@@ -0,0 +1,76 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PercyLogger = void 0;
+const node_path_1 = __importDefault(require("node:path"));
+const node_fs_1 = __importDefault(require("node:fs"));
+const logger_1 = __importDefault(require("@wdio/logger"));
+const constants_1 = require("../constants");
+const log = (0, logger_1.default)('@wdio/browserstack-service');
+class PercyLogger {
+    static logToFile(logMessage, logLevel) {
+        try {
+            if (!this.logFileStream) {
+                if (!node_fs_1.default.existsSync(this.logFolderPath)) {
+                    node_fs_1.default.mkdirSync(this.logFolderPath);
+                }
+                this.logFileStream = node_fs_1.default.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 `${new Date().toISOString()} ${level.toUpperCase()} @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() {
+        try {
+            if (node_fs_1.default.existsSync(this.logFilePath)) {
+                node_fs_1.default.truncateSync(this.logFilePath);
+            }
+        }
+        catch (err) {
+            log.error(`Failed to clear percy.log file. Error ${err}`);
+        }
+    }
+}
+exports.PercyLogger = PercyLogger;
+PercyLogger.logFilePath = node_path_1.default.join(process.cwd(), constants_1.PERCY_LOGS_FILE);
+PercyLogger.logFolderPath = node_path_1.default.join(process.cwd(), 'logs');

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":"AA0BA,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,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.screenshotApp = exports.screenshot = exports.snapshot = void 0;
+const tryRequire = function (pkg, fallback) {
+    try {
+        return require(pkg);
+    }
+    catch {
+        return fallback;
+    }
+};
+const percySnapshot = tryRequire('@percy/selenium-webdriver', null);
+const percyAppScreenshot = tryRequire('@percy/appium-app', {});
+const PercyLogger_1 = require("./PercyLogger");
+/* eslint-disable @typescript-eslint/no-unused-vars */
+let snapshotHandler = (...args) => {
+    PercyLogger_1.PercyLogger.error('Unsupported driver for percy');
+};
+if (percySnapshot) {
+    snapshotHandler = (browser, name) => {
+        if (process.env.PERCY_SNAPSHOT === 'true') {
+            return percySnapshot(browser, name);
+        }
+    };
+}
+exports.snapshot = snapshotHandler;
+/* eslint-disable @typescript-eslint/no-unused-vars */
+let screenshotHandler = async (...args) => {
+    PercyLogger_1.PercyLogger.error('Unsupported driver for percy');
+};
+if (percySnapshot && percySnapshot.percyScreenshot) {
+    screenshotHandler = percySnapshot.percyScreenshot;
+}
+exports.screenshot = screenshotHandler;
+/* eslint-disable @typescript-eslint/no-unused-vars */
+let screenshotAppHandler = async (...args) => {
+    PercyLogger_1.PercyLogger.error('Unsupported driver for percy');
+};
+if (percyAppScreenshot) {
+    screenshotAppHandler = percyAppScreenshot;
+}
+exports.screenshotApp = screenshotAppHandler;

package/build/constants.d.ts

@@ -14,4 +14,7 @@ export declare const DEFAULT_WAIT_TIMEOUT_FOR_PENDING_UPLOADS = 5000;
 export declare const DEFAULT_WAIT_INTERVAL_FOR_PENDING_UPLOADS = 100;
 export declare const ACCESSIBILITY_API_URL = "https://accessibility.browserstack.com/api";
 export declare const NOT_ALLOWED_KEYS_IN_CAPS: string[];
+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,SAAS,CAAA;AAEjD,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;AACvE,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;AAE5D,eAAO,MAAM,qBAAqB,+CAA+C,CAAA;AACjF,eAAO,MAAM,wBAAwB,UAA6D,CAAA"}
+{"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,CAKvD,CAAA;AAED,eAAO,MAAM,aAAa,EAAE,OAAO,OAAoC,CAAA;AACvE,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;AAE5D,eAAO,MAAM,qBAAqB,+CAA+C,CAAA;AACjF,eAAO,MAAM,wBAAwB,UAA6D,CAAA;AAElG,eAAO,MAAM,eAAe,mBAAmB,CAAA;AAE/C,eAAO,MAAM,qCAAqC,UAQjD,CAAA;AAED,eAAO,MAAM,aAAa,UAAwD,CAAA"}

package/build/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NOT_ALLOWED_KEYS_IN_CAPS = exports.ACCESSIBILITY_API_URL = exports.DEFAULT_WAIT_INTERVAL_FOR_PENDING_UPLOADS = exports.DEFAULT_WAIT_TIMEOUT_FOR_PENDING_UPLOADS = exports.BATCH_EVENT_TYPES = exports.DATA_BATCH_INTERVAL = exports.DATA_BATCH_SIZE = exports.DATA_SCREENSHOT_ENDPOINT = exports.DATA_BATCH_ENDPOINT = exports.DATA_EVENT_ENDPOINT = exports.DATA_ENDPOINT = exports.consoleHolder = exports.DEFAULT_OPTIONS = exports.VALID_APP_EXTENSION = exports.BROWSER_DESCRIPTION = void 0;
+exports.CAPTURE_MODES = exports.PERCY_DOM_CHANGING_COMMANDS_ENDPOINTS = exports.PERCY_LOGS_FILE = exports.NOT_ALLOWED_KEYS_IN_CAPS = exports.ACCESSIBILITY_API_URL = exports.DEFAULT_WAIT_INTERVAL_FOR_PENDING_UPLOADS = exports.DEFAULT_WAIT_TIMEOUT_FOR_PENDING_UPLOADS = exports.BATCH_EVENT_TYPES = exports.DATA_BATCH_INTERVAL = exports.DATA_BATCH_SIZE = exports.DATA_SCREENSHOT_ENDPOINT = exports.DATA_BATCH_ENDPOINT = exports.DATA_EVENT_ENDPOINT = exports.DATA_ENDPOINT = exports.consoleHolder = exports.DEFAULT_OPTIONS = exports.VALID_APP_EXTENSION = exports.BROWSER_DESCRIPTION = void 0;
 exports.BROWSER_DESCRIPTION = [
     'device',
     'os',
@@ -34,3 +34,14 @@ exports.DEFAULT_WAIT_TIMEOUT_FOR_PENDING_UPLOADS = 5000; // 5s
 exports.DEFAULT_WAIT_INTERVAL_FOR_PENDING_UPLOADS = 100; // 100ms
 exports.ACCESSIBILITY_API_URL = 'https://accessibility.browserstack.com/api';
 exports.NOT_ALLOWED_KEYS_IN_CAPS = ['includeTagsInTestingScope', 'excludeTagsInTestingScope'];
+exports.PERCY_LOGS_FILE = 'logs/percy.log';
+exports.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'
+];
+exports.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';
+export declare const PercySDK: typeof Percy;
 export * from './types';
 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,YAAY,CAAA;AAC7C,OAAO,mBAAmB,MAAM,WAAW,CAAA;AAC3C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAEjD,OAAO,eAAe,MAAM,mBAAmB,CAAA;AAE/C,eAAe,mBAAmB,CAAA;AAClC,eAAO,MAAM,QAAQ,6BAAuB,CAAA;AAC5C,eAAO,MAAM,cAAc;;CAAgB,CAAA;AAC3C,eAAO,MAAM,mBAAmB,wBAAkB,CAAA;AAClD,cAAc,SAAS,CAAA;AAEvB,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,YAAY,CAAA;AAC7C,OAAO,mBAAmB,MAAM,WAAW,CAAA;AAC3C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAEjD,OAAO,eAAe,MAAM,mBAAmB,CAAA;AAE/C,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,kBAAkB,CAAA;AACzC,eAAO,MAAM,QAAQ,cAAQ,CAAA;AAE7B,cAAc,SAAS,CAAA;AAEvB,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,WAAW,CAAC;QAClB,UAAU,aAAc,SAAQ,kBAAkB;SAAG;KACxD;CACJ"}

package/build/index.js

@@ -11,6 +11,18 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
@@ -18,7 +30,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BStackTestOpsLogger = exports.log4jsAppender = exports.launcher = void 0;
+exports.PercySDK = exports.BStackTestOpsLogger = exports.log4jsAppender = exports.launcher = void 0;
 const launcher_1 = __importDefault(require("./launcher"));
 const service_1 = __importDefault(require("./service"));
 const log4jsAppender_1 = require("./log4jsAppender");
@@ -27,4 +39,6 @@ exports.default = service_1.default;
 exports.launcher = launcher_1.default;
 exports.log4jsAppender = { configure: log4jsAppender_1.configure };
 exports.BStackTestOpsLogger = logReportingAPI_1.default;
+const Percy = __importStar(require("./Percy/PercySDK"));
+exports.PercySDK = Percy;
 __exportStar(require("./types"), exports);

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 { App, AppConfig, AppUploadResponse, BrowserstackConfig } from './types';
+import type { App, AppConfig, AppUploadResponse, BrowserstackConfig, UserConfig } from './types';
 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,11 +14,16 @@ export default class BrowserstackLauncherService implements Services.ServiceInst
     private _buildTag?;
     private _buildIdentifier?;
     private _accessibilityAutomation?;
+    private _percy?;
+    private _percyBestPlatformCaps?;
     _testOpsBuildStopped?: boolean;
     constructor(_options: BrowserstackConfig & Options.Testrunner, capabilities: Capabilities.RemoteCapability, _config: Options.Testrunner);
+    onWorkerStart(cid: any, caps: any): Promise<void>;
     setupExitHandlers(): 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":"AASA,OAAO,KAAK,yBAAyB,MAAM,oBAAoB,CAAA;AAE/D,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAMlE,OAAO,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAkBpF,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;IACnC,oBAAoB,CAAC,EAAE,OAAO,CAAA;gBAGzB,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EACzD,YAAY,EAAE,YAAY,CAAC,gBAAgB,EACnC,OAAO,EAAE,OAAO,CAAC,UAAU;IA+FvC,iBAAiB;IAUX,SAAS,CAAE,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB;IA4ItF,UAAU;IA6DV,UAAU,CAAC,GAAG,EAAC,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAkBrD;;;OAGG;IACG,YAAY,CAAE,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAyBhE,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,EAAC,MAAM;IAoF3F,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;CAQtF"}
+{"version":3,"file":"launcher.d.ts","sourceRoot":"","sources":["../src/launcher.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,yBAAyB,MAAM,oBAAoB,CAAA;AAE/D,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAOlE,OAAO,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAqBhG,KAAK,iBAAiB,GAAG,yBAAyB,CAAC,KAAK,GAAG;IACvD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,KAAK,IAAI,GAAG,IAAI,CAAC;CAC/C,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;IAC1D,oBAAoB,CAAC,EAAE,OAAO,CAAA;gBAGzB,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EACzD,YAAY,EAAE,YAAY,CAAC,gBAAgB,EACnC,OAAO,EAAE,OAAO,CAAC,UAAU;IAgGjC,aAAa,CAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG;IAaxC,iBAAiB;IAUX,SAAS,CAAE,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,EAAE,YAAY,CAAC,EAAE,YAAY,CAAC,kBAAkB;IAwJtF,UAAU;IAmEV,UAAU,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,UAAU,EAAE,QAAQ,EAAE,UAAU;IAuB7G,SAAS;IAYT,UAAU,CAAC,GAAG,EAAC,GAAG,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAkBrD;;;OAGG;IACG,YAAY,CAAE,SAAS,EAAE,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAyBhE,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,EAAC,MAAM;IAoF3F,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;CAQtF"}

package/build/launcher.js

@@ -40,14 +40,17 @@ const node_child_process_1 = require("node:child_process");
 // @ts-ignore
 const package_json_1 = require("../package.json");
 const crash_reporter_1 = __importDefault(require("./crash-reporter"));
+const PercyHelper_1 = require("./Percy/PercyHelper");
 const constants_1 = require("./constants");
 const util_2 = require("./util");
 const performance_tester_1 = __importDefault(require("./performance-tester"));
+const PercyLogger_1 = require("./Percy/PercyLogger");
 const log = (0, logger_1.default)('@wdio/browserstack-service');
 class BrowserstackLauncherService {
     constructor(_options, capabilities, _config) {
         this._options = _options;
         this._config = _config;
+        PercyLogger_1.PercyLogger.clearLogFile();
         // added to maintain backward compatibility with webdriverIO v5
         this.setupExitHandlers();
         this._config || (this._config = _options);
@@ -143,6 +146,19 @@ class BrowserstackLauncherService {
             log.error(`[Crash_Report_Upload] Config processing failed due to ${error}`);
         }
     }
+    async onWorkerStart(cid, caps) {
+        try {
+            if (this._options.percy && this._percyBestPlatformCaps) {
+                const isThisBestPercyPlatform = (0, util_2.ObjectsAreEqual)(caps, this._percyBestPlatformCaps);
+                if (isThisBestPercyPlatform) {
+                    process.env.BEST_PLATFORM_CID = cid;
+                }
+            }
+        }
+        catch (err) {
+            PercyLogger_1.PercyLogger.error(`Error while setting best platform for Percy snapshot at worker start ${err}`);
+        }
+    }
     setupExitHandlers() {
         process.on('exit', (code) => {
             if (!!process.env.BS_TESTOPS_JWT && !this._testOpsBuildStopped) {
@@ -239,6 +255,18 @@ class BrowserstackLauncherService {
                 buildIdentifier: this._buildIdentifier
             });
         }
+        if (this._options.percy) {
+            try {
+                const bestPlatformPercyCaps = (0, PercyHelper_1.getBestPlatformForPercySnapshot)(capabilities);
+                this._percyBestPlatformCaps = bestPlatformPercyCaps;
+                await this.setupPercy(this._options, this._config, {
+                    projectName: this._projectName
+                });
+            }
+            catch (err) {
+                PercyLogger_1.PercyLogger.error(`Error while setting up Percy ${err}`);
+            }
+        }
         if (!this._options.browserstackLocal) {
             return log.info('browserstackLocal is not enabled - skipping...');
         }
@@ -302,6 +330,10 @@ class BrowserstackLauncherService {
             const duration = (new Date()).getTime() - (new Date(process.env.START_TIME)).getTime();
             log.info(`Total duration is ${duration / 1000} s`);
         }
+        if (this._options.percy) {
+            await this.stopPercy();
+        }
+        PercyLogger_1.PercyLogger.clearLogger();
         if (!this.browserstackLocal || !this.browserstackLocal.isRunning()) {
             return;
         }
@@ -331,6 +363,42 @@ class BrowserstackLauncherService {
             return Promise.reject(err);
         });
     }
+    async setupPercy(options, config, bsConfig) {
+        var _a;
+        if ((_a = this._percy) === null || _a === void 0 ? void 0 : _a.isRunning()) {
+            return;
+        }
+        try {
+            this._percy = await (0, PercyHelper_1.startPercy)(options, config, bsConfig);
+            if (!this._percy) {
+                throw new Error('Could not start percy, check percy logs for info.');
+            }
+            PercyLogger_1.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_1.PercyLogger.debug(`Error in percy setup ${err}`);
+        }
+    }
+    async stopPercy() {
+        if (!this._percy || !this._percy.isRunning()) {
+            return;
+        }
+        try {
+            await (0, PercyHelper_1.stopPercy)(this._percy);
+            PercyLogger_1.PercyLogger.info('Percy stopped');
+        }
+        catch (err) {
+            PercyLogger_1.PercyLogger.error(`Error occured while stopping percy : ${err}`);
+        }
+    }
     async _uploadApp(app) {
         log.info(`uploading app ${app.app} ${app.customId ? `and custom_id: ${app.customId}` : ''} to browserstack`);
         const form = new form_data_1.default();

package/build/service.d.ts

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

package/build/service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC9E,OAAO,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAE9D,OAAO,KAAK,EAAE,kBAAkB,EAAE,iBAAiB,EAA8C,MAAM,SAAS,CAAA;AAKhH,OAAO,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AAgB7F,MAAM,CAAC,OAAO,OAAO,mBAAoB,YAAW,QAAQ,CAAC,eAAe;IAmBpE,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,OAAO;IAnBnB,OAAO,CAAC,eAAe,CAAmD;IAC1E,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,iBAAiB,CAAe;IACxC,OAAO,CAAC,gBAAgB,CAA4D;IACpF,OAAO,CAAC,QAAQ,CAAC,CAAgD;IACjE,OAAO,CAAC,WAAW,CAAC,CAAQ;IAC5B,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,YAAY,CAAC,YAAY,GAAG,YAAY,CAAC,mBAAmB,KAAK,IAAI;IAU7F,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,OAAO,CAAC,OAAO,CAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC;IA+D1H;;;;;;OAMG;IACG,WAAW,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IAQpC,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,GAAC,YAAY,EAAE,OAAO,EAAE,GAAG;IAK5D,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,GAAC,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,UAAU;IAI9F,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI;IAoBjC,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU;IAW/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;IA+BzD,cAAc,IAAI,OAAO;IAOzB,UAAU,CAAE,WAAW,EAAE,GAAG;IAU5B,kBAAkB,CAAE,MAAM,EAAE,iBAAiB;IAqB7C,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG;IAsBrC,gBAAgB;YAiCR,eAAe;IA0B7B,OAAO,CAAC,cAAc;YAIR,eAAe;CAqBhC"}
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAC9E,OAAO,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAE9D,OAAO,KAAK,EAAE,kBAAkB,EAAE,iBAAiB,EAA8C,MAAM,SAAS,CAAA;AAKhH,OAAO,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AAiB7F,MAAM,CAAC,OAAO,OAAO,mBAAoB,YAAW,QAAQ,CAAC,eAAe;IAqBpE,OAAO,CAAC,KAAK;IACb,OAAO,CAAC,OAAO;IArBnB,OAAO,CAAC,eAAe,CAAmD;IAC1E,OAAO,CAAC,YAAY,CAAe;IACnC,OAAO,CAAC,iBAAiB,CAAe;IACxC,OAAO,CAAC,gBAAgB,CAA4D;IACpF,OAAO,CAAC,QAAQ,CAAC,CAAgD;IACjE,OAAO,CAAC,WAAW,CAAC,CAAQ;IAC5B,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;IACnB,OAAO,CAAC,MAAM,CAAA;IACd,OAAO,CAAC,aAAa,CAAC,CAAc;gBAGhC,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,YAAY,CAAC,YAAY,GAAG,YAAY,CAAC,mBAAmB,KAAK,IAAI;IAU7F,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,OAAO,CAAC,OAAO,CAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC;IA4F1H;;;;;;OAMG;IACG,WAAW,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IAQpC,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,GAAC,YAAY,EAAE,OAAO,EAAE,GAAG;IAK5D,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,GAAC,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,UAAU;IAI9F,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI;IAoBjC,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU;IAY/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;IA+BzD,cAAc,IAAI,OAAO;IAOzB,UAAU,CAAE,WAAW,EAAE,GAAG;IAU5B,kBAAkB,CAAE,MAAM,EAAE,iBAAiB;IAqB7C,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG;IAsBrC,gBAAgB;YAiCR,eAAe;IA4B7B,OAAO,CAAC,cAAc;YAIR,eAAe;CAqBhC"}

package/build/service.js

@@ -12,6 +12,7 @@ const util_1 = require("./util");
 const reporter_1 = __importDefault(require("./reporter"));
 const performance_tester_1 = __importDefault(require("./performance-tester"));
 const accessibility_handler_1 = __importDefault(require("./accessibility-handler"));
+const Percy_Handler_1 = __importDefault(require("./Percy/Percy-Handler"));
 const log = (0, logger_1.default)('@wdio/browserstack-service');
 class BrowserstackService {
     constructor(options, _caps, _config) {
@@ -28,6 +29,7 @@ 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) {
             (_a = this._config.reporters) === null || _a === void 0 ? void 0 : _a.push(reporter_1.default);
@@ -44,6 +46,9 @@ 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;
@@ -77,29 +82,43 @@ class BrowserstackService {
             this._sessionBaseUrl = 'https://api.browserstack.com/automate-turboscale/v1/sessions';
         }
         this._scenariosThatRan = [];
-        if (this._observability && this._browser) {
+        if (this._browser) {
+            if (this._percy) {
+                this._percyHandler = new Percy_Handler_1.default(this._options.percyCaptureMode, this._browser, this._caps, this._isAppAutomate(), this._config.framework);
+                this._percyHandler.before();
+            }
             try {
-                (0, util_1.patchConsoleLogs)();
-                this._insightsHandler = new insights_handler_1.default(this._browser, this._browser.capabilities, this._isAppAutomate(), this._browser.sessionId, this._config.framework);
-                await this._insightsHandler.before();
+                if (this._observability) {
+                    (0, util_1.patchConsoleLogs)();
+                    this._insightsHandler = new insights_handler_1.default(this._browser, this._browser.capabilities, this._isAppAutomate(), this._browser.sessionId, this._config.framework);
+                    await this._insightsHandler.before();
+                }
                 /**
                  * register command event
                  */
                 this._browser.on('command', async (command) => {
-                    var _a, _b;
-                    return await ((_a = this._insightsHandler) === null || _a === void 0 ? void 0 : _a.browserCommand('client:beforeCommand', Object.assign(command, { sessionId: (_b = this._browser) === null || _b === void 0 ? void 0 : _b.sessionId }), this._currentTest));
+                    var _a, _b, _c, _d;
+                    if (this._observability) {
+                        await ((_a = this._insightsHandler) === null || _a === void 0 ? void 0 : _a.browserCommand('client:beforeCommand', Object.assign(command, { sessionId: (_b = this._browser) === null || _b === void 0 ? void 0 : _b.sessionId }), this._currentTest));
+                    }
+                    await ((_c = this._percyHandler) === null || _c === void 0 ? void 0 : _c.browserBeforeCommand(Object.assign(command, { sessionId: (_d = this._browser) === null || _d === void 0 ? void 0 : _d.sessionId })));
                 });
                 /**
                  * register result event
                  */
                 this._browser.on('result', async (result) => {
-                    var _a, _b;
-                    return await ((_a = this._insightsHandler) === null || _a === void 0 ? void 0 : _a.browserCommand('client:afterCommand', Object.assign(result, { sessionId: (_b = this._browser) === null || _b === void 0 ? void 0 : _b.sessionId }), this._currentTest));
+                    var _a, _b, _c, _d;
+                    if (this._observability) {
+                        await ((_a = this._insightsHandler) === null || _a === void 0 ? void 0 : _a.browserCommand('client:afterCommand', Object.assign(result, { sessionId: (_b = this._browser) === null || _b === void 0 ? void 0 : _b.sessionId }), this._currentTest));
+                    }
+                    (_c = this._percyHandler) === null || _c === void 0 ? void 0 : _c.browserAfterCommand(Object.assign(result, { sessionId: (_d = this._browser) === null || _d === void 0 ? void 0 : _d.sessionId }));
                 });
             }
             catch (err) {
                 log.error(`Error in service class before function: ${err}`);
-                crash_reporter_1.default.uploadCrashReport(`Error in service class before function: ${err}`, err && err.stack);
+                if (this._observability) {
+                    crash_reporter_1.default.uploadCrashReport(`Error in service class before function: ${err}`, err && err.stack);
+                }
             }
         }
         if (this._browser && (0, util_1.isBrowserstackSession)(this._browser)) {
@@ -159,17 +178,18 @@ class BrowserstackService {
         await ((_c = this._accessibilityHandler) === null || _c === void 0 ? void 0 : _c.beforeTest(suiteTitle, test));
     }
     async afterTest(test, context, results) {
-        var _a, _b;
+        var _a, _b, _c;
         this._specsRan = true;
         const { error, passed } = results;
         if (!passed) {
             this._failReasons.push((error && error.message) || 'Unknown Error');
         }
         await ((_a = this._insightsHandler) === null || _a === void 0 ? void 0 : _a.afterTest(test, results));
-        await ((_b = this._accessibilityHandler) === null || _b === void 0 ? void 0 : _b.afterTest(this._suiteTitle, test));
+        await ((_b = this._percyHandler) === null || _b === void 0 ? void 0 : _b.afterTest());
+        await ((_c = this._accessibilityHandler) === null || _c === void 0 ? void 0 : _c.afterTest(this._suiteTitle, test));
     }
     async after(result) {
-        var _a, _b;
+        var _a, _b, _c;
         const { preferScenarioName, setSessionName, setSessionStatus } = this._options;
         // For Cucumber: Checks scenarios that ran (i.e. not skipped) on the session
         // Only 1 Scenario ran and option enabled => Redefine session name to Scenario's name
@@ -186,6 +206,7 @@ class BrowserstackService {
         }
         await ((_a = this._insightsHandler) === null || _a === void 0 ? void 0 : _a.uploadPending());
         await ((_b = this._insightsHandler) === null || _b === void 0 ? void 0 : _b.teardown());
+        await ((_c = this._percyHandler) === null || _c === void 0 ? void 0 : _c.teardown());
         if (process.env.BROWSERSTACK_O11Y_PERF_MEASUREMENT) {
             await performance_tester_1.default.stopAndGenerate('performance-service.html');
             performance_tester_1.default.calculateTimes([
@@ -219,7 +240,7 @@ class BrowserstackService {
         await this._setAnnotation(`Scenario: ${scenarioName}`);
     }
     async afterScenario(world) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d;
         this._specsRan = true;
         const status = (_a = world.result) === null || _a === void 0 ? void 0 : _a.status.toLowerCase();
         if (status !== 'skipped') {
@@ -233,7 +254,8 @@ class BrowserstackService {
             this._failReasons.push(exception);
         }
         await ((_b = this._insightsHandler) === null || _b === void 0 ? void 0 : _b.afterScenario(world));
-        await ((_c = this._accessibilityHandler) === null || _c === void 0 ? void 0 : _c.afterScenario(world));
+        await ((_c = this._percyHandler) === null || _c === void 0 ? void 0 : _c.afterScenario());
+        await ((_d = this._accessibilityHandler) === null || _d === void 0 ? void 0 : _d.afterScenario(world));
     }
     async beforeStep(step, scenario) {
         var _a;
@@ -348,6 +370,7 @@ class BrowserstackService {
         });
     }
     async _setSessionName(suiteTitle, test) {
+        var _a;
         if (!this._options.setSessionName || !suiteTitle) {
             return;
         }
@@ -361,6 +384,7 @@ class BrowserstackService {
             const post = !this._options.sessionNameOmitTestTitle ? ` - ${test.title}` : '';
             name = `${pre}${test.parent}${post}`;
         }
+        (_a = this._percyHandler) === null || _a === void 0 ? void 0 : _a._setSessionName(name);
         if (name !== this._fullTitle) {
             this._fullTitle = name;
             await this._updateJob({ name });