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

Author: vzabaznov

app/code/Magento/MessageQueue/Test/Unit/Console/StartConsumerCommandTest.php

@@ -103,7 +103,6 @@ public function testExecute(
         $pidFilePath,
         $singleThread,
         $lockExpects,
-        $isLockedExpects,
         $isLocked,
         $unlockExpects,
         $runProcessExpects,
@@ -144,14 +143,11 @@ public function testExecute(
             ->method('get')->with($consumerName, $batchSize)->willReturn($consumer);
         $consumer->expects($this->exactly($runProcessExpects))->method('process')->with($numberOfMessages);
 
-        $this->lockManagerMock->expects($this->exactly($isLockedExpects))
-            ->method('isLocked')
-            ->with(md5($consumerName)) //phpcs:ignore
-            ->willReturn($isLocked);
-
         $this->lockManagerMock->expects($this->exactly($lockExpects))
             ->method('lock')
-            ->with(md5($consumerName)); //phpcs:ignore
+            ->with(md5($consumerName))//phpcs:ignore
+            ->willReturn($isLocked);
+
         $this->lockManagerMock->expects($this->exactly($unlockExpects))
             ->method('unlock')
             ->with(md5($consumerName)); //phpcs:ignore
@@ -172,8 +168,7 @@ public function executeDataProvider()
                 'pidFilePath' => null,
                 'singleThread' => false,
                 'lockExpects' => 0,
-                'isLockedExpects' => 0,
-                'isLocked' => false,
+                'isLocked' => true,
                 'unlockExpects' => 0,
                 'runProcessExpects' => 1,
                 'expectedReturn' => Cli::RETURN_SUCCESS,
@@ -182,19 +177,17 @@ public function executeDataProvider()
                 'pidFilePath' => '/var/consumer.pid',
                 'singleThread' => true,
                 'lockExpects' => 1,
-                'isLockedExpects' => 1,
-                'isLocked' => false,
+                'isLocked' => true,
                 'unlockExpects' => 1,
                 'runProcessExpects' => 1,
                 'expectedReturn' => Cli::RETURN_SUCCESS,
             ],
             [
                 'pidFilePath' => '/var/consumer.pid',
                 'singleThread' => true,
-                'lockExpects' => 0,
-                'isLockedExpects' => 1,
-                'isLocked' => true,
-                'unlockExpects' => 0,
+                'lockExpects' => 1,
+                'isLocked' => false,
+                'unlockExpects' => 1,
                 'runProcessExpects' => 0,
                 'expectedReturn' => Cli::RETURN_FAILURE,
             ],

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

@@ -60,14 +60,15 @@ public function testParallelLock(): void
      */
     public function testParallelLockExpired(): void
     {
-        $lifeTime = \Closure::bind(function (Cache $class) {
-            return $class->defaultLifetime;
+        $testLifeTime = 2;
+        \Closure::bind(function (Cache $class) use ($testLifeTime) {
+            $class->defaultLifetime = $testLifeTime;
         }, null, $this->cacheInstance1)($this->cacheInstance1);
 
         $identifier1 = \uniqid('lock_name_1_', true);
 
         $this->assertTrue($this->cacheInstance1->lock($identifier1, 0));
-        $this->assertTrue($this->cacheInstance2->lock($identifier1, $lifeTime + 1));
+        $this->assertTrue($this->cacheInstance2->lock($identifier1, $testLifeTime + 1));
 
         $this->cacheInstance2->unlock($identifier1);
     }

lib/internal/Magento/Framework/Cache/Test/Unit/LockGuardedCacheLoaderTest.php

@@ -95,7 +95,7 @@ public function testDataCollectedAfterDeadlineReached(): void
 
         $this->lockManagerInterfaceMock
             ->expects($this->atLeastOnce())->method('lock')
-            ->with($lockName, 10)
+            ->with($lockName, 0)
             ->willReturn(false);
 
         $this->lockManagerInterfaceMock->expects($this->never())->method('unlock');
@@ -129,7 +129,7 @@ public function testDataWrite(): void
 
         $this->lockManagerInterfaceMock
             ->expects($this->once())->method('lock')
-            ->with($lockName, 10)
+            ->with($lockName, 0)
             ->willReturn(true);
 
         $this->lockManagerInterfaceMock->expects($this->once())->method('unlock');
@@ -168,7 +168,7 @@ public function testDataCollectedWithParallelGeneration(): void
 
         $this->lockManagerInterfaceMock
             ->expects($this->once())->method('lock')
-            ->with($lockName, 10)
+            ->with($lockName, 0)
             ->willReturn(false);
 
         $this->lockManagerInterfaceMock->expects($this->never())->method('unlock');

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

@@ -43,7 +43,14 @@ class Cache implements \Magento\Framework\Lock\LockManagerInterface
      *
      * @var int
      */
-    private $defaultLifetime = 10;
+    private $defaultLifetime = 7200;
+
+    /**
+     * Array for keeping all lock attempt to release them on destruct.
+     *
+     * @var string[]
+     */
+    private $lockArrayState = [];
 
     /**
      * @param FrontendInterface $cache
@@ -77,6 +84,7 @@ public function lock(string $name, int $timeout = -1): bool
         $data = $this->cache->load($this->getIdentifier($name));
 
         if ($data === $this->lockSign) {
+            $this->lockArrayState[$name] = 1;
             return true;
         }
 
@@ -101,6 +109,7 @@ public function unlock(string $name): bool
         $removeResult = false;
         if ($data === $this->lockSign) {
             $removeResult = (bool)$this->cache->remove($this->getIdentifier($name));
+            unset($this->lockArrayState[$name]);
         }
 
         return $removeResult;
@@ -147,4 +156,26 @@ private function generateLockSign()
 
         return $sign;
     }
+
+    /**
+     * Destruct method should release all locks that left.
+     *
+     * @return void
+     */
+    public function __destruct()
+    {
+        $this->releaseLocks();
+    }
+
+    /**
+     * Release all locks that were not removed with unlock method.
+     *
+     * @return void
+     */
+    private function releaseLocks()
+    {
+        foreach ($this->lockArrayState as $name => $value) {
+            $this->unlock($name);
+        }
+    }
 }

lib/internal/Magento/Framework/Lock/Test/Unit/Backend/CacheTest.php

@@ -162,6 +162,6 @@ public function testLockWithNotEmptyData(): void
             ->with(self::LOCK_PREFIX . $identifier)
             ->willReturn(\uniqid('some_rand-', true));
 
-        $this->assertEquals(false, $this->cache->lock($identifier));
+        $this->assertEquals(false, $this->cache->lock($identifier, 0));
     }
 }