start_grpc_server from BroserBatteries

Author: aaltat

Browser/playwright.py

@@ -132,24 +132,26 @@ def start_playwright(self) -> Optional[Popen]:
             logfile = self.playwright_log.open("w", encoding="utf-8")
         else:
             logfile = Path(os.devnull).open("w", encoding="utf-8")  # noqa: SIM115
+        host = str(self.host) if self.host is not None else "127.0.0.1"
+        port = str(find_free_port())
+        self.host = host
+        self.port = port
         if start_grpc_server is None:
-            return self._start_playwright_from_node(logfile)
-        return start_grpc_server(logfile)
+            return self._start_playwright_from_node(logfile, host, port)
+        return start_grpc_server(logfile, host, port, self.enable_playwright_debug)
 
-    def _start_playwright_from_node(self, logfile: TextIOWrapper) -> Popen:
+    def _start_playwright_from_node(
+        self, logfile: TextIOWrapper, host: str, port: str
+    ) -> 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:
             os.environ["DEBUG"] = "pw:api"
         logger.info(
             f"Starting Browser process {playwright_script} using at {host}:{port}"
         )
-        self.host = host
-        self.port = port
         node_args = ["node"]
         node_debug_options = os.environ.get(
             "ROBOT_FRAMEWORK_BROWSER_NODE_DEBUG_OPTIONS"

Browser/utils/misc.py

@@ -18,6 +18,7 @@
 import socket
 import string
 import subprocess
+from io import TextIOWrapper
 from pathlib import Path
 from typing import Any, Union
 
@@ -51,11 +52,23 @@ def spawn_node_process(output_dir: Path) -> tuple[subprocess.Popen, str]:
 
 
     """
+    try:
+        from BrowserBatteries import start_grpc_server  # noqa: PLC0415
+    except ImportError:
+        start_grpc_server = None  # type: ignore[assignment]
     logfile = output_dir.open("w", encoding="utf-8")
     os.environ["DEBUG"] = "pw:api"
-    os.environ["PLAYWRIGHT_BROWSERS_PATH"] = "0"
+    if start_grpc_server is None:
+        os.environ["PLAYWRIGHT_BROWSERS_PATH"] = "0"
     host = "127.0.0.1"
     port = str(find_free_port())
+    if start_grpc_server is None:
+        return _spawn_node_process(logfile, host, port)
+    process = start_grpc_server(logfile, host, port, True)
+    return process, port
+
+
+def _spawn_node_process(logfile: TextIOWrapper, host: str, port: str):
     process = subprocess.Popen(
         [
             "node",

browser_batteries/BrowserBatteries/__init__.py

@@ -13,16 +13,43 @@
 # limitations under the License.
 
 
+import os
 from io import TextIOWrapper
 from pathlib import Path
-from subprocess import Popen
+from subprocess import STDOUT, Popen
 
 from robot.api import logger
 
+from Browser.utils.data_types import PlaywrightLogTypes
 
-def start_grpc_server(logfile: TextIOWrapper) -> Popen:
+
+def start_grpc_server(
+    logfile: TextIOWrapper,
+    host: str,
+    port: str,
+    enable_playwright_debug: "PlaywrightLogTypes | bool",
+) -> 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)])
+    logger.info(f"Starting GRPC process {playwright_script} using at {host}:{port}")
+    args = [str(playwright_script), host, port]
+    workdir = current_dir / "bin"
+    if enable_playwright_debug == PlaywrightLogTypes.playwright:
+        logger.trace("Enabling Playwright debug logging")
+        os.environ["DEBUG"] = "pw:api"
+    if os.environ.get("ROBOT_FRAMEWORK_BROWSER_NODE_DEBUG_OPTIONS"):
+        logger.trace(
+            "it is not possible to define ROBOT_FRAMEWORK_BROWSER_NODE_DEBUG_OPTIONS for BrowserBatteries"
+        )
+    if not os.environ.get("PLAYWRIGHT_BROWSERS_PATH"):
+        logger.trace("Setting PLAYWRIGHT_BROWSERS_PATH to '0'")
+        os.environ["PLAYWRIGHT_BROWSERS_PATH"] = "0"
+    logger.trace(f"GRPC startup parameters: {args}")
+    return Popen(
+        args,
+        cwd=workdir,
+        env=os.environ,
+        stdout=logfile,
+        stderr=STDOUT,
+    )

tasks.py

@@ -44,7 +44,9 @@
 WRAPPER_DIR = PYTHON_SRC_DIR / "wrapper"
 node_protobuf_dir = ROOT_DIR / "node" / "playwright-wrapper" / "generated"
 node_dir = ROOT_DIR / "node"
-npm_deps_timestamp_file = ROOT_DIR / "node_modules" / ".installed"
+NODE_MODULES = ROOT_DIR / "node_modules"
+npm_deps_timestamp_file = NODE_MODULES / ".installed"
+
 node_lint_timestamp_file = node_dir / ".linted"
 ATEST_TIMEOUT = 900
 cpu_count = os.cpu_count() or 1
@@ -104,7 +106,7 @@ def deps(c, system=False):
     print("Install package dependencies.")
     c.run(uv_deps_cmd)
     if os.environ.get("CI"):
-        shutil.rmtree("node_modules", ignore_errors=True)
+        shutil.rmtree(str(NODE_MODULES), ignore_errors=True)
 
     if _sources_changed([ROOT_DIR / "./package-lock.json"], npm_deps_timestamp_file):
         arch = " --target_arch=x64" if platform.processor() == "arm" else ""
@@ -198,14 +200,9 @@ def _python_protobuf_gen(c):
 def _node_protobuf_gen(c):
     plugin_suffix = ".cmd" if platform.platform().startswith("Windows") else ""
     protoc_plugin = (
-        ROOT_DIR
-        / "node_modules"
-        / ".bin"
-        / f"grpc_tools_node_protoc_plugin{plugin_suffix}"
-    )
-    protoc_ts_plugin = (
-        ROOT_DIR / "node_modules" / ".bin" / f"protoc-gen-ts{plugin_suffix}"
+        NODE_MODULES / ".bin" / f"grpc_tools_node_protoc_plugin{plugin_suffix}"
     )
+    protoc_ts_plugin = NODE_MODULES / ".bin" / f"protoc-gen-ts{plugin_suffix}"
     cmd = (
         "npm run grpc_tools_node_protoc -- "
         f"--js_out=import_style=commonjs,binary:{node_protobuf_dir} "
@@ -320,6 +317,14 @@ def clean_atest(c):
     _clean_zip_dir()
 
 
+def _batteries(batteries: bool):
+    if batteries:
+        print("Running with BrowserBatteries")
+        sys.path.append(str(BROWSER_BATTERIES_DIR))
+        browser_path = NODE_MODULES / "playwright-core" / ".local-browsers"
+        os.environ["PLAYWRIGHT_BROWSERS_PATH"] = str(browser_path)
+
+
 @task(clean_atest, create_test_app)
 def atest(
     c,
@@ -335,6 +340,7 @@ def atest(
     framed=False,
     exclude=None,
     loglevel=None,
+    batteries=False,
 ):
     """Runs Robot Framework acceptance tests with pabot.
 
@@ -348,6 +354,7 @@ def atest(
         smoke: If true, runs only tests that take less than 500ms.
         include_mac: Does not exclude no-mac-support tags. Should be only used in local testing
         loglevel: Set log level for robot framework
+        batteries: Run test with BrowserBatteries. Assumes that GRPC server is build.
     """
     if IS_GITPOD and (not processes or int(processes) > 6):
         processes = "6"
@@ -381,7 +388,7 @@ def atest(
     loglevel = loglevel or "DEBUG"
     args.extend(["--exclude", "tidy-transformer"])
     ATEST_OUTPUT.mkdir(parents=True, exist_ok=True)
-
+    _batteries(batteries)
     background_process, port = spawn_node_process(ATEST_OUTPUT / "playwright-log.txt")
     try:
         os.environ["ROBOT_FRAMEWORK_BROWSER_NODE_PORT"] = port
@@ -475,12 +482,13 @@ def copy_xunit(c):
 
 
 @task(clean_atest)
-def atest_robot(c, zip=None, smoke=False, suite=None):
+def atest_robot(c, zip=None, smoke=False, suite=None, batteries=False):
     """Run atest with Robot Framework
 
     Arguments:
         zip: Create zip file from output files.
         smoke: If true, runs only tests that take less than 500ms.
+        batteries: If true, includes BrowserBatteries in the test run.
     """
     os.environ["ROBOT_SYSLOG_FILE"] = str(ATEST_OUTPUT / "syslog.txt")
     sys_var_ci = int(os.environ.get("SYS_VAR_CI_INSTALL_TEST", 0))
@@ -511,6 +519,7 @@ def atest_robot(c, zip=None, smoke=False, suite=None):
         command_args.extend(["--suite", suite])
     command_args = _add_skips(command_args)
     command_args.append("atest/test")
+    _batteries(batteries)
     env = os.environ.copy()
     process = subprocess.Popen(command_args, env=env)
     process.wait(ATEST_TIMEOUT)
@@ -540,11 +549,14 @@ def atest_failed(c):
 
 
 @task()
-def run_tests(c, tests):
+def run_tests(c, tests, batteries=False):
     """Run robot with dev Browser.
 
-    Parameter [tests] is the path to tests to run.
+    Arguments:
+        tests: is the path to tests to run.
+        batteries: If true, includes BrowserBatteries in the test run.
     """
+    _batteries(batteries)
     env = os.environ.copy()
     process = subprocess.Popen(
         [