Starting BrowserBatteries

Author: aaltat

.gitignore

@@ -36,7 +36,6 @@ Browser/.installed
 
 browser_batteries/BrowserBatteries/bin/
 browser_batteries/robotframework_browser_batteries.egg-info
-browser_batteries/.DS_Store
 
 # Robot Framework outputs
 log.html

Browser/dev-requirements.txt

@@ -3,7 +3,7 @@ pytest >= 7.4.2
 pytest-watch >= 4.2.0
 mypy >= 1.8.0
 mypy-protobuf >= 3.5.0
-ruff>=0.12.0
+ruff>=0.12.8
 wheel>=0.40.0
 robotframework-pabot >= 4.0.0
 twine >= 4.0.2

Browser/playwright.py

@@ -18,12 +18,18 @@
 import platform
 import time
 from functools import cached_property
+from io import TextIOWrapper
 from pathlib import Path
 from subprocess import DEVNULL, STDOUT, CalledProcessError, Popen, run
 from typing import TYPE_CHECKING, Optional, Union
 
 import grpc  # type: ignore
 
+try:
+    from BrowserBatteries import start_grpc_server
+except ImportError:
+    start_grpc_server = None  # type: ignore[assignment]
+
 from Browser.generated import playwright_pb2_grpc
 from Browser.generated.playwright_pb2 import Request
 
@@ -36,6 +42,10 @@
 from .utils import PlaywrightLogTypes, find_free_port, logger
 
 
+def _run_grpc_server() -> bool:
+    return start_grpc_server is not None
+
+
 class Playwright(LibraryComponent):
     """A wrapper for communicating with nodejs Playwright process."""
 
@@ -66,7 +76,15 @@ def _playwright_process(self) -> Optional[Popen]:
         return process
 
     def ensure_node_dependencies(self):
-        # Checks if node is in PATH, errors if it isn't
+        """Ensure that node dependencies are installed.
+
+        If BrowserBatteries is installed, does nothing.
+        """
+        if _run_grpc_server():
+            logger.trace(
+                "Running gRPC server from BrowserBatteries, no need to check node"
+            )
+            return
         try:
             run(["node", "-v"], stdout=DEVNULL, check=True)
         except (CalledProcessError, FileNotFoundError, PermissionError) as err:
@@ -114,13 +132,19 @@ def start_playwright(self) -> Optional[Popen]:
                     f"ROBOT_FRAMEWORK_BROWSER_NODE_PORT {existing_port} defined in env, skipping Browser process start"
                 )
             return None
-        current_dir = Path(__file__).parent
-        workdir = current_dir / "wrapper"
-        playwright_script = workdir / "index.js"
         if self.playwright_log:
             logfile = self.playwright_log.open("w", encoding="utf-8")
         else:
             logfile = Path(os.devnull).open("w", encoding="utf-8")  # noqa: SIM115
+        if _run_grpc_server():
+            return start_grpc_server(logfile)
+        return self._start_playwright_from_node(logfile)
+
+    def _start_playwright_from_node(self, logfile: TextIOWrapper) -> Popen:
+        """Start Playwright from nodejs wrapper."""
+        current_dir = Path(__file__).parent
+        workdir = current_dir / "wrapper"
+        playwright_script = workdir / "index.js"
         host = str(self.host) if self.host is not None else "127.0.0.1"
         port = str(find_free_port())
         if self.enable_playwright_debug == PlaywrightLogTypes.playwright:

browser_batteries/BrowserBatteries/__init__.py

@@ -13,5 +13,16 @@
 # limitations under the License.
 
 
-def run_grpc_server():
-    """Run the gRPC server."""
+from io import TextIOWrapper
+from pathlib import Path
+from subprocess import Popen
+
+from robot.api import logger
+
+
+def start_grpc_server(logfile: TextIOWrapper) -> Popen:
+    """Run the prebuilt gRPC server."""
+    current_dir = Path(__file__).parent
+    playwright_script = current_dir / "bin" / "grpc_server"
+    logger.trace(f"Starting gRPC server from {playwright_script}")
+    return Popen([str(playwright_script)])