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

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