MAGECLOUD-1343: Drop Stuck Crons During Deployment Process (#103)

Author: oshmyheliuk

src/App/Container.php

@@ -96,6 +96,7 @@ public function __construct(string $root, array $config)
                         $this->make(DeployProcess\InstallUpdate::class),
                         $this->make(DeployProcess\DeployStaticContent::class),
                         $this->make(DeployProcess\DisableGoogleAnalytics::class),
+                        $this->make(DeployProcess\UnlockCronJobs::class)
                     ],
                 ]);
             });

src/Process/Deploy/UnlockCronJobs.php

@@ -0,0 +1,74 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\MagentoCloud\Process\Deploy;
+
+use Magento\MagentoCloud\DB\ConnectionInterface;
+use Magento\MagentoCloud\Process\ProcessInterface;
+use Psr\Log\LoggerInterface;
+
+/**
+ * Updates running cron jobs.
+ *
+ * In magento version 2.2 was implemented locking functionality for cron jobs, new cron jobs can't be started
+ * if exist job in status 'running' with same 'job_code'.
+ * This process are used for unlocking cron jobs that stuck in 'running' status.
+ */
+class UnlockCronJobs implements ProcessInterface
+{
+    const STATUS_RUNNING = 'running';
+    const STATUS_MISSED = 'missed';
+
+    /**
+     * @var ConnectionInterface
+     */
+    private $connection;
+
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
+    /**
+     * @param ConnectionInterface $connection
+     * @param LoggerInterface $logger
+     */
+    public function __construct(
+        ConnectionInterface $connection,
+        LoggerInterface $logger
+    ) {
+        $this->connection = $connection;
+        $this->logger = $logger;
+    }
+
+    /**
+     * Updates running cron jobs to status 'missed'.
+     *
+     * {@inheritdoc}
+     */
+    public function execute()
+    {
+        $updateCronStatusQuery = 'UPDATE `cron_schedule` SET `status` = :to_status WHERE `status` = :from_status';
+
+        $updatedJobsCount = $this->connection->affectingQuery(
+            $updateCronStatusQuery,
+            [
+                ':to_status' => self::STATUS_MISSED,
+                ':from_status' => self::STATUS_RUNNING
+            ]
+        );
+
+        if ($updatedJobsCount) {
+            $this->logger->info(
+                sprintf(
+                    '%d cron jobs were updated from status "%s" to status "%s"',
+                    $updatedJobsCount,
+                    self::STATUS_RUNNING,
+                    self::STATUS_MISSED
+                )
+            );
+        }
+    }
+}

src/Test/Unit/Process/Deploy/UnlockCronJobsTest.php

@@ -0,0 +1,77 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\MagentoCloud\Test\Unit\Process\Deploy;
+
+use Magento\MagentoCloud\Process\Deploy\UnlockCronJobs;
+use PHPUnit\Framework\TestCase;
+use PHPUnit_Framework_MockObject_MockObject as Mock;
+use Psr\Log\LoggerInterface;
+use Magento\MagentoCloud\DB\ConnectionInterface;
+
+class UnlockCronJobsTest extends TestCase
+{
+    /**
+     * @var LoggerInterface|Mock
+     */
+    private $loggerMock;
+
+    /**
+     * @var ConnectionInterface|Mock
+     */
+    private $connectionMock;
+
+    /**
+     * @var UnlockCronJobs
+     */
+    private $process;
+
+    protected function setUp()
+    {
+        $this->loggerMock = $this->getMockForAbstractClass(LoggerInterface::class);
+        $this->connectionMock = $this->getMockForAbstractClass(ConnectionInterface::class);
+
+        $this->process = new UnlockCronJobs(
+            $this->connectionMock,
+            $this->loggerMock
+        );
+    }
+
+    public function testExecute()
+    {
+        $this->updateCronJobs(5);
+        $this->loggerMock->expects($this->once())
+            ->method('info')
+            ->with('5 cron jobs were updated from status "running" to status "missed"');
+
+        $this->process->execute();
+    }
+
+    public function testExecuteNoJobsUpdated()
+    {
+        $this->updateCronJobs(0);
+        $this->loggerMock->expects($this->never())
+            ->method('info');
+
+        $this->process->execute();
+    }
+
+    /**
+     * @param int $updatedRowsCount
+     */
+    private function updateCronJobs(int $updatedRowsCount)
+    {
+        $this->connectionMock->expects($this->once())
+            ->method('affectingQuery')
+            ->with(
+                'UPDATE `cron_schedule` SET `status` = :to_status WHERE `status` = :from_status',
+                [
+                    ':to_status' => UnlockCronJobs::STATUS_MISSED,
+                    ':from_status' => UnlockCronJobs::STATUS_RUNNING
+                ]
+            )
+            ->willReturn($updatedRowsCount);
+    }
+}