feat(symfony): add getOperation Expression Language function on Mercure topics

Author: vincentchalamon

features/mercure/publish.feature

@@ -31,3 +31,30 @@ Feature: Mercure publish support
         "name": "Hello World!"
     }
     """
+
+  Scenario: Checks that Mercure Updates are dispatched following topics configured with expression language
+    Given I add "Accept" header equal to "application/ld+json"
+    And I add "Content-Type" header equal to "application/ld+json"
+    When I send a "POST" request to "/mercure_with_topics" with body:
+    """
+    {
+      "name": "Hello World!"
+    }
+    """
+    Then the response status code should be 201
+    And the response should be in JSON
+    And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
+    Then 1 Mercure update should have been sent
+    And the Mercure update should have topics:
+      | http://example.com/mercure_with_topics/1                 |
+      | http://example.com/custom_resource/mercure_with_topics/1 |
+    And the Mercure update should have data:
+    """
+    {
+        "@context": "/contexts/MercureWithTopics",
+        "@id": "/mercure_with_topics/1",
+        "@type": "MercureWithTopics",
+        "id": 1,
+        "name": "Hello World!"
+    }
+    """

src/Doctrine/EventListener/PublishMercureUpdatesListener.php

@@ -22,6 +22,7 @@
 use ApiPlatform\GraphQl\Subscription\SubscriptionManagerInterface as GraphQlSubscriptionManagerInterface;
 use ApiPlatform\Metadata\HttpOperation;
 use ApiPlatform\Metadata\IriConverterInterface;
+use ApiPlatform\Metadata\Operation;
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 use ApiPlatform\Metadata\ResourceClassResolverInterface;
 use ApiPlatform\Metadata\UrlGeneratorInterface;
@@ -84,7 +85,10 @@ public function __construct(LegacyResourceClassResolverInterface|ResourceClassRe
             $this->expressionLanguage->addFunction($rawurlencode);
 
             $this->expressionLanguage->addFunction(
-                new ExpressionFunction('iri', static fn (string $apiResource, int $referenceType = UrlGeneratorInterface::ABS_URL): string => sprintf('iri(%s, %d)', $apiResource, $referenceType), static fn (array $arguments, $apiResource, int $referenceType = UrlGeneratorInterface::ABS_URL): string => $iriConverter->getIriFromResource($apiResource, $referenceType))
+                new ExpressionFunction('getOperation', static fn (string $apiResource, string $name): string => sprintf('getOperation(%s, %s)', $apiResource, $name), static fn (array $arguments, $apiResource, string $name): Operation => $resourceMetadataFactory->create($resourceClassResolver->getResourceClass($apiResource))->getOperation($name))
+            );
+            $this->expressionLanguage->addFunction(
+                new ExpressionFunction('iri', static fn (string $apiResource, int $referenceType = UrlGeneratorInterface::ABS_URL, string $operation = null): string => sprintf('iri(%s, %d, %s)', $apiResource, $referenceType, $operation), static fn (array $arguments, $apiResource, int $referenceType = UrlGeneratorInterface::ABS_URL, $operation = null): string => $iriConverter->getIriFromResource($apiResource, $referenceType, $operation))
             );
         }
 

tests/Fixtures/TestBundle/Document/MercureWithTopics.php

@@ -0,0 +1,42 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Fixtures\TestBundle\Document;
+
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\Get;
+use ApiPlatform\Metadata\Post;
+use ApiPlatform\Metadata\UrlGeneratorInterface;
+use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
+
+#[ApiResource(
+    operations: [
+        new Get(uriTemplate: '/mercure_with_topics/{id}{._format}'),
+        new Post(uriTemplate: '/mercure_with_topics{._format}'),
+        new Get(uriTemplate: '/custom_resource/mercure_with_topics/{id}{._format}'),
+    ],
+    mercure: [
+        'topics' => [
+            '@=iri(object)',
+            '@=iri(object, '.UrlGeneratorInterface::ABS_URL.', getOperation(object, "/custom_resource/mercure_with_topics/{id}{._format}"))',
+        ],
+    ]
+)]
+#[ODM\Document]
+class MercureWithTopics
+{
+    #[ODM\Id(strategy: 'INCREMENT', type: 'int')]
+    public $id;
+    #[ODM\Field(type: 'string')]
+    public $name;
+}

tests/Fixtures/TestBundle/Entity/MercureWithTopics.php

@@ -0,0 +1,44 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Tests\Fixtures\TestBundle\Entity;
+
+use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\Get;
+use ApiPlatform\Metadata\Post;
+use ApiPlatform\Metadata\UrlGeneratorInterface;
+use Doctrine\ORM\Mapping as ORM;
+
+#[ApiResource(
+    operations: [
+        new Get(uriTemplate: '/mercure_with_topics/{id}{._format}'),
+        new Post(uriTemplate: '/mercure_with_topics{._format}'),
+        new Get(uriTemplate: '/custom_resource/mercure_with_topics/{id}{._format}'),
+    ],
+    mercure: [
+        'topics' => [
+            '@=iri(object)',
+            '@=iri(object, '.UrlGeneratorInterface::ABS_URL.', getOperation(object, "/custom_resource/mercure_with_topics/{id}{._format}"))',
+        ],
+    ]
+)]
+#[ORM\Entity]
+class MercureWithTopics
+{
+    #[ORM\Id]
+    #[ORM\Column(type: 'integer')]
+    #[ORM\GeneratedValue(strategy: 'AUTO')]
+    public $id;
+    #[ORM\Column]
+    public $name;
+}

tests/Symfony/Bundle/Test/ApiTestCaseTest.php

@@ -217,8 +217,7 @@ public function testFindIriBy(): void
      */
     public function testGetMercureMessages(): void
     {
-        // debug mode is required to get Mercure TraceableHub
-        $this->recreateSchema(['debug' => true, 'environment' => 'mercure']);
+        $this->recreateSchema(['environment' => 'mercure']);
 
         self::createClient()->request('POST', '/direct_mercures', [
             'headers' => [