Merge pull request #766 from greblov/759-chenge-command-exit-status

makasim · web-flow · commit cb084ea15363 · 2019-02-14T16:08:00.000+02:00
[consumption] Add ability to change process exit status from within queue consumer extension
diff --git a/pkg/enqueue/Consumption/Context/End.php b/pkg/enqueue/Consumption/Context/End.php
@@ -27,12 +27,23 @@ final class End
      */
     private $logger;
 
-    public function __construct(Context $context, int $startTime, int $endTime, LoggerInterface $logger)
-    {
+    /**
+     * @var int
+     */
+    private $exitStatus;
+
+    public function __construct(
+        Context $context,
+        int $startTime,
+        int $endTime,
+        LoggerInterface $logger,
+        ?int $exitStatus = null
+    ) {
         $this->context = $context;
         $this->logger = $logger;
         $this->startTime = $startTime;
         $this->endTime = $endTime;
+        $this->exitStatus = $exitStatus;
     }
 
     public function getContext(): Context
@@ -60,4 +71,9 @@ public function getEndTime(): int
     {
         return $this->startTime;
     }
+
+    public function getExitStatus(): ?int
+    {
+        return $this->exitStatus;
+    }
 }
diff --git a/pkg/enqueue/Consumption/Context/PostConsume.php b/pkg/enqueue/Consumption/Context/PostConsume.php
@@ -43,6 +43,11 @@ final class PostConsume
      */
     private $executionInterrupted;
 
+    /**
+     * @var int
+     */
+    private $exitStatus;
+
     public function __construct(Context $context, SubscriptionConsumer $subscriptionConsumer, int $receivedMessagesCount, int $cycle, int $startTime, LoggerInterface $logger)
     {
         $this->context = $context;
@@ -85,13 +90,19 @@ public function getLogger(): LoggerInterface
         return $this->logger;
     }
 
+    public function getExitStatus(): ?int
+    {
+        return $this->exitStatus;
+    }
+
     public function isExecutionInterrupted(): bool
     {
         return $this->executionInterrupted;
     }
 
-    public function interruptExecution(): void
+    public function interruptExecution(?int $exitStatus = null): void
     {
+        $this->exitStatus = $exitStatus;
         $this->executionInterrupted = true;
     }
 }
diff --git a/pkg/enqueue/Consumption/Context/PostMessageReceived.php b/pkg/enqueue/Consumption/Context/PostMessageReceived.php
@@ -45,6 +45,11 @@ final class PostMessageReceived
      */
     private $executionInterrupted;
 
+    /**
+     * @var int
+     */
+    private $exitStatus;
+
     public function __construct(
         Context $context,
         Consumer $consumer,
@@ -89,20 +94,26 @@ public function getReceivedAt(): int
     }
 
     /**
-     * @return Result|null|object|string
+     * @return Result|object|string|null
      */
     public function getResult()
     {
         return $this->result;
     }
 
+    public function getExitStatus(): ?int
+    {
+        return $this->exitStatus;
+    }
+
     public function isExecutionInterrupted(): bool
     {
         return $this->executionInterrupted;
     }
 
-    public function interruptExecution(): void
+    public function interruptExecution(?int $exitStatus = null): void
     {
+        $this->exitStatus = $exitStatus;
         $this->executionInterrupted = true;
     }
 }
diff --git a/pkg/enqueue/Consumption/Context/PreConsume.php b/pkg/enqueue/Consumption/Context/PreConsume.php
@@ -43,6 +43,11 @@ final class PreConsume
      */
     private $executionInterrupted;
 
+    /**
+     * @var int
+     */
+    private $exitStatus;
+
     public function __construct(Context $context, SubscriptionConsumer $subscriptionConsumer, LoggerInterface $logger, int $cycle, int $receiveTimeout, int $startTime)
     {
         $this->context = $context;
@@ -85,13 +90,19 @@ public function getStartTime(): int
         return $this->startTime;
     }
 
+    public function getExitStatus(): ?int
+    {
+        return $this->exitStatus;
+    }
+
     public function isExecutionInterrupted(): bool
     {
         return $this->executionInterrupted;
     }
 
-    public function interruptExecution(): void
+    public function interruptExecution(?int $exitStatus = null): void
     {
+        $this->exitStatus = $exitStatus;
         $this->executionInterrupted = true;
     }
 }
diff --git a/pkg/enqueue/Consumption/Context/Start.php b/pkg/enqueue/Consumption/Context/Start.php
@@ -38,6 +38,11 @@ final class Start
      */
     private $executionInterrupted;
 
+    /**
+     * @var int
+     */
+    private $exitStatus;
+
     /**
      * @param BoundProcessor[] $processors
      */
