Chris@18: <?php
Chris@18: 
Chris@18: namespace Drupal\Tests\jsonapi\Functional;
Chris@18: 
Chris@18: use Behat\Mink\Driver\BrowserKitDriver;
Chris@18: use Drupal\Core\Url;
Chris@18: use GuzzleHttp\RequestOptions;
Chris@18: 
Chris@18: /**
Chris@18:  * Boilerplate for JSON:API Functional tests' HTTP requests.
Chris@18:  *
Chris@18:  * @internal
Chris@18:  */
Chris@18: trait JsonApiRequestTestTrait {
Chris@18: 
Chris@18:   /**
Chris@18:    * Performs a HTTP request. Wraps the Guzzle HTTP client.
Chris@18:    *
Chris@18:    * Why wrap the Guzzle HTTP client? Because we want to keep the actual test
Chris@18:    * code as simple as possible, and hence not require them to specify the
Chris@18:    * 'http_errors = FALSE' request option, nor do we want them to have to
Chris@18:    * convert Drupal Url objects to strings.
Chris@18:    *
Chris@18:    * We also don't want to follow redirects automatically, to ensure these tests
Chris@18:    * are able to detect when redirects are added or removed.
Chris@18:    *
Chris@18:    * @param string $method
Chris@18:    *   HTTP method.
Chris@18:    * @param \Drupal\Core\Url $url
Chris@18:    *   URL to request.
Chris@18:    * @param array $request_options
Chris@18:    *   Request options to apply.
Chris@18:    *
Chris@18:    * @return \Psr\Http\Message\ResponseInterface
Chris@18:    *   The response.
Chris@18:    *
Chris@18:    * @see \GuzzleHttp\ClientInterface::request()
Chris@18:    */
Chris@18:   protected function request($method, Url $url, array $request_options) {
Chris@18:     $this->refreshVariables();
Chris@18:     $request_options[RequestOptions::HTTP_ERRORS] = FALSE;
Chris@18:     $request_options[RequestOptions::ALLOW_REDIRECTS] = FALSE;
Chris@18:     $request_options = $this->decorateWithXdebugCookie($request_options);
Chris@18:     $client = $this->getSession()->getDriver()->getClient()->getClient();
Chris@18:     return $client->request($method, $url->setAbsolute(TRUE)->toString(), $request_options);
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Adds the Xdebug cookie to the request options.
Chris@18:    *
Chris@18:    * @param array $request_options
Chris@18:    *   The request options.
Chris@18:    *
Chris@18:    * @return array
Chris@18:    *   Request options updated with the Xdebug cookie if present.
Chris@18:    */
Chris@18:   protected function decorateWithXdebugCookie(array $request_options) {
Chris@18:     $session = $this->getSession();
Chris@18:     $driver = $session->getDriver();
Chris@18:     if ($driver instanceof BrowserKitDriver) {
Chris@18:       $client = $driver->getClient();
Chris@18:       foreach ($client->getCookieJar()->all() as $cookie) {
Chris@18:         if (isset($request_options[RequestOptions::HEADERS]['Cookie'])) {
Chris@18:           $request_options[RequestOptions::HEADERS]['Cookie'] .= '; ' . $cookie->getName() . '=' . $cookie->getValue();
Chris@18:         }
Chris@18:         else {
Chris@18:           $request_options[RequestOptions::HEADERS]['Cookie'] = $cookie->getName() . '=' . $cookie->getValue();
Chris@18:         }
Chris@18:       }
Chris@18:     }
Chris@18:     return $request_options;
Chris@18:   }
Chris@18: 
Chris@18: }