Allow to use different URL to publish and subscribe

Author: dunglas

src/Bridge/Doctrine/EventListener/PublishMercureUpdatesListener.php

@@ -15,6 +15,7 @@
 
 use ApiPlatform\Core\Api\IriConverterInterface;
 use ApiPlatform\Core\Api\ResourceClassResolverInterface;
+use ApiPlatform\Core\Api\UrlGeneratorInterface;
 use ApiPlatform\Core\Exception\InvalidArgumentException;
 use ApiPlatform\Core\Exception\RuntimeException;
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
@@ -146,7 +147,7 @@ private function storeEntityToPublish($entity, string $property): void
         }
 
         if ('deletedEntities' === $property) {
-            $this->deletedEntities[$this->iriConverter->getIriFromItem($entity)] = $value;
+            $this->deletedEntities[$this->iriConverter->getIriFromItem($entity, UrlGeneratorInterface::ABS_URL)] = $value;
 
             return;
         }
@@ -166,7 +167,7 @@ private function publishUpdate($entity, array $targets, bool $deleted = false):
             $iri = $entity;
             $data = json_encode(['@id' => $iri]);
         } else {
-            $iri = $this->iriConverter->getIriFromItem($entity);
+            $iri = $this->iriConverter->getIriFromItem($entity, UrlGeneratorInterface::ABS_URL);
             $data = $this->serializer->serialize($entity, 'jsonld');
         }
 

src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php

@@ -144,7 +144,7 @@ public function load(array $configs, ContainerBuilder $container)
         $this->registerHttpCache($container, $config, $loader, $useDoctrine);
         $this->registerValidatorConfiguration($container, $config, $loader);
         $this->registerDataCollector($container, $config, $loader);
