ACP-3963 Algolia Event-Based Features. (#11158)

ACP-3963 Algolia Event-Based Features.
spryker · Nov 21, 2024 · c09b9ed · c09b9ed
1 parent 0bf0a79
commit c09b9ed
Show file tree

Hide file tree

Showing 8 changed files with 135 additions and 44 deletions.
diff --git a/src/Spryker/Client/KernelApp/Dependency/External/KernelAppToGuzzleHttpClientAdapter.php b/src/Spryker/Client/KernelApp/Dependency/External/KernelAppToGuzzleHttpClientAdapter.php
@@ -39,11 +39,16 @@ public function send(AcpHttpRequestTransfer $acpHttpRequestTransfer): AcpHttpRes
             $acpHttpRequestTransfer->getMethodOrFail(),
             $acpHttpRequestTransfer->getUriOrFail(),
             $acpHttpRequestTransfer->getHeaders(),
-            $acpHttpRequestTransfer->getBodyOrFail(),
+            $acpHttpRequestTransfer->getBody(),
         );
+        $options = [];
+
+        if ($acpHttpRequestTransfer->getQuery()) {
+            $options['query'] = $acpHttpRequestTransfer->getQuery();
+        }
 
         try {
-            $response = $this->httpClient->send($request);
+            $response = $this->httpClient->send($request, $options);
         } catch (RequestException $e) {
             $acpHttpResponseTransfer = new AcpHttpResponseTransfer();
             $acpHttpResponseTransfer

diff --git a/src/Spryker/Client/KernelApp/KernelAppConfig.php b/src/Spryker/Client/KernelApp/KernelAppConfig.php
@@ -10,8 +10,35 @@
 use Spryker\Client\Kernel\AbstractBundleConfig;
 use Spryker\Shared\KernelApp\KernelAppConstants;
 
+/**
+ * @method \Spryker\Shared\KernelApp\KernelAppConfig getSharedConfig()
+ */
 class KernelAppConfig extends AbstractBundleConfig
 {
+    /**
+     * @var string
+     */
+    protected const HEADER_TENANT_IDENTIFIER = 'x-tenant-identifier';
+
+    /**
+     * Specification:
+     * - Returns an array of default headers to be used in HTTP requests.
+     * - The array keys represent the header names.
+     * - The array values represent the header values.
+     * - The default headers include a 'x-tenant-identifier' header that merges the shared headers.
+     * - If a header already exists in the request, it will not be overridden.
+     *
+     * @api
+     *
+     * @return array<string, string>
+     */
+    public function getDefaultHeaders(): array
+    {
+        return array_merge($this->getSharedConfig()->getDefaultHeaders(), [
+            static::HEADER_TENANT_IDENTIFIER => $this->getTenantIdentifier(),
+        ]);
+    }
+
     /**
      * @api
      *

diff --git a/src/Spryker/Client/KernelApp/Request/Request.php b/src/Spryker/Client/KernelApp/Request/Request.php
@@ -14,9 +14,9 @@
 
 class Request implements RequestInterface
 {
-    /**
-     * @var array<\Spryker\Shared\KernelAppExtension\RequestExpanderPluginInterface>
-     */
+ /**
+  * @var array<\Spryker\Shared\KernelAppExtension\RequestExpanderPluginInterface>
+  */
     protected array $requestExpanderPlugins;
 
     protected KernelAppConfig $config;
@@ -72,16 +72,14 @@ protected function executeRequestExpanderPlugins(AcpHttpRequestTransfer $acpHttp
      */
     protected function expandRequest(AcpHttpRequestTransfer $acpHttpRequestTransfer): AcpHttpRequestTransfer
     {
-        return $this->addTenantIdentifier($acpHttpRequestTransfer);
-    }
+        foreach ($this->config->getDefaultHeaders() as $headerName => $headerValue) {
+            if (isset($acpHttpRequestTransfer->getHeaders()[$headerName])) {
+                continue;
+            }
 
-    /**
-     * @param \Generated\Shared\Transfer\AcpHttpRequestTransfer $acpHttpRequestTransfer
-     *
-     * @return \Generated\Shared\Transfer\AcpHttpRequestTransfer
-     */
-    protected function addTenantIdentifier(AcpHttpRequestTransfer $acpHttpRequestTransfer): AcpHttpRequestTransfer
-    {
-        return $acpHttpRequestTransfer->addHeader('x-tenant-identifier', $this->config->getTenantIdentifier());
+            $acpHttpRequestTransfer->addHeader($headerName, $headerValue);
+        }
+
+        return $acpHttpRequestTransfer;
     }
 }
diff --git a/src/Spryker/Shared/KernelApp/KernelAppConfig.php b/src/Spryker/Shared/KernelApp/KernelAppConfig.php
@@ -0,0 +1,55 @@
+<?php
+
+/**
+ * Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
+ * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
+ */
+
+namespace Spryker\Shared\KernelApp;
+
+use Spryker\Shared\Kernel\AbstractBundleConfig;
+use Symfony\Component\HttpFoundation\Request;
+
+class KernelAppConfig extends AbstractBundleConfig
+{
+    /**
+     * @var string
+     */
+    protected const COOKIE_HEADER = 'Cookie';
+
+    /**
+     * @var string
+     */
+    protected const CONTENT_TYPE_HEADER = 'Content-Type';
+
+    /**
+     * @var string
+     */
+    protected const CONTENT_TYPE_HEADER_VALUE = 'application/json';
+
+    /**
+     * Specification:
+     * - Returns an array of default headers to be used in HTTP requests.
+     * - The array keys represent the header names.
+     * - The array values represent the header values.
+     * - The default headers include a 'Content-Type' header with the value 'application/json' and Cookie for zdebug session..
+     * - If a header already exists in the request, it will not be overridden.
+     *
+     * @api
+     *
+     * @return array<string, string>
+     */
+    public function getDefaultHeaders(): array
+    {
+        $headers = [
+            static::CONTENT_TYPE_HEADER => static::CONTENT_TYPE_HEADER_VALUE,
+        ];
+
+        $request = Request::createFromGlobals();
+        if ($request->cookies->has('XDEBUG_SESSION')) {
+            $headers[static::COOKIE_HEADER] = sprintf('XDEBUG_SESSION=%s', $request->cookies->get('XDEBUG_SESSION'));
+        }
+
+        return $headers;
+    }
+}
diff --git a/src/Spryker/Shared/KernelApp/Transfer/kernel_app.transfer.xml b/src/Spryker/Shared/KernelApp/Transfer/kernel_app.transfer.xml
@@ -21,6 +21,7 @@
         <property name="method" type="string"/>
         <property name="uri" type="string"/>
         <property name="headers" type="array" associative="true" singular="header"/>
+        <property name="query" type="array" associative="true" singular="param"/>
         <property name="body" type="string"/>
     </transfer>
 

diff --git a/src/Spryker/Zed/KernelApp/Business/Request/Request.php b/src/Spryker/Zed/KernelApp/Business/Request/Request.php
@@ -11,7 +11,6 @@
 use Generated\Shared\Transfer\AcpHttpResponseTransfer;
 use Spryker\Client\KernelApp\KernelAppClientInterface;
 use Spryker\Zed\KernelApp\KernelAppConfig;
-use Symfony\Component\HttpFoundation\Request as SymfonyRequest;
 
 class Request implements RequestInterface
 {
@@ -53,13 +52,6 @@ public function __construct(
     public function request(AcpHttpRequestTransfer $acpHttpRequestTransfer): AcpHttpResponseTransfer
     {
         $acpHttpRequestTransfer = $this->executeRequestExpanderPlugins($acpHttpRequestTransfer);
-
-        $internalRequest = SymfonyRequest::createFromGlobals();
-
-        if ($internalRequest->cookies->has('XDEBUG_SESSION')) {
-            $acpHttpRequestTransfer->addHeader('Cookie', sprintf('XDEBUG_SESSION=%s', $internalRequest->cookies->get('XDEBUG_SESSION')));
-        }
-
         $acpHttpRequestTransfer = $this->expandWithDefaultHeaders($acpHttpRequestTransfer);
 
         return $this->kernelAppClient->request($acpHttpRequestTransfer);

diff --git a/src/Spryker/Zed/KernelApp/KernelAppConfig.php b/src/Spryker/Zed/KernelApp/KernelAppConfig.php
@@ -9,18 +9,11 @@
 
 use Spryker\Zed\Kernel\AbstractBundleConfig;
 
+/**
+ * @method \Spryker\Shared\KernelApp\KernelAppConfig getSharedConfig()
+ */
 class KernelAppConfig extends AbstractBundleConfig
 {
-    /**
-     * @var string
-     */
-    protected const CONTENT_TYPE_HEADER = 'Content-Type';
-
-    /**
-     * @var string
-     */
-    protected const CONTENT_TYPE_HEADER_VALUE = 'application/json';
-
     /**
      * Specification:
      * - Returns an array of default headers to be used in HTTP requests.
@@ -35,8 +28,6 @@ class KernelAppConfig extends AbstractBundleConfig
      */
     public function getDefaultHeaders(): array
     {
-        return [
-            static::CONTENT_TYPE_HEADER => static::CONTENT_TYPE_HEADER_VALUE,
-        ];
+        return $this->getSharedConfig()->getDefaultHeaders();
     }
 }
diff --git a/tests/SprykerTest/Client/KernelApp/KernelAppClientTest.php b/tests/SprykerTest/Client/KernelApp/KernelAppClientTest.php
@@ -40,9 +40,13 @@ class KernelAppClientTest extends Unit
     protected KernelAppClientTester $tester;
 
     /**
+     * @dataProvider requestTransferProvider
+     *
+     * @param \Generated\Shared\Transfer\AcpHttpRequestTransfer $acpHttpRequestTransfer
+     *
      * @return void
      */
-    public function testRequestIsExpendedWithHeaderFromExpanderPluginBeforeRequestIsSend(): void
+    public function testRequestIsExpendedWithHeaderFromExpanderPluginBeforeRequestIsSend(AcpHttpRequestTransfer $acpHttpRequestTransfer): void
     {
         // Arrange
         $kernelAppClient = new KernelAppClient();
@@ -52,10 +56,13 @@ public function testRequestIsExpendedWithHeaderFromExpanderPluginBeforeRequestIs
 
         // Mock GuzzleClient to be able to introspect the RequestInterface and manipulate the returned response
         $clientMock = Stub::make(Client::class, [
-            'send' => function (RequestInterface $request) use ($expectedXMas): ResponseInterface {
+            'send' => function (RequestInterface $request, $options) use ($expectedXMas, $acpHttpRequestTransfer): ResponseInterface {
                 $this->assertTrue($request->hasHeader('x-mas'));
                 $xMas = $request->getHeader('x-mas')[0];
                 $this->assertSame($expectedXMas, $xMas);
+                ($acpHttpRequestTransfer->getMethod() === 'GET') ?
+                    $this->assertNotEmpty($options['query']) :
+                    $this->assertNotEmpty($acpHttpRequestTransfer->getBody());
 
                 return Stub::makeEmpty(ResponseInterface::class, [
                     'getBody' => function () {
@@ -101,12 +108,6 @@ public function expandRequest(AcpHttpRequestTransfer $acpHttpRequestTransfer): A
         ]);
 
         // Act
-        $acpHttpRequestTransfer = new AcpHttpRequestTransfer();
-        $acpHttpRequestTransfer
-            ->setMethod('POST')
-            ->setUri('www.example.com')
-            ->setBody('{"foo": "bar"}');
-
         $acpHttpResponseTransfer = $kernelAppClient->request($acpHttpRequestTransfer);
 
         // Assert
@@ -191,4 +192,25 @@ public function expandRequest(AcpHttpRequestTransfer $acpHttpRequestTransfer): A
         $this->assertInstanceOf(AcpHttpResponseTransfer::class, $acpHttpResponseTransfer);
         $this->assertSame(422, $acpHttpResponseTransfer->getHttpStatusCode());
     }
+
+    /**
+     * @return array<\Generated\Shared\Transfer\AcpHttpRequestTransfer>
+     */
+    protected function requestTransferProvider(): array
+    {
+        return [
+            [
+                (new AcpHttpRequestTransfer())
+                    ->setMethod('GET')
+                    ->setUri('www.example.com')
+                    ->setQuery(['foo' => 'bar']),
+            ],
+            [
+                (new AcpHttpRequestTransfer())
+                    ->setMethod('POST')
+                    ->setUri('www.example.com')
+                    ->setBody('{"foo": "bar"}'),
+            ],
+        ];
+    }
 }