Add a nullable logger to MemoryLimitReceiver

AlptisAssurances · AlptisAssurances · commit 0d2d782b5747 · 2018-04-20T14:11:48.000+02:00
diff --git a/src/Symfony/Component/Messenger/Tests/Transport/Enhancers/MemoryLimitReceiverTest.php b/src/Symfony/Component/Messenger/Tests/Transport/Enhancers/MemoryLimitReceiverTest.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Messenger\Tests\Transport\Enhancers;
 
 use PHPUnit\Framework\TestCase;
+use Psr\Log\LoggerInterface;
 use Symfony\Component\Messenger\Tests\Fixtures\CallbackReceiver;
 use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
 use Symfony\Component\Messenger\Transport\Enhancers\MemoryLimitReceiver;
@@ -44,8 +45,11 @@ public function testReceiverStopsWhenMemoryLimitExceeded($memoryUsage, $memoryLi
             return $memoryUsage;
         };
 
-        $memoryLimitReceiver = new MemoryLimitReceiver($decoratedReceiver, $memoryLimit, $memoryResolver);
-        $memoryLimitReceiver->receive(function () {});
+        $memoryLimitReceiver = new MemoryLimitReceiver($decoratedReceiver, $memoryLimit, null, $memoryResolver);
+        $memoryLimitReceiver->receive(
+            function () {
+            }
+        );
     }
 
     public function memoryProvider()
@@ -83,4 +87,33 @@ public function invalidMemoryLimitProvider()
         yield array('128m'); // lowercase unit
         yield array('128 M'); // string with space
     }
+
+    public function testReceiverLogsMemoryExceededWhenLoggerIsGiven()
+    {
+        $callable = function ($handler) {
+            $handler(new DummyMessage('API'));
+        };
+
+        $decoratedReceiver = $this->getMockBuilder(CallbackReceiver::class)
+            ->setConstructorArgs(array($callable))
+            ->enableProxyingToOriginalMethods()
+            ->getMock();
+
+        $decoratedReceiver->expects($this->once())->method('receive');
+        $decoratedReceiver->expects($this->once())->method('stop');
+
+        $logger = $this->createMock(LoggerInterface::class);
+        $logger->expects($this->once())->method('info')
+            ->with($this->equalTo('Receiver stopped due to memory limit exceeded.'));
+
+        $memoryResolver = function () {
+            return 70 * 1024 * 1024;
+        };
+
+        $memoryLimitReceiver = new MemoryLimitReceiver($decoratedReceiver, '64M', $logger, $memoryResolver);
+        $memoryLimitReceiver->receive(
+            function () {
+            }
+        );
+    }
 }
diff --git a/src/Symfony/Component/Messenger/Tests/WorkerTest.php b/src/Symfony/Component/Messenger/Tests/WorkerTest.php
@@ -16,7 +16,6 @@
 use Symfony\Component\Messenger\MessageBusInterface;
 use Symfony\Component\Messenger\Tests\Fixtures\CallbackReceiver;
 use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
-use Symfony\Component\Messenger\Transport\ReceiverInterface;
 use Symfony\Component\Messenger\Worker;
 
 class WorkerTest extends TestCase
diff --git a/src/Symfony/Component/Messenger/Transport/Enhancers/MemoryLimitReceiver.php b/src/Symfony/Component/Messenger/Transport/Enhancers/MemoryLimitReceiver.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Messenger\Transport\Enhancers;
 
+use Psr\Log\LoggerInterface;
 use Symfony\Component\Messenger\Transport\ReceiverInterface;
 
 /**
@@ -20,12 +21,19 @@ class MemoryLimitReceiver implements ReceiverInterface
 {
     private $decoratedReceiver;
     private $memoryLimit;
+    private $logger;
     private $memoryResolver;
 
-    public function __construct(ReceiverInterface $decoratedReceiver, string $memoryLimit, callable $memoryResolver = null)
+    public function __construct(
+        ReceiverInterface $decoratedReceiver,
+        string $memoryLimit,
+        LoggerInterface $logger = null,
+        callable $memoryResolver = null
+    )
     {
         $this->decoratedReceiver = $decoratedReceiver;
         $this->memoryLimit = $this->convertToOctets($memoryLimit);
+        $this->logger = $logger;
         $this->memoryResolver = $memoryResolver ?: function () {
             return \memory_get_usage();
         };
@@ -39,6 +47,9 @@ public function receive(callable $handler): void
             $memoryResolver = $this->memoryResolver;
             if ($memoryResolver() >= $this->memoryLimit) {
                 $this->stop();
+                if ($this->logger) {
+                    $this->logger->info('Receiver stopped due to memory limit exceeded.');
+                }
             }
         });
     }
@@ -50,16 +61,16 @@ public function stop(): void
 
     private function convertToOctets(string $size): int
     {
-        if (\preg_match('/^(\d+)([G|M|K]*)$/', $size, $matches)) {
+        if (!\preg_match('/^(\d+)([G|M|K]*)$/', $size, $matches)) {
+            throw new \InvalidArgumentException('Invalid memory limit given.');
+        } else {
             if ('G' == $matches[2]) {
                 $size = $matches[1] * 1024 * 1024 * 1024;
             } elseif ('M' == $matches[2]) {
                 $size = $matches[1] * 1024 * 1024;
             } elseif ('K' == $matches[2]) {
                 $size = $matches[1] * 1024;
             }
-        } else {
-            throw new \InvalidArgumentException('Invalid memory limit given.');
         }
 
         return $size;
