MAGETWO-98151: Add support ZooKeeper locks

Author: BaDos

dev/tests/integration/testsuite/Magento/Framework/Lock/Backend/ZookeeperTest.php

@@ -88,4 +88,3 @@ public function testUnlockWithoutExistingLock()
         $this->assertFalse($this->model->unlock($name));
     }
 }
-

lib/internal/Magento/Framework/Lock/Backend/Zookeeper.php

@@ -101,7 +101,8 @@ public function __construct(string $host, string $path = self::DEFAULT_PATH)
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
+     *
      * You can see the lock algorithm by the link
      * @link https://zookeeper.apache.org/doc/r3.1.2/recipes.html#sc_recipes_Locks
      *
@@ -124,7 +125,7 @@ public function lock(string $name, int $timeout = -1): bool
             throw new RuntimeException(new Phrase('Failed creating lock %1', [$lockPath]));
         }
 
-        while($this->isAnyLock($lockKey, $this->getIndex($lockKey))) {
+        while ($this->isAnyLock($lockKey, $this->getIndex($lockKey))) {
             if (!$skipDeadline && $deadline <= microtime(true)) {
                 $this->getProvider()->delete($lockKey);
                 return false;
@@ -139,7 +140,8 @@ public function lock(string $name, int $timeout = -1): bool
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
+     *
      * @throws RuntimeException
      */
     public function unlock(string $name): bool
@@ -152,7 +154,8 @@ public function unlock(string $name): bool
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
+     *
      * @throws RuntimeException
      */
     public function isLocked(string $name): bool
@@ -184,7 +187,7 @@ private function getProvider(): \Zookeeper
         }
 
         $deadline = microtime(true) + $this->connectionTimeout;
-        while($this->zookeeper->getState() != \Zookeeper::CONNECTED_STATE) {
+        while ($this->zookeeper->getState() != \Zookeeper::CONNECTED_STATE) {
             if ($deadline <= microtime(true)) {
                 throw new RuntimeException(new Phrase('Zookeeper connection timed out!'));
             }
@@ -227,16 +230,17 @@ private function checkAndCreateParentNode(string $path): bool
      */
     private function getIndex(string $key)
     {
-        if (!preg_match('/' . $this->lockName . '([0-9]+)$/', $key, $matches))
+        if (!preg_match('/' . $this->lockName . '([0-9]+)$/', $key, $matches)) {
             return null;
+        }
 
         return intval($matches[1]);
     }
 
     /**
      * Checks if there is any sequence node under parent of $fullKey.
-     * At first checks that the $fullKey node is present, if not - returns false.
      *
+     * At first checks that the $fullKey node is present, if not - returns false.
      * If $indexKey is non-null and there is a smaller index than $indexKey then returns true,
      * otherwise returns false.
      *
@@ -255,14 +259,14 @@ private function isAnyLock(string $fullKey, int $indexKey = null): bool
 
         $children = $this->getProvider()->getChildren($parent);
 
-        if (is_null($indexKey) && !empty($children)) {
+        if (null === $indexKey && !empty($children)) {
             return true;
         }
 
         foreach ($children as $childKey) {
             $childIndex = $this->getIndex($childKey);
 
-            if (is_null($childIndex)) {
+            if (null === $childIndex) {
                 continue;
             }
 

lib/internal/Magento/Framework/Lock/Proxy.php

@@ -37,7 +37,8 @@ public function __construct(LockBackendFactory $factory)
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
+     *
      * @throws RuntimeException
      */
     public function isLocked(string $name): bool
@@ -46,7 +47,8 @@ public function isLocked(string $name): bool
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
+     *
      * @throws RuntimeException
      */
     public function lock(string $name, int $timeout = -1): bool
@@ -55,7 +57,8 @@ public function lock(string $name, int $timeout = -1): bool
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
+     *
      * @throws RuntimeException
      */
     public function unlock(string $name): bool

setup/src/Magento/Setup/Model/ConfigOptionsList/Lock.php

@@ -212,9 +212,9 @@ private function validateZookeeperConfig(array $options, DeploymentConfig $deplo
 
         $host = $options[self::INPUT_KEY_LOCK_ZOOKEEPER_HOST]
             ?? $deploymentConfig->get(
-                   self::CONFIG_PATH_LOCK_ZOOKEEPER_HOST,
-                   $this->getDefaultValue(self::INPUT_KEY_LOCK_ZOOKEEPER_HOST)
-               );
+                self::CONFIG_PATH_LOCK_ZOOKEEPER_HOST,
+                $this->getDefaultValue(self::INPUT_KEY_LOCK_ZOOKEEPER_HOST)
+            );
         $path = $options[self::INPUT_KEY_LOCK_ZOOKEEPER_PATH]
             ?? $deploymentConfig->get(
                 self::CONFIG_PATH_LOCK_ZOOKEEPER_PATH,
@@ -251,7 +251,6 @@ private function getLockProvider(array $options, DeploymentConfig $deploymentCon
         return (string) $options[self::INPUT_KEY_LOCK_PROVIDER];
     }
 
-
     /**
      * Sets default configuration for locks
      *

setup/src/Magento/Setup/Test/Unit/Model/ConfigOptionsList/LockTest.php

@@ -163,7 +163,10 @@ public function testValidate(array $options, array $expectedResult)
         $this->deploymentConfigMock->expects($this->any())
             ->method('get')
             ->willReturnArgument(1);
-        $this->assertSame($expectedResult, $this->lockConfigOptionsList->validate($options, $this->deploymentConfigMock));
+        $this->assertSame(
+            $expectedResult,
+            $this->lockConfigOptionsList->validate($options, $this->deploymentConfigMock)
+        );
     }
 
     /**
@@ -186,10 +189,16 @@ public function validateDataProvider(): array
                     LockConfigOptionsList::INPUT_KEY_LOCK_ZOOKEEPER_HOST => '',
                     LockConfigOptionsList::INPUT_KEY_LOCK_ZOOKEEPER_PATH => '',
                 ],
-                'expectedResult' => [
-                    'Zookeeper path needs to be a non-empty string.',
-                    'Zookeeper host is should be set.',
-                ],
+                'expectedResult' => extension_loaded('zookeeper')
+                    ? [
+                        'Zookeeper path needs to be a non-empty string.',
+                        'Zookeeper host is should be set.',
+                    ]
+                    : [
+                        'php extension Zookeeper is not installed.',
+                        'Zookeeper path needs to be a non-empty string.',
+                        'Zookeeper host is should be set.',
+                    ],
             ],
         ];
     }