Implemented locking on pruning to prevent concurrent pruning processes

Author: Toflar

src/Psr6Store.php

@@ -395,7 +395,14 @@ public function prune()
             return;
         }
 
-        $this->cache->prune();
+        // Make sure we do not have multiple pruning processes running
+        $lock = $this->lockFactory->createLock('prune-lock');
+
+        if ($lock->acquire()) {
+            $this->cache->prune();
+
+            $lock->release();
+        }
     }
 
     /**

tests/Psr6StoreTest.php

@@ -506,10 +506,27 @@ public function testAutoPruneExpiredEntries()
             ->expects($this->exactly(3))
             ->method('prune');
 
+        $lock = $this->createMock(LockInterface::class);
+        $lock
+            ->expects($this->exactly(3))
+            ->method('acquire')
+            ->willReturn(true);
+        $lock
+            ->expects($this->exactly(3))
+            ->method('release')
+            ->willReturn(true);
+
+        $lockFactory = $this->createMock(Factory::class);
+        $lockFactory
+            ->expects($this->any())
+            ->method('createLock')
+            ->with('prune-lock')
+            ->willReturn($lock);
+
         $store = new Psr6Store([
-            'cache_directory' => sys_get_temp_dir(),
             'cache' => $cache,
             'prune_threshold' => 5,
+            'lock_factory' => $lockFactory,
         ]);
 
         foreach (range(1, 21) as $entry) {
@@ -550,6 +567,47 @@ public function testAutoPruneIsSkippedIfThresholdDisabled()
         $store->cleanup();
     }
 
+    public function testAutoPruneIsSkippedIfPruningIsAlreadyInProgress()
+    {
+        $innerCache = new ArrayAdapter();
+        $cache = $this->getMockBuilder(TagAwareAdapter::class)
+            ->setConstructorArgs([$innerCache])
+            ->setMethods(['prune'])
+            ->getMock();
+
+        $cache
+            ->expects($this->never())
+            ->method('prune');
+
+        $lock = $this->createMock(LockInterface::class);
+        $lock
+            ->expects($this->exactly(3))
+            ->method('acquire')
+            ->willReturn(false);
+
+        $lockFactory = $this->createMock(Factory::class);
+        $lockFactory
+            ->expects($this->any())
+            ->method('createLock')
+            ->with('prune-lock')
+            ->willReturn($lock);
+
+        $store = new Psr6Store([
+            'cache' => $cache,
+            'prune_threshold' => 5,
+            'lock_factory' => $lockFactory,
+        ]);
+
+        foreach (range(1, 21) as $entry) {
+            $request = Request::create('https://foobar.com/'.$entry);
+            $response = new Response('hello world', 200);
+
+            $store->write($request, $response);
+        }
+
+        $store->cleanup();
+    }
+
     public function testItFailsWithoutCacheDirectoryForCache()
     {
         $this->expectException(MissingOptionsException::class);