feat: add @type property on mercure delete update (#2688)

Co-authored-by: toriqo <flavius@pionix.ro> Co-authored-by: Alan Poulain <contact@alanpoulain.eu>

Author: 3 people

src/Doctrine/EventListener/PublishMercureUpdatesListener.php

@@ -21,6 +21,7 @@
 use ApiPlatform\Exception\RuntimeException;
 use ApiPlatform\GraphQl\Subscription\MercureSubscriptionIriGeneratorInterface as GraphQlMercureSubscriptionIriGeneratorInterface;
 use ApiPlatform\GraphQl\Subscription\SubscriptionManagerInterface as GraphQlSubscriptionManagerInterface;
+use ApiPlatform\Metadata\HttpOperation;
 use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 use ApiPlatform\Symfony\Messenger\DispatchTrait;
 use ApiPlatform\Util\ResourceClassInfoTrait;
@@ -63,7 +64,7 @@ final class PublishMercureUpdatesListener
  /**
  * @param array<string, string[]|string> $formats
  */
- public function __construct(ResourceClassResolverInterface $resourceClassResolver, private readonly IriConverterInterface $iriConverter, ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory, private readonly SerializerInterface $serializer, private readonly array $formats, MessageBusInterface $messageBus = null, private readonly ?HubRegistry $hubRegistry = null, private readonly ?GraphQlSubscriptionManagerInterface $graphQlSubscriptionManager = null, private readonly ?GraphQlMercureSubscriptionIriGeneratorInterface $graphQlMercureSubscriptionIriGenerator = null, ExpressionLanguage $expressionLanguage = null)
+ public function __construct(ResourceClassResolverInterface $resourceClassResolver, private readonly IriConverterInterface $iriConverter, ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory, private readonly SerializerInterface $serializer, private readonly array $formats, MessageBusInterface $messageBus = null, private readonly ?HubRegistry $hubRegistry = null, private readonly ?GraphQlSubscriptionManagerInterface $graphQlSubscriptionManager = null, private readonly ?GraphQlMercureSubscriptionIriGeneratorInterface $graphQlMercureSubscriptionIriGenerator = null, ExpressionLanguage $expressionLanguage = null, private bool $includeType = false)
  {
  if (null === $messageBus && null === $hubRegistry) {
  throw new InvalidArgumentException('A message bus or a hub registry must be provided.');
@@ -84,6 +85,10 @@ public function __construct(ResourceClassResolverInterface $resourceClassResolve
  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))
  );
  }
+
+ if (false === $this->includeType) {
+ trigger_deprecation('api-platform/core', '3.1', 'Having mercure.include_type (always include @type in Mercure updates, even delete ones) set to false in the configuration is deprecated. It will be true by default in API Platform 4.0.');
+ }
  }
 
  /**
@@ -150,8 +155,9 @@ private function storeObjectToPublish(object $object, string $property): void
  return;
  }
 
+ $operation = $this->resourceMetadataFactory->create($resourceClass)->getOperation();
  try {
- $options = $this->resourceMetadataFactory->create($resourceClass)->getOperation()->getMercure() ?? false;
+ $options = $operation->getMercure() ?? false;
  } catch (OperationNotFoundException) {
  return;
  }
@@ -208,9 +214,15 @@ private function storeObjectToPublish(object $object, string $property): void
  }
 
  if ('deletedObjects' === $property) {
+ $types = $operation instanceof HttpOperation ? $operation->getTypes() : null;
+ if (null === $types) {
+ $types = [$operation->getShortName()];
+ }
+
  $this->deletedObjects[(object) [
  'id' => $this->iriConverter->getIriFromResource($object),
  'iri' => $this->iriConverter->getIriFromResource($object, UrlGeneratorInterface::ABS_URL),
+ 'type' => 1 === \count($types) ? $types[0] : $types,
  ]] = $options;
 
  return;
@@ -222,12 +234,12 @@ private function storeObjectToPublish(object $object, string $property): void
  private function publishUpdate(object $object, array $options, string $type): void
  {
  if ($object instanceof \stdClass) {
- // By convention, if the object has been deleted, we send only its IRI.
+ // By convention, if the object has been deleted, we send only its IRI and its type.
  // This may change in the feature, because it's not JSON Merge Patch compliant,
  // and I'm not a fond of this approach.
  $iri = $options['topics'] ?? $object->iri;
  /** @var string $data */
