Merge pull request #81 from ruturaj-browserstack/own_local_binary

feat: add USE_OWN_LOCAL_BINARY_PROCESS option to control local binary usage

Author: Vishalan

src/config.ts

@@ -30,12 +30,17 @@ for (const key of BROWSERSTACK_LOCAL_OPTION_KEYS) {
   }
 }
 
+/**
+ * USE_OWN_LOCAL_BINARY_PROCESS:
+ *   If true, the system will not start a new local binary process, but will use the user's own process.
+ */
 export class Config {
   constructor(
     public readonly browserstackUsername: string,
     public readonly browserstackAccessKey: string,
     public readonly DEV_MODE: boolean,
     public readonly browserstackLocalOptions: Record<string, any>,
+    public readonly USE_OWN_LOCAL_BINARY_PROCESS: boolean,
   ) {}
 }
 
@@ -44,6 +49,7 @@ const config = new Config(
   process.env.BROWSERSTACK_ACCESS_KEY!,
   process.env.DEV_MODE === "true",
   browserstackLocalOptions,
+  process.env.USE_OWN_LOCAL_BINARY_PROCESS === "true",
 );
 
 export default config;

src/lib/local.ts

@@ -80,6 +80,24 @@ export async function ensureLocalBinarySetup(
     "Ensuring local binary setup as it is required for private URLs...",
   );
 
+  if (config.USE_OWN_LOCAL_BINARY_PROCESS) {
+    logger.info(
+      "Using user's own BrowserStack Local binary process, checking if it's running...",
+    );
+
+    const isRunning = await isBrowserStackLocalRunning();
+    if (!isRunning) {
+      throw new Error(
+        "USE_OWN_LOCAL_BINARY_PROCESS is enabled but BrowserStack Local process is not running. Please start your BrowserStack Local binary process first.",
+      );
+    }
+
+    logger.info(
+      "BrowserStack Local process is running, proceeding with user's own process.",
+    );
+    return;
+  }
+
   const localBinary = new Local();
   await killExistingBrowserStackLocalProcesses();
 

src/tools/accessiblity-utils/scanner.ts

@@ -35,6 +35,12 @@ export class AccessibilityScanner {
     const localHosts = new Set(["127.0.0.1", "localhost", "0.0.0.0"]);
     const BS_LOCAL_DOMAIN = "bs-local.com";
 
+    if (config.USE_OWN_LOCAL_BINARY_PROCESS && hasLocal) {
+      throw new Error(
+        "Cannot start scan with local URLs when using own BrowserStack Local binary process. Please set USE_OWN_LOCAL_BINARY_PROCESS to false.",
+      );
+    }
+
     if (hasLocal) {
       await ensureLocalBinarySetup(localIdentifier);
     } else {