-        $this->registerMercureConfiguration($container, $loader, $useDoctrine);
+        $this->registerMercureConfiguration($container, $config, $loader, $useDoctrine);
     }
 
     /**
@@ -523,13 +523,15 @@ private function registerDataCollector(ContainerBuilder $container, array $confi
         $loader->load('data_collector.xml');
     }
 
-    private function registerMercureConfiguration(ContainerBuilder $container, XmlFileLoader $loader, bool $useDoctrine)
+    private function registerMercureConfiguration(ContainerBuilder $container, array $config, XmlFileLoader $loader, bool $useDoctrine)
     {
-        if (!$container->hasParameter('mercure.default_hub')) {
+        if (!$config['mercure']['enabled'] || !$container->hasParameter('mercure.default_hub')) {
             return;
         }
 
         $loader->load('mercure.xml');
+        $container->getDefinition('api_platform.mercure.listener.response.add_link_header')->addArgument($config['mercure']['hub_url'] ?? '%mercure.default_hub%');
+
         if ($useDoctrine) {
             $loader->load('doctrine_orm_mercure_publisher.xml');
         }

src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php

@@ -23,6 +23,7 @@
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Mercure\Update;
 use Symfony\Component\Serializer\Exception\ExceptionInterface;
 
 /**
@@ -218,6 +219,13 @@ public function getConfigTreeBuilder()
                     ->end()
                 ->end()
 
+                ->arrayNode('mercure')
+                    ->{class_exists(Update::class) ? 'canBeDisabled' : 'canBeEnabled'}()
+                    ->children()
+                        ->scalarNode('hub_url')->defaultNull()->info('The URL send in the Link HTTP header. If not set, will default to the URL for the Symfony\'s bundle default hub.')
+                    ->end()
+                ->end()
+
             ->end();
 
         $this->addExceptionToStatusSection($rootNode);

src/Bridge/Symfony/Bundle/Resources/config/mercure.xml

@@ -9,7 +9,6 @@
 
         <service id="api_platform.mercure.listener.response.add_link_header" class="ApiPlatform\Core\Mercure\EventListener\AddLinkHeaderListener">
             <argument type="service" id="api_platform.metadata.resource.metadata_factory" />
-            <argument>%mercure.default_hub%</argument>
 
             <tag name="kernel.event_listener" event="kernel.response" method="onKernelResponse" />
         </service>

tests/Bridge/Doctrine/EventListener/PublishMercureUpdatesListenerTest.php

@@ -15,6 +15,7 @@
 
 use ApiPlatform\Core\Api\IriConverterInterface;
 use ApiPlatform\Core\Api\ResourceClassResolverInterface;
+use ApiPlatform\Core\Api\UrlGeneratorInterface;
 use ApiPlatform\Core\Bridge\Doctrine\EventListener\PublishMercureUpdatesListener;
 use ApiPlatform\Core\Exception\InvalidArgumentException;
 use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
@@ -57,10 +58,10 @@ public function testPublishUpdate()
         $resourceClassResolverProphecy->isResourceClass(DummyFriend::class)->willReturn(true);
 
         $iriConverterProphecy = $this->prophesize(IriConverterInterface::class);
-        $iriConverterProphecy->getIriFromItem($toInsert)->willReturn('/dummies/1')->shouldBeCalled();
-        $iriConverterProphecy->getIriFromItem($toUpdate)->willReturn('/dummies/2')->shouldBeCalled();
-        $iriConverterProphecy->getIriFromItem($toDelete)->willReturn('/dummies/3')->shouldBeCalled();
-        $iriConverterProphecy->getIriFromItem($toDeleteExpressionLanguage)->willReturn('/dummy_friends/4')->shouldBeCalled();
+        $iriConverterProphecy->getIriFromItem($toInsert, UrlGeneratorInterface::ABS_URL)->willReturn('http://example.com/dummies/1')->shouldBeCalled();
+        $iriConverterProphecy->getIriFromItem($toUpdate, UrlGeneratorInterface::ABS_URL)->willReturn('http://example.com/dummies/2')->shouldBeCalled();
+        $iriConverterProphecy->getIriFromItem($toDelete, UrlGeneratorInterface::ABS_URL)->willReturn('http://example.com/dummies/3')->shouldBeCalled();
+        $iriConverterProphecy->getIriFromItem($toDeleteExpressionLanguage, UrlGeneratorInterface::ABS_URL)->willReturn('http://example.com/dummy_friends/4')->shouldBeCalled();
 
         $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
         $resourceMetadataFactoryProphecy->create(Dummy::class)->willReturn(new ResourceMetadata(null, null, null, null, null, ['mercure' => true]));
@@ -101,7 +102,7 @@ public function testPublishUpdate()
         $listener->onFlush($eventArgs);
         $listener->postFlush();
 
-        $this->assertSame(['/dummies/1', '/dummies/2', '/dummies/3', '/dummy_friends/4'], $topics);
+        $this->assertSame(['http://example.com/dummies/1', 'http://example.com/dummies/2', 'http://example.com/dummies/3', 'http://example.com/dummy_friends/4'], $topics);
         $this->assertSame([[], [], [], ['foo', 'bar']], $targets);
     }
 

tests/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtensionTest.php

@@ -757,6 +757,8 @@ private function getBaseContainerBuilderProphecy()
         $containerBuilderProphecy->getParameter('api_platform.metadata_cache')->willReturn(true)->shouldBeCalled();
         $containerBuilderProphecy->hasParameter('mercure.default_hub')->willReturn(true)->shouldBeCalled();
 
+        $containerBuilderProphecy->getDefinition('api_platform.mercure.listener.response.add_link_header')->willReturn(new Definition());
+
         return $containerBuilderProphecy;
     }
 }

tests/Bridge/Symfony/Bundle/DependencyInjection/ConfigurationTest.php

@@ -143,6 +143,10 @@ public function testDefaultConfig()
                 'vary' => ['Accept'],
                 'public' => null,
             ],
+            'mercure' => [
+                'enabled' => true,
+                'hub_url' => null,
+            ],
             'allow_plain_identifiers' => false,
             'resource_class_directories' => [],
         ], $config);