Add option to use Chrome's old headless mode

Author: mdmintz

seleniumbase/behave/behave_sb.py

@@ -44,8 +44,9 @@
 -D sjw  (Skip JS Waits for readyState to be "complete" or Angular to load.)
 -D wfa  (Wait for AngularJS to be done loading after specific web actions.)
 -D pls=PLS  (Set pageLoadStrategy on Chrome: "normal", "eager", or "none".)
--D headless  (Run tests in headless mode. The default arg on Linux OS.)
--D headless2  (Use the new headless mode, which supports extensions.)
+-D headless  (The default headless mode. Linux uses this mode by default.)
+-D headless1  (Use Chrome's old headless mode. Fast, but has limitations.)
+-D headless2  (Use Chrome's new headless mode, which supports extensions.)
 -D headed  (Run tests in headed/GUI mode on Linux OS, where not default.)
 -D xvfb  (Run tests using the Xvfb virtual display server on Linux OS.)
 -D xvfb-metrics=STRING  (Set Xvfb display size on Linux: "Width,Height".)
@@ -144,6 +145,7 @@ def get_configured_sb(context):
     sb.browser = "chrome"
     sb.is_behave = True
     sb.headless = False
+    sb.headless1 = False
     sb.headless2 = False
     sb.headless_active = False
     sb.headed = False
@@ -296,6 +298,11 @@ def get_configured_sb(context):
             sb.headless = True
             continue
         # Handle: -D headless2
+        if low_key == "headless1":
+            sb.headless1 = True
+            sb.headless = True
+            continue
+        # Handle: -D headless2
         if low_key == "headless2":
             sb.headless2 = True
             continue
@@ -864,6 +871,7 @@ def get_configured_sb(context):
     # Recorder Mode can still optimize scripts in "-D headless2" mode.
     if sb.recorder_ext and sb.headless:
         sb.headless = False
+        sb.headless1 = False
         sb.headless2 = True
     if sb.headless2 and sb.browser == "firefox":
         sb.headless2 = False  # Only for Chromium browsers
@@ -900,11 +908,13 @@ def get_configured_sb(context):
     # Recorder Mode can still optimize scripts in --headless2 mode.
     if sb.recorder_mode and sb.headless:
         sb.headless = False
+        sb.headless1 = False
         sb.headless2 = True
     if not sb.headless and not sb.headless2:
         sb.headed = True
     if sb.browser == "safari" and sb.headless:
         sb.headless = False  # Safari doesn't support headless mode
+        sb.headless1 = False
     if sb.save_screenshot_after_test and sb.no_screenshot_after_test:
         sb.save_screenshot_after_test = False  # "no_screenshot" has priority
     if sb.servername != "localhost":

seleniumbase/core/browser_launcher.py

@@ -1553,6 +1553,7 @@ def _set_chrome_options(
     log_cdp_events,
     no_sandbox,
     disable_gpu,
+    headless1,
     headless2,
     incognito,
     guest_mode,
@@ -1771,7 +1772,10 @@ def _set_chrome_options(
             pass  # Processed After Version Check
     elif headless:
         if not undetectable:
-            chrome_options.add_argument("--headless")
+            if headless1:
+                chrome_options.add_argument("--headless=old")
+            else:
+                chrome_options.add_argument("--headless")
         if undetectable and servername and servername != "localhost":
             # The Grid Node will need Chrome 109 or newer
             chrome_options.add_argument("--headless=new")
@@ -2193,6 +2197,7 @@ def get_driver(
     log_cdp_events=False,
     no_sandbox=False,
     disable_gpu=False,
+    headless1=False,
     headless2=False,
     incognito=False,
     guest_mode=False,
@@ -2406,6 +2411,7 @@ def get_driver(
             log_cdp_events,
             no_sandbox,
             disable_gpu,
+            headless1,
             headless2,
             incognito,
             guest_mode,
@@ -2462,6 +2468,7 @@ def get_driver(
             log_cdp_events,
             no_sandbox,
             disable_gpu,
+            headless1,
             headless2,
             incognito,
             guest_mode,
@@ -2522,6 +2529,7 @@ def get_remote_driver(
     log_cdp_events,
     no_sandbox,
     disable_gpu,
+    headless1,
     headless2,
     incognito,
     guest_mode,
@@ -2657,6 +2665,7 @@ def get_remote_driver(
             log_cdp_events,
             no_sandbox,
             disable_gpu,
+            headless1,
             headless2,
             incognito,
             guest_mode,
@@ -2829,6 +2838,7 @@ def get_remote_driver(
             log_cdp_events,
             no_sandbox,
             disable_gpu,
+            headless1,
             headless2,
             incognito,
             guest_mode,
@@ -2948,6 +2958,7 @@ def get_local_driver(
     log_cdp_events,
     no_sandbox,
     disable_gpu,
+    headless1,
     headless2,
     incognito,
     guest_mode,
@@ -3425,8 +3436,14 @@ def get_local_driver(
                 else:
                     pass  # Will need Xvfb on Linux
         elif headless:
-            if "--headless" not in edge_options.arguments:
-                edge_options.add_argument("--headless")
+            if (
+                "--headless" not in edge_options.arguments
+                and "--headless=old" not in edge_options.arguments
+            ):
+                if headless1:
+                    edge_options.add_argument("--headless=old")
+                else:
+                    edge_options.add_argument("--headless")
         if mobile_emulator and not is_using_uc(undetectable, browser_name):
             emulator_settings = {}
             device_metrics = {}
@@ -3788,6 +3805,7 @@ def get_local_driver(
                 log_cdp_events,
                 no_sandbox,
                 disable_gpu,
+                headless1,
                 headless2,
                 incognito,
                 guest_mode,
@@ -3960,8 +3978,14 @@ def get_local_driver(
                 except Exception:
                     pass  # Will need Xvfb on Linux
             elif headless:
-                if "--headless" not in chrome_options.arguments:
-                    chrome_options.add_argument("--headless")
+                if (
+                    "--headless" not in chrome_options.arguments
+                    and "--headless=old" not in chrome_options.arguments
+                ):
+                    if headless1:
+                        chrome_options.add_argument("--headless=old")
+                    else:
+                        chrome_options.add_argument("--headless")
             if LOCAL_CHROMEDRIVER and os.path.exists(LOCAL_CHROMEDRIVER):
                 try:
                     make_driver_executable_if_not(LOCAL_CHROMEDRIVER)
@@ -4227,6 +4251,12 @@ def get_local_driver(
                                     chrome_options.arguments.remove(
                                         "--headless"
                                     )
+                                if "--headless=old" in (
+                                    chrome_options.arguments
+                                ):
+                                    chrome_options.arguments.remove(
+                                        "--headless=old"
+                                    )
                             uc_chrome_version = None
                             if (
                                 use_version.isnumeric()
@@ -4300,6 +4330,7 @@ def get_local_driver(
                                         False,  # log_cdp_events
                                         no_sandbox,
                                         disable_gpu,
+                                        False,  # headless1
                                         False,  # headless2
                                         incognito,
                                         guest_mode,
@@ -4541,6 +4572,7 @@ def get_local_driver(
                         False,  # log_cdp_events
                         no_sandbox,
                         disable_gpu,
+                        False,  # headless1
                         False,  # headless2
                         incognito,
                         guest_mode,
@@ -4792,6 +4824,8 @@ def get_local_driver(
                     )
                     if "--headless" in chrome_options.arguments:
                         chrome_options.arguments.remove("--headless")
+                    if "--headless=old" in chrome_options.arguments:
+                        chrome_options.arguments.remove("--headless=old")
                     service = ChromeService(
                         log_output=os.devnull,
                         service_args=["--disable-build-check"]

seleniumbase/fixtures/base_case.py

@@ -3771,6 +3771,7 @@ def get_new_driver(
         log_cdp_events=None,
         no_sandbox=None,
         disable_gpu=None,
+        headless1=None,
         headless2=None,
         incognito=None,
         guest_mode=None,
@@ -3830,6 +3831,7 @@ def get_new_driver(
         log_cdp_events - capture {"performance": "ALL", "browser": "ALL"})
         no_sandbox - the option to enable the "No-Sandbox" feature (Chrome)
         disable_gpu - the option to enable Chrome's "Disable GPU" feature
+        headless1 - the option to use the older headless mode (Chromium)
         headless2 - the option to use the newer headless mode (Chromium)
         incognito - the option to enable Chrome's Incognito mode (Chrome)
         guest_mode - the option to enable Chrome's Guest mode (Chrome)
@@ -3938,6 +3940,8 @@ def get_new_driver(
             no_sandbox = self.no_sandbox
         if disable_gpu is None:
             disable_gpu = self.disable_gpu
+        if headless1 is None:
+            headless1 = self.headless1
         if headless2 is None:
             headless2 = self.headless2
         if incognito is None:
@@ -4036,6 +4040,7 @@ def get_new_driver(
             log_cdp_events=log_cdp_events,
             no_sandbox=no_sandbox,
             disable_gpu=disable_gpu,
+            headless1=headless1,
             headless2=headless2,
             incognito=incognito,
             guest_mode=guest_mode,
@@ -14324,6 +14329,10 @@ def setUp(self, masterqa_mode=False):
             self.env = self.environment  # Add a shortened version
             self.with_selenium = sb_config.with_selenium  # Should be True
             self.headless = sb_config.headless
+            self.headless1 = sb_config.headless1
+            if self.headless1:
+                self.headless = True
+            self.headless2 = sb_config.headless2
             self.headless_active = False
             sb_config.headless_active = False
             self.headed = sb_config.headed
@@ -14392,7 +14401,6 @@ def setUp(self, masterqa_mode=False):
             self.log_cdp_events = sb_config.log_cdp_events
             self.no_sandbox = sb_config.no_sandbox
             self.disable_gpu = sb_config.disable_gpu
-            self.headless2 = sb_config.headless2
             self.incognito = sb_config.incognito
             self.guest_mode = sb_config.guest_mode
             self.dark_mode = sb_config.dark_mode
@@ -14768,6 +14776,7 @@ def setUp(self, masterqa_mode=False):
                 log_cdp_events=self.log_cdp_events,
                 no_sandbox=self.no_sandbox,
                 disable_gpu=self.disable_gpu,
+                headless1=self.headless1,
                 headless2=self.headless2,
                 incognito=self.incognito,
                 guest_mode=self.guest_mode,

seleniumbase/plugins/driver_manager.py

@@ -65,7 +65,8 @@ def __exit__(self, exc_type, exc_val, exc_tb):
 
 def Driver(
     browser=None,  # Choose from "chrome", "edge", "firefox", or "safari".
-    headless=None,  # The original headless mode for Chromium and Firefox.
+    headless=None,  # The default headless mode for Chromium and Firefox.
+    headless1=None,  # Chromium's old headless mode. (Fast, but limited)
     headless2=None,  # Chromium's new headless mode. (Has more features)
     headed=None,  # Run tests in headed/GUI mode on Linux, where not default.
     locale_code=None,  # Set the Language Locale Code for the web browser.
@@ -336,6 +337,13 @@ def Driver(
             headless = True
         else:
             headless = False
+    if headless1 is None:
+        if "--headless1" in sys_argv:
+            headless1 = True
+        else:
+            headless1 = False
+    if headless1:
+        headless = True
     if headless2 is None:
         if "--headless2" in sys_argv:
             headless2 = True
@@ -601,6 +609,7 @@ def Driver(
         headless = True
     if recorder_mode and headless:
         headless = False
+        headless1 = False
         headless2 = True
     if headless2 and browser == "firefox":
         headless2 = False  # Only for Chromium browsers
@@ -773,6 +782,7 @@ def Driver(
         log_cdp_events=log_cdp_events,
         no_sandbox=no_sandbox,
         disable_gpu=disable_gpu,
+        headless1=headless1,
         headless2=headless2,
         incognito=incognito,
         guest_mode=guest_mode,

seleniumbase/plugins/pytest_plugin.py

@@ -62,8 +62,9 @@ def pytest_addoption(parser):
     --sjw  (Skip JS Waits for readyState to be "complete" or Angular to load.)
     --wfa  (Wait for AngularJS to be done loading after specific web actions.)
     --pls=PLS  (Set pageLoadStrategy on Chrome: "normal", "eager", or "none".)
-    --headless  (Run tests in headless mode. The default arg on Linux OS.)
-    --headless2  (Use the new headless mode, which supports extensions.)
+    --headless  (The default headless mode. Linux uses this mode by default.)
+    --headless1  (Use Chrome's old headless mode. Fast, but has limitations.)
+    --headless2  (Use Chrome's new headless mode, which supports extensions.)
     --headed  (Run tests in headed/GUI mode on Linux OS, where not default.)
     --xvfb  (Run tests using the Xvfb virtual display server on Linux OS.)
     --xvfb-metrics=STRING  (Set Xvfb display size on Linux: "Width,Height".)
@@ -700,6 +701,15 @@ def pytest_addoption(parser):
                 UNLESS using a virtual display with Xvfb.
                 Default: False on Mac/Windows. True on Linux.""",
     )
+    parser.addoption(
+        "--headless1",
+        action="store_true",
+        dest="headless1",
+        default=False,
+        help="""This option activates the old headless mode,
+                which is faster, but has limitations.
+                (May be phased out by Chrome in the future.)""",
+    )
     parser.addoption(
         "--headless2",
         action="store_true",
@@ -1533,6 +1543,9 @@ def pytest_configure(config):
     sb_config.mobile_emulator = config.getoption("mobile_emulator")
     sb_config.device_metrics = config.getoption("device_metrics")
     sb_config.headless = config.getoption("headless")
+    sb_config.headless1 = config.getoption("headless1")
+    if sb_config.headless1:
+        sb_config.headless = True
     sb_config.headless2 = config.getoption("headless2")
     if sb_config.headless2 and sb_config.browser == "firefox":
         sb_config.headless2 = False  # Only for Chromium browsers
@@ -1759,6 +1772,7 @@ def pytest_configure(config):
     # Recorder Mode can still optimize scripts in --headless2 mode.
     if sb_config.recorder_mode and sb_config.headless:
         sb_config.headless = False
+        sb_config.headless1 = False
         sb_config.headless2 = True
 
     if not sb_config.headless and not sb_config.headless2:
@@ -1779,6 +1793,7 @@ def pytest_configure(config):
 
     if sb_config.browser == "safari" and sb_config.headless:
         sb_config.headless = False  # Safari doesn't support headless mode
+        sb_config.headless1 = False
 
     if sb_config.dash_title:
         constants.Dashboard.TITLE = sb_config.dash_title.replace("_", " ")