MC-35903: Refactor place where lock mechanism is used regarding proper lock description

Author: vzabaznov

app/code/Magento/MessageQueue/Console/StartConsumerCommand.php

@@ -79,22 +79,20 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
         $singleThread = $input->getOption(self::OPTION_SINGLE_THREAD);
 
-        if ($singleThread && $this->lockManager->isLocked(md5($consumerName))) { //phpcs:ignore
-            $output->writeln('<error>Consumer with the same name is running</error>');
-            return \Magento\Framework\Console\Cli::RETURN_FAILURE;
-        }
-
-        if ($singleThread) {
-            $this->lockManager->lock(md5($consumerName)); //phpcs:ignore
-        }
-
-        $this->appState->setAreaCode($areaCode ?? 'global');
-
-        $consumer = $this->consumerFactory->get($consumerName, $batchSize);
-        $consumer->process($numberOfMessages);
-
-        if ($singleThread) {
-            $this->lockManager->unlock(md5($consumerName)); //phpcs:ignore
+        try {
+            if ($singleThread && !$this->lockManager->lock(md5($consumerName),0)) { //phpcs:ignore
+                $output->writeln('<error>Consumer with the same name is running</error>');
+                return \Magento\Framework\Console\Cli::RETURN_FAILURE;
+            }
+
+            $this->appState->setAreaCode($areaCode ?? 'global');
+
+            $consumer = $this->consumerFactory->get($consumerName, $batchSize);
+            $consumer->process($numberOfMessages);
+        } finally {
+            if ($singleThread) {
+                $this->lockManager->unlock(md5($consumerName)); //phpcs:ignore
+            }
         }
 
         return \Magento\Framework\Console\Cli::RETURN_SUCCESS;
@@ -163,7 +161,7 @@ protected function configure()
 To specify the preferred area:
 
     <comment>%command.full_name% someConsumer --area-code='adminhtml'</comment>
-    
+
 To do not run multiple copies of one consumer simultaneously:
 
     <comment>%command.full_name% someConsumer --single-thread'</comment>

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

@@ -47,16 +47,10 @@ public function testParallelLock(): void
     {
         $identifier1 = \uniqid('lock_name_1_', true);
 
-        $this->assertTrue($this->cacheInstance1->lock($identifier1, 2));
+        $this->assertTrue($this->cacheInstance1->lock($identifier1));
 
-        $this->assertFalse($this->cacheInstance1->lock($identifier1, 2));
-        $this->assertFalse($this->cacheInstance2->lock($identifier1, 2));
-        sleep(4);
-        $this->assertFalse($this->cacheInstance1->isLocked($identifier1));
-
-        $this->assertTrue($this->cacheInstance2->lock($identifier1, -1));
-        sleep(4);
-        $this->assertTrue($this->cacheInstance1->isLocked($identifier1));
+        $this->assertFalse($this->cacheInstance1->lock($identifier1, 0));
+        $this->assertFalse($this->cacheInstance2->lock($identifier1, 0));
     }
 
     /**
@@ -66,19 +60,16 @@ public function testParallelLock(): void
      */
     public function testParallelLockExpired(): void
     {
-        $identifier1 = \uniqid('lock_name_1_', true);
+        $lifeTime = \Closure::bind(function (Cache $class) {
+            return $class->defaultLifetime;
+        }, null, $this->cacheInstance1)($this->cacheInstance1);
 
-        $this->assertTrue($this->cacheInstance1->lock($identifier1, 1));
-        sleep(2);
-        $this->assertFalse($this->cacheInstance1->isLocked($identifier1));
+        $identifier1 = \uniqid('lock_name_1_', true);
 
-        $this->assertTrue($this->cacheInstance1->lock($identifier1, 1));
-        sleep(2);
-        $this->assertFalse($this->cacheInstance1->isLocked($identifier1));
+        $this->assertTrue($this->cacheInstance1->lock($identifier1, 0));
+        $this->assertTrue($this->cacheInstance2->lock($identifier1, $lifeTime + 1));
 
-        $this->assertTrue($this->cacheInstance2->lock($identifier1, 1));
-        sleep(2);
-        $this->assertFalse($this->cacheInstance1->isLocked($identifier1));
+        $this->cacheInstance2->unlock($identifier1);
     }
 
     /**

lib/internal/Magento/Framework/Cache/LockGuardedCacheLoader.php

@@ -131,7 +131,7 @@ public function lockedLoadData(
                 return $dataCollector();
             }
 
-            if ($this->locker->lock($lockName, $this->lockTimeout / 1000)) {
+            if ($this->locker->lock($lockName, 0)) {
                 try {
                     $data = $dataCollector();
                     $dataSaver($data);

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

@@ -31,6 +31,20 @@ class Cache implements \Magento\Framework\Lock\LockManagerInterface
      */
     private $lockSign;
 
+    /**
+     * How many microseconds to wait before re-try to acquire a lock
+     *
+     * @var int
+     */
+    private $sleepCycle = 100000;
+
+    /**
+     * Lifetime of lock data in seconds.
+     *
+     * @var int
+     */
+    private $defaultLifetime = 10;
+
     /**
      * @param FrontendInterface $cache
      */
@@ -49,14 +63,16 @@ public function lock(string $name, int $timeout = -1): bool
             $this->lockSign = $this->generateLockSign();
         }
 
-        $data = $this->cache->load($this->getIdentifier($name));
-
-        if (false !== $data) {
-             return false;
+        $skipDeadline = $timeout < 0;
+        $deadline = microtime(true) + $timeout;
+        while ($this->cache->load($this->getIdentifier($name))) {
+            if (!$skipDeadline && $deadline <= microtime(true)) {
+                return false;
+            }
+            usleep($this->sleepCycle);
         }
 
-        $timeout = $timeout <= 0 ? null : $timeout;
-        $this->cache->save($this->lockSign, $this->getIdentifier($name), [], $timeout);
+        $this->cache->save($this->lockSign, $this->getIdentifier($name), [], $this->defaultLifetime);
 
         $data = $this->cache->load($this->getIdentifier($name));