refactor(lock): align store interface and service behavior

memleakd · memleakd · commit 66671328581c · 2026-04-27T12:11:58.000+02:00
Signed-off-by: memleakd &lt;121398829+memleakd@users.noreply.github.com&gt;
diff --git a/deptrac.yaml b/deptrac.yaml
@@ -174,7 +174,6 @@ deptrac:
       - URI
     Cache:
       - I18n
-      - Lock
     Controller:
       - HTTP
       - Validation
diff --git a/system/Cache/Handlers/FileHandler.php b/system/Cache/Handlers/FileHandler.php
@@ -14,8 +14,8 @@
 namespace CodeIgniter\Cache\Handlers;
 
 use CodeIgniter\Cache\Exceptions\CacheException;
+use CodeIgniter\Cache\LockStoreInterface;
 use CodeIgniter\I18n\Time;
-use CodeIgniter\Lock\LockStoreInterface;
 use Config\Cache;
 use Throwable;
 
diff --git a/system/Cache/Handlers/PredisHandler.php b/system/Cache/Handlers/PredisHandler.php
@@ -13,9 +13,9 @@
 
 namespace CodeIgniter\Cache\Handlers;
 
+use CodeIgniter\Cache\LockStoreInterface;
 use CodeIgniter\Exceptions\CriticalError;
 use CodeIgniter\I18n\Time;
-use CodeIgniter\Lock\LockStoreInterface;
 use Config\Cache;
 use Exception;
 use Predis\Client;
diff --git a/system/Cache/Handlers/RedisHandler.php b/system/Cache/Handlers/RedisHandler.php
@@ -13,9 +13,9 @@
 
 namespace CodeIgniter\Cache\Handlers;
 
+use CodeIgniter\Cache\LockStoreInterface;
 use CodeIgniter\Exceptions\CriticalError;
 use CodeIgniter\I18n\Time;
-use CodeIgniter\Lock\LockStoreInterface;
 use Config\Cache;
 use Redis;
 use RedisException;
diff --git a/system/Cache/LockStoreInterface.php b/system/Cache/LockStoreInterface.php
@@ -11,7 +11,7 @@
  * the LICENSE file that was distributed with this source code.
  */
 
