dispatch before/after events for web driver commands

instaclick · Dec 9, 2023 · 6238e49 · 6238e49
1 parent b453d4c
commit 6238e49
Show file tree

Hide file tree

Showing 16 changed files with 165 additions and 69 deletions.
diff --git a/composer.json b/composer.json
@@ -26,10 +26,10 @@
     ],
     "require": {
         "php": ">=7.2",
+        "psr/event-dispatcher": "^1.0.0",
         "ext-curl": "*"
     },
     "require-dev": {
-        "php": ">=7.2",
         "phpunit/phpunit": "^8.5 || ^9.5"
     },
     "minimum-stability": "dev",

diff --git a/lib/WebDriver/AbstractWebDriver.php b/lib/WebDriver/AbstractWebDriver.php
@@ -11,7 +11,9 @@
 
 namespace WebDriver;
 
+use Psr\EventDispatcher\EventDispatcherInterface;
 use WebDriver\Exception as WebDriverException;
+use WebDriver\Service\CurlServiceInterface;
 
 /**
  * Abstract WebDriver\AbstractWebDriver class
@@ -34,6 +36,13 @@ abstract class AbstractWebDriver
      */
     private $curlService;
 
+    /**
+     * Event Dispatcher
+     *
+     * @var \Psr\EventDispatcher\EventDispatcherInterface
+     */
+    private $eventDispatcher;
+
     /**
      * Transient options
      *
@@ -77,6 +86,7 @@ public function __construct($url)
         $this->transientOptions = [];
         $this->extensions = [];
         $this->curlService = ServiceFactory::getInstance()->getService('service.curl');
+        $this->eventDispatcher = ServiceFactory::getInstance()->getService('event_dispatcher');
     }
 
     /**
@@ -104,7 +114,7 @@ public function getURL()
      *
      * @param \WebDriver\Service\CurlServiceInterface $curlService
      */
-    public function setCurlService($curlService)
+    public function setCurlService(CurlServiceInterface $curlService)
     {
         $this->curlService = $curlService;
     }
@@ -119,6 +129,26 @@ public function getCurlService()
         return $this->curlService;
     }
 
+    /**
+     * Set event dispatcher
+     *
+     * @param \Psr\EventDispatcher\EventDispatcherInterface $eventDispatcher
+     */
+    public function setEventDispatcher(EventDispatcherInterface $eventDispatcher)
+    {
+        $this->eventDispatcher = $eventDispatcher;
+    }
+
+    /**
+     * Get curl service
+     *
+     * @return \Psr\EventDispatcher\EventDispatcherInterface
+     */
+    public function getEventDispatcher()
+    {
+        return $this->eventDispatcher;
+    }
+
     /**
      * Set transient options
      *
@@ -204,7 +234,7 @@ public function __call($name, $arguments)
         }
 
         $parameters = array_shift($arguments);
-        $result = $this->curl($requestMethod, '/' . $webdriverCommand, $parameters);
+        $result = $this->curl($requestMethod, $webdriverCommand, $parameters);
 
         return $result['value'];
     }
@@ -225,6 +255,32 @@ public function __get($name)
         trigger_error('Undefined property: ' . __CLASS__ . '::$' . $name, E_USER_WARNING);
     }
 
+    /**
+     * Event firing command wrapper
+     */
+    protected function curl($requestMethod, $command, $parameters = null, $extraOptions = [])
+    {
+        $name = strtoupper($requestMethod) . ':'
+              . substr($className = get_class($this), strrpos($className, '\\') + 1) . ':'
+              . ($command ?: substr($this->url, strrpos($this->url, '/') + 1));
+
+        $this->eventDispatcher->dispatch((object) ['event' => 'before', 'command' => $name, 'parameters' => $parameters]);
+
+        try {
+            $result = $this->curlExec($requestMethod, $command, $parameters, $extraOptions);
+        } catch (\Exception $e) {
+            $source = substr($className = get_class($e), strrpos($className, '\\') + 1);
+
+            $this->eventDispatcher->dispatch((object) ['event' => 'error', 'command' => $name, 'error' => $source]);
+
+            throw $e;
+        }
+
+        $this->eventDispatcher->dispatch((object) ['event' => 'after', 'command' => $name, 'result' => $result['value']]);
+
+        return $result;
+    }
+
     /**
      * Curl request to webdriver server.
      *
@@ -238,7 +294,7 @@ public function __get($name)
      *
      * @throws \WebDriver\Exception if error
      */
