Fix full page screenshot on mobile web

Author: eirenik0

eyes_selenium/applitools/selenium/eyes_selenium_utils.py

@@ -100,14 +100,21 @@
 _RETRIES = 3
 
 
-def is_mobile_device(driver):
+def is_mobile_platform(driver):
+    driver = get_underlying_driver(driver)
+    if isinstance(driver, AppiumWebDriver):
+        return True
+    return is_mobile_web(driver) or is_mobile_app(driver)
+
+
+def is_mobile_web(driver):
     # type: (AnyWebDriver) -> bool
     """
     Returns whether the platform running is a mobile device or not.
 
     :return: True if the platform running the test is a mobile platform. False otherwise.
     """
-    is_mobile = """
+    is_mobile_script = """
 if( navigator.userAgent.match(/Android/i) ||
     navigator.userAgent.match(/iPhone/i) ||
     navigator.userAgent.match(/iPad/i)   ||
@@ -117,29 +124,31 @@ def is_mobile_device(driver):
     return false;
 }
     """
-    # TODO: Implement proper UserAgent handling
-    driver = get_underlying_driver(driver)
-    if isinstance(driver, AppiumWebDriver):
-        return True
-
     # if driver is selenium based
     platform_name = driver.desired_capabilities.get("platformName", "").lower()
     # platformName sometime have different names
-    is_mobile_platform = "android" in platform_name or "ios" in platform_name
-    if not is_mobile_platform:
+    is_mobile = "android" in platform_name or "ios" in platform_name
+    if not is_mobile:
         try:
-            is_mobile_platform = driver.execute_script(is_mobile)
+            is_mobile = driver.execute_script(is_mobile_script)
         except WebDriverException as e:
             logger.warning(
-                "Got error during checking if current platform is mobile. "
+                "Got error during checking if current platform is mobile web. "
                 "\n\t {}".format(str(e))
             )
-            if "Method is not implemented" in str(e):
-                # potentially mobile app
-                is_mobile_platform = True
-            else:
-                is_mobile_platform = False
-    return is_mobile_platform
+            is_mobile = False
+    return is_mobile
+
+
+def is_mobile_app(driver):
+    # TODO: check with hybrid mobile apps
+    platform_name = driver.desired_capabilities.get("platformName", "").lower()
+    # platformName sometime have different names
+    is_mobile = "android" in platform_name or "ios" in platform_name
+    app = driver.desired_capabilities.get("app", None)
+    if is_mobile and app:
+        return True
+    return False
 
 
 def get_underlying_driver(driver):
@@ -210,7 +219,7 @@ def set_browser_size(driver, required_size):
     retries_left = _RETRIES
 
     # set browser size for mobile devices isn't working
-    if is_mobile_device(driver):
+    if is_mobile_web(driver):
         return True
 
     while True:
@@ -380,7 +389,7 @@ def timeout(timeout):
 
 
 def is_landscape_orientation(driver):
-    if is_mobile_device(driver):
+    if is_mobile_web(driver):
         # could be AppiumRemoteWebDriver
         appium_driver = get_underlying_driver(
             driver
@@ -453,7 +462,7 @@ def root_html():
         return driver.find_element_by_tag_name("html")
 
     scroll_root_element = None
-    if not driver.is_mobile_device():
+    if not driver.is_mobile_app:
         if container is None:
             scroll_root_element = root_html()
         else:
@@ -479,6 +488,6 @@ def current_frame_scroll_root_element(driver):
     root_element = None
     if cur_frame:
         root_element = cur_frame.scroll_root_element
-    if root_element is None and not driver.is_mobile_device():
+    if root_element is None and not driver.is_mobile_app:
         root_element = driver.find_element_by_tag_name("html")
     return root_element

eyes_selenium/applitools/selenium/positioning.py

@@ -50,7 +50,7 @@ def __init__(self, driver, scroll_root_element):
 
     def __enter__(self):
         # type: () -> SeleniumPositionProvider
-        if self._driver.is_mobile_device():
+        if self._driver.is_mobile_app:
             return self
         return super(SeleniumPositionProvider, self).__enter__()
 
@@ -61,7 +61,7 @@ def __exit__(
         exc_tb,  # type: Optional[Any]
     ):
         # type: (...) -> Union[CSSTranslatePositionProvider, ScrollPositionProvider]
-        if self._driver.is_mobile_device():
+        if self._driver.is_mobile_app:
             return self
         return super(SeleniumPositionProvider, self).__exit__(exc_type, exc_val, exc_tb)
 
@@ -71,7 +71,7 @@ def get_entire_size(self):
         :return: The entire size of the container which the position is relative to.
         """
         try:
