refactor: refactor JavaScript execution and introduce runtime commands

Author: thalissonvs

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,25 @@ 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.
 
         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 = {
+                'method': 'Runtime.evaluate',
+                'params': {'expression': script, 'returnByValue': True},
+            }
         return await self._execute_command(command)
 
     async def _wait_page_load(self, timeout: int = 300):

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(
@@ -65,20 +50,6 @@ def scroll_into_view(
             object_id=object_id,
         )
 
-    @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 = cls._create_command(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 get_outer_html(cls, node_id: int) -> dict:
         """Generates the command to get the outer HTML"""
@@ -123,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(
@@ -184,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,
@@ -230,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() {'
@@ -241,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, '
@@ -268,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() {'
@@ -284,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, '

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

pydoll/element.py

@@ -5,6 +5,7 @@
 from pydoll import exceptions
 from pydoll.commands.dom import DomCommands
 from pydoll.commands.input import InputCommands
+from pydoll.commands.runtime import RuntimeCommands
 from pydoll.connection import ConnectionHandler
 from pydoll.constants import By, Scripts
 from pydoll.mixins.find_elements import FindElementsMixin
@@ -146,7 +147,7 @@ async def _execute_script(
             script (str): The JavaScript script to execute.
         """
         return await self._execute_command(
-            DomCommands.call_function_on(
+            RuntimeCommands.call_function_on(
                 self._node['objectId'], script, return_by_value
             )
         )
@@ -204,7 +205,6 @@ async def scroll_into_view(self):
         await self._execute_command(command)
 
     async def click(self):
-
         if self._is_option_tag():
             return await self.click_option_tag()
 
@@ -259,7 +259,7 @@ async def realistic_click(self, x_offset: int = 0, y_offset: int = 0):
 
     async def click_option_tag(self):
         script = Scripts.CLICK_OPTION_TAG.replace('{self.value}', self.value)
-        await self._execute_command(DomCommands.evaluate_js(script))
+        await self._execute_command(RuntimeCommands.evaluate_script(script))
 
     async def send_keys(self, text: str):
         """

pydoll/exceptions.py

@@ -32,3 +32,15 @@ class BrowserNotRunning(Exception):
 
 class ElementNotFound(Exception):
     pass
+
+
+class ClickIntercepted(Exception):
+    pass
+
+
+class ElementNotVisible(Exception):
+    pass
+
+
+class ElementNotInteractable(Exception):
+    pass