- $data = json_encode(['@id' => $object->id], \JSON_THROW_ON_ERROR);
+ $data = json_encode(['@id' => $object->id] + ($this->includeType ? ['@type' => $object->type] : []), \JSON_THROW_ON_ERROR);
  } else {
  $resourceClass = $this->getObjectClass($object);
  $context = $options['normalization_context'] ?? $this->resourceMetadataFactory->create($resourceClass)->getOperation()->getNormalizationContext() ?? [];

src/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php

@@ -680,6 +680,8 @@ private function registerMercureConfiguration(ContainerBuilder $container, array
  return;
  }
 
+ $container->setParameter('api_platform.mercure.include_type', $config['mercure']['include_type']);
+
  $loader->load('mercure.xml');
 
  if ($this->isConfigEnabled($container, $config['doctrine'])) {

src/Symfony/Bundle/DependencyInjection/Configuration.php

@@ -376,6 +376,10 @@ private function addMercureSection(ArrayNodeDefinition $rootNode): void
  ->defaultNull()
  ->info('The URL sent in the Link HTTP header. If not set, will default to the URL for MercureBundle\'s default hub.')
  ->end()
+ ->booleanNode('include_type')
+ ->defaultFalse()
+ ->info('Always include @type in updates (including delete ones).')
+ ->end()
  ->end()
  ->end()
  ->end();

src/Symfony/Bundle/Resources/config/doctrine_odm_mercure_publisher.xml

@@ -18,6 +18,8 @@
  <argument type="service" id="Symfony\Component\Mercure\HubRegistry" />
  <argument type="service" id="api_platform.graphql.subscription.subscription_manager" on-invalid="ignore" />
  <argument type="service" id="api_platform.graphql.subscription.mercure_iri_generator" on-invalid="ignore" />
+ <argument>null</argument>
+ <argument>%api_platform.mercure.include_type%</argument>
 
  <tag name="doctrine_mongodb.odm.event_listener" event="onFlush" />
  <tag name="doctrine_mongodb.odm.event_listener" event="postFlush" />

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

@@ -18,6 +18,8 @@
  <argument type="service" id="Symfony\Component\Mercure\HubRegistry" />
  <argument type="service" id="api_platform.graphql.subscription.subscription_manager" on-invalid="ignore" />
  <argument type="service" id="api_platform.graphql.subscription.mercure_iri_generator" on-invalid="ignore" />
+ <argument>null</argument>
+ <argument>%api_platform.mercure.include_type%</argument>
 
  <tag name="doctrine.event_listener" event="onFlush" />
  <tag name="doctrine.event_listener" event="postFlush" />

tests/Doctrine/EventListener/PublishMercureUpdatesListenerTest.php

@@ -98,16 +98,16 @@ public function testPublishUpdate(): void
  ]))]));
 
  $resourceMetadataFactoryProphecy->create(Dummy::class)->willReturn(new ResourceMetadataCollection(Dummy::class, [(new ApiResource())->withOperations(new Operations([
- 'get' => (new Get())->withMercure(['hub' => 'managed', 'enable_async_update' => false])->withNormalizationContext(['groups' => ['foo', 'bar']]),
+ 'get' => (new Get())->withShortName('Dummy')->withMercure(['hub' => 'managed', 'enable_async_update' => false])->withNormalizationContext(['groups' => ['foo', 'bar']]),
  ]))]));
  $resourceMetadataFactoryProphecy->create(DummyCar::class)->willReturn(new ResourceMetadataCollection(DummyCar::class, [(new ApiResource())->withOperations(new Operations([
  'get' => new Get(),
  ]))]));
  $resourceMetadataFactoryProphecy->create(DummyFriend::class)->willReturn(new ResourceMetadataCollection(DummyFriend::class, [(new ApiResource())->withOperations(new Operations([
- 'get' => (new Get())->withMercure(['private' => true, 'retry' => 10, 'hub' => 'managed', 'enable_async_update' => false]),
+ 'get' => (new Get())->withTypes('https://schema.org/Person')->withShortName('DummyFriend')->withMercure(['private' => true, 'retry' => 10, 'hub' => 'managed', 'enable_async_update' => false]),
  ]))]));
  $resourceMetadataFactoryProphecy->create(DummyOffer::class)->willReturn(new ResourceMetadataCollection(DummyOffer::class, [(new ApiResource())->withOperations(new Operations([
- 'get' => (new Get())->withMercure(['topics' => 'http://example.com/custom_topics/1', 'data' => 'mercure_custom_data', 'hub' => 'managed', 'enable_async_update' => false])->withNormalizationContext(['groups' => ['baz']]),
+ 'get' => (new Get())->withShortName('DummyOffer')->withMercure(['topics' => 'http://example.com/custom_topics/1', 'data' => 'mercure_custom_data', 'hub' => 'managed', 'enable_async_update' => false])->withNormalizationContext(['groups' => ['baz']]),
  ]))]));
  $resourceMetadataFactoryProphecy->create(DummyMercure::class)->willReturn(new ResourceMetadataCollection(DummyMercure::class, [(new ApiResource())->withOperations(new Operations([
  'get' => (new Get())->withMercure(['topics' => ['/dummies/1', '/users/3'], 'hub' => 'managed', 'enable_async_update' => false])->withNormalizationContext(['groups' => ['baz']]),
@@ -144,7 +144,11 @@ public function testPublishUpdate(): void
  null,
  new HubRegistry($this->createMock(HubInterface::class), [
  'managed' => $managedHub,
- ])
+ ]),
+ null,
+ null,
+ null,
+ true,
  );
 
  $uowProphecy = $this->prophesize(UnitOfWork::class);
@@ -159,7 +163,7 @@ public function testPublishUpdate(): void
  $listener->onFlush($eventArgs);
  $listener->postFlush();
 
- $this->assertEquals(['1', '2', 'mercure_custom_data', 'mercure_options', '{"@id":"\/dummies\/3"}', '{"@id":"\/dummy_friends\/4"}', '{"@id":"\/dummy_offers\/5"}'], $data);
+ $this->assertEquals(['1', '2', 'mercure_custom_data', 'mercure_options', '{"@id":"\/dummies\/3","@type":"Dummy"}', '{"@id":"\/dummy_friends\/4","@type":"https:\/\/schema.org\/Person"}', '{"@id":"\/dummy_offers\/5","@type":"DummyOffer"}'], $data);
  $this->assertEquals(['http://example.com/dummies/1', 'http://example.com/dummies/2', 'http://example.com/custom_topics/1', '/dummies/1', '/users/3', 'http://example.com/dummies/3', 'http://example.com/dummy_friends/4', 'http://example.com/custom_topics/1'], $topics);
  $this->assertEquals([false, false, false, false, false, true, false], $private);
  $this->assertEquals([null, null, null, null, null, 10, null], $retry);
@@ -218,7 +222,9 @@ public function testPublishGraphQlUpdates(): void
  null,
  new HubRegistry($defaultHub, ['default' => $defaultHub]),
  $graphQlSubscriptionManagerProphecy->reveal(),
- $graphQlMercureSubscriptionIriGenerator->reveal()
+ $graphQlMercureSubscriptionIriGenerator->reveal(),
+ null,
+ true,
  );
 
  $uowProphecy = $this->prophesize(UnitOfWork::class);

tests/Fixtures/app/config/config_common.yml

@@ -80,6 +80,8 @@ api_platform:
  paths:
  - '%kernel.project_dir%/../TestBundle/Enum'
  - '%kernel.project_dir%/../TestBundle/Model'
+ mercure:
+ include_type: true
 
 parameters:
  container.autowiring.strict_mode: true

tests/Symfony/Bundle/DependencyInjection/ConfigurationTest.php

@@ -197,6 +197,7 @@ private function runDefaultConfigTests(array $doctrineIntegrationsToLoad = ['orm
  'mercure' => [
  'enabled' => true,
  'hub_url' => null,
+ 'include_type' => false,
  ],
  'resource_class_directories' => [],
  'asset_package' => null,