Merge pull request #22 from thalissonvs/feat/check-click

thalissonvs · web-flow · commit cee24f232381 · 2024-11-11T16:43:46.000-03:00
Feat: check if the click was completed correctly
diff --git a/pydoll/browser/page.py b/pydoll/browser/page.py
@@ -7,8 +7,10 @@
 from pydoll.commands.fetch import FetchCommands
 from pydoll.commands.network import NetworkCommands
 from pydoll.commands.page import PageCommands
+from pydoll.commands.runtime import RuntimeCommands
 from pydoll.commands.storage import StorageCommands
 from pydoll.connection import ConnectionHandler
+from pydoll.element import WebElement
 from pydoll.events.page import PageEvents
 from pydoll.mixins.find_elements import FindElementsMixin
 from pydoll.utils import decode_image_to_bytes
@@ -328,20 +330,31 @@ async def callback_wrapper(event):
             event_name, function_to_register, temporary
         )
 
-    async def execute_js_script(self, script: str) -> dict:
+    async def execute_script(self, script: str, element: WebElement = None):
         """
         Executes a JavaScript script in the page.
+        If an element is provided, the script will be executed in the context
+        of that element. To provide the element context, use the 'argument'
+        keyword in the script.
+
+        Examples:
+        ```python
+        await page.execute_script('argument.click()', element)
+        await page.execute_script('argument.value = "Hello, World!"', element)
+        ```
 
         Args:
             script (str): The JavaScript script to execute.
-
-        Returns:
-            dict: The result of the JavaScript script execution.
         """
-        command = {
-            'method': 'Runtime.evaluate',
-            'params': {'expression': script, 'returnByValue': True},
-        }
+        if element:
+            script = script.replace('argument', 'this')
+            script = f'function(){{ {script} }}'
+            object_id = element._node['objectId']
+            command = RuntimeCommands.call_function_on(
+                object_id, script, return_by_value=True
+            )
+        else:
+            command = RuntimeCommands.evaluate_script(script)
         return await self._execute_command(command)
 
     async def _wait_page_load(self, timeout: int = 300):
diff --git a/pydoll/commands/dom.py b/pydoll/commands/dom.py
@@ -1,6 +1,7 @@
 import copy
 from typing import Literal
 
+from pydoll.commands.runtime import RuntimeCommands
 from pydoll.constants import By
 
 
@@ -26,14 +27,9 @@ class DomCommands:
         'method': 'DOM.querySelectorAll',
         'params': {},
     }
-    EVALUATE_TEMPLATE = {'method': 'Runtime.evaluate', 'params': {}}
     BOX_MODEL_TEMPLATE = {'method': 'DOM.getBoxModel', 'params': {}}
     RESOLVE_NODE_TEMPLATE = {'method': 'DOM.resolveNode', 'params': {}}
     REQUEST_NODE_TEMPLATE = {'method': 'DOM.requestNode', 'params': {}}
-    CALL_FUNCTION_ON_TEMPLATE = {
-        'method': 'Runtime.callFunctionOn',
-        'params': {},
-    }
     GET_OUTER_HTML = {
         'method': 'DOM.getOuterHTML',
         'params': {},
@@ -42,17 +38,6 @@ class DomCommands:
         'method': 'DOM.scrollIntoViewIfNeeded',
         'params': {},
     }
