Update CDP Mode

Author: mdmintz

CHANGELOG.md

@@ -1,3 +1,5 @@
 <h2><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32" /> CHANGELOG</h2>
 
-### See: [SeleniumBase/releases](https://github.com/seleniumbase/SeleniumBase/releases)
+## See: [SeleniumBase/releases](https://github.com/seleniumbase/SeleniumBase/releases) 🗂️ 📋
+
+### (For CDP updates, see the [CDP Mode docs](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/cdp_mode/ReadMe.md))

examples/cdp_mode/ReadMe.md

@@ -395,12 +395,17 @@ sb.cdp.uncheck_if_checked(selector)
 sb.cdp.unselect_if_selected(selector)
 sb.cdp.is_element_present(selector)
 sb.cdp.is_element_visible(selector)
-sb.cdp.assert_element_present(selector)
-sb.cdp.assert_element_absent(selector)
+sb.cdp.wait_for_element_visible(selector)
 sb.cdp.assert_element(selector)
 sb.cdp.assert_element_visible(selector)
+sb.cdp.assert_element_present(selector)
+sb.cdp.assert_element_absent(selector)
 sb.cdp.assert_element_not_visible(selector)
+sb.cdp.assert_element_attribute(selector, attribute, value=None)
 sb.cdp.assert_title(title)
+sb.cdp.assert_title_contains(substring)
+sb.cdp.assert_url(url)
+sb.cdp.assert_url_contains(substring)
 sb.cdp.assert_text(text, selector="html")
 sb.cdp.assert_exact_text(text, selector="html")
 sb.cdp.scroll_into_view(selector)

help_docs/method_summary.md

@@ -362,6 +362,8 @@ self.get_cookie(name)
 
 self.get_cookies()
 
+self.get_cookie_string()
+
 self.add_cookie(cookie_dict, expiry=False)
 
 self.add_cookies(cookies, expiry=False)

help_docs/uc_mode.md

@@ -4,6 +4,8 @@
 
 👤 <b translate="no">SeleniumBase</b> <b translate="no">UC Mode</b> (Undetected-Chromedriver Mode) allows bots to appear human, which lets them evade detection from anti-bot services that try to block them or trigger CAPTCHAs on various websites.
 
+> #### (For the successor to default UC Mode, see **[CDP Mode 🐙](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/cdp_mode/ReadMe.md)**)
+
 ---
 
 <!-- YouTube View --><a href="https://www.youtube.com/watch?v=5dMFI3e85ig"><img src="http://img.youtube.com/vi/5dMFI3e85ig/0.jpg" title="SeleniumBase on YouTube" width="350" /></a>

sbase/steps.py

@@ -1189,3 +1189,10 @@ def set_attributes(context, selector, attribute, value):
     if attribute.endswith("'") or attribute.endswith('"'):
         attribute = attribute[:-1]
     sb.set_attributes(selector, attribute, value)
+
+
+@step("Activate CDP Mode")
+@step("User activates CDP Mode")
+def activate_cdp_mode(context):
+    sb = context.sb
+    sb.activate_cdp_mode()

seleniumbase/console_scripts/sb_mkrec.py

@@ -144,7 +144,9 @@ def main():
             elif option.lower() in ("--gui", "--headed"):
                 if "linux" in sys.platform:
                     force_gui = True
-            elif option.lower() in ("--uc", "--undetected", "--undetectable"):
+            elif option.lower() in (
+                "--uc", "--cdp", "--undetected", "--undetectable"
+            ):
                 use_uc = True
             elif option.lower() in ("--rec-behave", "--behave", "--gherkin"):
                 rec_behave = True

seleniumbase/console_scripts/sb_recorder.py

@@ -9,6 +9,7 @@
 
 Options:
     --uc / --undetected  (Use undetectable mode.)
+    --cdp  (Same as "--uc" and "--undetectable".)
     --behave  (Also output Behave/Gherkin files.)
 
 Output:
@@ -151,6 +152,7 @@ def do_recording(file_name, url, overwrite_enabled, use_chrome, window):
             command += " --edge"
         if (
             "--uc" in command_args
+            or "--cdp" in command_args
             or "--undetected" in command_args
             or "--undetectable" in command_args
         ):
@@ -193,6 +195,7 @@ def do_playback(file_name, use_chrome, window, demo_mode=False):
     command_args = sys.argv[2:]
     if (
         "--uc" in command_args
+        or "--cdp" in command_args
         or "--undetected" in command_args
         or "--undetectable" in command_args
     ):

seleniumbase/core/browser_launcher.py

@@ -683,12 +683,17 @@ def uc_open_with_cdp_mode(driver, url=None):
     cdp.is_checked = CDPM.is_checked
     cdp.is_element_present = CDPM.is_element_present
     cdp.is_element_visible = CDPM.is_element_visible
