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

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\Event\ElasticaRequestExceptionEvent;
  21. use FOS\ElasticaBundle\Event\PostElasticaRequestEvent;
  22. use FOS\ElasticaBundle\Event\PreElasticaRequestEvent;
  23. use FOS\ElasticaBundle\Logger\ElasticaLogger;
  24. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  25. use Symfony\Component\Stopwatch\Stopwatch;
  27. /**
  28. * Extends the default Elastica client to provide logging for errors that occur
  29. * during communication with ElasticSearch.
  30. *
  31. * @author Gordon Franke <info@nevalon.de>
  32. */
  33. class Client extends BaseClient
  34. {
  35. /**
  36. * Stores created indexes to avoid recreation.
  37. *
  38. * @var array<string, BaseIndex>
  39. */
  40. private $indexCache = [];
  42. /**
  43. * Stores created index template to avoid recreation.
  44. *
  45. * @var array<string, IndexTemplate>
  46. */
  47. private $indexTemplateCache = [];
  49. /**
  50. * Symfony's debugging Stopwatch.
  51. *
  52. * @var Stopwatch|null
  53. */
  54. private $stopwatch;
  56. private ?EventDispatcherInterface $dispatcher = null;
  58. /**
  59. * @param array<mixed> $data
  60. * @param array<mixed> $query
  61. */
  62. public function request(string $path, string $method = Request::GET, $data = [], array $query = [], string $contentType = Request::DEFAULT_CONTENT_TYPE): Response
  63. {
  64. if ($this->stopwatch) {
  65. $this->stopwatch->start('es_request', 'fos_elastica');
  66. }
  68. if ($this->dispatcher) {
  69. $this->dispatcher->dispatch(new PreElasticaRequestEvent($path, $method, $data, $query, $contentType));
  70. }
  72. try {
  73. $response = parent::request($path, $method, $data, $query, $contentType);
  75. if ($this->dispatcher) {
  76. $this->dispatcher->dispatch(new PostElasticaRequestEvent($this->getLastRequest(), $this->getLastResponse()));
  77. }
  78. } catch (ExceptionInterface $e) {
  79. $this->logQuery($path, $method, $data, $query, 0, 0, 0);
  81. if ($this->dispatcher) {
  82. $this->dispatcher->dispatch(new ElasticaRequestExceptionEvent($this->getLastRequest(), $e));
  83. }
  85. throw $e;
  86. }
  88. $responseData = $response->getData();
  90. $transportInfo = $response->getTransferInfo();
  91. $connection = $this->getLastRequest()->getConnection();
  92. $forbiddenHttpCodes = $connection->hasConfig('http_error_codes') ? $connection->getConfig('http_error_codes') : [];
  94. if (isset($transportInfo['http_code']) && \in_array($transportInfo['http_code'], $forbiddenHttpCodes, true)) {
  95. $body = \json_encode($responseData);
  96. $message = \sprintf('Error in transportInfo: response code is %s, response body is %s', $transportInfo['http_code'], $body);
  97. throw new ClientException($message);
  98. }
  100. if (isset($responseData['took'], $responseData['hits'])) {
  101. $this->logQuery($path, $method, $data, $query, $response->getQueryTime(), $response->getEngineTime(), $responseData['hits']['total']['value'] ?? 0);
  102. } else {
  103. $this->logQuery($path, $method, $data, $query, $response->getQueryTime(), 0, 0);
  104. }
  106. if ($this->stopwatch) {
  107. $this->stopwatch->stop('es_request');
  108. }
  110. return $response;
  111. }
  113. public function getIndex(string $name): BaseIndex
  114. {
  115. // TODO PHP >= 7.4 ??=
  116. return $this->indexCache[$name] ?? ($this->indexCache[$name] = new Index($this, $name));
  117. }
  119. /**
  120. * @param string $name
  121. */
  122. public function getIndexTemplate($name): IndexTemplate
  123. {
  124. // TODO PHP >= 7.4 ??=
  125. return $this->indexTemplateCache[$name] ?? ($this->indexTemplateCache[$name] = new IndexTemplate($this, $name));
  126. }
  128. /**
  129. * Sets a stopwatch instance for debugging purposes.
  130. */
  131. public function setStopwatch(?Stopwatch $stopwatch = null): void
  132. {
  133. $this->stopwatch = $stopwatch;
  134. }
  136. public function setEventDispatcher(?EventDispatcherInterface $dispatcher = null): void
  137. {
  138. $this->dispatcher = $dispatcher;
  139. }
  141. /**
  142. * Log the query if we have an instance of ElasticaLogger.
  143. *
  144. * @param array<mixed>|string $data
  145. * @param array<mixed> $query
  146. * @param float $queryTime
  147. * @param int $engineMS
  148. */
  149. private function logQuery(string $path, string $method, $data, array $query, $queryTime, $engineMS = 0, int $itemCount = 0): void
  150. {
  151. if (!$this->_logger instanceof ElasticaLogger) {
  152. return;
  153. }
  155. $connection = $this->getLastRequest()->getConnection();
  157. $connectionArray = [
  158. 'host' => $connection->getHost(),
  159. 'port' => $connection->getPort(),
  160. 'transport' => $connection->getTransport(),
  161. 'headers' => $connection->hasConfig('headers') ? $connection->getConfig('headers') : [],
  162. ];
  164. $this->_logger->logQuery($path, $method, $data, $queryTime, $connectionArray, $query, $engineMS, $itemCount);
  165. }
  166. }