-namespace CodeIgniter\Lock;
+namespace CodeIgniter\Cache;
 
 interface LockStoreInterface
 {
diff --git a/system/Config/Services.php b/system/Config/Services.php
@@ -139,15 +139,13 @@ public static function cache(?Cache $config = null, bool $getShared = true)
      */
     public static function locks(?CacheInterface $cache = null, bool $getShared = true)
     {
-        if ($cache instanceof CacheInterface) {
-            return new LockManager($cache);
-        }
-
         if ($getShared) {
-            return static::getSharedInstance('locks', null);
+            return static::getSharedInstance('locks', $cache);
         }
 
-        return new LockManager(AppServices::get('cache'));
+        $cache ??= AppServices::get('cache');
+
+        return new LockManager($cache);
     }
 
     /**
diff --git a/system/Lock/Lock.php b/system/Lock/Lock.php
@@ -14,6 +14,7 @@
 namespace CodeIgniter\Lock;
 
 use Closure;
+use CodeIgniter\Cache\LockStoreInterface;
 use CodeIgniter\Exceptions\InvalidArgumentException;
 
 class Lock implements LockInterface
diff --git a/system/Lock/LockManager.php b/system/Lock/LockManager.php
@@ -14,6 +14,7 @@
 namespace CodeIgniter\Lock;
 
 use CodeIgniter\Cache\CacheInterface;
+use CodeIgniter\Cache\LockStoreInterface;
 use CodeIgniter\Exceptions\InvalidArgumentException;
 use CodeIgniter\Lock\Exceptions\LockException;
 
diff --git a/tests/system/Cache/Handlers/PredisHandlerTest.php b/tests/system/Cache/Handlers/PredisHandlerTest.php
@@ -14,9 +14,9 @@
 namespace CodeIgniter\Cache\Handlers;
 
 use CodeIgniter\Cache\CacheFactory;
+use CodeIgniter\Cache\LockStoreInterface;
 use CodeIgniter\CLI\CLI;
 use CodeIgniter\I18n\Time;
-use CodeIgniter\Lock\LockStoreInterface;
 use Config\Cache;
 use PHPUnit\Framework\Attributes\Group;
 
diff --git a/tests/system/Cache/Handlers/RedisHandlerTest.php b/tests/system/Cache/Handlers/RedisHandlerTest.php
@@ -14,9 +14,9 @@
 namespace CodeIgniter\Cache\Handlers;
 
 use CodeIgniter\Cache\CacheFactory;
+use CodeIgniter\Cache\LockStoreInterface;
 use CodeIgniter\CLI\CLI;
 use CodeIgniter\I18n\Time;
-use CodeIgniter\Lock\LockStoreInterface;
 use Config\Cache;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Group;
diff --git a/tests/system/Config/ServicesTest.php b/tests/system/Config/ServicesTest.php
@@ -115,7 +115,7 @@ public function testNewLocks(): void
         $this->assertInstanceOf(LockManager::class, $actual);
     }
 
-    public function testLocksWithCustomCacheIsNotShared(): void
+    public function testNewUnsharedLocksWithCustomCache(): void
     {
         $config                    = new Cache();
         $config->file['storePath'] = WRITEPATH . 'cache/ServicesLockTest';
@@ -127,8 +127,8 @@ public function testLocksWithCustomCacheIsNotShared(): void
         try {
             $custom = Services::cache($config, false);
 
-            $this->assertInstanceOf(LockManager::class, Services::locks($custom));
-            $this->assertNotSame(Services::locks($custom), Services::locks());
+            $this->assertInstanceOf(LockManager::class, Services::locks($custom, false));
+            $this->assertNotSame(Services::locks($custom, false), Services::locks($custom, false));
         } finally {
             delete_files($config->file['storePath'], false, true);
             rmdir($config->file['storePath']);
diff --git a/user_guide_src/source/libraries/locks.rst b/user_guide_src/source/libraries/locks.rst
@@ -88,7 +88,7 @@ If the configured cache handler does not support locks, creating a lock throws a
 ``CodeIgniter\Lock\Exceptions\LockException``.
 
 Custom cache handlers can support locks by implementing
-``CodeIgniter\Lock\LockStoreInterface``. This keeps lock support opt-in and does
+``CodeIgniter\Cache\LockStoreInterface``. This keeps lock support opt-in and does
 not require all cache handlers to implement lock operations.
 
 ***************

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`* the LICENSE file that was distributed with this source code.`
`12`	`12`	`*/`
`13`	`13`
`14`		`-namespace CodeIgniter\Lock;`
	`14`	`+namespace CodeIgniter\Cache;`
`15`	`15`
`16`	`16`	`interface LockStoreInterface`
`17`	`17`	`{`
Original file line number	Diff line number	Diff line change
`@@ -139,15 +139,13 @@ public static function cache(?Cache $config = null, bool $getShared = true)`
`139`	`139`	`*/`
`140`	`140`	`public static function locks(?CacheInterface $cache = null, bool $getShared = true)`
`141`	`141`	`{`
`142`		`- if ($cache instanceof CacheInterface) {`
`143`		`- return new LockManager($cache);`
`144`		`- }`
`145`		`-`
`146`	`142`	`if ($getShared) {`
`147`		`- return static::getSharedInstance('locks', null);`
	`143`	`+ return static::getSharedInstance('locks', $cache);`
`148`	`144`	`}`
`149`	`145`
`150`		`- return new LockManager(AppServices::get('cache'));`
	`146`	`+ $cache ??= AppServices::get('cache');`
	`147`	`+`
	`148`	`+ return new LockManager($cache);`
`151`	`149`	`}`
`152`	`150`
`153`	`151`	`/**`