Provides an integration with the Symfony Messenger component

Author: dunglas

composer.json

@@ -60,7 +60,7 @@
         "symfony/framework-bundle": "^3.3 || ^4.0",
         "symfony/mercure": "*",
         "symfony/mercure-bundle": "*",
-        "symfony/messenger": "^4.1",
+        "symfony/messenger": "^4.2",
         "symfony/phpunit-bridge": "^3.3 || ^4.0",
         "symfony/routing": "^3.3 || ^4.0",
         "symfony/security": "^3.0 || ^4.0",

src/Annotation/ApiResource.php

@@ -42,6 +42,7 @@
  *     @Attribute("itemOperations", type="array"),
  *     @Attribute("maximumItemsPerPage", type="int"),
  *     @Attribute("mercure", type="mixed"),
+ *     @Attribute("messenger", type="bool"),
  *     @Attribute("normalizationContext", type="array"),
  *     @Attribute("order", type="array"),
  *     @Attribute("outputClass", type="mixed"),
@@ -183,6 +184,13 @@ final class ApiResource
      */
     private $mercure;
 
+    /**
+     * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
+     *
+     * @var bool
+     */
+    private $messenger;
+
     /**
      * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
      *

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

@@ -37,6 +37,7 @@
 use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
 use Symfony\Component\Finder\Finder;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
+use Symfony\Component\Messenger\MessageBusInterface;
 use Symfony\Component\Validator\Validator\ValidatorInterface;
 use Symfony\Component\Yaml\Yaml;
 
@@ -145,6 +146,10 @@ public function load(array $configs, ContainerBuilder $container)
         $this->registerValidatorConfiguration($container, $config);
         $this->registerDataCollectorConfiguration($container, $config, $loader);
         $this->registerMercureConfiguration($container, $config, $loader, $useDoctrine);
+
+        if (interface_exists(MessageBusInterface::class)) {
+            $loader->load('messenger.xml');
+        }
     }
 
     /**

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

@@ -0,0 +1,18 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <services>
+        <service id="api_platform.message_bus" alias="message_bus" />
+
+        <service id="api_platform.messenger.data_persister" class="ApiPlatform\Core\DataPersister\MessengerDataPersister" public="false">
+            <argument type="service" id="api_platform.metadata.resource.metadata_factory" />
+            <argument type="service" id="api_platform.message_bus" />
+
+            <tag name="api_platform.data_persister" priority="-900" />
+        </service>
+    </services>
+
+</container>

src/DataPersister/MessengerDataPersister.php

@@ -0,0 +1,66 @@
+<?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\Core\DataPersister;
+
+use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
+use ApiPlatform\Core\Util\ClassInfoTrait;
+use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\MessageBusInterface;
+
+/**
+ * Dispatches the given resource using the message bus of Symfony Messenger.
+ *
+ * @experimental
+ *
+ * @author Kévin Dunglas <[email protected]>
+ */
+final class MessengerDataPersister implements DataPersisterInterface
+{
+    use ClassInfoTrait;
+
+    private $resourceMetadataFactory;
+    private $messageBus;
+
+    public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, MessageBusInterface $messageBus)
+    {
+        $this->resourceMetadataFactory = $resourceMetadataFactory;
+        $this->messageBus = $messageBus;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function supports($data): bool
+    {
+        return true === $this->resourceMetadataFactory->create($this->getObjectClass($data))->getAttribute('messenger');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function persist($data)
+    {
+        $this->messageBus->dispatch($data);
+
+        return $data;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function remove($data)
+    {
+        $this->messageBus->dispatch(new Envelope($data, new RemoveStamp()));
+    }
+}

src/DataPersister/RemoveStamp.php

@@ -0,0 +1,25 @@
+<?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\Core\DataPersister;
+
+use Symfony\Component\Messenger\Stamp\StampInterface;
+
+/**
+ * Hints that the resource in the enveloppe must be removed.
+ *
+ * @author Kévin Dunglas <[email protected]>
+ */
+final class RemoveStamp implements StampInterface
+{
+}

tests/Annotation/ApiResourceTest.php

@@ -38,12 +38,15 @@ public function testConstruct()
             'formats' => ['foo', 'bar' => ['application/bar']],
             'filters' => ['foo', 'bar'],
             'graphql' => ['query' => ['normalization_context' => ['groups' => ['foo', 'bar']]]],
+            'inputClass' => 'Foo',
             'iri' => 'http://example.com/res',
             'itemOperations' => ['foo' => ['bar']],
             'maximumItemsPerPage' => 42,
             'mercure' => '[\'foo\', object.owner]',
+            'messenger' => true,
             'normalizationContext' => ['groups' => ['bar']],
             'order' => ['foo', 'bar' => 'ASC'],
+            'outputClass' => 'Bar',
             'paginationClientEnabled' => true,
             'paginationClientItemsPerPage' => true,
             'paginationClientPartial' => true,
@@ -74,10 +77,13 @@ public function testConstruct()
             'force_eager' => false,
             'formats' => ['foo', 'bar' => ['application/bar']],
             'filters' => ['foo', 'bar'],
+            'input_class' => 'Foo',
             'maximum_items_per_page' => 42,
             'mercure' => '[\'foo\', object.owner]',
+            'messenger' => true,
             'normalization_context' => ['groups' => ['bar']],
             'order' => ['foo', 'bar' => 'ASC'],
+            'output_class' => 'Bar',
             'pagination_client_enabled' => true,
             'pagination_client_items_per_page' => true,
             'pagination_client_partial' => true,

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

@@ -767,6 +767,7 @@ private function getBaseContainerBuilderProphecy()
             'api_platform.validator',
             'api_platform.mercure.listener.response.add_link_header',
             'api_platform.doctrine.listener.mercure.publish',
+            'api_platform.messenger.data_persister',
         ];
 
         foreach ($definitions as $definition) {
@@ -775,6 +776,7 @@ private function getBaseContainerBuilderProphecy()
 
         $aliases = [
             'api_platform.http_cache.purger' => 'api_platform.http_cache.purger.varnish',
+            'api_platform.message_bus' => 'message_bus',
             EagerLoadingExtension::class => 'api_platform.doctrine.orm.query_extension.eager_loading',
             FilterExtension::class => 'api_platform.doctrine.orm.query_extension.filter',
             FilterEagerLoadingExtension::class => 'api_platform.doctrine.orm.query_extension.filter_eager_loading',

tests/DataPersister/MessengerDataPersisterTest.php

@@ -0,0 +1,63 @@
+<?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\Core\Tests\DataPersister;
+
+use ApiPlatform\Core\DataPersister\MessengerDataPersister;
+use ApiPlatform\Core\DataPersister\RemoveStamp;
+use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
+use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Dummy;
+use PHPUnit\Framework\TestCase;
+use Prophecy\Argument;
+use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\MessageBusInterface;
+
+/**
+ * @author Kévin Dunglas <[email protected]>
+ */
+class MessengerDataPersisterTest extends TestCase
+{
+    public function testSupport()
+    {
+        $metadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
+        $metadataFactoryProphecy->create(Dummy::class)->willReturn(new ResourceMetadata(null, null, null, null, null, ['messenger' => true]));
+
+        $dataPersister = new MessengerDataPersister($metadataFactoryProphecy->reveal(), $this->prophesize(MessageBusInterface::class)->reveal());
+        $this->assertTrue($dataPersister->supports(new Dummy()));
+    }
+
+    public function testPersist()
+    {
+        $dummy = new Dummy();
+
+        $messageBus = $this->prophesize(MessageBusInterface::class);
+        $messageBus->dispatch($dummy)->willReturn(new Envelope(new \stdClass()))->shouldBeCalled();
+
+        $dataPersister = new MessengerDataPersister($this->prophesize(ResourceMetadataFactoryInterface::class)->reveal(), $messageBus->reveal());
+        $this->assertSame($dummy, $dataPersister->persist($dummy));
+    }
+
+    public function testRemove()
+    {
+        $dummy = new Dummy();
+
+        $messageBus = $this->prophesize(MessageBusInterface::class);
+        $messageBus->dispatch(Argument::that(function (Envelope $envelope) {
+            return null !== $envelope->last(RemoveStamp::class);
+        }))->willReturn(new Envelope(new \stdClass()))->shouldBeCalled();
+
+        $dataPersister = new MessengerDataPersister($this->prophesize(ResourceMetadataFactoryInterface::class)->reveal(), $messageBus->reveal());
+        $dataPersister->remove($dummy);
+    }
+}

tests/DataPersister/RemoveStampTest.php

@@ -0,0 +1,29 @@
+<?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\Core\Tests\DataPersister;
+
+use ApiPlatform\Core\DataPersister\RemoveStamp;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Messenger\Stamp\StampInterface;
+
+/**
+ * @author Kévin Dunglas <[email protected]>
+ */
+class RemoveStampTest extends TestCase
+{
+    public function testConstruct()
+    {
+        $this->assertInstanceOf(StampInterface::class, new RemoveStamp());
+    }
+}