[Improvement]: Add search client adapter (#10)

* feat: add search client adapter * Apply php-cs-fixer changes * add missing search client adapter methods * update conception * remove pimcore version checks * Apply php-cs-fixer changes --------- Co-authored-by: lukmzig <[email protected]>
pimcore · Nov 7, 2024 · 5840b6e · 5840b6e
1 parent 919ebf8
commit 5840b6e
Show file tree

Hide file tree

Showing 8 changed files with 507 additions and 44 deletions.
diff --git a/.github/workflows/codeception.yaml b/.github/workflows/codeception.yaml
@@ -18,7 +18,6 @@ env:
     PIMCORE_PROJECT_ROOT: ${{ github.workspace }}
     APP_ENV: test
     PIMCORE_TEST: 1
-    SYMFONY_DEPRECATIONS_HELPER: weak # TODO remove when remove support for Pimcore 10
 
 jobs:
     codeception-tests:
@@ -28,7 +27,6 @@ jobs:
         strategy:
             matrix:
                 include:
-                    - { php-version: 8.0, dependencies: lowest, pimcore_version: "", experimental: false }
                     - { php-version: 8.1, dependencies: lowest, pimcore_version: "", experimental: false }
                     - { php-version: 8.2, dependencies: highest, pimcore_version: "", experimental: false }
 

diff --git a/composer.json b/composer.json
@@ -17,8 +17,8 @@
   "prefer-stable": true,
   "minimum-stability": "dev",
   "require": {
-    "php": "^8.0",
-    "pimcore/pimcore": "^10.6 || ^11.0",
+    "php": "^8.1",
+    "pimcore/pimcore": "^11.x-dev",
     "opensearch-project/opensearch-php": "^2.2.0"
   },
   "require-dev": {

diff --git a/phpstan.neon b/phpstan.neon
@@ -7,7 +7,6 @@ parameters:
         - phpstan-bootstrap.php
     excludePaths:
         - src/Tests/*
-        - src/LogHandler/Filter404Handler.php # TODO remove when remove support for Pimcore 10
 
 includes:
     - phpstan-baseline.neon
diff --git a/src/DependencyInjection/PimcoreOpenSearchClientExtension.php b/src/DependencyInjection/PimcoreOpenSearchClientExtension.php
@@ -20,6 +20,7 @@
 
 use OpenSearch\Client;
 use Pimcore\Bundle\OpenSearchClientBundle\OpenSearchClientFactory;
+use Pimcore\Bundle\OpenSearchClientBundle\SearchClient\SearchClient;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
@@ -35,6 +36,8 @@ final class PimcoreOpenSearchClientExtension extends ConfigurableExtension imple
 {
     const CLIENT_SERVICE_PREFIX = 'pimcore.open_search_client.';
 
+    const PIMCORE_CLIENT_PREFIX = 'pimcore.openSearch.custom_client.';
+
     /**
      *
      *
@@ -53,6 +56,11 @@ protected function loadInternal(array $mergedConfig, ContainerBuilder $container
             $definition->addTag('monolog.logger', ['channel' => $clientConfig['logger_channel']]);
             $definition->setPublic(true);
             $container->setDefinition(self::CLIENT_SERVICE_PREFIX . $clientName, $definition);
+
+            $customClientDefinition = new Definition(SearchClient::class);
+            $customClientDefinition->setArgument('$client', $definition);
+            $customClientDefinition->setPublic(true);
+            $container->setDefinition(self::PIMCORE_CLIENT_PREFIX . $clientName, $customClientDefinition);
         }
     }
 

diff --git a/src/LogHandler/Filter404Handler.php b/src/LogHandler/Filter404Handler.php
@@ -19,41 +19,35 @@
 use Monolog\Handler\AbstractHandler;
 use Monolog\Level;
 use Monolog\LogRecord;
-use Pimcore\Version;
 
-// TODO remove if when remove support for Pimcore 10
-if(Version::getMajorVersion() >= 11) {
+/**
+ * Ignores warning messages for 404 errors as they are spamming the logs
+ *
+ * @internal
+ */
+final class Filter404Handler extends AbstractHandler
+{
+    private bool $ignoreNextResponseWarning = false;
 
-    /**
-     * Ignores warning messages for 404 errors as they are spamming the logs
-     *
-     * @internal
-     */
-    final class Filter404Handler extends AbstractHandler
+    public function isHandling(LogRecord $record): bool
     {
-        private bool $ignoreNextResponseWarning = false;
-
-        public function isHandling(LogRecord $record): bool
-        {
-            $ignore =
-                $record->level === Level::Warning
-                && ($record->context['HTTP code'] ?? null) === 404;
-
-            if ($ignore) {
-                $this->ignoreNextResponseWarning = true;
-            } else {
-                $ignore = $this->ignoreNextResponseWarning
-                    && $record->level === Level::Warning
-                    && $record->message === 'Response';
-                $this->ignoreNextResponseWarning = false;
-            }
-
-            return $ignore;
+        $ignore =
+            $record->level === Level::Warning
+            && ($record->context['HTTP code'] ?? null) === 404;
+        if ($ignore) {
+            $this->ignoreNextResponseWarning = true;
+        } else {
+            $ignore = $this->ignoreNextResponseWarning
+                && $record->level === Level::Warning
+                && $record->message === 'Response';
+            $this->ignoreNextResponseWarning = false;
         }
 
-        public function handle(LogRecord $record): bool
-        {
-            return $this->isHandling($record);
-        }
+        return $ignore;
+    }
+
+    public function handle(LogRecord $record): bool
+    {
+        return $this->isHandling($record);
     }
 }
diff --git a/src/OpenSearchClientFactory.php b/src/OpenSearchClientFactory.php
@@ -20,7 +20,6 @@
 use OpenSearch\Client;
 use OpenSearch\ClientBuilder;
 use Pimcore\Bundle\OpenSearchClientBundle\LogHandler\Filter404Handler;
-use Pimcore\Version;
 use Psr\Log\LoggerInterface;
 
 /**
@@ -33,15 +32,12 @@ public static function createOpenSearchClient(LoggerInterface $logger, array $co
         $clientBuilder = new ClientBuilder();
         $clientBuilder->setHosts($config['hosts']);
 
-        // TODO remove if when remove support for Pimcore 10
-        if (Version::getMajorVersion() >= 11) {
-            if (!$config['log_404_errors'] && $logger instanceof Logger) {
-                $logger->pushHandler(new Filter404Handler());
-            }
-
-            $clientBuilder->setLogger($logger);
+        if (!$config['log_404_errors'] && $logger instanceof Logger) {
+            $logger->pushHandler(new Filter404Handler());
         }
 
+        $clientBuilder->setLogger($logger);
+
         if (isset($config['username'], $config['password'])) {
             $clientBuilder->setBasicAuthentication($config['username'], $config['password']);
         }

diff --git a/src/SearchClient/OpenSearchClientInterface.php b/src/SearchClient/OpenSearchClientInterface.php
@@ -0,0 +1,25 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * Pimcore
+ *
+ * This source file is available under two different licenses:
+ * - GNU General Public License version 3 (GPLv3)
+ * - Pimcore Commercial License (PCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
+ *  @license    http://www.pimcore.org/license     GPLv3 and PCL
+ */
+
+namespace Pimcore\Bundle\OpenSearchClientBundle\SearchClient;
+
+use OpenSearch\Client;
+use Pimcore\SearchClient\SearchClientInterface;
+
+interface OpenSearchClientInterface extends SearchClientInterface
+{
+    public function getOriginalClient(): Client;
+}