Merge pull request #7 from alextcyinnovation/add-release-memory-middleware

Add ReleaseMemoryMiddleware. Add option to clear memory before or after processing message

Author: ZhukV

src/DependencyInjection/AmqpExtension.php

@@ -340,6 +340,7 @@ private function configureExchanges(ContainerBuilder $container, array $exchange
             $exchangeFactoryServiceId = \sprintf('fivelab.amqp.exchange_factory.%s', $key);
             $exchangeFactoryServiceDef = new Definition(ExchangeFactoryInterface::class);
             $exchangeFactoryServiceDef->setFactory([new Reference($this->driverFactories[$exchange['connection']]), 'createExchangeFactory']);
+
             $exchangeFactoryServiceDef->setArguments([
                 new Reference($this->defaultChannelFactories[$exchange['connection']]),
                 new Reference($exchangeDefinitionServiceId),
@@ -496,6 +497,7 @@ private function configureQueues(ContainerBuilder $container, array $queues, arr
             $queueFactoryServiceId = \sprintf('fivelab.amqp.queue_factory.%s', $key);
             $queueFactoryServiceDef = new Definition(QueueFactoryInterface::class);
             $queueFactoryServiceDef->setFactory([new Reference($this->driverFactories[$queue['connection']]), 'createQueueFactory']);
+
             $queueFactoryServiceDef->setArguments([
                 new Reference($this->defaultChannelFactories[$queue['connection']]),
                 new Reference($queueDefinitionServiceId),

src/Middleware/ReleaseMemoryMiddleware.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace FiveLab\Bundle\AmqpBundle\Middleware;
+
+use FiveLab\Component\Amqp\Consumer\Middleware\ConsumerMiddlewareInterface;
+use FiveLab\Component\Amqp\Message\ReceivedMessage;
+use Symfony\Contracts\Service\ResetInterface;
+
+class ReleaseMemoryMiddleware implements ConsumerMiddlewareInterface
+{
+    public function __construct(private ResetInterface $servicesResetter, private bool $clearBeforeHandle = false)
+    {
+    }
+
+    public function handle(ReceivedMessage $message, callable $next): void
+    {
+        if (true === $this->clearBeforeHandle) {
+            $this->resetMemory();
+        }
+
+        try {
+            $next($message);
+        } finally {
+            if (false === $this->clearBeforeHandle) {
+                $this->resetMemory();
+            }
+        }
+    }
+
+    private function resetMemory(): void
+    {
+        $this->servicesResetter->reset();
+
+        \gc_collect_cycles();
+    }
+}

tests/DependencyInjection/AmqpExtensionConfigureConsumersTest.php

@@ -123,6 +123,7 @@ public function shouldSuccessConfigureSingleConsumer(): void
 
         // Verify registry
         $this->assertContainerBuilderHasService('fivelab.amqp.consumer_registry', ContainerConsumerRegistry::class);
+
         $this->assertContainerBuilderHasServiceDefinitionWithServiceLocatorArgument('fivelab.amqp.consumer_registry', 0, [
             'foo' => 'fivelab.amqp.consumer.foo',
         ]);
@@ -147,6 +148,7 @@ public function shouldSuccessConfigureWithChecker(): void
         ]);
 
         $this->assertContainerBuilderHasService('fivelab.amqp.consumer_checker_registry', ContainerRunConsumerCheckerRegistry::class);
+
         $this->assertContainerBuilderHasServiceDefinitionWithServiceLocatorArgument('fivelab.amqp.consumer_checker_registry', 0, [
             'bla' => 'default_checker',
         ]);

tests/Middleware/ReleaseMemoryMiddlewareTest.php

@@ -0,0 +1,78 @@
+<?php
+
+/*
+ * This file is part of the FiveLab AmqpBundle package
+ *
+ * (c) FiveLab
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code
+ */
+
+declare(strict_types = 1);
+
+namespace FiveLab\Bundle\AmqpBundle\Tests\Middleware;
+
+use FiveLab\Bundle\AmqpBundle\Middleware\ReleaseMemoryMiddleware;
+use FiveLab\Component\Amqp\Message\ReceivedMessage;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+use Symfony\Contracts\Service\ResetInterface;
+
+class ReleaseMemoryMiddlewareTest extends TestCase
+{
+    private ResetInterface $servicesResetter;
+
+    protected function setUp(): void
+    {
+        $this->servicesResetter = $this->createMock(ResetInterface::class);
+    }
+
+    #[Test]
+    public function clearMemoryBeforeMessage(): void
+    {
+        $alreadyReset = false;
+        $message = $this->createMock(ReceivedMessage::class);
+
+        $next = function (ReceivedMessage $message) use (&$alreadyReset) {
+            $this->assertTrue($alreadyReset);
+        };
+
+        $this->servicesResetter
+            ->expects($this->once())
+            ->method('reset')
+            ->willReturnCallback(function () use (&$alreadyReset): void {
+                $alreadyReset = true;
+            });
+
+        $this->getMiddleware(true)->handle($message, $next);
+    }
+
+    #[Test]
+    public function clearMemoryOnlyAfterMessage(): void
+    {
+        $alreadyReset = false;
+        $message = $this->createMock(ReceivedMessage::class);
+
+        $next = function (ReceivedMessage $message) use (&$alreadyReset) {
+            $this->assertFalse($alreadyReset);
+        };
+
+        $this->servicesResetter
+            ->expects($this->once())
+            ->method('reset')
+            ->willReturnCallback(function () use (&$alreadyReset): void {
+                $alreadyReset = true;
+            });
+
+        $this->getMiddleware(false)->handle($message, $next);
+    }
+
+    private function getMiddleware(bool $clearBeforeMessage): ReleaseMemoryMiddleware
+    {
+        return new ReleaseMemoryMiddleware(
+            $this->servicesResetter,
+            $clearBeforeMessage
+        );
+    }
+}