-            if self._driver.is_mobile_device():
+            if self._driver.is_mobile_app:
                 width, height = self._driver.execute_script(
                     self._JS_GET_CONTENT_ENTIRE_SIZE
                 )
@@ -108,7 +108,7 @@ def set_position(self, location):
         logger.debug(
             "setting position of %s to %s" % (location, self._scroll_root_element)
         )
-        if self._driver.is_mobile_device():
+        if self._driver.is_mobile_web:
             scroll_command = "window.scrollTo({0}, {1})".format(location.x, location.y)
             self._driver.execute_script(scroll_command)
             self._last_set_position = location
@@ -139,7 +139,7 @@ def get_current_position(self):
         """
         The scroll position of the current frame.
         """
-        if self._driver.is_mobile_device():
+        if self._driver.is_mobile_web:
             x, y = self._driver.execute_script(
                 self._JS_GET_CURRENT_SCROLL_POSITION, self._scroll_root_element
             )

eyes_selenium/applitools/selenium/selenium_eyes.py

@@ -243,7 +243,7 @@ def check(self, name, check_settings=None):
         )
         self._original_frame_chain = self.driver.frame_chain.clone()
 
-        if not self.driver.is_mobile_device():
+        if not self.driver.is_mobile_web:
             # hide scrollbar for main window
             self._try_hide_scrollbars()
 
@@ -294,7 +294,7 @@ def _check_result_flow(self, name, check_settings):
                     result = self._check_frame_fluent(name, check_settings)
             else:
                 logger.debug("default case")
-                if not self.driver.is_mobile_device():
+                if not self.driver.is_mobile_platform:
                     # required to prevent cut line on the last stitched part of the
                     # page on some browsers (like firefox).
                     self.driver.switch_to.default_content()
@@ -499,7 +499,7 @@ def _set_viewport_size(self, size):
         #     logger.info("Ignored (viewport size given explicitly)")
         #     return None
 
-        if not self.driver.is_mobile_device():
+        if not self.driver.is_mobile_platform:
             original_frame = self.driver.frame_chain.clone()
             self.driver.switch_to.default_content()
 
@@ -525,7 +525,7 @@ def _environment(self):
             logger.info("No OS set, checking for mobile OS...")
             # Since in Python Appium driver is the same for Android and iOS,
             # we need to use the desired capabilities to figure this out.
-            if eyes_selenium_utils.is_mobile_device(self._driver):
+            if self._driver.is_mobile_platform:
                 platform_name = self._driver.platform_name
                 logger.info(platform_name + " detected")
                 platform_version = self._driver.platform_version
@@ -668,7 +668,7 @@ def _try_hide_caret(self):
 
     def _get_screenshot(self):
         with self._driver.switch_to.frames_and_back(self._original_frame_chain):
-            if self.position_provider and not self.driver.is_mobile_device():
+            if self.position_provider and not self.driver.is_mobile_platform:
                 self.position_provider.push_state()
 
         self._try_hide_caret()
@@ -683,7 +683,7 @@ def _get_screenshot(self):
             self._last_screenshot = self._viewport_screenshot(scale_provider)
 
         with self._driver.switch_to.frames_and_back(self._original_frame_chain):
-            if self.position_provider and not self.driver.is_mobile_device():
+            if self.position_provider and not self.driver.is_mobile_platform:
                 self.position_provider.pop_state()
 
         return self._last_screenshot
