fix: CacheSchedulingMutex should use lock connection (#56472) (#56614)

Co-authored-by: Julius van Dijk <julius@anaglyphic.com>

Author: GrahamCampbell

src/Illuminate/Console/Scheduling/CacheSchedulingMutex.php

@@ -3,7 +3,9 @@
 namespace Illuminate\Console\Scheduling;
 
 use DateTimeInterface;
+use Illuminate\Cache\DynamoDbStore;
 use Illuminate\Contracts\Cache\Factory as Cache;
+use Illuminate\Contracts\Cache\LockProvider;
 
 class CacheSchedulingMutex implements SchedulingMutex, CacheAware
 {
@@ -41,8 +43,16 @@ public function __construct(Cache $cache)
  */
  public function create(Event $event, DateTimeInterface $time)
  {
+ $mutexName = $event->mutexName().$time->format('Hi');
+
+ if ($this->shouldUseLocks($this->cache->store($this->store)->getStore())) {
+ return $this->cache->store($this->store)->getStore()
+ ->lock($mutexName, 3600)
+ ->acquire();
+ }
+
  return $this->cache->store($this->store)->add(
- $event->mutexName().$time->format('Hi'), true, 3600
+ $mutexName, true, 3600
  );
  }
 
@@ -55,9 +65,26 @@ public function create(Event $event, DateTimeInterface $time)
  */
  public function exists(Event $event, DateTimeInterface $time)
  {
- return $this->cache->store($this->store)->has(
- $event->mutexName().$time->format('Hi')
- );
+ $mutexName = $event->mutexName().$time->format('Hi');
+
+ if ($this->shouldUseLocks($this->cache->store($this->store)->getStore())) {
+ return ! $this->cache->store($this->store)->getStore()
+ ->lock($mutexName, 3600)
+ ->get(fn () => true);
+ }
+
+ return $this->cache->store($this->store)->has($mutexName);
+ }
+
+ /**
+ * Determine if the given store should use locks for cache event mutexes.
+ *
+ * @param \Illuminate\Contracts\Cache\Store $store
+ * @return bool
+ */
+ protected function shouldUseLocks($store)
+ {
+ return $store instanceof LockProvider && ! $store instanceof DynamoDbStore;
  }
 
  /**

tests/Console/Scheduling/CacheSchedulingMutexTest.php

@@ -2,6 +2,7 @@
 
 namespace Illuminate\Tests\Console\Scheduling;
 
+use Illuminate\Cache\ArrayStore;
 use Illuminate\Console\Scheduling\CacheEventMutex;
 use Illuminate\Console\Scheduling\CacheSchedulingMutex;
 use Illuminate\Console\Scheduling\Event;
@@ -52,13 +53,15 @@ protected function setUp(): void
 
  public function testMutexReceivesCorrectCreate()
  {
+ $this->cacheRepository->shouldReceive('getStore')->andReturn(new \stdClass);
  $this->cacheRepository->shouldReceive('add')->once()->with($this->event->mutexName().$this->time->format('Hi'), true, 3600)->andReturn(true);
 
  $this->assertTrue($this->cacheMutex->create($this->event, $this->time));
  }
 
  public function testCanUseCustomConnection()
  {
+ $this->cacheRepository->shouldReceive('getStore')->andReturn(new \stdClass);
  $this->cacheFactory->shouldReceive('store')->with('test')->andReturn($this->cacheRepository);
  $this->cacheRepository->shouldReceive('add')->once()->with($this->event->mutexName().$this->time->format('Hi'), true, 3600)->andReturn(true);
  $this->cacheMutex->useStore('test');
@@ -68,22 +71,58 @@ public function testCanUseCustomConnection()
 
  public function testPreventsMultipleRuns()
  {
+ $this->cacheRepository->shouldReceive('getStore')->andReturn(new \stdClass);
  $this->cacheRepository->shouldReceive('add')->once()->with($this->event->mutexName().$this->time->format('Hi'), true, 3600)->andReturn(false);
 
  $this->assertFalse($this->cacheMutex->create($this->event, $this->time));
  }
 
  public function testChecksForNonRunSchedule()
  {
+ $this->cacheRepository->shouldReceive('getStore')->andReturn(new \stdClass);
  $this->cacheRepository->shouldReceive('has')->once()->with($this->event->mutexName().$this->time->format('Hi'))->andReturn(false);
 
  $this->assertFalse($this->cacheMutex->exists($this->event, $this->time));
  }
 
  public function testChecksForAlreadyRunSchedule()
  {
+ $this->cacheRepository->shouldReceive('getStore')->andReturn(new \stdClass);
  $this->cacheRepository->shouldReceive('has')->with($this->event->mutexName().$this->time->format('Hi'))->andReturn(true);
 
  $this->assertTrue($this->cacheMutex->exists($this->event, $this->time));
  }
+
+ public function testMutexReceivesCorrectCreateWithLockProvider()
+ {
+ $this->cacheRepository->shouldReceive('getStore')->andReturn(new ArrayStore);
+
+ $this->assertTrue($this->cacheMutex->create($this->event, $this->time));
+ }
+
+ public function testPreventsMultipleRunsWithLockProvider()
+ {
+ $this->cacheRepository->shouldReceive('getStore')->andReturn(new ArrayStore);
+
+ // first create the lock, so we can test that the next call fails.
+ $this->cacheMutex->create($this->event, $this->time);
+
+ $this->assertFalse($this->cacheMutex->create($this->event, $this->time));
+ }
+
+ public function testChecksForNonRunScheduleWithLockProvider()
+ {
+ $this->cacheRepository->shouldReceive('getStore')->andReturn(new ArrayStore);
+
+ $this->assertFalse($this->cacheMutex->exists($this->event, $this->time));
+ }
+
+ public function testChecksForAlreadyRunScheduleWithLockProvider()
+ {
+ $this->cacheRepository->shouldReceive('getStore')->andReturn(new ArrayStore);
+
+ $this->cacheMutex->create($this->event, $this->time);
+
+ $this->assertTrue($this->cacheMutex->exists($this->event, $this->time));
+ }
 }