+    cdp.wait_for_element_visible = CDPM.wait_for_element_visible
+    cdp.assert_element = CDPM.assert_element
+    cdp.assert_element_visible = CDPM.assert_element_visible
     cdp.assert_element_present = CDPM.assert_element_present
     cdp.assert_element_absent = CDPM.assert_element_absent
-    cdp.assert_element = CDPM.assert_element
-    cdp.assert_element_visible = CDPM.assert_element
     cdp.assert_element_not_visible = CDPM.assert_element_not_visible
+    cdp.assert_element_attribute = CDPM.assert_element_attribute
     cdp.assert_title = CDPM.assert_title
+    cdp.assert_title_contains = CDPM.assert_title_contains
+    cdp.assert_url = CDPM.assert_url
+    cdp.assert_url_contains = CDPM.assert_url_contains
     cdp.assert_text = CDPM.assert_text
     cdp.assert_exact_text = CDPM.assert_exact_text
     cdp.scroll_into_view = CDPM.scroll_into_view

seleniumbase/core/sb_cdp.py

@@ -20,8 +20,16 @@ def __init__(self, loop, page, driver):
         self.driver = driver
 
     def __slow_mode_pause_if_set(self):
-        if hasattr(sb_config, "slow_mode") and sb_config.slow_mode:
-            time.sleep(0.16)
+        if (
+            (hasattr(sb_config, "demo_mode") and sb_config.demo_mode)
+            or "--demo" in sys.argv
+        ):
+            time.sleep(0.48)
+        elif (
+            (hasattr(sb_config, "slow_mode") and sb_config.slow_mode)
+            or "--slow" in sys.argv
+        ):
+            time.sleep(0.24)
 
     def __add_light_pause(self):
         time.sleep(0.007)
@@ -543,7 +551,7 @@ def click_visible_elements(self, selector, limit=0):
                 if (width != 0 or height != 0):
                     element.click()
                     click_count += 1
-                    time.sleep(0.0375)
+                    time.sleep(0.042)
                     self.__slow_mode_pause_if_set()
                     self.loop.run_until_complete(self.page.wait())
             except Exception:
@@ -660,10 +668,10 @@ def press_keys(self, selector, text, timeout=settings.SMALL_TIMEOUT):
             text = text[:-1]
         for key in text:
             element.send_keys(key)
-            time.sleep(0.0375)
+            time.sleep(0.042)
         if submit:
             element.send_keys("\r\n")
-            time.sleep(0.0375)
+            time.sleep(0.042)
         self.__slow_mode_pause_if_set()
         self.loop.run_until_complete(self.page.wait())
 
@@ -733,7 +741,7 @@ def maximize(self):
             return
         elif self.get_window()[1].window_state.value == "minimized":
             self.loop.run_until_complete(self.page.maximize())
-            time.sleep(0.0375)
+            time.sleep(0.042)
         return self.loop.run_until_complete(self.page.maximize())
 
     def minimize(self):
@@ -743,7 +751,7 @@ def minimize(self):
     def medimize(self):
         if self.get_window()[1].window_state.value == "minimized":
             self.loop.run_until_complete(self.page.medimize())
-            time.sleep(0.0375)
+            time.sleep(0.042)
         return self.loop.run_until_complete(self.page.medimize())
 
     def set_window_rect(self, x, y, width, height):
@@ -752,7 +760,7 @@ def set_window_rect(self, x, y, width, height):
                 self.page.set_window_size(
                     left=x, top=y, width=width, height=height)
             )
-            time.sleep(0.0375)
+            time.sleep(0.042)
         return self.loop.run_until_complete(
             self.page.set_window_size(
                 left=x, top=y, width=width, height=height)
@@ -1117,7 +1125,7 @@ def gui_press_key(self, key):
         )
         with gui_lock:
             pyautogui.press(key)
-            time.sleep(0.0375)
+            time.sleep(0.042)
         self.__slow_mode_pause_if_set()
         self.loop.run_until_complete(self.page.wait())
 
@@ -1131,7 +1139,7 @@ def gui_press_keys(self, keys):
         with gui_lock:
             for key in keys:
                 pyautogui.press(key)
-                time.sleep(0.0375)
+                time.sleep(0.042)
         self.__slow_mode_pause_if_set()
         self.loop.run_until_complete(self.page.wait())
 
@@ -1472,25 +1480,53 @@ def is_element_visible(self, selector):
                 return True
             return False
 
+    def wait_for_element_visible(
+        self, selector, timeout=settings.SMALL_TIMEOUT
+    ):
+        try:
+            self.select(selector, timeout=timeout)
+        except Exception:
+            raise Exception("Element {%s} was not found!" % selector)
+        for i in range(30):
+            if self.is_element_visible(selector):
+                return self.select(selector)
+            time.sleep(0.1)
+        raise Exception("Element {%s} was not visible!" % selector)
+
     def assert_element(self, selector, timeout=settings.SMALL_TIMEOUT):
