Integrate Client events.

biozshock · biozshock · commit 59797d10309c · 2025-03-17T15:59:48.000+01:00
diff --git a/CHANGELOG-7.0.md b/CHANGELOG-7.0.md
@@ -17,6 +17,8 @@ in 7.x versions.
 * **[BC break]** Configuration options: `host`, `port`, `url` are no longer available and replaced with single `hosts`.
 * **[BC break]** Configuration options: `proxy`, `auth_type`, `aws_*`, `ssl`, `curl`, `persistent`, `compression`, `connectTimeout` are no longer available.
 * **[BC break]** Configuration `connectionStrategy` is renamed to `connection_strategy`.
+* **[BC break]** Event `PostElasticaRequestEvent` now operates with `Psr\Http\Message\RequestInterface` instead of `Elastica\Request`.
+* **[BC break]** Event `ElasticaRequestExceptionEvent` now operates with `Psr\Http\Message\RequestInterface` instead of `Elastica\Request`, and `Elastic\Elasticsearch\Exception\ElasticsearchException` instead of `Elastica\Exception\ExceptionInterface`.
 
 Main change is the configuration of the bundle:
 * There are no `connections` level anymore.
diff --git a/src/Elastica/Client.php b/src/Elastica/Client.php
@@ -16,10 +16,10 @@
 use Elastic\Elasticsearch\Response\Elasticsearch;
 use Elastica\Client as BaseClient;
 use Elastica\Exception\ClientException;
-use FOS\ElasticaBundle\Logger\ElasticaLogger;
 use FOS\ElasticaBundle\Event\ElasticaRequestExceptionEvent;
 use FOS\ElasticaBundle\Event\PostElasticaRequestEvent;
 use FOS\ElasticaBundle\Event\PreElasticaRequestEvent;
+use FOS\ElasticaBundle\Logger\ElasticaLogger;
 use Psr\Http\Message\RequestInterface;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
@@ -82,38 +82,39 @@ public function sendRequest(RequestInterface $request): Elasticsearch
         $query = [];
         \parse_str($request->getUri()->getQuery(), $query);
 
