Do not register the search routes when search is disabled

The search controller services already only exist when search.enabled
(services/conditional/search.xml), but the shop search routes were always
registered, pointing at non-existent controllers when search was off.

Load the shop routes through a custom SearchRouteLoader (tagged
routing.loader) that returns them only when search is enabled. The route
YAMLs now import the shop routes via this loader (type
setono_sylius_meilisearch_search) instead of importing shop.yaml directly;
the admin synonym routes are unaffected.

Closes #129

Author: loevgaard

src/Resources/config/routes.yaml

@@ -1,5 +1,8 @@
+# The shop routes are loaded through a custom loader so they are only registered when
+# search is enabled (search.enabled). See Routing\SearchRouteLoader.
 setono_sylius_meilisearch_shop:
-    resource: "@SetonoSyliusMeilisearchPlugin/Resources/config/routes/shop.yaml"
+    resource: .
+    type: setono_sylius_meilisearch_search
     prefix: /{_locale}
     requirements:
         _locale: ^[A-Za-z]{2,4}(_([A-Za-z]{4}|[0-9]{3}))?(_([A-Za-z]{2}|[0-9]{3}))?$

src/Resources/config/routes_no_locale.yaml

@@ -2,8 +2,11 @@
 # localized URLs (see https://docs.sylius.com/en/latest/cookbook/shop/disabling-localised-urls.html).
 # To accommodate this in your plugin, provide a routes file for non localized stores and tell this in the README.md
 
+# The shop routes are loaded through a custom loader so they are only registered when
+# search is enabled (search.enabled). See Routing\SearchRouteLoader.
 setono_sylius_meilisearch_shop:
-    resource: "@SetonoSyliusMeilisearchPlugin/Resources/config/routes/shop.yaml"
+    resource: .
+    type: setono_sylius_meilisearch_search
 
 setono_sylius_meilisearch_admin:
     resource: "@SetonoSyliusMeilisearchPlugin/Resources/config/routes/admin.yaml"

src/Resources/config/services.xml

@@ -19,6 +19,7 @@
         <import resource="services/normalizer.xml"/>
         <import resource="services/provider.xml"/>
         <import resource="services/resolver.xml"/>
+        <import resource="services/routing.xml"/>
         <import resource="services/twig.xml"/>
         <import resource="services/url_generator.xml"/>
     </imports>

src/Resources/config/services/routing.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<container xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://symfony.com/schema/dic/services"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+    <services>
+        <service id="Setono\SyliusMeilisearchPlugin\Routing\SearchRouteLoader">
+            <argument>%setono_sylius_meilisearch.search.enabled%</argument>
+            <argument>%kernel.environment%</argument>
+
+            <tag name="routing.loader"/>
+        </service>
+    </services>
+</container>

src/Routing/SearchRouteLoader.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Routing;
+
+use Symfony\Component\Config\Loader\Loader;
+use Symfony\Component\Routing\RouteCollection;
+
+/**
+ * Loads the shop search routes only when search is enabled. When search is disabled the search
+ * controller services are not registered either (see services/conditional/search.xml), so the
+ * routes would otherwise point at non-existent controllers.
+ */
+final class SearchRouteLoader extends Loader
+{
+    public function __construct(private readonly bool $enabled, ?string $env = null)
+    {
+        parent::__construct($env);
+    }
+
+    public function load(mixed $resource, ?string $type = null): RouteCollection
+    {
+        $routes = new RouteCollection();
+
+        if ($this->enabled) {
+            /** @var RouteCollection $imported */
+            $imported = $this->import('@SetonoSyliusMeilisearchPlugin/Resources/config/routes/shop.yaml');
+            $routes->addCollection($imported);
+        }
+
+        return $routes;
+    }
+
+    public function supports(mixed $resource, ?string $type = null): bool
+    {
+        return 'setono_sylius_meilisearch_search' === $type;
+    }
+}

tests/Unit/Routing/SearchRouteLoaderTest.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Tests\Unit\Routing;
+
+use PHPUnit\Framework\TestCase;
+use Setono\SyliusMeilisearchPlugin\Routing\SearchRouteLoader;
+
+/**
+ * @covers \Setono\SyliusMeilisearchPlugin\Routing\SearchRouteLoader
+ */
+final class SearchRouteLoaderTest extends TestCase
+{
+    /**
+     * @test
+     */
+    public function it_registers_no_routes_when_search_is_disabled(): void
+    {
+        $loader = new SearchRouteLoader(enabled: false);
+
+        $routes = $loader->load('.', 'setono_sylius_meilisearch_search');
+
+        self::assertCount(0, $routes);
+    }
+
+    /**
+     * @test
+     */
+    public function it_supports_only_its_own_type(): void
+    {
+        $loader = new SearchRouteLoader(enabled: true);
+
+        self::assertTrue($loader->supports('.', 'setono_sylius_meilisearch_search'));
+        self::assertFalse($loader->supports('.', 'yaml'));
+        self::assertFalse($loader->supports('.', null));
+    }
+}