@@ -105,13 +110,19 @@ public function changeBoundProcessors(array $processors): void
         });
     }
 
+    public function getExitStatus(): ?int
+    {
+        return $this->exitStatus;
+    }
+
     public function isExecutionInterrupted(): bool
     {
         return $this->executionInterrupted;
     }
 
-    public function interruptExecution(): void
+    public function interruptExecution(?int $exitStatus = null): void
     {
+        $this->exitStatus = $exitStatus;
         $this->executionInterrupted = true;
     }
 }
diff --git a/pkg/enqueue/Consumption/Extension/ExitStatusExtension.php b/pkg/enqueue/Consumption/Extension/ExitStatusExtension.php
@@ -0,0 +1,24 @@
+<?php
+
+namespace Enqueue\Consumption\Extension;
+
+use Enqueue\Consumption\Context\End;
+use Enqueue\Consumption\EndExtensionInterface;
+
+class ExitStatusExtension implements EndExtensionInterface
+{
+    /**
+     * @var int
+     */
+    private $exitStatus;
+
+    public function onEnd(End $context): void
+    {
+        $this->exitStatus = $context->getExitStatus();
+    }
+
+    public function getExitStatus(): ?int
+    {
+        return $this->exitStatus;
+    }
+}
diff --git a/pkg/enqueue/Consumption/QueueConsumer.php b/pkg/enqueue/Consumption/QueueConsumer.php
@@ -147,7 +147,7 @@ public function consume(ExtensionInterface $runtimeExtension = null): void
         $extension->onStart($start);
 
         if ($start->isExecutionInterrupted()) {
-            $this->onEnd($extension, $startTime);
+            $this->onEnd($extension, $startTime, $start->getExitStatus());
 
             return;
         }
@@ -256,7 +256,7 @@ public function consume(ExtensionInterface $runtimeExtension = null): void
             $extension->onPreConsume($preConsume);
 
             if ($preConsume->isExecutionInterrupted()) {
-                $this->onEnd($extension, $startTime, $subscriptionConsumer);
+                $this->onEnd($extension, $startTime, $preConsume->getExitStatus(), $subscriptionConsumer);
 
                 return;
             }
@@ -267,7 +267,7 @@ public function consume(ExtensionInterface $runtimeExtension = null): void
             $extension->onPostConsume($postConsume);
 
             if ($interruptExecution || $postConsume->isExecutionInterrupted()) {
-                $this->onEnd($extension, $startTime, $subscriptionConsumer);
+                $this->onEnd($extension, $startTime, $postConsume->getExitStatus(), $subscriptionConsumer);
 
                 return;
             }
@@ -286,11 +286,12 @@ public function setFallbackSubscriptionConsumer(SubscriptionConsumer $fallbackSu
         $this->fallbackSubscriptionConsumer = $fallbackSubscriptionConsumer;
     }
 
-    private function onEnd(ExtensionInterface $extension, int $startTime, SubscriptionConsumer $subscriptionConsumer = null): void
+    private function onEnd(ExtensionInterface $extension, int $startTime, ?int $exitStatus = null, SubscriptionConsumer $subscriptionConsumer = null): void
     {
         $endTime = (int) (microtime(true) * 1000);
 
-        $extension->onEnd(new End($this->interopContext, $startTime, $endTime, $this->logger));
+        $endContext = new End($this->interopContext, $startTime, $endTime, $this->logger, $exitStatus);
+        $extension->onEnd($endContext);
 
         if ($subscriptionConsumer) {
             $subscriptionConsumer->unsubscribeAll();
diff --git a/pkg/enqueue/Symfony/Client/ConsumeCommand.php b/pkg/enqueue/Symfony/Client/ConsumeCommand.php
@@ -4,6 +4,7 @@
 
 use Enqueue\Client\DriverInterface;
 use Enqueue\Consumption\ChainExtension;
+use Enqueue\Consumption\Extension\ExitStatusExtension;
 use Enqueue\Consumption\Extension\LoggerExtension;
 use Enqueue\Consumption\ExtensionInterface;
 use Enqueue\Consumption\QueueConsumerInterface;
@@ -143,9 +144,12 @@ protected function execute(InputInterface $input, OutputInterface $output): ?int
             $consumer->bind($queue, $processor);
         }
 
-        $consumer->consume($this->getRuntimeExtensions($input, $output));
+        $runtimeExtensionChain = $this->getRuntimeExtensions($input, $output);
+        $exitStatusExtension = new ExitStatusExtension();
 
-        return null;
+        $consumer->consume(new ChainExtension([$runtimeExtensionChain, $exitStatusExtension]));
+
+        return $exitStatusExtension->getExitStatus();
     }
 
     protected function getRuntimeExtensions(InputInterface $input, OutputInterface $output): ExtensionInterface
