[EasyServerless] Listener for resetting Symfony services between messages (#1781)

Author: zeromodule

packages/EasyServerless/bundle/EasyServerlessBundle.php

@@ -83,6 +83,10 @@ public function loadExtension(array $config, ContainerConfigurator $container, C
 
         if ($this->isBundleEnabled('BrefMessengerBundle', $builder)) {
             $container->import('config/messenger.php');
+
+            if ($config['sqs']['reset_services']['enabled']) {
+                $container->import('config/sqs_reset_services.php');
+            }
         }
 
         if (\class_exists(Logger::class) && $config['monolog']['enabled']) {

packages/EasyServerless/bundle/config/definition.php

@@ -39,6 +39,15 @@
             ->arrayNode('monolog')
                 ->canBeDisabled()
             ->end()
+            ->arrayNode('sqs')
+                ->addDefaultsIfNotSet()
+                ->children()
+                    ->arrayNode('reset_services')
+                        ->canBeDisabled()
+                        ->info('Enable resetting Symfony services between serverless message handling.')
+                    ->end()
+                ->end()
+            ->end()
             ->arrayNode('state')
                 ->canBeDisabled()
                 ->children()

packages/EasyServerless/bundle/config/sqs_reset_services.php

@@ -0,0 +1,16 @@
+<?php
+declare(strict_types=1);
+
+namespace Symfony\Component\DependencyInjection\Loader\Configurator;
+
+use EonX\EasyServerless\Messenger\Listener\ResetServicesListener;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    $services = $containerConfigurator->services();
+    $services->defaults()
+        ->autowire()
+        ->autoconfigure();
+
+    $services->set(ResetServicesListener::class)
+        ->arg('$servicesResetter', service('services_resetter'));
+};

packages/EasyServerless/src/Messenger/Listener/ResetServicesListener.php

@@ -0,0 +1,22 @@
+<?php
+declare(strict_types=1);
+
+namespace EonX\EasyServerless\Messenger\Listener;
+
+use EonX\EasyServerless\Messenger\Event\EnvelopeDispatchedEvent;
+use Symfony\Component\EventDispatcher\Attribute\AsEventListener;
+use Symfony\Component\HttpKernel\DependencyInjection\ServicesResetter;
+
+#[AsEventListener(priority: -1024)]
+final readonly class ResetServicesListener
+{
+    public function __construct(
+        private ServicesResetter $servicesResetter,
+    ) {
+    }
+
+    public function __invoke(EnvelopeDispatchedEvent $event): void
+    {
+        $this->servicesResetter->reset();
+    }
+}

packages/EasyServerless/tests/Fixture/config/sqs_reset_services_disabled.php

@@ -0,0 +1,14 @@
+<?php
+declare(strict_types=1);
+
+namespace Symfony\Component\DependencyInjection\Loader\Configurator;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    $containerConfigurator->extension('easy_serverless', [
+        'sqs' => [
+            'reset_services' => [
+                'enabled' => false,
+            ],
+        ],
+    ]);
+};

packages/EasyServerless/tests/Stub/Kernel/KernelStub.php

@@ -5,12 +5,20 @@
 
 use Bref\Symfony\Messenger\Service\BusDriver;
 use EonX\EasyServerless\Bundle\EasyServerlessBundle;
+use Psr\Log\NullLogger;
 use Symfony\Component\Config\Loader\LoaderInterface;
+use Symfony\Component\DependencyInjection\Argument\IteratorArgument;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\ServiceLocator;
+use Symfony\Component\HttpKernel\DependencyInjection\ServicesResetter;
 use Symfony\Component\HttpKernel\Kernel;
 use Symfony\Component\HttpKernel\KernelInterface;
+use Symfony\Component\Messenger\MessageBus;
+use Symfony\Component\Messenger\MessageBusInterface;
+use Symfony\Component\Messenger\Transport\Serialization\PhpSerializer;
+use Symfony\Component\Messenger\Transport\Serialization\SerializerInterface;
 
 final class KernelStub extends Kernel implements CompilerPassInterface
 {
@@ -19,15 +27,23 @@ final class KernelStub extends Kernel implements CompilerPassInterface
      */
     private readonly array $configs;
 
+    /**
+     * @var \Symfony\Component\HttpKernel\Bundle\BundleInterface[]
+     */
+    private readonly array $extraBundles;
+
     /**
      * @param string[]|null $configs
+     * @param \Symfony\Component\HttpKernel\Bundle\BundleInterface[]|null $bundles
      */
     public function __construct(
         string $environment,
         bool $debug,
         ?array $configs = null,
+        ?array $bundles = null,
     ) {
         $this->configs = $configs ?? [];
+        $this->extraBundles = $bundles ?? [];
 
         parent::__construct($environment, $debug);
     }
@@ -40,6 +56,23 @@ public function process(ContainerBuilder $container): void
         );
         $container->setAlias(KernelInterface::class, 'kernel');
         $container->setDefinition(BusDriver::class, new Definition(BusDriver::class));
+        $container->setDefinition(NullLogger::class, new Definition(NullLogger::class));
+        $container->setAlias('logger', NullLogger::class);
+        $container->setDefinition(
+            MessageBus::class,
+            (new Definition(MessageBus::class))->setArguments([[]])
+        );
+        $container->setAlias(MessageBusInterface::class, MessageBus::class);
+        $container->setDefinition(PhpSerializer::class, new Definition(PhpSerializer::class));
+        $container->setAlias(SerializerInterface::class, PhpSerializer::class);
+        $container->setDefinition(
+            'messenger.retry_strategy_locator',
+            (new Definition(ServiceLocator::class))->setArguments([[]])
+        );
+        $container->setDefinition(
+            'services_resetter',
+            (new Definition(ServicesResetter::class))->setArguments([new IteratorArgument([]), []])
+        );
 
         foreach ($container->getDefinitions() as $definition) {
             $definition->setPublic(true);
@@ -56,6 +89,10 @@ public function process(ContainerBuilder $container): void
     public function registerBundles(): iterable
     {
         yield new EasyServerlessBundle();
+
+        foreach ($this->extraBundles as $bundle) {
+            yield $bundle;
+        }
     }
 
     public function registerContainerConfiguration(LoaderInterface $loader): void

packages/EasyServerless/tests/Unit/AbstractSymfonyTestCase.php

@@ -12,14 +12,15 @@ abstract class AbstractSymfonyTestCase extends AbstractUnitTestCase
 
     /**
      * @param string[]|null $configs
+     * @param \Symfony\Component\HttpKernel\Bundle\BundleInterface[]|null $bundles
      */
-    protected function getKernel(?array $configs = null): KernelInterface
+    protected function getKernel(?array $configs = null, ?array $bundles = null): KernelInterface
     {
-        if ($this->kernel !== null && $configs === null) {
+        if ($this->kernel !== null && $configs === null && $bundles === null) {
             return $this->kernel;
         }
 
-        $this->kernel = new KernelStub('test', true, $configs);
+        $this->kernel = new KernelStub('test', true, $configs, $bundles);
         $this->kernel->boot();
 
         return $this->kernel;

packages/EasyServerless/tests/Unit/bundle/EasyServerlessBundleTest.php

@@ -3,20 +3,42 @@
 
 namespace EonX\EasyServerless\Tests\Unit\Bundle;
 
+use Bref\Symfony\Messenger\BrefMessengerBundle;
 use EonX\EasyServerless\Bundle\Enum\ConfigParam;
+use EonX\EasyServerless\Messenger\Listener\ResetServicesListener;
 use EonX\EasyServerless\Monolog\Processor\PhpSourceProcessor;
 use EonX\EasyServerless\Tests\Unit\AbstractSymfonyTestCase;
 
 final class EasyServerlessBundleTest extends AbstractSymfonyTestCase
 {
     public function testDisableMonologSucceeds(): void
     {
-        $container = $this->getKernel([__DIR__ . '/../../Fixture/config/monolog_disabled.php'])
-            ->getContainer();
+        $container = $this->getKernel(
+            configs: [__DIR__ . '/../../Fixture/config/monolog_disabled.php']
+        )->getContainer();
 
         self::assertFalse($container->has(PhpSourceProcessor::class));
     }
 
+    public function testDisableResetServicesSucceeds(): void
+    {
+        $container = $this->getKernel(
+            configs: [__DIR__ . '/../../Fixture/config/sqs_reset_services_disabled.php'],
+            bundles: [new BrefMessengerBundle()]
+        )->getContainer();
+
+        self::assertFalse($container->has(ResetServicesListener::class));
+    }
+
+    public function testResetServicesEnabledByDefault(): void
+    {
+        $container = $this->getKernel(
+            bundles: [new BrefMessengerBundle()]
+        )->getContainer();
+
+        self::assertTrue($container->has(ResetServicesListener::class));
+    }
+
     public function testSanity(): void
     {
         $container = $this->getKernel()