[Messenger] Add call to gc_collect_cycles() after each message is handled

jwage · nicolas-grekas · commit b0df65ae9aeb · 2023-10-25T18:15:11.000+02:00
diff --git a/src/Symfony/Component/Messenger/Tests/WorkerTest.php b/src/Symfony/Component/Messenger/Tests/WorkerTest.php
@@ -578,6 +578,25 @@ public function testFlushBatchOnStop()
 
         $this->assertSame($expectedMessages, $handler->processedMessages);
     }
+
+    public function testGcCollectCyclesIsCalledOnMessageHandle()
+    {
+        $apiMessage = new DummyMessage('API');
+
+        $receiver = new DummyReceiver([[new Envelope($apiMessage)]]);
+
+        $bus = $this->createMock(MessageBusInterface::class);
+
+        $dispatcher = new EventDispatcher();
+        $dispatcher->addSubscriber(new StopWorkerOnMessageLimitListener(1));
+
+        $worker = new Worker(['transport' => $receiver], $bus, $dispatcher);
+        $worker->run();
+
+        $gcStatus = gc_status();
+
+        $this->assertGreaterThan(0, $gcStatus['runs']);
+    }
 }
 
 class DummyReceiver implements ReceiverInterface
diff --git a/src/Symfony/Component/Messenger/Worker.php b/src/Symfony/Component/Messenger/Worker.php
@@ -118,6 +118,8 @@ public function run(array $options = []): void
                 // this should prevent multiple lower priority receivers from
                 // blocking too long before the higher priority are checked
                 if ($envelopeHandled) {
+                    gc_collect_cycles();
+
                     break;
                 }
             }

Original file line number	Diff line number	Diff line change
`@@ -118,6 +118,8 @@ public function run(array $options = []): void`
`118`	`118`	`// this should prevent multiple lower priority receivers from`
`119`	`119`	`// blocking too long before the higher priority are checked`
`120`	`120`	`if ($envelopeHandled) {`
	`121`	`+ gc_collect_cycles();`
	`122`	`+`
`121`	`123`	`break;`
`122`	`124`	`}`
`123`	`125`	`}`