diff --git a/pkg/enqueue/Symfony/Consumption/ConsumeCommand.php b/pkg/enqueue/Symfony/Consumption/ConsumeCommand.php
@@ -3,6 +3,7 @@
 namespace Enqueue\Symfony\Consumption;
 
 use Enqueue\Consumption\ChainExtension;
+use Enqueue\Consumption\Extension\ExitStatusExtension;
 use Enqueue\Consumption\QueueConsumerInterface;
 use Psr\Container\ContainerInterface;
 use Psr\Container\NotFoundExceptionInterface;
@@ -75,9 +76,12 @@ protected function execute(InputInterface $input, OutputInterface $output): ?int
             array_unshift($extensions, $loggerExtension);
         }
 
+        $exitStatusExtension = new ExitStatusExtension();
+        array_unshift($extensions, $exitStatusExtension);
+
         $consumer->consume(new ChainExtension($extensions));
 
-        return null;
+        return $exitStatusExtension->getExitStatus();
     }
 
     private function getQueueConsumer(string $name): QueueConsumerInterface
diff --git a/pkg/enqueue/Tests/Consumption/QueueConsumerTest.php b/pkg/enqueue/Tests/Consumption/QueueConsumerTest.php
@@ -16,6 +16,7 @@
 use Enqueue\Consumption\Context\ProcessorException;
 use Enqueue\Consumption\Context\Start;
 use Enqueue\Consumption\Exception\InvalidArgumentException;
+use Enqueue\Consumption\Extension\ExitStatusExtension;
 use Enqueue\Consumption\ExtensionInterface;
 use Enqueue\Consumption\QueueConsumer;
 use Enqueue\Consumption\Result;
@@ -1429,6 +1430,29 @@ public function testShouldCallProcessorAsMessageComeAlong()
         $this->assertSame($fooConsumerStub, $actualContexts[2]->getConsumer());
     }
 
+    public function testCaptureExitStatus()
+    {
+        $testExitCode = 5;
+
+        $stubExtension = $this->createExtension();
+
+        $stubExtension
+            ->expects($this->once())
+            ->method('onStart')
+            ->with($this->isInstanceOf(Start::class))
+            ->willReturnCallback(function (Start $context) use ($testExitCode) {
+                $context->interruptExecution($testExitCode);
+            })
+        ;
+
+        $exitExtension = new ExitStatusExtension();
+
+        $consumer = new QueueConsumer($this->createContextStub(), $stubExtension);
+        $consumer->consume(new ChainExtension([$exitExtension]));
+
+        $this->assertEquals($testExitCode, $exitExtension->getExitStatus());
+    }
+
     /**
      * @return \PHPUnit_Framework_MockObject_MockObject
      */
@@ -1508,7 +1532,7 @@ private function createExtension()
     }
 
     /**
-     * @param null|mixed $queue
+     * @param mixed|null $queue
      *
      * @return \PHPUnit_Framework_MockObject_MockObject|Consumer
      */
diff --git a/pkg/enqueue/Tests/Symfony/Client/ConsumeCommandTest.php b/pkg/enqueue/Tests/Symfony/Client/ConsumeCommandTest.php
diff --git a/pkg/enqueue/Tests/Symfony/Consumption/ConsumeCommandTest.php b/pkg/enqueue/Tests/Symfony/Consumption/ConsumeCommandTest.php

Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,11 @@ final class PostConsume`
`43`	`43`	`*/`
`44`	`44`	`private $executionInterrupted;`
`45`	`45`
	`46`	`+ /**`
	`47`	`+ * @var int`
	`48`	`+ */`
	`49`	`+ private $exitStatus;`
	`50`	`+`
`46`	`51`	`public function __construct(Context $context, SubscriptionConsumer $subscriptionConsumer, int $receivedMessagesCount, int $cycle, int $startTime, LoggerInterface $logger)`
`47`	`52`	`{`
`48`	`53`	`$this->context = $context;`
`@@ -85,13 +90,19 @@ public function getLogger(): LoggerInterface`
`85`	`90`	`return $this->logger;`
`86`	`91`	`}`
`87`	`92`
	`93`	`+ public function getExitStatus(): ?int`
	`94`	`+ {`
	`95`	`+ return $this->exitStatus;`
	`96`	`+ }`
	`97`	`+`
`88`	`98`	`public function isExecutionInterrupted(): bool`
`89`	`99`	`{`
`90`	`100`	`return $this->executionInterrupted;`
`91`	`101`	`}`
`92`	`102`
`93`		`- public function interruptExecution(): void`
	`103`	`+ public function interruptExecution(?int $exitStatus = null): void`
`94`	`104`	`{`
	`105`	`+ $this->exitStatus = $exitStatus;`
`95`	`106`	`$this->executionInterrupted = true;`
`96`	`107`	`}`
`97`	`108`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,11 @@ final class PostMessageReceived`
`45`	`45`	`*/`
`46`	`46`	`private $executionInterrupted;`
`47`	`47`
	`48`	`+ /**`
	`49`	`+ * @var int`
	`50`	`+ */`
	`51`	`+ private $exitStatus;`
	`52`	`+`