+        """Same as assert_element_visible()"""
         try:
             self.select(selector, timeout=timeout)
         except Exception:
-            raise Exception("Element {%s} not found!" % selector)
+            raise Exception("Element {%s} was not found!" % selector)
         for i in range(30):
             if self.is_element_visible(selector):
                 return True
             time.sleep(0.1)
-        raise Exception("Element {%s} not visible!" % selector)
+        raise Exception("Element {%s} was not visible!" % selector)
+
+    def assert_element_visible(self, selector, timeout=settings.SMALL_TIMEOUT):
+        """Same as assert_element()"""
+        try:
+            self.select(selector, timeout=timeout)
+        except Exception:
+            raise Exception("Element {%s} was not found!" % selector)
+        for i in range(30):
+            if self.is_element_visible(selector):
+                return True
+            time.sleep(0.1)
+        raise Exception("Element {%s} was not visible!" % selector)
 
     def assert_element_present(self, selector, timeout=settings.SMALL_TIMEOUT):
+        """Assert element is present in the DOM. (Visibility NOT required)"""
         try:
             self.select(selector, timeout=timeout)
         except Exception:
-            raise Exception("Element {%s} not found!" % selector)
+            raise Exception("Element {%s} was not found!" % selector)
         return True
 
     def assert_element_absent(self, selector, timeout=settings.SMALL_TIMEOUT):
+        """Assert element is not present in the DOM."""
         start_ms = time.time() * 1000.0
         stop_ms = start_ms + (timeout * 1000.0)
         for i in range(int(timeout * 10)):
@@ -1511,6 +1547,7 @@ def assert_element_absent(self, selector, timeout=settings.SMALL_TIMEOUT):
     def assert_element_not_visible(
         self, selector, timeout=settings.SMALL_TIMEOUT
     ):
+        """Assert element is not visible on page. (May still be in DOM)"""
         start_ms = time.time() * 1000.0
         stop_ms = start_ms + (timeout * 1000.0)
         for i in range(int(timeout * 10)):
@@ -1530,6 +1567,21 @@ def assert_element_not_visible(
             % (selector, timeout, plural)
         )
 
+    def assert_element_attribute(self, selector, attribute, value=None):
+        attributes = self.get_element_attributes(selector)
+        if attribute not in attributes:
+            raise Exception(
+                "Attribute {%s} was not found in element {%s}!"
+                % (attribute, selector)
+            )
+        if value and attributes[attribute] != value:
+            raise Exception(
+                "Expected value {%s} of attribute {%s} "
+                "was not found in element {%s}! "
+                "(Actual value was {%s})"
+                % (value, attribute, selector, attributes[attribute])
+            )
+
     def assert_title(self, title):
         expected = title.strip()
         actual = self.get_title().strip()
@@ -1541,11 +1593,55 @@ def assert_title(self, title):
                 raise Exception(error % (expected, actual))
         except Exception:
             time.sleep(2)
-            expected = title.strip()
             actual = self.get_title().strip()
             if expected != actual:
                 raise Exception(error % (expected, actual))
 
+    def assert_title_contains(self, substring):
+        expected = substring.strip()
+        actual = self.get_title().strip()
+        error = (
+            "Expected title substring [%s] does not appear "
+            "in the actual page title [%s]!"
+        )
+        try:
+            if expected not in actual:
+                raise Exception(error % (expected, actual))
+        except Exception:
+            time.sleep(2)
+            actual = self.get_title().strip()
+            if expected not in actual:
+                raise Exception(error % (expected, actual))
+
+    def assert_url(self, url):
+        expected = url.strip()
+        actual = self.get_current_url().strip()
+        error = "Expected URL [%s] does not match the actual URL [%s]!"
+        try:
+            if expected != actual:
+                raise Exception(error % (expected, actual))
+        except Exception:
+            time.sleep(2)
+            actual = self.get_current_url().strip()
+            if expected != actual:
+                raise Exception(error % (expected, actual))
+
+    def assert_url_contains(self, substring):
+        expected = substring.strip()
+        actual = self.get_current_url().strip()
+        error = (
+            "Expected URL substring [%s] does not appear "
+            "in the full URL [%s]!"
+        )
+        try:
+            if expected not in actual:
+                raise Exception(error % (expected, actual))
+        except Exception:
+            time.sleep(2)
+            actual = self.get_current_url().strip()
+            if expected not in actual:
+                raise Exception(error % (expected, actual))
+
     def assert_text(
         self, text, selector="html", timeout=settings.SMALL_TIMEOUT
     ):