Reworking retry command so that it doesn't use get() unless it needs to

weaverryan · weaverryan · commit 5c32f29a831c · 2019-04-29T12:29:09.000-04:00
diff --git a/src/Symfony/Component/Messenger/Command/FailedMessagesRetryCommand.php b/src/Symfony/Component/Messenger/Command/FailedMessagesRetryCommand.php
@@ -22,6 +22,7 @@
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\Event\WorkerMessageReceivedEvent;
+use Symfony\Component\Messenger\Exception\LogicException;
 use Symfony\Component\Messenger\MessageBusInterface;
 use Symfony\Component\Messenger\Retry\RetryStrategyInterface;
 use Symfony\Component\Messenger\Transport\Receiver\ListableReceiverInterface;
@@ -109,28 +110,48 @@ protected function execute(InputInterface $input, OutputInterface $output)
                 throw new RuntimeException('Message id must be passed when in non-interactive mode.');
             }
 
-            return $this->runInteractive($io, $shouldForce);
-        }
+            $this->runInteractive($io, $shouldForce);
 
-        if (!$receiver instanceof ListableReceiverInterface) {
-            throw new RuntimeException(sprintf('The "%s" receiver does not support retrying messages by id.', $this->getReceiverName()));
+            return;
         }
 
-        foreach ($ids as $id) {
-            $envelope = $receiver->find($id);
-            if (null === $envelope) {
-                throw new RuntimeException(sprintf('The message "%s" was not found.', $id));
-            }
-
-            $singleReceiver = new SingleMessageReceiver($receiver, $envelope);
-            $this->runWorker($singleReceiver, $io, $shouldForce);
-        }
+        $this->retrySpecificIds($ids, $io, $shouldForce);
         $io->success('All done!');
     }
 
     private function runInteractive(SymfonyStyle $io, bool $shouldForce)
     {
-        $count = $this->runWorker($this->getReceiver(), $io, $shouldForce);
+        $receiver = $this->getReceiver();
+        $count = 0;
+        if ($receiver instanceof ListableReceiverInterface) {
+            // for listable receivers, find the messages one-by-one
+            // this avoids using get(), which for some less-robust
+            // transports (like Doctrine), will cause the message
+            // to be temporarily "acked", even if the user aborts
+            // handling the message
+            while (true) {
+                $ids = [];
+                foreach ($receiver->all(1) as $envelope) {
+                    $count++;
+
+                    $id = $this->getMessageId($envelope);
+                    if (null === $id) {
+                        throw new LogicException(sprintf('The "%s" receiver is able to list messages by id but the envelope is missing the TransportMessageIdStamp stamp.', $this->getReceiverName()));
+                    }
+                    $ids[] = $id;
+                }
+
+                // break the loop if all messages are consumed
+                if (0 === \count($ids)) {
+                    break;
+                }
+
+                $this->retrySpecificIds($ids, $io, $shouldForce);
+            }
+        } else {
+            // get() and ask messages one-by-one
+            $count = $this->runWorker($this->getReceiver(), $io, $shouldForce);
+        }
 
         // avoid success message if nothing was processed
         if (1 < $count) {
@@ -178,4 +199,23 @@ private function runWorker(ReceiverInterface $receiver, SymfonyStyle $io, bool $
 
         return $count;
     }
+
+    private function retrySpecificIds(array $ids, SymfonyStyle $io, bool $shouldForce)
+    {
+        $receiver = $this->getReceiver();
+
+        if (!$receiver instanceof ListableReceiverInterface) {
+            throw new RuntimeException(sprintf('The "%s" receiver does not support retrying messages by id.', $this->getReceiverName()));
+        }
+
+        foreach ($ids as $id) {
+            $envelope = $receiver->find($id);
+            if (null === $envelope) {
+                throw new RuntimeException(sprintf('The message "%s" was not found.', $id));
+            }
+
+            $singleReceiver = new SingleMessageReceiver($receiver, $envelope);
+            $this->runWorker($singleReceiver, $io, $shouldForce);
+        }
+    }
 }
