Initial commit of additional patching for selenium 3 move_to bug.

First, I'll note my workaround is slightly different. Instead of catching attribute errors,
I pass in both the driver and the element(s) checking first if this is indeed an
EventFiringWebDriver and not Selenium 4 or greater. I did this because I didn't see the other
try/catch method till after I wrote this. I can modify these to go that path. My one concern is
that in all the additional places discovered which are affected I was worried that we might
need multiple try/catch within a single method or one a large block of code. The other concern
was that we may get a AttributError for other reasons.

I added in acceptance tests (but no unit tests yet) for the additional changes. I copied pasted
into the current selenium_move_to_workaround.robot test suite. This feels a little hackish to me
and I would like to either copy paste into multiple test suites under a folder (still hackish).
Or what I would really like to do is to use the existing test suites and accomplish this with
tags and some mechanism to run with a differnt open browser setup. This may be too complicated
for now (mostly in time to figure out that solution) so open for ideas here ..

I have not yet tested with selenium 4 due to a bug I encountered when running the acceptance tests.
Need to look at that now.

Welcome any feedback...

Author: emanlove

atest/acceptance/2-event_firing_webdriver/resource_event_firing_webdriver.robot

@@ -5,3 +5,10 @@ ${REMOTE_URL}=              ${NONE}
 ${DESIRED_CAPABILITIES}=    ${NONE}
 ${ROOT}=                    http://${SERVER}/html
 ${FRONT_PAGE}=              ${ROOT}/
+
+*** Keyword ***
+
+Go To Page "${relative url}"
+    [Documentation]    Goes to page
+    Go To    ${ROOT}/${relative url}
+

atest/acceptance/2-event_firing_webdriver/selenium_move_to_workaround.robot

@@ -22,3 +22,82 @@ Selenium move_to workaround Mouse Out
 Selenium move_to workaround Mouse Over
     [Documentation]    LOG 1:5 DEBUG  Workaround for Selenium 3 bug.
     Mouse Over    id:some_id
