Merge pull request #2674 from toriqo/2.4

publish to mercure using the default format and also respect the entity's serializer context

Author: soyuka

src/Bridge/Doctrine/EventListener/PublishMercureUpdatesListener.php

@@ -47,8 +47,9 @@ final class PublishMercureUpdatesListener
     private $createdEntities;
     private $updatedEntities;
     private $deletedEntities;
+    private $formats;
 
-    public function __construct(ResourceClassResolverInterface $resourceClassResolver, IriConverterInterface $iriConverter, ResourceMetadataFactoryInterface $resourceMetadataFactory, SerializerInterface $serializer, MessageBusInterface $messageBus = null, callable $publisher = null, ExpressionLanguage $expressionLanguage = null)
+    public function __construct(ResourceClassResolverInterface $resourceClassResolver, IriConverterInterface $iriConverter, ResourceMetadataFactoryInterface $resourceMetadataFactory, SerializerInterface $serializer, array $formats, MessageBusInterface $messageBus = null, callable $publisher = null, ExpressionLanguage $expressionLanguage = null)
     {
         if (null === $messageBus && null === $publisher) {
             throw new InvalidArgumentException('A message bus or a publisher must be provided.');
@@ -58,6 +59,7 @@ public function __construct(ResourceClassResolverInterface $resourceClassResolve
         $this->iriConverter = $iriConverter;
         $this->resourceMetadataFactory = $resourceMetadataFactory;
         $this->serializer = $serializer;
+        $this->formats = $formats;
         $this->messageBus = $messageBus;
         $this->publisher = $publisher;
         $this->expressionLanguage = $expressionLanguage ?? class_exists(ExpressionLanguage::class) ? new ExpressionLanguage() : null;
@@ -157,7 +159,7 @@ private function storeEntityToPublish($entity, string $property): void
     }
 
     /**
-     * @param object|string $entity
+     * @param object $entity
      */
     private function publishUpdate($entity, array $targets): void
     {
@@ -168,8 +170,11 @@ private function publishUpdate($entity, array $targets): void
             $iri = $entity->iri;
             $data = json_encode(['@id' => $entity->id]);
         } else {
+            $resourceClass = $this->getObjectClass($entity);
+            $context = $this->resourceMetadataFactory->create($resourceClass)->getAttribute('normalization_context', []);
+
             $iri = $this->iriConverter->getIriFromItem($entity, UrlGeneratorInterface::ABS_URL);
-            $data = $this->serializer->serialize($entity, 'jsonld');
+            $data = $this->serializer->serialize($entity, key($this->formats), $context);
         }
 
         $update = new Update($iri, $data, $targets);

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

@@ -13,6 +13,7 @@
             <argument type="service" id="api_platform.iri_converter" />
             <argument type="service" id="api_platform.metadata.resource.metadata_factory" />
             <argument type="service" id="api_platform.serializer" />
+            <argument>%api_platform.formats%</argument>
             <argument type="service" id="message_bus" on-invalid="ignore" />
             <argument type="service" id="mercure.hub.default.publisher" />
 

tests/Bridge/Doctrine/EventListener/PublishMercureUpdatesListenerTest.php

@@ -66,13 +66,15 @@ public function testPublishUpdate()
         $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]));
+        $resourceMetadataFactoryProphecy->create(Dummy::class)->willReturn(new ResourceMetadata(null, null, null, null, null, ['mercure' => true, 'normalization_context' => ['groups' => ['foo', 'bar']]]));
         $resourceMetadataFactoryProphecy->create(DummyCar::class)->willReturn(new ResourceMetadata());
         $resourceMetadataFactoryProphecy->create(DummyFriend::class)->willReturn(new ResourceMetadata(null, null, null, null, null, ['mercure' => "['foo', 'bar']"]));
 
         $serializerProphecy = $this->prophesize(SerializerInterface::class);
-        $serializerProphecy->serialize($toInsert, 'jsonld')->willReturn('1');
-        $serializerProphecy->serialize($toUpdate, 'jsonld')->willReturn('2');
+        $serializerProphecy->serialize($toInsert, 'jsonld', ['groups' => ['foo', 'bar']])->willReturn('1');
+        $serializerProphecy->serialize($toUpdate, 'jsonld', ['groups' => ['foo', 'bar']])->willReturn('2');
+
+        $formats = ['jsonld' => ['application/ld+json'], 'jsonhal' => ['application/hal+json']];
 
         $topics = [];
         $targets = [];
@@ -88,6 +90,7 @@ public function testPublishUpdate()
             $iriConverterProphecy->reveal(),
             $resourceMetadataFactoryProphecy->reveal(),
             $serializerProphecy->reveal(),
+            $formats,
             null,
             $publisher
         );
@@ -118,6 +121,7 @@ public function testNoPublisher()
             $this->prophesize(IriConverterInterface::class)->reveal(),
             $this->prophesize(ResourceMetadataFactoryInterface::class)->reveal(),
             $this->prophesize(SerializerInterface::class)->reveal(),
+            ['jsonld' => ['application/ld+json'], 'jsonhal' => ['application/hal+json']],
             null,
             null
         );
@@ -145,6 +149,7 @@ public function testInvalidMercureAttribute()
             $iriConverterProphecy->reveal(),
             $resourceMetadataFactoryProphecy->reveal(),
             $serializerProphecy->reveal(),
+            ['jsonld' => ['application/ld+json'], 'jsonhal' => ['application/hal+json']],
             null,
             function (Update $update): string {
                 return 'will never be called';