Merge branch '0.x' into 'master'

Author: itnelo

CHANGELOG.md

@@ -1,3 +1,4 @@
+
 # Changelog
 
 All notable changes to this project will be documented in this file.
@@ -6,18 +7,36 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+
 ### Changed
 
 - No description yet.
 
+## [0.3.0] - 2021-02-11
+
+### Added
+
+- `ClientInterface::removeSession()` implementation to properly close a WebDriver session.
+- Configurable `checkInterval` for the `WebDriverInterface::waitUntil()` method, to define a custom frequency for the
+condition checks.
+- README: minimal configuration snippet.
+
+### Fixed
+
+- `command.timeout` option now accepts both float and int values (will be normalized to float by the driver factory).
+- `onCommandConfirmation` hook is now propagates driver error message from the response alongside the predefined error
+label.
+
 ## [0.2.1] - 2020-12-22
+
 ### Fixed
 
 - `WebDriverInterface::waitUntil()`: a resulting value from the promise, that has been generated by the
 "condition-to-satisfy" callback, is now properly forwarded to the `onFulfilled` handler, for the `waitUntil` method
 itself.
 
 ## [0.2.0] - 2020-12-18
+
 ### Added
 
 - `ClientInterface::getTabIdentifiers()` method implementation (reading a list of tabs, which are opened in the
@@ -41,9 +60,11 @@ a screen state of the remote browser instance.
 - README: a "Requirements" block, description improvements.
 
 ### Changed
+
 - `Timeout\Interceptor` is now raising a single exception with both method-specific message and a timeout context.
 
 ### Fixed
+
 - Interface fixes and a minor redesign for some signatures.
 
 This version brings an async variant for most methods (no tests yet), which were defined by the
@@ -69,6 +90,7 @@ for the executable file and profile preferences) to launch a browser instance (w
 ``` 
 
 ## [0.1.0] (core design) - 2020-12-02
+
 ### Added
 
 - `WebDriverInterface` and low-level `ClientInterface` to communicate with
@@ -84,7 +106,8 @@ browser instance).
 This early development version doesn't yet contain full implementation for the introduced `WebDriverInterface`, only
 core design solutions and library interfaces are defined.
 
-[Unreleased]: https://github.com/itnelo/reactphp-webdriver/compare/0.2.1...0.x
+[Unreleased]: https://github.com/itnelo/reactphp-webdriver/compare/0.3.0...0.x
+[0.3.0]: https://github.com/itnelo/reactphp-webdriver/compare/0.2.1..0.3.0
 [0.2.1]: https://github.com/itnelo/reactphp-webdriver/compare/0.2.0..0.2.1
 [0.2.0]: https://github.com/itnelo/reactphp-webdriver/compare/0.1.0..0.2.0
 [0.1.0]: https://github.com/itnelo/reactphp-webdriver/releases/tag/0.1.0

README.md

@@ -32,7 +32,27 @@ $ composer require itnelo/reactphp-webdriver:^0.2
 
 ## How to use
 
-Call a factory method to get your instance (recommended):
+Call a factory method to get your instance (recommended). The minimal configuration is:
+
+```php
+use React\EventLoop\Factory as LoopFactory;
+use Itnelo\React\WebDriver\WebDriverFactory;
+
+$loop = LoopFactory::create();
+
+$webDriver = WebDriverFactory::create(
+    $loop,
+    [
+        'hub' => [
+            'host' => 'selenium-hub',
+            'port' => 4444,
+        ],
+    ]
+);
+```
+
+You can customize a set of parameters for the underlying [ReactPHP Browser](https://github.com/reactphp/http#browser)
+and tune driver options:
 
 ```php
 use React\EventLoop\Factory as LoopFactory;
@@ -45,7 +65,7 @@ $webDriver = WebDriverFactory::create(
     [
         'browser' => [
             'tcp' => [
-                'bindto' => '192.168.56.10:0',
+                'bindto' => '192.169.56.10:0',
             ],
             'tls' => [
                 'verify_peer' => false,
@@ -63,7 +83,7 @@ $webDriver = WebDriverFactory::create(
 );
 ```
 
-Manual configuration (if you want to configure each component as a separate service, e.g. compiling a DI container
+Manual configuration (if you prefer to configure each component as a separate service, e.g. compiling a DI container
 and want to reuse existing service definitions):
 
 ```php
@@ -80,7 +100,7 @@ $socketConnector = new SocketConnector(
     $loop,
     [
         'tcp' => [
-            'bindto' => '192.168.56.10:0',
+            'bindto' => '192.169.56.10:0',
         ],
         'tls' => [
             'verify_peer' => false,

src/Client/W3CClient.php

@@ -3,7 +3,7 @@
 /*
  * This file is part of the ReactPHP WebDriver <https://github.com/itnelo/reactphp-webdriver>.
  *
- * (c) 2020 Pavel Petrov <[email protected]>.
+ * (c) 2020-2021 Pavel Petrov <[email protected]>.
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -184,9 +184,30 @@ function (Throwable $rejectionReason) use ($sessionOpeningDeferred) {
      */
     public function removeSession(string $sessionIdentifier): PromiseInterface
     {
-        // todo: implementation
+        $requestUri = sprintf(
+            'http://%s:%d/wd/hub/session/%s',
+            $this->_options['server']['host'],
+            $this->_options['server']['port'],
+            $sessionIdentifier
+        );
 
-        return reject(new RuntimeException('Not implemented.'));
+        $requestHeaders = [
+            'Content-Type' => 'application/json; charset=UTF-8',
+        ];
+
+        $responsePromise = $this->httpClient->delete($requestUri, $requestHeaders);
+
+        $quitConfirmationPromise = $responsePromise
+            ->then(fn (ResponseInterface $response) => $this->onCommandConfirmation($response))
+            ->then(
+                null,
+                function (Throwable $rejectionReason) {
+                    throw new RuntimeException('Unable to close a session.', 0, $rejectionReason);
+                }
+            )
+        ;
+
+        return $quitConfirmationPromise;
     }
 
     /**
@@ -817,10 +838,14 @@ private function onCommandConfirmation(ResponseInterface $response, string $erro
     {
         $responseValueNode = $this->deserializeResponse($response);
 
-        // todo: locate an error message or set it as "undefined error"
-        if (null !== $responseValueNode) {
-            throw new RuntimeException($errorMessage);
+        if (null === $responseValueNode) {
+            return;
         }
+
+        $driverMessage            = $responseValueNode['message'] ?? 'undefined driver error';
+        $confirmationErrorMessage = sprintf('%s %s.', $errorMessage, $driverMessage);
+
+        throw new RuntimeException($confirmationErrorMessage);
     }
 
     /**

src/Routine/Condition/CheckRoutine.php

@@ -84,7 +84,7 @@ public function __construct(LoopInterface $loop, TimeoutInterceptor $timeoutInte
      *
      * @throws RuntimeException Whenever the routine is already in the running state
      */
-    public function run(callable $conditionMetCallback, float $checkInterval = 0.5): PromiseInterface
+    public function run(callable $conditionMetCallback, float $checkInterval): PromiseInterface
     {
         if ($this->_evaluationTimer instanceof TimerInterface) {
             throw new RuntimeException('Routine is already running.');

src/SeleniumHubDriver.php

@@ -3,7 +3,7 @@
 /*
  * This file is part of the ReactPHP WebDriver <https://github.com/itnelo/reactphp-webdriver>.
  *
- * (c) 2020 Pavel Petrov <[email protected]>.
+ * (c) 2020-2021 Pavel Petrov <[email protected]>.
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -114,9 +114,12 @@ public function getSessionIdentifiers(): PromiseInterface
      */
     public function removeSession(string $sessionIdentifier): PromiseInterface
     {
-        // todo: implementation
+        $quitConfirmationPromise = $this->hubClient->removeSession($sessionIdentifier);
 
-        return reject(new RuntimeException('Not implemented.'));
+        return $this->timeoutInterceptor->applyTimeout(
+            $quitConfirmationPromise,
+            'Unable to complete a session remove command.'
+        );
     }
 
     /**
@@ -310,15 +313,21 @@ public function wait(float $time = 30.0): PromiseInterface
     /**
      * {@inheritDoc}
      */
-    public function waitUntil(callable $conditionMetCallback, float $time = 30.0): PromiseInterface
-    {
-        $timeNormalized = max(0.5, $time);
+    public function waitUntil(
+        callable $conditionMetCallback,
+        float $time = 30.0,
+        float $checkInterval = 0.5
+    ): PromiseInterface {
+        $timeNormalized          = max(0.5, $time);
+        $checkIntervalNormalized = max(0.1, $checkInterval);
 
         // todo: probably, should be redesigned, to reduce amount of "new" calls
         $timeoutInterceptor = new TimeoutInterceptor($this->loop, $timeNormalized);
         $checkRoutine       = new ConditionCheckRoutine($this->loop, $timeoutInterceptor);
 
-        return $checkRoutine->run($conditionMetCallback);
+        $conditionMetPromise = $checkRoutine->run($conditionMetCallback, $checkIntervalNormalized);
+
+        return $conditionMetPromise;
     }
 
     /**

src/WebDriverFactory.php

@@ -21,6 +21,7 @@
 use React\Http\Browser;
 use React\Socket\Connector as SocketConnector;
 use Symfony\Component\OptionsResolver\Exception\ExceptionInterface as ConfigurationExceptionInterface;
+use Symfony\Component\OptionsResolver\Options;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
 /**
@@ -41,7 +42,7 @@ final class WebDriverFactory
      *     [
      *         'browser' => [
      *             'tcp' => [
-     *                 'bindto' => '192.168.56.10:0',
+     *                 'bindto' => '192.169.56.10:0',
      *             ],
      *             'tls' => [
      *                 'verify_peer' => false,
@@ -108,8 +109,16 @@ function (OptionsResolver $commandOptionsResolver) {
                             'Maximum time to wait (in seconds) for command execution '
                             . '(do not correlate with HTTP timeouts)'
                         )
-                        ->allowedTypes('float')
+                        ->allowedTypes('int', 'float')
                         ->default(30.0)
+                        ->normalize(
+                            function (Options $options, $commandTimeout) {
+                                $commandTimeoutNormalized = (float) $commandTimeout;
+                                $commandTimeoutNormalized = max(0.1, $commandTimeoutNormalized);
+
+                                return $commandTimeoutNormalized;
+                            }
+                        )
                     ;
                 }
             )

src/WebDriverInterface.php

@@ -3,7 +3,7 @@
 /*
  * This file is part of the ReactPHP WebDriver <https://github.com/itnelo/reactphp-webdriver>.
  *
- * (c) 2020 Pavel Petrov <[email protected]>.
+ * (c) 2020-2021 Pavel Petrov <[email protected]>.
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -116,10 +116,15 @@ public function wait(float $time = 30.0): PromiseInterface;
      * @param callable $conditionMetCallback A condition to be met, as a callback
      * @param float    $time                 Time (in seconds) to wait for successfully resolved promise from the
      *                                       condition callback (minimum: 0.5)
+     * @param float    $checkInterval        The interval for condition checks, in seconds (minimum: 0.1)
      *
      * @return PromiseInterface<mixed>
      */
-    public function waitUntil(callable $conditionMetCallback, float $time = 30.0): PromiseInterface;
+    public function waitUntil(
+        callable $conditionMetCallback,
+        float $time = 30.0,
+        float $checkInterval = 0.5
+    ): PromiseInterface;
 
     /**
      * Returns a promise that will be resolved if a screenshot is successfully received and saved using the specified