[Mercure] Add a normalization_context option in mercure attribute (#3772)

* chore: bump PHPUnit and phpDocumentor

* feat: add a normalization_context option for mercure attribute

Author: alanpoulain

.github/workflows/ci.yml

@@ -122,7 +122,7 @@ jobs:
           composer update --no-progress --no-suggest --ansi
       - name: Install PHPUnit
         env:
-          SYMFONY_PHPUNIT_VERSION: '9.2'
+          SYMFONY_PHPUNIT_VERSION: '9.4'
         run: vendor/bin/simple-phpunit --version
       - name: Clear test app cache
         run: |
@@ -140,7 +140,7 @@ jobs:
         continue-on-error: true
       - name: Run PHPStan analysis
         env:
-          SYMFONY_PHPUNIT_VERSION: '9.2'
+          SYMFONY_PHPUNIT_VERSION: '9.4'
         run: vendor/bin/phpstan analyse --no-progress --no-interaction --ansi
 
   phpunit:

composer.json

@@ -47,8 +47,8 @@
         "jangregor/phpstan-prophecy": "^0.6",
         "justinrainbow/json-schema": "^5.2.1",
         "nelmio/api-doc-bundle": "^2.13.4",
-        "phpdocumentor/reflection-docblock": "^3.0 || ^4.0",
-        "phpdocumentor/type-resolver": "^0.3 || ^0.4",
+        "phpdocumentor/reflection-docblock": "^3.0 || ^4.0 || ^5.0",
+        "phpdocumentor/type-resolver": "^0.3 || ^0.4 || ^0.5 || ^0.6 || ^0.7 || ^1.0",
         "phpstan/extension-installer": "^1.0",
         "phpstan/phpstan": "^0.12.4",
         "phpstan/phpstan-doctrine": "^0.12.7",

src/Bridge/Doctrine/EventListener/PublishMercureUpdatesListener.php

@@ -48,6 +48,7 @@ final class PublishMercureUpdatesListener
         'id' => true,
         'type' => true,
         'retry' => true,
+        'normalization_context' => true,
     ];
 
     use DispatchTrait;
@@ -215,7 +216,7 @@ private function publishUpdate($object, array $options, string $type): void
             $data = $options['data'] ?? json_encode(['@id' => $object->id]);
         } else {
             $resourceClass = $this->getObjectClass($object);
-            $context = $this->resourceMetadataFactory->create($resourceClass)->getAttribute('normalization_context', []);
+            $context = $options['normalization_context'] ?? $this->resourceMetadataFactory->create($resourceClass)->getAttribute('normalization_context', []);
 
             $iri = $options['topics'] ?? $this->iriConverter->getIriFromItem($object, UrlGeneratorInterface::ABS_URL);
             $data = $options['data'] ?? $this->serializer->serialize($object, key($this->formats), $context);

tests/Bridge/Doctrine/EventListener/PublishMercureUpdatesListenerTest.php

@@ -26,6 +26,7 @@
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Dummy;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyCar;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyFriend;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyOffer;
 use ApiPlatform\Core\Tests\ProphecyTrait;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Event\OnFlushEventArgs;
@@ -137,6 +138,7 @@ public function testPublishUpdate(): void
         $toUpdate = new Dummy();
         $toUpdate->setId(2);
         $toUpdateNoMercureAttribute = new DummyCar();
+        $toUpdateMercureOptions = new DummyOffer();
 
         $toDelete = new Dummy();
         $toDelete->setId(3);
@@ -147,10 +149,12 @@ public function testPublishUpdate(): void
         $resourceClassResolverProphecy->getResourceClass(Argument::type(Dummy::class))->willReturn(Dummy::class);
         $resourceClassResolverProphecy->getResourceClass(Argument::type(DummyCar::class))->willReturn(DummyCar::class);
         $resourceClassResolverProphecy->getResourceClass(Argument::type(DummyFriend::class))->willReturn(DummyFriend::class);
+        $resourceClassResolverProphecy->getResourceClass(Argument::type(DummyOffer::class))->willReturn(DummyOffer::class);
         $resourceClassResolverProphecy->isResourceClass(Dummy::class)->willReturn(true);
         $resourceClassResolverProphecy->isResourceClass(NotAResource::class)->willReturn(false);
         $resourceClassResolverProphecy->isResourceClass(DummyCar::class)->willReturn(true);
         $resourceClassResolverProphecy->isResourceClass(DummyFriend::class)->willReturn(true);
+        $resourceClassResolverProphecy->isResourceClass(DummyOffer::class)->willReturn(true);
 
         $iriConverterProphecy = $this->prophesize(IriConverterInterface::class);
         $iriConverterProphecy->getIriFromItem($toInsert, UrlGeneratorInterface::ABS_URL)->willReturn('http://example.com/dummies/1')->shouldBeCalled();
@@ -164,10 +168,12 @@ public function testPublishUpdate(): void
         $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' => ['private' => true, 'retry' => 10]]));
+        $resourceMetadataFactoryProphecy->create(DummyOffer::class)->willReturn(new ResourceMetadata(null, null, null, null, null, ['mercure' => ['topics' => 'http://example.com/custom_topics/1', 'normalization_context' => ['groups' => ['baz']]]]));
 
         $serializerProphecy = $this->prophesize(SerializerInterface::class);
         $serializerProphecy->serialize($toInsert, 'jsonld', ['groups' => ['foo', 'bar']])->willReturn('1');
         $serializerProphecy->serialize($toUpdate, 'jsonld', ['groups' => ['foo', 'bar']])->willReturn('2');
+        $serializerProphecy->serialize($toUpdateMercureOptions, 'jsonld', ['groups' => ['baz']])->willReturn('mercure_options');
 
         $formats = ['jsonld' => ['application/ld+json'], 'jsonhal' => ['application/hal+json']];
 
@@ -194,7 +200,7 @@ public function testPublishUpdate(): void
 
         $uowProphecy = $this->prophesize(UnitOfWork::class);
         $uowProphecy->getScheduledEntityInsertions()->willReturn([$toInsert, $toInsertNotResource])->shouldBeCalled();
-        $uowProphecy->getScheduledEntityUpdates()->willReturn([$toUpdate, $toUpdateNoMercureAttribute])->shouldBeCalled();
+        $uowProphecy->getScheduledEntityUpdates()->willReturn([$toUpdate, $toUpdateNoMercureAttribute, $toUpdateMercureOptions])->shouldBeCalled();
         $uowProphecy->getScheduledEntityDeletions()->willReturn([$toDelete, $toDeleteExpressionLanguage])->shouldBeCalled();
 
         $emProphecy = $this->prophesize(EntityManagerInterface::class);
@@ -204,9 +210,9 @@ public function testPublishUpdate(): void
         $listener->onFlush($eventArgs);
         $listener->postFlush();
 
-        $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([false, false, false, true], $private);
-        $this->assertSame([null, null, null, 10], $retry);
+        $this->assertSame(['http://example.com/dummies/1', 'http://example.com/dummies/2', 'http://example.com/custom_topics/1', 'http://example.com/dummies/3', 'http://example.com/dummy_friends/4'], $topics);
+        $this->assertSame([false, false, false, false, true], $private);
+        $this->assertSame([null, null, null, null, 10], $retry);
     }
 
     public function testPublishGraphQlUpdates(): void