Add more options for capturing CDP logs

Author: mdmintz

examples/raw_parameter_script.py

@@ -71,6 +71,7 @@
     sb.no_sandbox = False
     sb.disable_js = False
     sb.disable_gpu = False
+    sb.log_cdp_events = False
     sb._multithreaded = False
     sb._reuse_session = False
     sb._crumbs = False

help_docs/method_summary.md

@@ -282,6 +282,7 @@ self.get_new_driver(
     undetectable=None,
     uc_cdp_events=None,
     uc_subprocess=None,
+    log_cdp_events=None,
     no_sandbox=None,
     disable_gpu=None,
     headless2=None,

seleniumbase/behave/behave_sb.py

@@ -75,6 +75,7 @@
 -D enable-sync  (Enable "Chrome Sync".)
 -D uc | -D undetected  (Use undetected-chromedriver to evade bot-detection)
 -D uc-cdp-events  (Capture CDP events when running in "-D undetected" mode)
+-D log-cdp  ("goog:loggingPrefs", {"performance": "ALL", "browser": "ALL"})
 -D remote-debug  (Sync to Chrome Remote Debugger chrome://inspect/#devices)
 -D dashboard  (Enable the SeleniumBase Dashboard. Saved at: dashboard.html)
 -D dash-title=STRING  (Set the title shown for the generated dashboard.)
@@ -181,6 +182,7 @@ def get_configured_sb(context):
     sb.undetectable = False
     sb.uc_cdp_events = False
     sb.uc_subprocess = False
+    sb.log_cdp_events = False
     sb.no_sandbox = False
     sb.disable_gpu = False
     sb._multithreaded = False
@@ -549,6 +551,10 @@ def get_configured_sb(context):
             sb.uc_subprocess = True
             sb.undetectable = True
             continue
+        # Handle: -D log-cdp-events / log_cdp_events / log-cdp
+        if low_key in ["log-cdp-events", "log_cdp_events", "log-cdp"]:
+            sb.log_cdp_events = True
+            continue
         # Handle: -D no-sandbox / no_sandbox
         if low_key in ["no-sandbox", "no_sandbox"]:
             sb.no_sandbox = True

seleniumbase/core/browser_launcher.py

@@ -714,6 +714,7 @@ def _set_chrome_options(
     undetectable,
     uc_cdp_events,
     uc_subprocess,
+    log_cdp_events,
     no_sandbox,
     disable_gpu,
     headless2,
@@ -787,6 +788,10 @@ def _set_chrome_options(
             "excludeSwitches",
             ["enable-automation", "enable-logging", "enable-blink-features"],
         )
+    if log_cdp_events:
+        chrome_options.set_capability(
+            "goog:loggingPrefs", {"performance": "ALL", "browser": "ALL"}
+        )
     if mobile_emulator and not is_using_uc(undetectable, browser_name):
         emulator_settings = {}
         device_metrics = {}
@@ -1258,6 +1263,7 @@ def get_driver(
     undetectable=False,
     uc_cdp_events=False,
     uc_subprocess=False,
+    log_cdp_events=False,
     no_sandbox=False,
     disable_gpu=False,
     headless2=False,
@@ -1468,6 +1474,7 @@ def get_driver(
             undetectable,
             uc_cdp_events,
             uc_subprocess,
+            log_cdp_events,
             no_sandbox,
             disable_gpu,
             headless2,
@@ -1521,6 +1528,7 @@ def get_driver(
             undetectable,
             uc_cdp_events,
             uc_subprocess,
+            log_cdp_events,
             no_sandbox,
             disable_gpu,
             headless2,
@@ -1578,6 +1586,7 @@ def get_remote_driver(
     undetectable,
     uc_cdp_events,
     uc_subprocess,
+    log_cdp_events,
     no_sandbox,
     disable_gpu,
     headless2,
@@ -1698,6 +1707,7 @@ def get_remote_driver(
             undetectable,
             uc_cdp_events,
             uc_subprocess,
+            log_cdp_events,
             no_sandbox,
             disable_gpu,
             headless2,
@@ -1861,6 +1871,7 @@ def get_remote_driver(
             undetectable,
             uc_cdp_events,
             uc_subprocess,
+            log_cdp_events,
             no_sandbox,
             disable_gpu,
             headless2,
@@ -1974,6 +1985,7 @@ def get_local_driver(
     undetectable,
     uc_cdp_events,
     uc_subprocess,
+    log_cdp_events,
     no_sandbox,
     disable_gpu,
     headless2,
@@ -2382,6 +2394,10 @@ def get_local_driver(
         edge_options.add_experimental_option(
             "excludeSwitches", ["enable-automation", "enable-logging"]
         )
+        if log_cdp_events:
+            edge_options.set_capability(
+                "ms:loggingPrefs", {"performance": "ALL", "browser": "ALL"}
+            )
         if not enable_sync:
             edge_options.add_argument("--disable-sync")
         if (
@@ -2712,6 +2728,7 @@ def get_local_driver(
                 undetectable,
                 uc_cdp_events,
                 uc_subprocess,
+                log_cdp_events,
                 no_sandbox,
                 disable_gpu,
                 headless2,

seleniumbase/fixtures/base_case.py

@@ -3737,6 +3737,7 @@ def get_new_driver(
         undetectable=None,
         uc_cdp_events=None,
         uc_subprocess=None,
+        log_cdp_events=None,
         no_sandbox=None,
         disable_gpu=None,
         headless2=None,
@@ -3793,6 +3794,7 @@ def get_new_driver(
         undetectable - the option to use an undetectable chromedriver
         uc_cdp_events - capture CDP events in "undetectable" mode (Chrome)
         uc_subprocess - use the undetectable chromedriver as a subprocess
+        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
         headless2 - the option to use the newer headless mode (Chromium)
@@ -3895,6 +3897,8 @@ def get_new_driver(
             uc_cdp_events = self.uc_cdp_events
         if uc_subprocess is None:
             uc_subprocess = self.uc_subprocess
+        if log_cdp_events is None:
+            log_cdp_events = self.log_cdp_events
         if no_sandbox is None:
             no_sandbox = self.no_sandbox
         if disable_gpu is None:
@@ -3992,6 +3996,7 @@ def get_new_driver(
             undetectable=undetectable,
             uc_cdp_events=uc_cdp_events,
             uc_subprocess=uc_subprocess,
+            log_cdp_events=log_cdp_events,
             no_sandbox=no_sandbox,
             disable_gpu=disable_gpu,
             headless2=headless2,
@@ -14233,6 +14238,7 @@ def setUp(self, masterqa_mode=False):
             self.undetectable = sb_config.undetectable
             self.uc_cdp_events = sb_config.uc_cdp_events
             self.uc_subprocess = sb_config.uc_subprocess
+            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
@@ -14556,6 +14562,7 @@ def setUp(self, masterqa_mode=False):
                 undetectable=self.undetectable,
                 uc_cdp_events=self.uc_cdp_events,
                 uc_subprocess=self.uc_subprocess,
+                log_cdp_events=self.log_cdp_events,
                 no_sandbox=self.no_sandbox,
                 disable_gpu=self.disable_gpu,
                 headless2=self.headless2,

seleniumbase/plugins/driver_manager.py

@@ -88,6 +88,7 @@ def Driver(
     undetectable=None,  # Use undetected-chromedriver to evade bot-detection.
     uc_cdp_events=None,  # Capture CDP events in undetected-chromedriver mode.
     uc_subprocess=None,  # Use undetected-chromedriver as a subprocess.
+    log_cdp_events=None,  # capture {"performance": "ALL", "browser": "ALL"})
     no_sandbox=None,  # (DEPRECATED) - "--no-sandbox" is always used now.
     disable_gpu=None,  # (DEPRECATED) - GPU is disabled if not "swiftshader".
     incognito=None,  # Enable Chromium's Incognito mode.
@@ -120,6 +121,7 @@ def Driver(
     undetected=None,  # Shortcut / Duplicate of "undetectable".
     uc_cdp=None,  # Shortcut / Duplicate of "uc_cdp_events".
     uc_sub=None,  # Shortcut / Duplicate of "uc_subprocess".
+    log_cdp=None,  # Shortcut / Duplicate of "log_cdp_events".
     wire=None,  # Shortcut / Duplicate of "use_wire".
     pls=None,  # Shortcut / Duplicate of "page_load_strategy".
 ):
@@ -352,6 +354,20 @@ def Driver(
         uc_cdp_events = True
     else:
         uc_cdp_events = False
+    if log_cdp_events is None and log_cdp is None:
+        if (
+            "--log-cdp-events" in sys_argv
+            or "--log_cdp_events" in sys_argv
+            or "--log-cdp" in sys_argv
+            or "--log_cdp" in sys_argv
+        ):
+            log_cdp_events = True
+        else:
+            log_cdp_events = False
+    elif log_cdp_events or log_cdp:
+        log_cdp_events = True
+    else:
+        log_cdp_events = False
     if use_auto_ext is None:
         if "--use-auto-ext" in sys_argv:
             use_auto_ext = True
@@ -458,6 +474,7 @@ def Driver(
         undetectable=undetectable,
         uc_cdp_events=uc_cdp_events,
         uc_subprocess=uc_subprocess,
+        log_cdp_events=log_cdp_events,
         no_sandbox=no_sandbox,
         disable_gpu=disable_gpu,
         headless2=headless2,

seleniumbase/plugins/pytest_plugin.py

@@ -90,6 +90,7 @@ def pytest_addoption(parser):
     --enable-sync  (Enable "Chrome Sync" on websites.)
     --uc | --undetected  (Use undetected-chromedriver to evade bot-detection.)
     --uc-cdp-events  (Capture CDP events when running in "--undetected" mode.)
+    --log-cdp  ("goog:loggingPrefs", {"performance": "ALL", "browser": "ALL"})
     --remote-debug  (Sync to Chrome Remote Debugger chrome://inspect/#devices)
     --ftrace | --final-trace  (Debug Mode after each test. Don't use with CI!)
     --dashboard  (Enable the SeleniumBase Dashboard. Saved at: dashboard.html)
@@ -1012,6 +1013,17 @@ def pytest_addoption(parser):
                 Using this enables the "Disable GPU" feature.
                 (GPU is disabled by default if swiftshader off.)""",
     )
+    parser.addoption(
+        "--log_cdp",
+        "--log-cdp",
+        "--log_cdp_events",
+        "--log-cdp-events",
+        action="store_true",
+        dest="log_cdp_events",
+        default=None,
+        help="""Capture CDP events. Then you can print them.
+                Eg. print(driver.get_log("performance"))""",
+    )
     parser.addoption(
         "--remote_debug",
         "--remote-debug",
@@ -1520,6 +1532,7 @@ def pytest_configure(config):
         sb_config.undetectable = True
     sb_config.no_sandbox = config.getoption("no_sandbox")
     sb_config.disable_gpu = config.getoption("disable_gpu")
+    sb_config.log_cdp_events = config.getoption("log_cdp_events")
     sb_config.remote_debug = config.getoption("remote_debug")
     sb_config.final_debug = config.getoption("final_debug")
     sb_config.dashboard = config.getoption("dashboard")

seleniumbase/plugins/sb_manager.py

@@ -54,6 +54,7 @@ def SB(
     undetectable=None,  # Use undetected-chromedriver to evade bot-detection.
     uc_cdp_events=None,  # Capture CDP events in undetected-chromedriver mode.
     uc_subprocess=None,  # Use undetected-chromedriver as a subprocess.
+    log_cdp_events=None,  # capture {"performance": "ALL", "browser": "ALL"})
     incognito=None,  # Enable Chromium's Incognito mode.
     guest_mode=None,  # Enable Chromium's Guest mode.
     dark_mode=None,  # Enable Chromium's Dark mode.
@@ -99,6 +100,7 @@ def SB(
     undetected=None,  # Shortcut / Duplicate of "undetectable".
     uc_cdp=None,  # Shortcut / Duplicate of "uc_cdp_events".
     uc_sub=None,  # Shortcut / Duplicate of "uc_subprocess".
+    log_cdp=None,  # Shortcut / Duplicate of "log_cdp_events".
     wire=None,  # Shortcut / Duplicate of "use_wire".
     pls=None,  # Shortcut / Duplicate of "page_load_strategy".
     sjw=None,  # Shortcut / Duplicate of "skip_js_waits".
@@ -470,6 +472,20 @@ def SB(
         uc_cdp_events = True
     else:
         uc_cdp_events = False
+    if log_cdp_events is None and log_cdp is None:
+        if (
+            "--log-cdp-events" in sys_argv
+            or "--log_cdp_events" in sys_argv
+            or "--log-cdp" in sys_argv
+            or "--log_cdp" in sys_argv
+        ):
+            log_cdp_events = True
+        else:
+            log_cdp_events = False
+    elif log_cdp_events or log_cdp:
+        log_cdp_events = True
+    else:
+        log_cdp_events = False
     if use_auto_ext is None:
         if "--use-auto-ext" in sys_argv:
             use_auto_ext = True
@@ -659,6 +675,7 @@ def SB(
     sb_config.undetectable = undetectable
     sb_config.uc_cdp_events = uc_cdp_events
     sb_config.uc_subprocess = uc_subprocess
+    sb_config.log_cdp_events = log_cdp_events
     sb_config.no_sandbox = None
     sb_config.disable_gpu = None
     sb_config.disable_js = disable_js
@@ -761,6 +778,7 @@ def SB(
     sb.undetectable = sb_config.undetectable
     sb.uc_cdp_events = sb_config.uc_cdp_events
     sb.uc_subprocess = sb_config.uc_subprocess
+    sb.log_cdp_events = sb_config.log_cdp_events
     sb.no_sandbox = sb_config.no_sandbox
     sb.disable_gpu = sb_config.disable_gpu
     sb.disable_js = sb_config.disable_js

seleniumbase/plugins/selenium_plugin.py

@@ -69,6 +69,7 @@ class SeleniumBrowser(Plugin):
     --enable-sync  (Enable "Chrome Sync" on websites.)
     --uc | --undetected  (Use undetected-chromedriver to evade bot-detection.)
     --uc-cdp-events  (Capture CDP events when running in "--undetected" mode.)
+    --log-cdp  ("goog:loggingPrefs", {"performance": "ALL", "browser": "ALL"})
     --remote-debug  (Sync to Chrome Remote Debugger chrome://inspect/#devices)
     --enable-3d-apis  (Enables WebGL and 3D APIs.)
     --swiftshader  (Chrome "--use-gl=angle" / "--use-angle=swiftshader-webgl")
@@ -730,7 +731,8 @@ def options(self, parser, env):
             action="store_true",
             dest="no_sandbox",
             default=False,
-            help="""Using this enables the "No Sandbox" feature.
+            help="""(DEPRECATED) - "--no-sandbox" is always used now.
+                    Using this enables the "No Sandbox" feature.
                     (This setting is now always enabled by default.)""",
         )
         parser.addoption(
@@ -739,8 +741,20 @@ def options(self, parser, env):
             action="store_true",
             dest="disable_gpu",
             default=False,
-            help="""Using this enables the "Disable GPU" feature.
-                    (This setting is now always enabled by default.)""",
+            help="""(DEPRECATED) - GPU is disabled if no swiftshader.
+                    Using this enables the "Disable GPU" feature.
+                    (GPU is disabled by default if swiftshader off.)""",
+        )
+        parser.addoption(
+            "--log_cdp",
+            "--log-cdp",
+            "--log_cdp_events",
+            "--log-cdp-events",
+            action="store_true",
+            dest="log_cdp_events",
+            default=None,
+            help="""Capture CDP events. Then you can print them.
+                    Eg. print(driver.get_log("performance"))""",
         )
         parser.addoption(
             "--remote_debug",
@@ -1103,6 +1117,7 @@ def beforeTest(self, test):
         test.test.use_auto_ext = self.options.use_auto_ext
         test.test.undetectable = self.options.undetectable
         test.test.uc_cdp_events = self.options.uc_cdp_events
+        test.test.log_cdp_events = self.options.log_cdp_events
         if test.test.uc_cdp_events and not test.test.undetectable:
             test.test.undetectable = True
         test.test.uc_subprocess = self.options.uc_subprocess