+
+Click Element
+    [Documentation]    LOG 2 Clicking element 'singleClickButton'.
+    [Setup]    Initialize Page For Click Element
+    Click Element    singleClickButton
+    Element Text Should Be    output    single clicked
+
+Double Click Element
+    [Documentation]    LOG 2 Double clicking element 'doubleClickButton'.
+    [Setup]    Initialize Page For Click Element
+    [Tags]    Known Issue Safari    Known Issue Firefox
+    Double Click Element    doubleClickButton
+    Element Text Should Be    output    double clicked
+
+Click Element Action Chain
+    [Tags]    NoGrid
+    [Documentation]
+    ...    LOB 1:1 INFO        Clicking 'singleClickButton' using an action chain.
+    ...    LOG 2:5 DEBUG GLOB: *actions {"actions": [{*
+    [Setup]    Initialize Page For Click Element
+    Click Element    singleClickButton      action_chain=True
+    Element Text Should Be    output    single clicked
+
+Mouse Down
+    [Tags]    Known Issue Safari
+    [Setup]        Go To Page "mouse/index.html"
+    Mouse Down    el_for_mousedown
+    Textfield Value Should Be    el_for_mousedown    mousedown el_for_mousedown
+    Run Keyword And Expect Error
+    ...    Element with locator 'not_there' not found.
+    ...    Mouse Down    not_there
+
+Mouse Up
+    [Tags]    Known Issue Safari    Known Issue Firefox
+    [Setup]        Go To Page "mouse/index.html"
+    Mouse Up    el_for_mouseup
+    Textfield Value Should Be    el_for_mouseup    mouseup el_for_mouseup
+    Run Keyword And Expect Error
+    ...    Element with locator 'not_there' not found.
+    ...    Mouse Up    not_there
+
+Open Context Menu
+    [Tags]    Known Issue Safari
+    [Setup]    Go To Page "javascript/context_menu.html"
+    Open Context Menu    myDiv
+
+Drag and Drop
+    [Tags]    Known Issue Internet Explorer    Known Issue Safari
+    [Setup]    Go To Page "javascript/drag_and_drop.html"
+    Element Text Should Be    id=droppable    Drop here
+    Drag and Drop    id=draggable    id=droppable
+    Element Text Should Be    id=droppable    Dropped!
+
+Drag and Drop by Offset
+    [Tags]    Known Issue Firefox    Known Issue Internet Explorer    Known Issue Safari
+    [Setup]    Go To Page "javascript/drag_and_drop.html"
+    Element Text Should Be    id=droppable    Drop here
+    Drag and Drop by Offset    id=draggable    ${1}    ${1}
+    Element Text Should Be    id=droppable    Drop here
+    Drag and Drop by Offset    id=draggable    ${100}    ${20}
+    Element Text Should Be    id=droppable    Dropped!
+
+Mouse Down On Link
+    [Tags]    Known Issue Safari
+    [Setup]    Go To Page "javascript/mouse_events.html"
+    Mouse Down On Image    image_mousedown
+    Text Field Should Contain    textfield    onmousedown
+    Mouse Up    image_mousedown
+    Input text    textfield    ${EMPTY}
+    Mouse Down On Link    link_mousedown
+    Text Field Should Contain    textfield    onmousedown
+    Mouse Up    link_mousedown
+
+*** Keywords ***
+Initialize Page For Click Element
+    [Documentation]    Initialize Page
+    Go To Page "javascript/click.html"
+    Reload Page
+    Element Text Should Be    output    initial output

src/SeleniumLibrary/keywords/element.py

@@ -17,6 +17,7 @@
 from typing import List, Optional, Tuple, Union
 
 from SeleniumLibrary.utils import is_noney
+from SeleniumLibrary.utils.events.event import _unwrap_eventfiring_elements
 from robot.utils import plural_or_not, is_truthy
 from selenium.webdriver.common.action_chains import ActionChains
 from selenium.webdriver.common.keys import Keys
@@ -641,6 +642,7 @@ def _click_with_action_chain(self, locator):
         self.info(f"Clicking '{locator}' using an action chain.")
         action = ActionChains(self.driver)
         element = self.find_element(locator)
+        element = _unwrap_eventfiring_elements(self.driver, element)
         action.move_to_element(element)
         action.click()
         action.perform()
@@ -656,6 +658,7 @@ def _click_with_modifier(self, locator, tag, modifier):
         element = self.find_element(locator, tag=tag[0], required=False)
         if not element:
             element = self.find_element(locator, tag=tag[1])
+        element = _unwrap_eventfiring_elements(self.driver, element)
         action.click(element)
         for item in modifier:
             action.key_up(item)
@@ -675,14 +678,15 @@ def click_element_at_coordinates(self, locator, xoffset, yoffset):
             f"Clicking element '{locator}' at coordinates x={xoffset}, y={yoffset}."
         )
         element = self.find_element(locator)
+        element = _unwrap_eventfiring_elements(self.driver,element)
         action = ActionChains(self.driver)
         # Try/except can be removed when minimum required Selenium is 4.0 or greater.
-        try:
-            action.move_to_element(element)
-        except AttributeError:
-            self.debug("Workaround for Selenium 3 bug.")
-            element = element.wrapped_element
-            action.move_to_element(element)
+        #try:
+        action.move_to_element(element)
+        #except AttributeError:
+        #    self.debug("Workaround for Selenium 3 bug.")
+        #    element = element.wrapped_element
+        #    action.move_to_element(element)
         action.move_by_offset(xoffset, yoffset)
         action.click()
         action.perform()
@@ -696,6 +700,7 @@ def double_click_element(self, locator: str):
         """
         self.info(f"Double clicking element '{locator}'.")
         element = self.find_element(locator)
+        element = _unwrap_eventfiring_elements(self.driver, element)
         action = ActionChains(self.driver)
         action.double_click(element).perform()
 
@@ -721,13 +726,14 @@ def scroll_element_into_view(self, locator: str):
         New in SeleniumLibrary 3.2.0
         """
         element = self.find_element(locator)
+        element = _unwrap_eventfiring_elements(self.driver, element)
         # Try/except can be removed when minimum required Selenium is 4.0 or greater.
-        try:
-            ActionChains(self.driver).move_to_element(element).perform()
-        except AttributeError:
-            self.debug("Workaround for Selenium 3 bug.")
-            element = element.wrapped_element
-            ActionChains(self.driver).move_to_element(element).perform()
+        #try:
+        ActionChains(self.driver).move_to_element(element).perform()
+        #except AttributeError:
+        #    self.debug("Workaround for Selenium 3 bug.")
+        #    element = element.wrapped_element
+        #    ActionChains(self.driver).move_to_element(element).perform()
 
     @keyword
     def drag_and_drop(self, locator: str, target: str):
@@ -741,6 +747,7 @@ def drag_and_drop(self, locator: str, target: str):
         | `Drag And Drop` | css:div#element | css:div.target |
         """
         element = self.find_element(locator)
+        element = _unwrap_eventfiring_elements(self.driver, element)
         target = self.find_element(target)
         action = ActionChains(self.driver)
         action.drag_and_drop(element, target).perform()
@@ -759,6 +766,7 @@ def drag_and_drop_by_offset(self, locator: str, xoffset: int, yoffset: int):
         | `Drag And Drop By Offset` | myElem | 50 | -35 | # Move myElem 50px right and 35px down |
         """
         element = self.find_element(locator)
+        element = _unwrap_eventfiring_elements(self.driver, element)
         action = ActionChains(self.driver)
         action.drag_and_drop_by_offset(element, xoffset, yoffset)
         action.perform()
@@ -777,6 +785,7 @@ def mouse_down(self, locator: str):
         """
         self.info(f"Simulating Mouse Down on element '{locator}'.")
         element = self.find_element(locator)
+        element = _unwrap_eventfiring_elements(self.driver, element)
         action = ActionChains(self.driver)
         action.click_and_hold(element).perform()
 
@@ -789,17 +798,18 @@ def mouse_out(self, locator: str):
         """
         self.info(f"Simulating Mouse Out on element '{locator}'.")
         element = self.find_element(locator)
+        element = _unwrap_eventfiring_elements(self.driver, element)
         size = element.size
         offsetx = (size["width"] / 2) + 1
         offsety = (size["height"] / 2) + 1
         action = ActionChains(self.driver)
         # Try/except can be removed when minimum required Selenium is 4.0 or greater.
-        try:
-            action.move_to_element(element)
-        except AttributeError:
-            self.debug("Workaround for Selenium 3 bug.")
-            element = element.wrapped_element
-            action.move_to_element(element)
+        #try:
+        action.move_to_element(element)
+        #except AttributeError:
+        #    self.debug("Workaround for Selenium 3 bug.")
+        #    element = element.wrapped_element
+        #    action.move_to_element(element)
         action.move_by_offset(offsetx, offsety)
         action.perform()
 
@@ -812,14 +822,15 @@ def mouse_over(self, locator: str):
         """
         self.info(f"Simulating Mouse Over on element '{locator}'.")
         element = self.find_element(locator)
+        element = _unwrap_eventfiring_elements(self.driver,element)
         action = ActionChains(self.driver)
         # Try/except can be removed when minimum required Selenium is 4.0 or greater.
-        try:
-            action.move_to_element(element).perform()
-        except AttributeError:
-            self.debug("Workaround for Selenium 3 bug.")
-            element = element.wrapped_element
-            action.move_to_element(element).perform()
+        #try:
+        action.move_to_element(element).perform()
+        #except AttributeError:
+        #    self.debug("Workaround for Selenium 3 bug.")
+        #    element = element.wrapped_element
+        #    action.move_to_element(element).perform()
 
     @keyword
     def mouse_up(self, locator: str):
@@ -830,12 +841,14 @@ def mouse_up(self, locator: str):
         """
         self.info(f"Simulating Mouse Up on element '{locator}'.")
         element = self.find_element(locator)
+        element = _unwrap_eventfiring_elements(self.driver, element)
         ActionChains(self.driver).release(element).perform()
 
     @keyword
     def open_context_menu(self, locator: str):
         """Opens the context menu on the element identified by ``locator``."""
         element = self.find_element(locator)
+        element = _unwrap_eventfiring_elements(self.driver, element)
         action = ActionChains(self.driver)
         action.context_click(element).perform()
 
@@ -924,6 +937,7 @@ def press_keys(self, locator: Optional[str] = None, *keys: str):
         if not is_noney(locator):
             self.info(f"Sending key(s) {keys} to {locator} element.")
             element = self.find_element(locator)
+            element = _unwrap_eventfiring_elements(self.driver, element)
             ActionChains(self.driver).click(element).perform()
         else:
             self.info(f"Sending key(s) {keys} to page.")
@@ -977,6 +991,7 @@ def mouse_down_on_link(self, locator: str):
         using ``id``, ``name``, ``href`` and the link text.
         """
         element = self.find_element(locator, tag="link")
+        element = _unwrap_eventfiring_elements(self.driver, element)
         action = ActionChains(self.driver)
         action.click_and_hold(element).perform()
 
@@ -1019,6 +1034,7 @@ def mouse_down_on_image(self, locator: str):
         using ``id``, ``name``, ``src`` and ``alt``.
         """
         element = self.find_element(locator, tag="image")
+        element = _unwrap_eventfiring_elements(self.driver, element)
         action = ActionChains(self.driver)
         action.click_and_hold(element).perform()
 

src/SeleniumLibrary/utils/events/event.py

@@ -15,9 +15,30 @@
 # limitations under the License.
 
 import abc
-
+from selenium.webdriver.support.event_firing_webdriver import EventFiringWebDriver
 
 class Event:
     @abc.abstractmethod
     def trigger(self, *args, **kwargs):
         pass
+
+def _unwrap_eventfiring_elements(ef_driver,elements):
+    """ Workaround for Selenium 3 bug.
+
+        References:
+        https://github.com/SeleniumHQ/selenium/issues/7877
+        https://github.com/SeleniumHQ/selenium/pull/8348
+        https://github.com/SeleniumHQ/selenium/issues/7467
+        https://github.com/SeleniumHQ/selenium/issues/6604
+
+    """
+    if not isinstance(ef_driver,EventFiringWebDriver) or selenium_major_version() >= 4:
+        return elements
+    unwrapped_elements = ef_driver._unwrap_element_args(elements)
+    return unwrapped_elements
+
+def selenium_major_version():
+    import selenium
+    selenium_version = selenium.__version__
+    (major,*sub_versions)=selenium_version.split('.')
+    return int(major)