-    GET_PROPERTIES = {
-        'method': 'Runtime.getProperties',
-        'params': {},
-    }
-
-    @classmethod
-    def get_properties(cls, object_id: str) -> dict:
-        """Generates the command to get the properties of a specific object."""
-        command = cls._create_command(cls.GET_PROPERTIES, object_id=object_id)
-        command['params']['ownProperties'] = True
-        return command
 
     @classmethod
     def scroll_into_view(
@@ -109,7 +94,7 @@ def enable_dom_events(cls) -> dict:
     @classmethod
     def get_current_url(cls) -> dict:
         """Generates the command to get the current URL of the page."""
-        return cls.evaluate_js('window.location.href')
+        return RuntimeCommands.evaluate_script('window.location.href')
 
     @classmethod
     def find_element(
@@ -170,16 +155,6 @@ def resolve_node(cls, node_id: int) -> dict:
         """Generates the command to resolve a specific DOM node."""
         return cls._create_command(cls.RESOLVE_NODE_TEMPLATE, node_id=node_id)
 
-    @classmethod
-    def evaluate_js(cls, expression: str) -> dict:
-        """Generates the command to evaluate JavaScript code."""
-        command = copy.deepcopy(cls.EVALUATE_TEMPLATE)
-        command['params'] = {
-            'expression': expression,
-            'returnByValue': False,
-        }
-        return command
-
     @classmethod
     def _create_command(
         cls,
@@ -216,7 +191,7 @@ def _find_element_by_xpath(cls, xpath: str, object_id: str) -> dict:
         escaped_value = xpath.replace('"', '\\"')
         if object_id:
             command = cls._create_command(
-                cls.CALL_FUNCTION_ON_TEMPLATE, object_id=object_id
+                RuntimeCommands.CALL_FUNCTION_ON_TEMPLATE, object_id=object_id
             )
             command['params']['functionDeclaration'] = (
                 'function() {'
@@ -227,7 +202,7 @@ def _find_element_by_xpath(cls, xpath: str, object_id: str) -> dict:
                 '}'
             )
         else:
-            command = cls._create_command(cls.EVALUATE_TEMPLATE)
+            command = cls._create_command(RuntimeCommands.EVALUATE_TEMPLATE)
             command['params']['expression'] = (
                 'var element = document.evaluate('
                 f'"{escaped_value}", document, null, '
@@ -254,7 +229,7 @@ def _find_elements_by_xpath(cls, xpath: str, object_id: str) -> dict:
         escaped_value = xpath.replace('"', '\\"')
         if object_id:
             command = cls._create_command(
-                cls.CALL_FUNCTION_ON_TEMPLATE, object_id=object_id
+                RuntimeCommands.CALL_FUNCTION_ON_TEMPLATE, object_id=object_id
             )
             command['params']['functionDeclaration'] = (
                 'function() {'
@@ -270,7 +245,7 @@ def _find_elements_by_xpath(cls, xpath: str, object_id: str) -> dict:
                 '}'
             )
         else:
-            command = cls._create_command(cls.EVALUATE_TEMPLATE)
+            command = cls._create_command(RuntimeCommands.EVALUATE_TEMPLATE)
             command['params']['expression'] = (
                 'var elements = document.evaluate('
                 f'"{escaped_value}", document, null, '
diff --git a/pydoll/commands/runtime.py b/pydoll/commands/runtime.py
@@ -0,0 +1,45 @@
+import copy
+
+
+class RuntimeCommands:
+    EVALUATE_TEMPLATE = {'method': 'Runtime.evaluate', 'params': {}}
+    CALL_FUNCTION_ON_TEMPLATE = {
+        'method': 'Runtime.callFunctionOn',
+        'params': {},
+    }
+    GET_PROPERTIES = {
+        'method': 'Runtime.getProperties',
+        'params': {},
+    }
+
+    @classmethod
+    def get_properties(cls, object_id: str) -> dict:
+        """Generates the command to get the properties of a specific object."""
+        command = copy.deepcopy(cls.GET_PROPERTIES)
+        command['params']['objectId'] = object_id
+        command['params']['ownProperties'] = True
+        return command
+
+    @classmethod
+    def call_function_on(
+        cls,
+        object_id: str,
+        function_declaration: str,
+        return_by_value: bool = False,
+    ) -> dict:
+        """Generates the command to call a function on a specific object."""
+        command = copy.deepcopy(cls.CALL_FUNCTION_ON_TEMPLATE)
+        command['params']['objectId'] = object_id
+        command['params']['functionDeclaration'] = function_declaration
+        command['params']['returnByValue'] = return_by_value
+        return command
+
+    @classmethod
+    def evaluate_script(cls, expression: str) -> dict:
+        """Generates the command to evaluate JavaScript code."""
+        command = copy.deepcopy(cls.EVALUATE_TEMPLATE)
+        command['params'] = {
+            'expression': expression,
+            'returnByValue': True,
+        }
+        return command
diff --git a/pydoll/constants.py b/pydoll/constants.py
@@ -7,3 +7,54 @@ class By(str, Enum):
     CLASS_NAME = 'class_name'
     ID = 'id'
     TAG_NAME = 'tag_name'
+
+
+class Scripts:
+    ELEMENT_VISIBLE = """
+    function() {
+        const rect = this.getBoundingClientRect();
+        return (
+            rect.width > 0 && rect.height > 0
+            && getComputedStyle(this).visibility !== 'hidden'
+            && getComputedStyle(this).display !== 'none'
+        )
+    }
+    """
+
+    ELEMENT_ON_TOP = """
+    function() {
+        const rect = this.getBoundingClientRect();
+        const elementFromPoint = document.elementFromPoint(
+            rect.x + rect.width / 2,
+            rect.y + rect.height / 2
+        );
+        return elementFromPoint === this;
+    }
+    """
+
+    CLICK = """
+    function(){
+        clicked = false;
+        this.addEventListener('click', function(){
+            clicked = true;
+        });
+        this.click();
+        return clicked;
+    }
+    """
+
+    CLICK_OPTION_TAG = """
+    document.querySelector('option[value="{self.value}"]').selected = true;
+    var selectParentXpath = (
+        '//option[@value="{self.value}"]//ancestor::select'
+    );
+    var select = document.evaluate(
+        selectParentXpath,
+        document,
+        null,
+        XPathResult.FIRST_ORDERED_NODE_TYPE,
+        null
+    ).singleNodeValue;
+    var event = new Event('change', { bubbles: true });
+    select.dispatchEvent(event);
+    """
diff --git a/pydoll/element.py b/pydoll/element.py
diff --git a/pydoll/exceptions.py b/pydoll/exceptions.py
