Merge pull request #174 from delyriand/feature/fallback-elasticsearch…

…-failed

Fallback on sylius taxon renderer if ES is down

UPGRADE-2.0.md

@@ -11,6 +11,7 @@
 - New method `deleteByDocumentIds` in the `MonsieurBiz\SyliusSearchPlugin\Index\IndexerInterface` interface
 - Deprecated the method `deleteByDocuments` in the `MonsieurBiz\SyliusSearchPlugin\Index\IndexerInterface` interface. Use `deleteByDocumentIds` instead. 
 - `ChannelFilter` and `EnabledFilter` in `MonsieurBiz\SyliusSearchPlugin\Search\Request\QueryFilter\Product` were moved to `MonsieurBiz\SyliusSearchPlugin\Search\Request\QueryFilter`
+- A fallback on the Sylius' taxon display is now used to keep your pages even if you Elasticsearch instance is down. If you want to disable it, check the [FakeElasticsearchChecker](docs/disable_elasticsearch_checker.md)
 
 # UPGRADE FROM v1.X.X TO v2.0.x
 

docs/disable_elasticsearch_checker.md

@@ -0,0 +1,11 @@
+# Disable the ElasticsearchChecker
+
+The plugin now checks if the Elasticsearch server is running before each search. 
+
+If you want to disable this feature, you can do it by adding the following configuration:
+
+```yaml
+services:
+    monsieurbiz.search.checker.elasticsearch_checker:
+        class: MonsieurBiz\SyliusSearchPlugin\Checker\FakeElasticsearchChecker
+```

docs/index.md

@@ -2,6 +2,7 @@
 
 ## Menu
 
+- [Disable the ElasticsearchChecker](./disable_elasticsearch_checker.md)
 - [Add custom sorts](./add_custom_sorts.md)
 - [Add custom values for an entity](./add_custom_values.md)
 - [Add custom filters](./add_custom_filters.md)

src/Checker/ElasticsearchChecker.php