-    protected function curl($requestMethod, $command, $parameters = null, $extraOptions = [])
+    protected function curlExec($requestMethod, $command, $parameters, $extraOptions)
     {
         if ($parameters && is_array($parameters) && $requestMethod !== 'POST') {
             throw WebDriverException::factory(
@@ -252,7 +308,13 @@ protected function curl($requestMethod, $command, $parameters = null, $extraOpti
             );
         }
 
-        $url = $this->url . $command;
+        $url = $this->url;
+
+        if ($command && substr($this->url, -1) !== '/') {
+            $url .= '/';
+        }
+
+        $url .= $command;
 
         if (($requestMethod === 'GET' || $requestMethod === 'DELETE')
             && $parameters && (is_int($parameters) || is_string($parameters))

diff --git a/lib/WebDriver/Alert.php b/lib/WebDriver/Alert.php
@@ -59,7 +59,7 @@ protected function aliases()
      */
     public function acceptAlert()
     {
-        $result = $this->curl('POST', '/accept');
+        $result = $this->curl('POST', 'accept');
 
         return $result['value'];
     }
@@ -71,7 +71,7 @@ public function acceptAlert()
      */
     public function dismissAlert()
     {
-        $result = $this->curl('POST', '/dismiss');
+        $result = $this->curl('POST', 'dismiss');
 
         return $result['value'];
     }
@@ -83,7 +83,7 @@ public function dismissAlert()
      */
     public function getAlertText()
     {
-        $result = $this->curl('GET', '/text');
+        $result = $this->curl('GET', 'text');
 
         return $result['value'];
     }
@@ -101,7 +101,7 @@ public function setAlertValue($text)
             ? $text
             : ['text' => $text];
 
-        $result = $this->curl('POST', '/text', $parameters);
+        $result = $this->curl('POST', 'text', $parameters);
 
         return $result['value'];
     }

diff --git a/lib/WebDriver/Container.php b/lib/WebDriver/Container.php
@@ -54,7 +54,7 @@ public function findElement($using = null, $value = null)
         $parameters = $this->parseArgs('element', func_get_args());
 
         try {
-            $result = $this->curl('POST', '/element', $parameters);
+            $result = $this->curl('POST', 'element', $parameters);
         } catch (WebDriverException\NoSuchElement $e) {
             throw WebDriverException::factory(
                 WebDriverException::NO_SUCH_ELEMENT,
@@ -100,7 +100,7 @@ public function findElements($using = null, $value = null)
     {
         $parameters = $this->parseArgs('elements', func_get_args());
 
-        $result = $this->curl('POST', '/elements', $parameters);
+        $result = $this->curl('POST', 'elements', $parameters);
 
         if (! is_array($result['value'])) {
             return [];

diff --git a/lib/WebDriver/Element.php b/lib/WebDriver/Element.php
@@ -126,7 +126,7 @@ public function getID()
      */
     public function getAccessibleName()
     {
-        $result = $this->curl('GET', '/computedlabel');
+        $result = $this->curl('GET', 'computedlabel');
 
         return $result['value'];
     }
@@ -138,7 +138,7 @@ public function getAccessibleName()
      */
     public function getAriaRole()
     {
-        $result = $this->curl('GET', '/computedrole');
+        $result = $this->curl('GET', 'computedrole');
 
         return $result['value'];
     }
@@ -155,7 +155,7 @@ public function getAriaRole()
      */
     public function getShadowRoot()
     {
-        $result = $this->curl('POST', '/shadow');
+        $result = $this->curl('POST', 'shadow');
         $value  = $result['value'];
 
         if (! is_array($value)) {
@@ -178,7 +178,7 @@ public function getShadowRoot()
      */
     public function isEnabled()
     {
-        $result = $this->curl('GET', '/enabled');
+        $result = $this->curl('GET', 'enabled');
 
         return $result['value'];
     }
@@ -190,7 +190,7 @@ public function isEnabled()
      */
     public function isSelected()
     {
-        $result = $this->curl('GET', '/selected');
+        $result = $this->curl('GET', 'selected');
 
         return $result['value'];
     }
@@ -218,7 +218,7 @@ public function sendKeys($text)
             $parameters['value'] = [$parameters['text']];
         }
 
-        $result = $this->curl('POST', '/value', $parameters);
+        $result = $this->curl('POST', 'value', $parameters);
 
         return $result['value'];
     }
@@ -235,7 +235,7 @@ public function submit()
         // trigger_error(__METHOD__, E_USER_DEPRECATED);
 
         try {
-            $result = $this->curl('POST', '/submit');
+            $result = $this->curl('POST', 'submit');
 
             return $result['value'];
         } catch (\Exception $e) {

diff --git a/lib/WebDriver/Execute.php b/lib/WebDriver/Execute.php
@@ -34,7 +34,7 @@ public function async($script, $args = null)
 
         $parameters['args'] = $this->serializeArguments($parameters['args']);
 
-        $result = $this->curl('POST', '/execute/async', $parameters);
+        $result = $this->curl('POST', 'execute/async', $parameters);
 
         return $this->unserializeResult($result['value']);
     }
@@ -55,7 +55,7 @@ public function sync($script, $args = null)
 
         $parameters['args'] = $this->serializeArguments($parameters['args']);
 
-        $result = $this->curl('POST', '/execute/sync', $parameters);
+        $result = $this->curl('POST', 'execute/sync', $parameters);
 
         return $this->unserializeResult($result['value']);
     }

diff --git a/lib/WebDriver/Extension/ChromeDevTools.php b/lib/WebDriver/Extension/ChromeDevTools.php
@@ -34,7 +34,7 @@ public function execute($cmd, $params = null)
             ? $cmd
             : ['cmd' => $cmd, 'params' => $params ?? new \stdclass];
 
-        $result = $this->curl('POST', '/execute', $parameters);
+        $result = $this->curl('POST', 'execute', $parameters);
 
         return $result['value'];
     }

diff --git a/lib/WebDriver/Extension/FederatedCredentialManagementAPI.php b/lib/WebDriver/Extension/FederatedCredentialManagementAPI.php
@@ -53,7 +53,7 @@ protected function methods()
      */
     public function cancelDialog()
     {
-        $result = $this->curl('POST', '/canceldialog');
+        $result = $this->curl('POST', 'canceldialog');
 
         return $result['value'];
     }
@@ -71,7 +71,7 @@ public function selectAccount($parameters)
             $parameters = ['accountIndex' => $parameters];
         }
 
-        $result = $this->curl('POST', '/selectaccount', $parameters);
+        $result = $this->curl('POST', 'selectaccount', $parameters);
 
         return $result['value'];
     }
@@ -85,7 +85,7 @@ public function selectAccount($parameters)
      */
     public function clickDialogButton($parameters)
     {
-        $result = $this->curl('POST', '/clickdialogbutton', $parameters);
+        $result = $this->curl('POST', 'clickdialogbutton', $parameters);
 
         return $result['value'];
     }
@@ -97,7 +97,7 @@ public function clickDialogButton($parameters)
      */
     public function getAccounts()
     {
-        $result = $this->curl('GET', '/accountlist');
+        $result = $this->curl('GET', 'accountlist');
 
         return $result['value'];
     }
@@ -109,7 +109,7 @@ public function getAccounts()
      */
     public function getTitle()
     {
-        $result = $this->curl('GET', '/gettitle');
+        $result = $this->curl('GET', 'gettitle');
 
         return $result['value'];
     }
@@ -121,7 +121,7 @@ public function getTitle()
      */
     public function getDialogType()
     {
-        $result = $this->curl('GET', '/getdialogtype');
+        $result = $this->curl('GET', 'getdialogtype');
 
         return $result['value'];
     }
@@ -139,7 +139,7 @@ public function setDelayEnabled($parameters)
             $parameters = ['enabled' => $parameters];
         }
 
-        $result = $this->curl('POST', '/setdelayenabled', $parameters);
+        $result = $this->curl('POST', 'setdelayenabled', $parameters);
 
         return $result['value'];
     }
@@ -151,7 +151,7 @@ public function setDelayEnabled($parameters)
      */
     public function resetCooldown()
     {
-        $result = $this->curl('POST', '/resetCooldown');
+        $result = $this->curl('POST', 'resetCooldown');
 
         return $result['value'];
     }