@@ -790,7 +790,7 @@ def _ensure_element_visible(self, element):
         if self._target_element is None:
             # No element? we must be checking the window.
             return None
-        if self.driver.is_mobile_device():
+        if self.driver.is_mobile_platform:
             logger.debug("NATIVE context identified, skipping 'ensure element visible'")
             return None
 

eyes_selenium/applitools/selenium/webdriver.py

@@ -96,27 +96,27 @@ def __init__(self, driver, switch_to):
     def frame_and_back(self, frame_reference):
         # type: (FrameReference) -> Generator
         cur_frame = None
-        if not self._driver.is_mobile_device():
+        if not self._driver.is_mobile_app:
             self.frame(frame_reference)
             cur_frame = self._driver.frame_chain.peek
 
         yield cur_frame
 
-        if not self._driver.is_mobile_device():
+        if not self._driver.is_mobile_app:
             self.parent_frame()
 
     @contextlib.contextmanager
     def frames_and_back(self, frame_chain):
         # type: (FrameChain) -> Generator
         cur_frame = None
         origin_fc = self._driver.frame_chain.clone()
-        if not self._driver.is_mobile_device():
+        if not self._driver.is_mobile_app:
             self.frames(frame_chain)
             cur_frame = self._driver.frame_chain.peek
 
         yield cur_frame
 
-        if not self._driver.is_mobile_device():
+        if not self._driver.is_mobile_app:
             self.frames(origin_fc)
 
     def frame(self, frame_reference):
@@ -324,14 +324,27 @@ def platform_version(self):
         return self._driver.desired_capabilities.get("platformVersion", None)
 
     def is_mobile_device(self):
+        logger.deprecation("Use `is_mobile_platform` property instead")
+        return self.is_mobile_platform
+
+    @property
+    def is_mobile_platform(self):
         # type: () -> bool
         """
         Returns whether the platform running is a mobile device or not.
 
         :return: True if the platform running the test is a mobile platform.
                  False otherwise.
         """
-        return eyes_selenium_utils.is_mobile_device(self._driver)
+        return eyes_selenium_utils.is_mobile_platform(self._driver)
+
+    @property
+    def is_mobile_web(self):
+        return eyes_selenium_utils.is_mobile_web(self._driver)
+
+    @property
+    def is_mobile_app(self):
+        return eyes_selenium_utils.is_mobile_app(self._driver)
 
     def get(self, url):
         # type: (Text) -> Optional[Any]

tests/functional/eyes_selenium/test_appium.py

@@ -79,7 +79,7 @@ def test_selenium_and_appium_work(eyes_open):
 
 
 @pytest.mark.platform("iOS")
-@pytest.mark.test_page_url("http://applitools.github.io/demo/TestPages/FramesTestPage/")
+@pytest.mark.test_page_url("https://www.goodrx.com/")
 @pytest.mark.parametrize(
     "eyes",
     [

tests/unit/eyes_selenium/test_eyes_selenium_utils.py

@@ -21,15 +21,15 @@
 )
 def test_different_mobile_platform_names(driver_mock, platform_name):
     driver_mock.desired_capabilities["platformName"] = platform_name
-    assert eyes_selenium_utils.is_mobile_device(driver_mock)
+    assert eyes_selenium_utils.is_mobile_web(driver_mock)
 
 
 @pytest.mark.parametrize("platform_name", ["Windows", "Winmo", "Linux", "macOs"])
 def test_different_not_mobile_platform_names(driver_mock, platform_name):
     driver_mock.desired_capabilities["platformName"] = platform_name
-    assert not eyes_selenium_utils.is_mobile_device(driver_mock)
+    assert not eyes_selenium_utils.is_mobile_web(driver_mock)
 
 
 def test_appium_webdriver(driver_mock):
     driver_mock._driver = mock.Mock(AppiumWebDriver)
-    assert eyes_selenium_utils.is_mobile_device(driver_mock)
+    assert eyes_selenium_utils.is_mobile_web(driver_mock)