@@ -0,0 +1,41 @@
+<?php
+
+/*
+ * This file is part of Monsieur Biz' Search plugin for Sylius.
+ *
+ * (c) Monsieur Biz <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE.txt
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace MonsieurBiz\SyliusSearchPlugin\Checker;
+
+use JoliCode\Elastically\Factory;
+
+class ElasticsearchChecker implements ElasticsearchCheckerInterface
+{
+    private ?bool $isAvailable = null;
+
+    public function check(): bool
+    {
+        if (null === $this->isAvailable) {
+            $client = (new Factory())->buildClient();
+
+            // Check client response
+            try {
+                $client->getStatus()->getResponse();
+            } catch (\Exception $e) {
+                $this->isAvailable = false;
+
+                return $this->isAvailable;
+            }
+
+            $this->isAvailable = true;
+        }
+
+        return $this->isAvailable;
+    }
+}

src/Checker/ElasticsearchCheckerInterface.php

@@ -0,0 +1,19 @@
+<?php
+
+/*
+ * This file is part of Monsieur Biz' Search plugin for Sylius.
+ *
+ * (c) Monsieur Biz <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE.txt
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace MonsieurBiz\SyliusSearchPlugin\Checker;
+
+interface ElasticsearchCheckerInterface
+{
+    public function check(): bool;
+}

src/Checker/FakeElasticsearchChecker.php

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of Monsieur Biz' Search plugin for Sylius.
+ *
+ * (c) Monsieur Biz <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE.txt
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace MonsieurBiz\SyliusSearchPlugin\Checker;
+
+class FakeElasticsearchChecker implements ElasticsearchCheckerInterface
+{
+    public function check(): bool
+    {
+        return true;
+    }
+}

src/Resources/config/routing/shop.yaml

@@ -5,6 +5,7 @@ monsieurbiz_search_search:
     _controller: MonsieurBiz\SyliusSearchPlugin\Controller\SearchController::searchAction
   requirements:
     query: .+
+  condition: "not(context.getPathInfo() matches '`^%sylius.security.new_api_route%`') and context.checkElasticsearch()"
 
 monsieurbiz_search_post:
   path: /search
@@ -27,3 +28,4 @@ monsieurbiz_sylius_search_taxon:
       taxon: "expr:notFoundOnNull(service('sylius.repository.taxon').findOneBySlug($slug, service('sylius.context.locale').getLocaleCode()))"
   requirements:
     slug: .+
+  condition: "not(context.getPathInfo() matches '`^%sylius.security.new_api_route%`') and context.checkElasticsearch()"

src/Resources/config/services.yaml

@@ -252,3 +252,17 @@ services:
       - { name: kernel.event_listener, event: sylius.product_variant.post_update, method: dispatchProductVariantReindexMessage }
       - { name: kernel.event_listener, event: sylius.product_variant.pre_delete, method: saveProductIdToDispatchReindexMessage }
       - { name: kernel.event_listener, event: sylius.product_variant.post_delete, method: dispatchProductReindexMessage }
+
+  monsieurbiz.search.checker.elasticsearch_checker:
+    class: MonsieurBiz\SyliusSearchPlugin\Checker\ElasticsearchChecker
+
+  MonsieurBiz\SyliusSearchPlugin\Twig\Extension\RenderSearchForm:
+    arguments:
+      $elasticsearchChecker: '@monsieurbiz.search.checker.elasticsearch_checker'
+
+  # Routing Context
+  MonsieurBiz\SyliusSearchPlugin\Routing\RequestContext:
+    decorates: router.request_context
+    arguments:
+      - '@MonsieurBiz\SyliusSearchPlugin\Routing\RequestContext.inner'
+      - '@monsieurbiz.search.checker.elasticsearch_checker'

src/Routing/RequestContext.php

@@ -0,0 +1,63 @@
+<?php
+
+/*
+ * This file is part of Monsieur Biz' Search plugin for Sylius.
+ *
+ * (c) Monsieur Biz <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE.txt
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace MonsieurBiz\SyliusSearchPlugin\Routing;
+
+use Exception;
+use MonsieurBiz\SyliusSearchPlugin\Checker\ElasticsearchCheckerInterface;
+use Symfony\Component\Routing\RequestContext as BaseRequestContext;
+
+class RequestContext extends BaseRequestContext
+{
+    private BaseRequestContext $decorated;
+
+    private ElasticsearchCheckerInterface $elasticsearchChecker;
+
+    public function __construct(
+        BaseRequestContext $decorated,
+        ElasticsearchCheckerInterface $elasticsearchChecker
+    ) {
+        parent::__construct(
+            $decorated->getBaseUrl(),
+            $decorated->getMethod(),
+            $decorated->getHost(),
+            $decorated->getScheme(),
+            $decorated->getHttpPort(),
+            $decorated->getHttpsPort(),
+            $decorated->getPathInfo(),
+            $decorated->getQueryString()
+        );
+        $this->decorated = $decorated;
+        $this->elasticsearchChecker = $elasticsearchChecker;
+    }
+
+    public function checkElasticsearch(): bool
+    {
+        return $this->elasticsearchChecker->check();
+    }
+
+    /**
+     * @throws Exception
+     *
+     * @return mixed
+     */
+    public function __call(string $name, array $arguments)
+    {
+        $callback = [$this->decorated, $name];
+        if (\is_callable($callback)) {
+            return \call_user_func($callback, $arguments);
+        }
+
+        throw new Exception(sprintf('Method %s not found for class "%s"', $name, \get_class($this->decorated)));
+    }
+}

src/Twig/Extension/RenderSearchForm.php

@@ -13,6 +13,7 @@
 
 namespace MonsieurBiz\SyliusSearchPlugin\Twig\Extension;
 
+use MonsieurBiz\SyliusSearchPlugin\Checker\ElasticsearchCheckerInterface;
 use MonsieurBiz\SyliusSearchPlugin\Form\Type\SearchType;
 use Symfony\Component\Form\FormFactoryInterface;
 use Symfony\Component\HttpFoundation\RequestStack;
@@ -29,14 +30,18 @@ class RenderSearchForm extends AbstractExtension
 
     private RequestStack $requestStack;
 
+    private ElasticsearchCheckerInterface $elasticsearchChecker;
+
     public function __construct(
         FormFactoryInterface $formFactory,
         Environment $templatingEngine,
-        RequestStack $requestStack
+        RequestStack $requestStack,
+        ElasticsearchCheckerInterface $elasticsearchChecker
     ) {
         $this->formFactory = $formFactory;
         $this->templatingEngine = $templatingEngine;
         $this->requestStack = $requestStack;
+        $this->elasticsearchChecker = $elasticsearchChecker;
     }
 
     public function getFunctions()
@@ -48,6 +53,10 @@ public function getFunctions()
 
     public function createForm(?string $template = null): Markup
     {
+        if (false === $this->elasticsearchChecker->check()) {
+            return new Markup('', 'UTF-8');
+        }
+
         $request = $this->requestStack->getCurrentRequest();
         $template = $template ?? '@MonsieurBizSyliusSearchPlugin/Search/_form.html.twig';
         $query = null !== $request ? $request->get('query', '') : '';