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

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\Index as BaseIndex;
  17. use Elastica\Request;
  18. use Elastica\Response;
  19. use FOS\ElasticaBundle\Logger\ElasticaLogger;
  20. use Symfony\Component\Stopwatch\Stopwatch;
  22. /**
  23.  * Extends the default Elastica client to provide logging for errors that occur
  24.  * during communication with ElasticSearch.
  25.  *
  26.  * @author Gordon Franke <info@nevalon.de>
  27.  */
  28. class Client extends BaseClient
  29. {
  30.     /**
  31.      * Stores created indexes to avoid recreation.
  32.      *
  33.      * @var array<string, BaseIndex>
  34.      */
  35.     private $indexCache = [];
  37.     /**
  38.      * Stores created index template to avoid recreation.
  39.      *
  40.      * @var array<string, IndexTemplate>
  41.      */
  42.     private $indexTemplateCache = [];
  44.     /**
  45.      * Symfony's debugging Stopwatch.
  46.      *
  47.      * @var Stopwatch|null
  48.      */
  49.     private $stopwatch;
  51.     /**
  52.      * {@inheritdoc}
  53.      *
  54.      * @param array<mixed> $data
  55.      * @param array<mixed> $query
  56.      */
  57.     public function request(string $path, string $method = Request::GET, $data = [], array $query = [], string $contentType = Request::DEFAULT_CONTENT_TYPE): Response
  58.     {
  59.         if ($this->stopwatch) {
  60.             $this->stopwatch->start('es_request', 'fos_elastica');
  61.         }
  63.         $response = parent::request($path, $method, $data, $query, $contentType);
  64.         $responseData = $response->getData();
  66.         $transportInfo = $response->getTransferInfo();
  67.         $connection = $this->getLastRequest()->getConnection();
  68.         $forbiddenHttpCodes = $connection->hasConfig('http_error_codes') ? $connection->getConfig('http_error_codes') : [];
  70.         if (isset($transportInfo['http_code']) && \in_array($transportInfo['http_code'], $forbiddenHttpCodes, true)) {
  71.             $body = \json_encode($responseData);
  72.             $message = \sprintf('Error in transportInfo: response code is %s, response body is %s', $transportInfo['http_code'], $body);
  73.             throw new ClientException($message);
  74.         }
  76.         if (isset($responseData['took'], $responseData['hits'])) {
  77.             $this->logQuery($path, $method, $data, $query, $response->getQueryTime(), $response->getEngineTime(), $responseData['hits']['total']['value'] ?? 0);
  78.         } else {
  79.             $this->logQuery($path, $method, $data, $query, $response->getQueryTime(), 0, 0);
  80.         }
  82.         if ($this->stopwatch) {
  83.             $this->stopwatch->stop('es_request');
  84.         }
  86.         return $response;
  87.     }
  89.     public function getIndex(string $name): BaseIndex
  90.     {
  91.         // TODO PHP >= 7.4 ??=
  92.         return $this->indexCache[$name] ?? ($this->indexCache[$name] = new Index($this, $name));
  93.     }
  95.     /**
  96.      * @param string $name
  97.      */
  98.     public function getIndexTemplate($name): IndexTemplate
  99.     {
  100.         // TODO PHP >= 7.4 ??=
  101.         return $this->indexTemplateCache[$name] ?? ($this->indexTemplateCache[$name] = new IndexTemplate($this, $name));
  102.     }
  104.     /**
  105.      * Sets a stopwatch instance for debugging purposes.
  106.      */
  107.     public function setStopwatch(?Stopwatch $stopwatch = null): void
  108.     {
  109.         $this->stopwatch = $stopwatch;
  110.     }
  112.     /**
  113.      * Log the query if we have an instance of ElasticaLogger.
  114.      *
  115.      * @param array<mixed>|string $data
  116.      * @param array<mixed>        $query
  117.      * @param float               $queryTime
  118.      * @param int                 $engineMS
  119.      */
  120.     private function logQuery(string $path, string $method, $data, array $query, $queryTime, $engineMS = 0, int $itemCount = 0): void
  121.     {
  122.         if (!$this->_logger instanceof ElasticaLogger) {
  123.             return;
  124.         }
  126.         $connection = $this->getLastRequest()->getConnection();
  128.         $connectionArray = [
  129.             'host' => $connection->getHost(),
  130.             'port' => $connection->getPort(),
  131.             'transport' => $connection->getTransport(),
  132.             'headers' => $connection->hasConfig('headers') ? $connection->getConfig('headers') : [],
  133.         ];
  135.         $this->_logger->logQuery($path, $method, $data, $queryTime, $connectionArray, $query, $engineMS, $itemCount);
  136.     }
  137. }