-        if ($this->dispatcher) {
-            $this->dispatcher->dispatch(new PreElasticaRequestEvent($path, $method, $data, $query, $contentType));
+        if (null !== $this->dispatcher) {
+            $this->dispatcher->dispatch(new PreElasticaRequestEvent($path, $method, $data, $query, $request->getHeaderLine('Content-Type')));
         }
 
         $start = \microtime(true);
         try {
             $elasticResponse = parent::sendRequest($request);
             $response = $this->toElasticaResponse($elasticResponse);
 
-            if ($this->dispatcher) {
+            if (null !== $this->dispatcher) {
                 $this->dispatcher->dispatch(new PostElasticaRequestEvent($request, $response));
             }
         } catch (ClientResponseException $responseException) {
             $this->logQuery($path, $method, $data, $query, 0.0, 0, 0);
 
             $response = $responseException->getResponse();
+
+            if (null !== $this->dispatcher) {
+                $this->dispatcher->dispatch(new ElasticaRequestExceptionEvent($request, $responseException));
+            }
+
             if (\in_array($response->getStatusCode(), $this->forbiddenCodes, true)) {
                 $body = (string) $response->getBody();
                 $message = \sprintf('Error in transportInfo: response code is %s, response body is %s', $response->getStatusCode(), $body);
-                throw new ClientException($message);
-            }
-
-            if ($this->dispatcher) {
-                $this->dispatcher->dispatch(new ElasticaRequestExceptionEvent($this->getLastRequest(), $e));
+                throw new ClientException($message, 0, $responseException);
             }
 
             throw $responseException;
         } catch (ElasticsearchException $e) {
             $this->logQuery($path, $method, $data, $query, 0.0, 0, 0);
 
-            if ($this->dispatcher) {
-                $this->dispatcher->dispatch(new ElasticaRequestExceptionEvent($this->getLastRequest(), $e));
+            if (null !== $this->dispatcher) {
+                $this->dispatcher->dispatch(new ElasticaRequestExceptionEvent($request, $e));
             }
 
             throw $e;
diff --git a/src/Event/ElasticaRequestExceptionEvent.php b/src/Event/ElasticaRequestExceptionEvent.php
@@ -11,28 +11,28 @@
 
 namespace FOS\ElasticaBundle\Event;
 
-use Elastica\Exception\ExceptionInterface;
-use Elastica\Request;
+use Elastic\Elasticsearch\Exception\ElasticsearchException;
+use Psr\Http\Message\RequestInterface;
 
 class ElasticaRequestExceptionEvent
 {
-    private Request $request;
-    private ExceptionInterface $exception;
+    private RequestInterface $request;
+    private ElasticsearchException $exception;
 
     public function __construct(
-        Request $request,
-        ExceptionInterface $exception
+        RequestInterface $request,
+        ElasticsearchException $exception
     ) {
         $this->request = $request;
         $this->exception = $exception;
     }
 
-    public function getRequest(): Request
+    public function getRequest(): RequestInterface
     {
         return $this->request;
     }
 
-    public function getException(): ExceptionInterface
+    public function getException(): ElasticsearchException
     {
         return $this->exception;
     }
diff --git a/src/Event/PostElasticaRequestEvent.php b/src/Event/PostElasticaRequestEvent.php
@@ -11,23 +11,23 @@
 
 namespace FOS\ElasticaBundle\Event;
 
-use Elastica\Request;
 use Elastica\Response;
+use Psr\Http\Message\RequestInterface;
 
 class PostElasticaRequestEvent
 {
-    private Request $request;
+    private RequestInterface $request;
     private Response $response;
 
     public function __construct(
-        Request $request,
+        RequestInterface $request,
         Response $response
     ) {
         $this->request = $request;
         $this->response = $response;
     }
 
-    public function getRequest(): Request
+    public function getRequest(): RequestInterface
     {
         return $this->request;
     }
diff --git a/tests/Unit/Elastica/ClientTest.php b/tests/Unit/Elastica/ClientTest.php
@@ -11,10 +11,12 @@
 
 namespace FOS\ElasticaBundle\Tests\Unit\Elastica;
 
+use Elastic\Elasticsearch\Exception\ElasticsearchException;
 use Elastic\Elasticsearch\Response\Elasticsearch;
 use Elastica\Exception\ClientException;
 use Elastica\JSON;
 use Elastica\Request;
+use Elastica\Response;
 use FOS\ElasticaBundle\Elastica\Client;
 use FOS\ElasticaBundle\Event\ElasticaRequestExceptionEvent;
 use FOS\ElasticaBundle\Event\PostElasticaRequestEvent;
@@ -66,7 +68,6 @@ public function testRequestsAreLogged()
 
     public function testSendsNormalEvents(): void
     {
-        $client = $this->getClientMock();
         $dispatcher = $this->createMock(EventDispatcherInterface::class);
         $dispatcher->expects($invoke = $this->exactly(2))
             ->method('dispatch')
@@ -94,11 +95,21 @@ public function testSendsNormalEvents(): void
 
                     $request = $o->getRequest();
 
-                    $this->assertEquals('event', $request->getPath());
-                    $this->assertEquals(Request::GET, $request->getMethod());
-                    $this->assertEquals(['some' => 'data'], $request->getData());
-                    $this->assertEquals(['query' => 'data'], $request->getQuery());
-                    $this->assertEquals(Request::DEFAULT_CONTENT_TYPE, $request->getContentType());
+                    $path = \ltrim($request->getUri()->getPath(), '/'); // to have the same result as in the 6.0
+                    $method = $request->getMethod();
+                    try {
+                        $data = \json_decode((string) $request->getBody(), true, 512, \JSON_THROW_ON_ERROR);
+                    } catch (\JsonException) {
+                        $data = [];
+                    }
+                    $query = [];
+                    \parse_str($request->getUri()->getQuery(), $query);
+
+                    $this->assertEquals('event', $path);
+                    $this->assertEquals(Request::GET, $method);
+                    $this->assertEquals(['some' => 'data'], $data);
+                    $this->assertEquals(['query' => 'data'], $query);
+                    $this->assertEquals(Request::DEFAULT_CONTENT_TYPE, $request->getHeaderLine('Content-Type'));
 
                     $this->assertInstanceOf(Response::class, $o->getResponse());
                 }
@@ -107,28 +118,34 @@ public function testSendsNormalEvents(): void
             }))
         ;
 
+        $response = new \GuzzleHttp\Psr7\Response(
+            200,
+            ['Content-Type' => 'application/json', Elasticsearch::HEADER_CHECK => Elasticsearch::PRODUCT_NAME],
+            \json_encode(['foo' => 'bar'], \JSON_THROW_ON_ERROR)
+        );
+        $logger = $this->createMock(ElasticaLogger::class);
+        $client = $this->getClient($logger, $response);
         $client->setEventDispatcher($dispatcher);
-        $client->request('event', Request::GET, ['some' => 'data'], ['query' => 'data']);
+
+        $client->sendRequest(new \GuzzleHttp\Psr7\Request(
+            Request::GET,
+            'https://some.tld/event?'.\http_build_query(['query' => 'data']),
+            ['Content-Type' => 'application/json'],
+            \json_encode(['some' => 'data'], \JSON_THROW_ON_ERROR)
+        ));
     }
 
     public function testSendsExceptionEvents(): void
     {
         $httpCode = 403;
         $responseString = JSON::stringify(['message' => 'some AWS error']);
-        $transferInfo = [
-            'request_header' => 'bar',
-            'http_code' => $httpCode,
-            'body' => $responseString,
-        ];
-        $response = new Response($responseString);
-        $response->setTransferInfo($transferInfo);
-
-        $connection = $this->getConnectionMock();
-        $connection->method('getTransportObject')
-            ->willThrowException(new ClientException())
-        ;
+        $response = new \GuzzleHttp\Psr7\Response(
+            $httpCode,
+            ['Content-Type' => 'application/json', Elasticsearch::HEADER_CHECK => Elasticsearch::PRODUCT_NAME],
+            $responseString
+        );
 
-        $client = $this->getClientMock($response, $connection);
+        $client = $this->getClient($this->createMock(LoggerInterface::class), $response);
 
         $dispatcher = $this->createMock(EventDispatcherInterface::class);
         $dispatcher->expects($invoke = $this->exactly(2))
@@ -157,13 +174,23 @@ public function testSendsExceptionEvents(): void
 
                     $request = $o->getRequest();
 
-                    $this->assertEquals('event', $request->getPath());
-                    $this->assertEquals(Request::GET, $request->getMethod());
-                    $this->assertEquals(['some' => 'data'], $request->getData());
-                    $this->assertEquals(['query' => 'data'], $request->getQuery());
-                    $this->assertEquals(Request::DEFAULT_CONTENT_TYPE, $request->getContentType());
+                    $path = \ltrim($request->getUri()->getPath(), '/'); // to have the same result as in the 6.0
+                    $method = $request->getMethod();
+                    try {
+                        $data = \json_decode((string) $request->getBody(), true, 512, \JSON_THROW_ON_ERROR);
+                    } catch (\JsonException) {
+                        $data = [];
+                    }
+                    $query = [];
+                    \parse_str($request->getUri()->getQuery(), $query);
+
+                    $this->assertEquals('event', $path);
+                    $this->assertEquals(Request::GET, $method);
+                    $this->assertEquals(['some' => 'data'], $data);
+                    $this->assertEquals(['query' => 'data'], $query);
+                    $this->assertEquals(Request::DEFAULT_CONTENT_TYPE, $request->getHeaderLine('Content-Type'));
 
-                    $this->assertInstanceOf(ClientException::class, $o->getException());
+                    $this->assertInstanceOf(ElasticsearchException::class, $o->getException());
                 }
 
                 return true;
@@ -172,7 +199,12 @@ public function testSendsExceptionEvents(): void
 
         $client->setEventDispatcher($dispatcher);
         $this->expectException(ClientException::class);
-        $client->request('event', Request::GET, ['some' => 'data'], ['query' => 'data']);
+        $client->sendRequest(new \GuzzleHttp\Psr7\Request(
+            Request::GET,
+            'https://some.tld/event?'.\http_build_query(['query' => 'data']),
+            ['Content-Type' => 'application/json'],
+            \json_encode(['some' => 'data'], \JSON_THROW_ON_ERROR)
+        ));
     }
 
     public function testRequestsWithTransportInfoErrorsRaiseExceptions()

Original file line number	Diff line number	Diff line change
`@@ -11,28 +11,28 @@`
`11`	`11`
`12`	`12`	`namespace FOS\ElasticaBundle\Event;`
`13`	`13`
`14`		`-use Elastica\Exception\ExceptionInterface;`
`15`		`-use Elastica\Request;`
	`14`	`+use Elastic\Elasticsearch\Exception\ElasticsearchException;`
	`15`	`+use Psr\Http\Message\RequestInterface;`
`16`	`16`
`17`	`17`	`class ElasticaRequestExceptionEvent`
`18`	`18`	`{`
`19`		`- private Request $request;`
`20`		`- private ExceptionInterface $exception;`
	`19`	`+ private RequestInterface $request;`
	`20`	`+ private ElasticsearchException $exception;`
`21`	`21`
`22`	`22`	`public function __construct(`
`23`		`- Request $request,`
`24`		`- ExceptionInterface $exception`
	`23`	`+ RequestInterface $request,`
	`24`	`+ ElasticsearchException $exception`
`25`	`25`	`) {`
`26`	`26`	`$this->request = $request;`
`27`	`27`	`$this->exception = $exception;`
`28`	`28`	`}`
`29`	`29`
`30`		`- public function getRequest(): Request`
	`30`	`+ public function getRequest(): RequestInterface`
`31`	`31`	`{`
`32`	`32`	`return $this->request;`
`33`	`33`	`}`
`34`	`34`
`35`		`- public function getException(): ExceptionInterface`
	`35`	`+ public function getException(): ElasticsearchException`
`36`	`36`	`{`
`37`	`37`	`return $this->exception;`
`38`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,23 +11,23 @@`
`11`	`11`
`12`	`12`	`namespace FOS\ElasticaBundle\Event;`
`13`	`13`
`14`		`-use Elastica\Request;`
`15`	`14`	`use Elastica\Response;`
	`15`	`+use Psr\Http\Message\RequestInterface;`
`16`	`16`
`17`	`17`	`class PostElasticaRequestEvent`
`18`	`18`	`{`
`19`		`- private Request $request;`
	`19`	`+ private RequestInterface $request;`
`20`	`20`	`private Response $response;`
`21`	`21`
`22`	`22`	`public function __construct(`
`23`		`- Request $request,`
	`23`	`+ RequestInterface $request,`
`24`	`24`	`Response $response`
`25`	`25`	`) {`
`26`	`26`	`$this->request = $request;`
`27`	`27`	`$this->response = $response;`
`28`	`28`	`}`
`29`	`29`
`30`		`- public function getRequest(): Request`
	`30`	`+ public function getRequest(): RequestInterface`
`31`	`31`	`{`
`32`	`32`	`return $this->request;`
`33`	`33`	`}`