`48`	`53`	`public function __construct(`
`49`	`54`	`Context $context,`
`50`	`55`	`Consumer $consumer,`
`@@ -89,20 +94,26 @@ public function getReceivedAt(): int`
`89`	`94`	`}`
`90`	`95`
`91`	`96`	`/**`
`92`		`- * @return Result\|null\|object\|string`
	`97`	`+ * @return Result\|object\|string\|null`
`93`	`98`	`*/`
`94`	`99`	`public function getResult()`
`95`	`100`	`{`
`96`	`101`	`return $this->result;`
`97`	`102`	`}`
`98`	`103`
	`104`	`+ public function getExitStatus(): ?int`
	`105`	`+ {`
	`106`	`+ return $this->exitStatus;`
	`107`	`+ }`
	`108`	`+`
`99`	`109`	`public function isExecutionInterrupted(): bool`
`100`	`110`	`{`
`101`	`111`	`return $this->executionInterrupted;`
`102`	`112`	`}`
`103`	`113`
`104`		`- public function interruptExecution(): void`
	`114`	`+ public function interruptExecution(?int $exitStatus = null): void`
`105`	`115`	`{`
	`116`	`+ $this->exitStatus = $exitStatus;`
`106`	`117`	`$this->executionInterrupted = true;`
`107`	`118`	`}`
`108`	`119`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,11 @@ final class PreConsume`
`43`	`43`	`*/`
`44`	`44`	`private $executionInterrupted;`
`45`	`45`
	`46`	`+ /**`
	`47`	`+ * @var int`
	`48`	`+ */`
	`49`	`+ private $exitStatus;`
	`50`	`+`
`46`	`51`	`public function __construct(Context $context, SubscriptionConsumer $subscriptionConsumer, LoggerInterface $logger, int $cycle, int $receiveTimeout, int $startTime)`
`47`	`52`	`{`
`48`	`53`	`$this->context = $context;`
`@@ -85,13 +90,19 @@ public function getStartTime(): int`
`85`	`90`	`return $this->startTime;`
`86`	`91`	`}`
`87`	`92`
	`93`	`+ public function getExitStatus(): ?int`
	`94`	`+ {`
	`95`	`+ return $this->exitStatus;`
	`96`	`+ }`
	`97`	`+`
`88`	`98`	`public function isExecutionInterrupted(): bool`
`89`	`99`	`{`
`90`	`100`	`return $this->executionInterrupted;`
`91`	`101`	`}`
`92`	`102`
`93`		`- public function interruptExecution(): void`
	`103`	`+ public function interruptExecution(?int $exitStatus = null): void`
`94`	`104`	`{`
	`105`	`+ $this->exitStatus = $exitStatus;`
`95`	`106`	`$this->executionInterrupted = true;`
`96`	`107`	`}`
`97`	`108`	`}`
Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,11 @@ final class Start`
`38`	`38`	`*/`
`39`	`39`	`private $executionInterrupted;`
`40`	`40`
	`41`	`+ /**`
	`42`	`+ * @var int`
	`43`	`+ */`
	`44`	`+ private $exitStatus;`
	`45`	`+`
`41`	`46`	`/**`
`42`	`47`	`* @param BoundProcessor[] $processors`
`43`	`48`	`*/`
`@@ -105,13 +110,19 @@ public function changeBoundProcessors(array $processors): void`
`105`	`110`	`});`
`106`	`111`	`}`
`107`	`112`
	`113`	`+ public function getExitStatus(): ?int`
	`114`	`+ {`
	`115`	`+ return $this->exitStatus;`
	`116`	`+ }`
	`117`	`+`
`108`	`118`	`public function isExecutionInterrupted(): bool`
`109`	`119`	`{`
`110`	`120`	`return $this->executionInterrupted;`
`111`	`121`	`}`
`112`	`122`
`113`		`- public function interruptExecution(): void`
	`123`	`+ public function interruptExecution(?int $exitStatus = null): void`
`114`	`124`	`{`
	`125`	`+ $this->exitStatus = $exitStatus;`
`115`	`126`	`$this->executionInterrupted = true;`
`116`	`127`	`}`
`117`	`128`	`}`