Add canonical URL generator

Author: vvasiloi

src/Controller/Action/SearchAction.php

@@ -10,6 +10,7 @@
 use Setono\SyliusMeilisearchPlugin\Engine\SearchEngineInterface;
 use Setono\SyliusMeilisearchPlugin\Engine\SearchRequest;
 use Setono\SyliusMeilisearchPlugin\Event\Search\SearchRequestCreated;
+use Setono\SyliusMeilisearchPlugin\Event\Search\SearchResponseCreated;
 use Setono\SyliusMeilisearchPlugin\Event\Search\SearchResponseParametersCreated;
 use Setono\SyliusMeilisearchPlugin\Event\Search\SearchResultReceived;
 use Setono\SyliusMeilisearchPlugin\Form\Builder\SearchFormBuilderInterface;
@@ -68,6 +69,15 @@ public function __invoke(Request $request): Response
 
         $this->eventDispatcher->dispatch($searchResponseParametersCreatedEvent);
 
-        return new Response($this->twig->render($searchResponseParametersCreatedEvent->template, $searchResponseParametersCreatedEvent->context));
+        $response = new Response(
+            $this->twig->render(
+                $searchResponseParametersCreatedEvent->template,
+                $searchResponseParametersCreatedEvent->context
+            )
+        );
+
+        $this->eventDispatcher->dispatch(new SearchResponseCreated($request, $response));
+
+        return $response;
     }
 }

src/Event/Search/SearchResponseCreated.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Event\Search;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+final class SearchResponseCreated
+{
+    public function __construct(
+        public readonly Request $request,
+        public readonly Response $response
+    ) {
+    }
+}

src/EventSubscriber/Search/CanonicalUrlSubscriber.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\EventSubscriber\Search;
+
+use Setono\SyliusMeilisearchPlugin\Event\Search\SearchResponseCreated;
+use Setono\SyliusMeilisearchPlugin\UrlGenerator\CanonicalUrlGeneratorInterface;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\WebLink\GenericLinkProvider;
+use Symfony\Component\WebLink\Link;
+
+final class CanonicalUrlSubscriber implements EventSubscriberInterface
+{
+    public function __construct(
+        private readonly CanonicalUrlGeneratorInterface $canonicalUrlGenerator
+    ) {
+    }
+
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            SearchResponseCreated::class => 'onSearchResponseCreated',
+        ];
+    }
+
+    public function onSearchResponseCreated(SearchResponseCreated $event): void
+    {
+        $link = new Link(Link::REL_CANONICAL, $this->canonicalUrlGenerator->generate($event->request));
+
+        if (null === $linkProvider = $event->request->attributes->get('_links')) {
+            $event->request->attributes->set('_links', new GenericLinkProvider([$link]));
+
+            return;
+        }
+
+        $event->request->attributes->set('_links', $linkProvider->withLink($link));
+    }
+}

src/Resources/config/services/event_subscriber.xml

@@ -12,5 +12,11 @@
 
             <tag name="kernel.event_subscriber"/>
         </service>
+
+        <service id="Setono\SyliusMeilisearchPlugin\EventSubscriber\Search\CanonicalUrlSubscriber">
+            <argument type="service" id="Setono\SyliusMeilisearchPlugin\UrlGenerator\CanonicalUrlGeneratorInterface"/>
+
+            <tag name="kernel.event_subscriber"/>
+        </service>
     </services>
 </container>

src/Resources/config/services/url_generator.xml

@@ -21,5 +21,12 @@
 
             <tag name="setono_sylius_meilisearch.url_generator"/>
         </service>
+
+        <service id="Setono\SyliusMeilisearchPlugin\UrlGenerator\CanonicalUrlGeneratorInterface"
+                 alias="setono_sylius_meilisearch.canonical_url_generator"/>
+        <service id="setono_sylius_meilisearch.canonical_url_generator"
+                 class="Setono\SyliusMeilisearchPlugin\UrlGenerator\CanonicalUrlGenerator">
+            <argument type="service" id="router"/>
+        </service>
     </services>
 </container>

src/UrlGenerator/CanonicalUrlGenerator.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\UrlGenerator;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+
+final class CanonicalUrlGenerator implements CanonicalUrlGeneratorInterface
+{
+    public function __construct(
+        private readonly UrlGeneratorInterface $urlGenerator,
+    ) {
+    }
+
+    public function generate(Request $request, array $parameters = []): string
+    {
+        $routeName = $request->attributes->get('_route');
+
+        if (null === $routeName) {
+            return $request->getUri();
+        }
+
+        return $this->urlGenerator->generate(
+            $routeName,
+            array_merge($request->attributes->get('_route_params', []), $parameters),
+            UrlGeneratorInterface::ABSOLUTE_URL
+        );
+    }
+}

src/UrlGenerator/CanonicalUrlGeneratorInterface.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\UrlGenerator;
+
+use Symfony\Component\HttpFoundation\Request;
+
+interface CanonicalUrlGeneratorInterface
+{
+    public function generate(Request $request, array $parameters = []): string;
+}

tests/Unit/UrlGenerator/CanonicalUrlGeneratorTest.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Tests\Unit\UrlGenerator;
+
+use Setono\SyliusMeilisearchPlugin\UrlGenerator\CanonicalUrlGenerator;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\Routing\Generator\UrlGenerator;
+use Symfony\Component\Routing\RequestContext;
+use Symfony\Component\Routing\Route;
+use Symfony\Component\Routing\RouteCollection;
+
+class CanonicalUrlGeneratorTest extends TestCase
+{
+    public function testGenerate(): void
+    {
+        $routes = new RouteCollection();
+        $routes->add('test_route', new Route('/test/{param1}'));
+        $context = new RequestContext(host: 'example.com', scheme: 'https');
+        $urlGenerator = new UrlGenerator($routes, $context);
+        $canonicalUrlGenerator = new CanonicalUrlGenerator($urlGenerator);
+
+        $request = Request::create('https://example.com/test/value1?param2=value2#fragment');
+        $request->attributes->set('_route', 'test_route');
+        $request->attributes->set('_route_params', ['param1' => 'value1']);
+
+        $result = $canonicalUrlGenerator->generate($request);
+
+        self::assertSame('https://example.com/test/value1', $result);
+    }
+}