Merge branch '0.x' into 'master'

Author: itnelo

CHANGELOG.md

@@ -12,6 +12,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - No description yet.
 
+## [0.4.0] - 2021-02-25
+
+### Added
+
+- `ClientInterface::getSessionIdentifiers()` implementation to get a list with WebDriver sessions from the active pool
+(as an opportunity to resume existing sessions).
+
+### Fixed
+
+- Missed type checks after WebDriver response deserialization for some methods (e.g. to prevent misreading an
+error array as a valid command output).
+
 ## [0.3.0] - 2021-02-11
 
 ### Added
@@ -106,7 +118,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.3.0...0.x
+[Unreleased]: https://github.com/itnelo/reactphp-webdriver/compare/0.4.0...0.x
+[0.4.0]: https://github.com/itnelo/reactphp-webdriver/compare/0.3.0..0.4.0
 [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

src/Client/W3CClient.php

@@ -39,6 +39,13 @@
  */
 class W3CClient implements ClientInterface
 {
+    /**
+     * A pattern to recognize session identifier in the WebDriver response
+     *
+     * @var string
+     */
+    private const PATTERN_SESSION_IDENTIFIER = '/[":\s]+([a-z\d]{32})/Ui';
+
     /**
      * Sends commands to the Selenium Grid endpoint using W3C protocol over HTTP
      *
@@ -116,9 +123,44 @@ function (OptionsResolver $serverOptionsResolver) {
      */
     public function getSessionIdentifiers(): PromiseInterface
     {
-        // todo: implementation
+        $requestUri = sprintf(
+            'http://%s:%d/wd/hub/sessions',
+            $this->_options['server']['host'],
+            $this->_options['server']['port']
+        );
 
-        return reject(new RuntimeException('Not implemented.'));
+        $requestHeaders = [
+            'Content-Type' => 'application/json; charset=UTF-8',
+        ];
+
+        $responsePromise = $this->httpClient->get($requestUri, $requestHeaders);
+
+        $identifierListPromise = $responsePromise
+            ->then(
+                function (ResponseInterface $response) {
+                    $dataArray = $this->deserializeResponse($response);
+                    $payload   = $dataArray['message'] ?? '';
+
+                    preg_match_all(self::PATTERN_SESSION_IDENTIFIER, $payload, $matches);
+
+                    if (!isset($matches[1]) || 1 > count($matches[1])) {
+                        throw new RuntimeException('Unable to locate a list of session identifiers in the response.');
+                    }
+
+                    $identifierList = $matches[1];
+
+                    return $identifierList;
+                }
+            )
+            ->then(
+                null,
+                function (Throwable $rejectionReason) {
+                    throw new RuntimeException('Unable to get a list of session identifiers.', 0, $rejectionReason);
+                }
+            )
+        ;
+
+        return $identifierListPromise;
     }
 
     /**
@@ -148,7 +190,7 @@ public function createSession(): PromiseInterface
             function (ResponseInterface $response) use ($sessionOpeningDeferred) {
                 try {
                     $responseBody = (string) $response->getBody();
-                    preg_match('/sessionid[":\s]+([a-z\d]{32})/Ui', $responseBody, $matches);
+                    preg_match(self::PATTERN_SESSION_IDENTIFIER, $responseBody, $matches);
 
                     if (!isset($matches[1])) {
                         // todo: locate an error message or set it as "undefined error"
@@ -235,6 +277,10 @@ function (ResponseInterface $response) use ($tabLookupDeferred) {
                 try {
                     $tabIdentifiers = $this->deserializeResponse($response);
 
+                    if (!is_array($tabIdentifiers)) {
+                        throw new RuntimeException('Unable to locate tab identifiers in the response.');
+                    }
+
                     $tabLookupDeferred->resolve($tabIdentifiers);
                 } catch (Throwable $exception) {
                     $reason = new RuntimeException(
@@ -281,6 +327,10 @@ public function getActiveTabIdentifier(string $sessionIdentifier): PromiseInterf
                 function (ResponseInterface $response) {
                     $tabIdentifier = $this->deserializeResponse($response);
 
+                    if (!is_string($tabIdentifier)) {
+                        throw new RuntimeException('Unable to locate a tab identifier in the response.');
+                    }
+
                     return $tabIdentifier;
                 }
             )
@@ -396,6 +446,10 @@ public function getCurrentUri(string $sessionIdentifier): PromiseInterface
                 function (ResponseInterface $response) {
                     $uriCurrent = $this->deserializeResponse($response);
 
+                    if (!is_string($uriCurrent)) {
+                        throw new RuntimeException('Unable to locate an URI in the response.');
+                    }
+
                     return $uriCurrent;
                 }
             )
@@ -433,6 +487,10 @@ public function getSource(string $sessionIdentifier): PromiseInterface
                 function (ResponseInterface $response) {
                     $sourceCode = $this->deserializeResponse($response);
 
+                    if (!is_string($sourceCode)) {
+                        throw new RuntimeException('Unable to locate source code in the response.');
+                    }
+
                     return $sourceCode;
                 }
             )
@@ -557,6 +615,10 @@ public function getElementVisibility(string $sessionIdentifier, array $elementId
                 function (ResponseInterface $response) {
                     $visibilityStatus = $this->deserializeResponse($response);
 
+                    if (!is_bool($visibilityStatus)) {
+                        throw new RuntimeException('Unable to locate a visibility status in the response.');
+                    }
+
                     return $visibilityStatus;
                 }
             )
@@ -736,7 +798,12 @@ public function getScreenshot(string $sessionIdentifier): PromiseInterface
             ->then(
                 function (ResponseInterface $response) {
                     $imageContentsEncoded = $this->deserializeResponse($response);
-                    $imageContents        = base64_decode($imageContentsEncoded);
+
+                    if (!is_string($imageContentsEncoded)) {
+                        throw new RuntimeException('Unable to locate screenshot contents in the response.');
+                    }
+
+                    $imageContents = base64_decode($imageContentsEncoded);
 
                     return $imageContents;
                 }

src/SeleniumHubDriver.php

@@ -104,9 +104,12 @@ public function createSession(): PromiseInterface
      */
     public function getSessionIdentifiers(): PromiseInterface
     {
-        // todo: implementation
+        $identifierListPromise = $this->hubClient->getSessionIdentifiers();
 
-        return reject(new RuntimeException('Not implemented.'));
+        return $this->timeoutInterceptor->applyTimeout(
+            $identifierListPromise,
+            'Unable to complete a get session identifiers command.'
+        );
     }
 
     /**
@@ -127,10 +130,10 @@ public function removeSession(string $sessionIdentifier): PromiseInterface
      */
     public function getTabIdentifiers(string $sessionIdentifier): PromiseInterface
     {
-        $sessionIdentifierPromise = $this->hubClient->getTabIdentifiers($sessionIdentifier);
+        $tabIdentifierListPromise = $this->hubClient->getTabIdentifiers($sessionIdentifier);
 
         return $this->timeoutInterceptor->applyTimeout(
-            $sessionIdentifierPromise,
+            $tabIdentifierListPromise,
             'Unable to complete a tab lookup command.'
         );
     }