MAGECLOUD-3611: Multi-threaded SCD Doesn’t Work as Expected

patches.json

@@ -159,6 +159,12 @@
       "2.1.4 - 2.1.17": "MC-5964__preauth_sql__2.1.4.patch",
       "2.2.0 - 2.2.7": "MC-5964__preauth_sql__2.2.0.patch",
       "2.3.0": "MC-5964__preauth_sql__2.3.0.patch"
+    },
+    "Multi-thread SCD": {
+      "2.2.0 - 2.2.3": "MAGECLOUD_3611_multi_thread_scd__2.2.0.patch",
+      "2.2.4 - 2.2.9": "MAGECLOUD_3611_multi_thread_scd__2.2.4.patch",
+      "2.3.0 - 2.3.1": "MAGECLOUD_3611_multi_thread_scd__2.3.0.patch",
+      "2.3.2": "MAGECLOUD_3611_multi_thread_scd__2.3.2.patch"
     }
   },
   "monolog/monolog": {

patches/MAGECLOUD_3611_multi_thread_scd__2.2.0.patch

@@ -0,0 +1,63 @@
+diff -Naur a/vendor/magento/module-deploy/Process/Queue.php b/vendor/magento/module-deploy/Process/Queue.php
+index e5e10c8f54a..85ef6514432 100644
+--- a/vendor/magento/module-deploy/Process/Queue.php
++++ b/vendor/magento/module-deploy/Process/Queue.php
+@@ -291,12 +291,30 @@ class Queue
+     {
+         if ($this->isCanBeParalleled()) {
+             if ($package->getState() === null) {
+-                $pid = pcntl_waitpid($this->getPid($package), $status, WNOHANG);
+-                if ($pid === $this->getPid($package)) {
++                $pid = $this->getPid($package);
++                if ($pid === null) {
++                    return false;
++                }
++                $result = pcntl_waitpid($pid, $status, WNOHANG);
++                if ($result === $pid) {
+                     $package->setState(Package::STATE_COMPLETED);
++                    $exitStatus = pcntl_wexitstatus($status);
++                    $this->logger->info(
++                        "Exited: " . $package->getPath() . "(status: $exitStatus)",
++                        [
++                            'process' => $package->getPath(),
++                            'status' => $exitStatus,
++                        ]
++                    );
+
+                     unset($this->inProgress[$package->getPath()]);
+                     return pcntl_wexitstatus($status) === 0;
++                } elseif ($result === -1) {
++                    $errno = pcntl_errno();
++                    $strerror = pcntl_strerror($errno);
++                    throw new \RuntimeException(
++                        "Error encountered checking child process status (PID: $pid): $strerror (errno: $errno)"
++                    );
+                 }
+                 return false;
+             }
+@@ -333,11 +351,23 @@ class Queue
+     public function __destruct()
+     {
+         foreach ($this->inProgress as $package) {
+-            if (pcntl_waitpid($this->getPid($package), $status) === -1) {
++            $pid = $this->getPid($package);
++            $this->logger->info(
++                "Reaping child process: {$package->getPath()} (PID: $pid)",
++                [
++                    'process' => $package->getPath(),
++                    'pid' => $pid,
++                ]
++            );
++            // phpcs:ignore Magento2.Functions.DiscouragedFunction
++            if (pcntl_waitpid($pid, $status) === -1) {
++                $errno = pcntl_errno();
++                $strerror = pcntl_strerror($errno);
+                 throw new \RuntimeException(
+-                    'Error while waiting for package deployed: ' . $this->getPid($package) . '; Status: ' . $status
++                    "Error encountered waiting for child process (PID: $pid): $strerror (errno: $errno)"
+                 );
+             }
++
+         }
+     }
+ }

patches/MAGECLOUD_3611_multi_thread_scd__2.2.4.patch

@@ -0,0 +1,245 @@
+diff -Naur a/vendor/magento/module-deploy/Process/Queue.php b/vendor/magento/module-deploy/Process/Queue.php
+index d8089457ce5b..ca75bf1acb73 100644
+--- a/vendor/magento/module-deploy/Process/Queue.php
++++ b/vendor/magento/module-deploy/Process/Queue.php
+@@ -3,14 +3,16 @@
+  * Copyright © Magento, Inc. All rights reserved.
+  * See COPYING.txt for license details.
+  */
++declare(strict_types=1);
++
+ namespace Magento\Deploy\Process;
+
+ use Magento\Deploy\Package\Package;
+ use Magento\Deploy\Service\DeployPackage;
+ use Magento\Framework\App\ResourceConnection;
+-use Psr\Log\LoggerInterface;
+ use Magento\Framework\App\State as AppState;
+ use Magento\Framework\Locale\ResolverInterface as LocaleResolver;
++use Psr\Log\LoggerInterface;
+
+ /**
+  * Deployment Queue
+@@ -125,6 +127,8 @@ public function __construct(
+     }
+
+     /**
++     * Adds deployment package.
++     *
+      * @param Package $package
+      * @param Package[] $dependencies
+      * @return bool true on success
+@@ -140,6 +144,8 @@ public function add(Package $package, array $dependencies = [])
+     }
+
+     /**
++     * Returns packages array.
++     *
+      * @return Package[]
+      */
+     public function getPackages()
+@@ -159,9 +165,11 @@ public function process()
+         $packages = $this->packages;
+         while (count($packages) && $this->checkTimeout()) {
+             foreach ($packages as $name => $packageJob) {
++                // Unsets each member of $packages array (passed by reference) as each is executed
+                 $this->assertAndExecute($name, $packages, $packageJob);
+             }
+             $this->logger->info('.');
++            // phpcs:ignore Magento2.Functions.DiscouragedFunction
+             sleep(3);
+             foreach ($this->inProgress as $name => $package) {
+                 if ($this->isDeployed($package)) {
+@@ -182,8 +190,6 @@ public function process()
+      * @param array $packages
+      * @param array $packageJob
+      * @return void
+-     *
+-     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+      */
+     private function assertAndExecute($name, array & $packages, array $packageJob)
+     {
+@@ -207,13 +213,23 @@ private function assertAndExecute($name, array & $packages, array $packageJob)
+                 }
+             }
+         }
++        $this->executePackage($package, $name, $packages, $dependenciesNotFinished);
++    }
+
++    /**
++     * Executes deployment package.
++     *
++     * @param Package $package
++     * @param string $name
++     * @param array $packages
++     * @param bool $dependenciesNotFinished
++     * @return void
++     */
++    private function executePackage(Package $package, string $name, array &$packages, bool $dependenciesNotFinished)
++    {
+         if (!$dependenciesNotFinished
+             && !$this->isDeployed($package)
+-            && (
+-                $this->maxProcesses < 2
+-                || (count($this->inProgress) < $this->maxProcesses)
+-            )
++            && ($this->maxProcesses < 2 || (count($this->inProgress) < $this->maxProcesses))
+         ) {
+             unset($packages[$name]);
+             $this->execute($package);
+@@ -234,6 +250,7 @@ private function awaitForAllProcesses()
+                 }
+             }
+             $this->logger->info('.');
++            // phpcs:ignore Magento2.Functions.DiscouragedFunction
+             sleep(5);
+         }
+         if ($this->isCanBeParalleled()) {
+@@ -243,6 +260,8 @@ private function awaitForAllProcesses()
+     }
+
+     /**
++     * Checks if can be parallel.
++     *
+      * @return bool
+      */
+     private function isCanBeParalleled()
+@@ -251,9 +270,12 @@ private function isCanBeParalleled()
+     }
+
+     /**
++     * Executes the process.
++     *
+      * @param Package $package
+      * @return bool true on success for main process and exit for child process
+      * @SuppressWarnings(PHPMD.ExitExpression)
++     * @throws \RuntimeException
+      */
+     private function execute(Package $package)
+     {
+@@ -281,6 +303,7 @@ function () use ($package) {
+         );
+
+         if ($this->isCanBeParalleled()) {
++            // phpcs:ignore Magento2.Functions.DiscouragedFunction
+             $pid = pcntl_fork();
+             if ($pid === -1) {
+                 throw new \RuntimeException('Unable to fork a new process');
+@@ -295,6 +318,7 @@ function () use ($package) {
+             // process child process
+             $this->inProgress = [];
+             $this->deployPackageService->deploy($package, $this->options, true);
++            // phpcs:ignore Magento2.Security.LanguageConstruct.ExitUsage
+             exit(0);
+         } else {
+             $this->deployPackageService->deploy($package, $this->options);
+@@ -303,6 +327,8 @@ function () use ($package) {
+     }
+
+     /**
++     * Checks if package is deployed.
++     *
+      * @param Package $package
+      * @return bool
+      */
+@@ -310,12 +336,41 @@ private function isDeployed(Package $package)
+     {
+         if ($this->isCanBeParalleled()) {
+             if ($package->getState() === null) {
+-                $pid = pcntl_waitpid($this->getPid($package), $status, WNOHANG);
+-                if ($pid === $this->getPid($package)) {
++                $pid = $this->getPid($package);
++
++                // When $pid comes back as null the child process for this package has not yet started; prevents both
++                // hanging until timeout expires (which was behaviour in 2.2.x) and the type error from strict_types
++                if ($pid === null) {
++                    return false;
++                }
++
++                // phpcs:ignore Magento2.Functions.DiscouragedFunction
++                $result = pcntl_waitpid($pid, $status, WNOHANG);
++                if ($result === $pid) {
+                     $package->setState(Package::STATE_COMPLETED);
++                    // phpcs:ignore Magento2.Functions.DiscouragedFunction
++                    $exitStatus = pcntl_wexitstatus($status);
++
++                    $this->logger->info(
++                        "Exited: " . $package->getPath() . "(status: $exitStatus)",
++                        [
++                            'process' => $package->getPath(),
++                            'status' => $exitStatus,
++                        ]
++                    );
+
+                     unset($this->inProgress[$package->getPath()]);
++                    // phpcs:ignore Magento2.Functions.DiscouragedFunction
+                     return pcntl_wexitstatus($status) === 0;
++                } elseif ($result === -1) {
++                    // phpcs:ignore Magento2.Functions.DiscouragedFunction
++                    $errno = pcntl_errno();
++                    // phpcs:ignore Magento2.Functions.DiscouragedFunction
++                    $strerror = pcntl_strerror($errno);
++
++                    throw new \RuntimeException(
++                        "Error encountered checking child process status (PID: $pid): $strerror (errno: $errno)"
++                    );
+                 }
+                 return false;
+             }
+@@ -324,17 +379,19 @@ private function isDeployed(Package $package)
+     }
+
+     /**
++     * Returns process ID or null if not found.
++     *
+      * @param Package $package
+      * @return int|null
+      */
+     private function getPid(Package $package)
+     {
+-        return isset($this->processIds[$package->getPath()])
+-            ? $this->processIds[$package->getPath()]
+-            : null;
++        return $this->processIds[$package->getPath()] ?? null;
+     }
+
+     /**
++     * Checks timeout.
++     *
+      * @return bool
+      */
+     private function checkTimeout()
+@@ -347,14 +404,31 @@ private function checkTimeout()
+      *
+      * Protect against zombie process
+      *
++     * @throws \RuntimeException
++     * @SuppressWarnings(PHPMD.UnusedLocalVariable)
+      * @return void
+      */
+     public function __destruct()
+     {
+         foreach ($this->inProgress as $package) {
+-            if (pcntl_waitpid($this->getPid($package), $status) === -1) {
++            $pid = $this->getPid($package);
++            $this->logger->info(
++                "Reaping child process: {$package->getPath()} (PID: $pid)",
++                [
++                    'process' => $package->getPath(),
++                    'pid' => $pid,
++                ]
++            );
++
++            // phpcs:ignore Magento2.Functions.DiscouragedFunction
++            if (pcntl_waitpid($pid, $status) === -1) {
++                // phpcs:ignore Magento2.Functions.DiscouragedFunction
++                $errno = pcntl_errno();
++                // phpcs:ignore Magento2.Functions.DiscouragedFunction
++                $strerror = pcntl_strerror($errno);
++
+                 throw new \RuntimeException(
+-                    'Error while waiting for package deployed: ' . $this->getPid($package) . '; Status: ' . $status
++                    "Error encountered waiting for child process (PID: $pid): $strerror (errno: $errno)"
+                 );
+             }
+         }

patches/MAGECLOUD_3611_multi_thread_scd__2.3.0.patch

@@ -0,0 +1,63 @@
+diff -Naur a/vendor/magento/module-deploy/Process/Queue.php b/vendor/magento/module-deploy/Process/Queue.php
+index e5e10c8f54a..85ef6514432 100644
+--- a/vendor/magento/module-deploy/Process/Queue.php
++++ b/vendor/magento/module-deploy/Process/Queue.php
+@@ -291,12 +291,30 @@ class Queue
+     {
+         if ($this->isCanBeParalleled()) {
+             if ($package->getState() === null) {
+-                $pid = pcntl_waitpid($this->getPid($package), $status, WNOHANG);
+-                if ($pid === $this->getPid($package)) {
++                $pid = $this->getPid($package);
++                if ($pid === null) {
++                    return false;
++                }
++                $result = pcntl_waitpid($pid, $status, WNOHANG);
++                if ($result === $pid) {
+                     $package->setState(Package::STATE_COMPLETED);
++                    $exitStatus = pcntl_wexitstatus($status);
++                    $this->logger->info(
++                        "Exited: " . $package->getPath() . "(status: $exitStatus)",
++                        [
++                            'process' => $package->getPath(),
++                            'status' => $exitStatus,
++                        ]
++                    );
+
+                     unset($this->inProgress[$package->getPath()]);
+                     return pcntl_wexitstatus($status) === 0;
++                } elseif ($result === -1) {
++                    $errno = pcntl_errno();
++                    $strerror = pcntl_strerror($errno);
++                    throw new \RuntimeException(
++                        "Error encountered checking child process status (PID: $pid): $strerror (errno: $errno)"
++                    );
+                 }
+                 return false;
+             }
+@@ -333,11 +351,23 @@ class Queue
+     public function __destruct()
+     {
+         foreach ($this->inProgress as $package) {
+-            if (pcntl_waitpid($this->getPid($package), $status) === -1) {
++            $pid = $this->getPid($package);
++            $this->logger->info(
++                "Reaping child process: {$package->getPath()} (PID: $pid)",
++                [
++                    'process' => $package->getPath(),
++                    'pid' => $pid,
++                ]
++            );
++            // phpcs:ignore Magento2.Functions.DiscouragedFunction
++            if (pcntl_waitpid($pid, $status) === -1) {
++                $errno = pcntl_errno();
++                $strerror = pcntl_strerror($errno);
+                 throw new \RuntimeException(
+-                    'Error while waiting for package deployed: ' . $this->getPid($package) . '; Status: ' . $status
++                    "Error encountered waiting for child process (PID: $pid): $strerror (errno: $errno)"
+                 );
+             }
++
+         }
+     }
+ }