vendor/friendsofsymfony/elastica-bundle/src/Elastica/Client.php line 56

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the FOSElasticaBundle package.
  5.  *
  6.  * (c) FriendsOfSymfony <https://friendsofsymfony.github.com/>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace FOS\ElasticaBundle\Elastica;
  14. use Elastica\Client as BaseClient;
  15. use Elastica\Exception\ClientException;
  16. use Elastica\Exception\ExceptionInterface;
  17. use Elastica\Index as BaseIndex;
  18. use Elastica\Request;
  19. use Elastica\Response;
  20. use FOS\ElasticaBundle\Logger\ElasticaLogger;
  21. use Symfony\Component\Stopwatch\Stopwatch;
  23. /**
  24.  * Extends the default Elastica client to provide logging for errors that occur
  25.  * during communication with ElasticSearch.
  26.  *
  27.  * @author Gordon Franke <info@nevalon.de>
  28.  */
  29. class Client extends BaseClient
  30. {
  31.     /**
  32.      * Stores created indexes to avoid recreation.
  33.      *
  34.      * @var array<string, BaseIndex>
  35.      */
  36.     private $indexCache = [];
  38.     /**
  39.      * Stores created index template to avoid recreation.
  40.      *
  41.      * @var array<string, IndexTemplate>
  42.      */
  43.     private $indexTemplateCache = [];
  45.     /**
  46.      * Symfony's debugging Stopwatch.
  47.      *
  48.      * @var Stopwatch|null
  49.      */
  50.     private $stopwatch;
  52.     /**
  53.      * @param array<mixed> $data
  54.      * @param array<mixed> $query
  55.      */
  56.     public function request(string $path, string $method = Request::GET, $data = [], array $query = [], string $contentType = Request::DEFAULT_CONTENT_TYPE): Response
  57.     {
  58.         if ($this->stopwatch) {
  59.             $this->stopwatch->start('es_request', 'fos_elastica');
  60.         }
  62.         try {
  63.             $response = parent::request($path, $method, $data, $query, $contentType);
  64.         } catch (ExceptionInterface $e) {
  65.             $this->logQuery($path, $method, $data, $query, 0, 0, 0);
  66.             throw $e;
  67.         }
  69.         $responseData = $response->getData();
  71.         $transportInfo = $response->getTransferInfo();
  72.         $connection = $this->getLastRequest()->getConnection();
  73.         $forbiddenHttpCodes = $connection->hasConfig('http_error_codes') ? $connection->getConfig('http_error_codes') : [];
  75.         if (isset($transportInfo['http_code']) && \in_array($transportInfo['http_code'], $forbiddenHttpCodes, true)) {
  76.             $body = \json_encode($responseData);
  77.             $message = \sprintf('Error in transportInfo: response code is %s, response body is %s', $transportInfo['http_code'], $body);
  78.             throw new ClientException($message);
  79.         }
  81.         if (isset($responseData['took'], $responseData['hits'])) {
  82.             $this->logQuery($path, $method, $data, $query, $response->getQueryTime(), $response->getEngineTime(), $responseData['hits']['total']['value'] ?? 0);
  83.         } else {
  84.             $this->logQuery($path, $method, $data, $query, $response->getQueryTime(), 0, 0);
  85.         }
  87.         if ($this->stopwatch) {
  88.             $this->stopwatch->stop('es_request');
  89.         }
  91.         return $response;
  92.     }
  94.     public function getIndex(string $name): BaseIndex
  95.     {
  96.         // TODO PHP >= 7.4 ??=
  97.         return $this->indexCache[$name] ?? ($this->indexCache[$name] = new Index($this, $name));
  98.     }
  100.     /**
  101.      * @param string $name
  102.      */
  103.     public function getIndexTemplate($name): IndexTemplate
  104.     {
  105.         // TODO PHP >= 7.4 ??=
  106.         return $this->indexTemplateCache[$name] ?? ($this->indexTemplateCache[$name] = new IndexTemplate($this, $name));
  107.     }
  109.     /**
  110.      * Sets a stopwatch instance for debugging purposes.
  111.      */
  112.     public function setStopwatch(?Stopwatch $stopwatch = null): void
  113.     {
  114.         $this->stopwatch = $stopwatch;
  115.     }
  117.     /**
  118.      * Log the query if we have an instance of ElasticaLogger.
  119.      *
  120.      * @param array<mixed>|string $data
  121.      * @param array<mixed>        $query
  122.      * @param float               $queryTime
  123.      * @param int                 $engineMS
  124.      */
  125.     private function logQuery(string $path, string $method, $data, array $query, $queryTime, $engineMS = 0, int $itemCount = 0): void
  126.     {
  127.         if (!$this->_logger instanceof ElasticaLogger) {
  128.             return;
  129.         }
  131.         $connection = $this->getLastRequest()->getConnection();
  133.         $connectionArray = [
  134.             'host' => $connection->getHost(),
  135.             'port' => $connection->getPort(),
  136.             'transport' => $connection->getTransport(),
  137.             'headers' => $connection->hasConfig('headers') ? $connection->getConfig('headers') : [],
  138.         ];
  140.         $this->_logger->logQuery($path, $method, $data, $queryTime, $connectionArray, $query, $engineMS, $itemCount);
  141.     }
  142. }