feature #58109 [Lock] Add NullStore (xabbuh)

nicolas-grekas · nicolas-grekas · commit 196e42926d83 · 2024-10-09T17:31:05.000+02:00
This PR was merged into the 7.2 branch. Discussion ---------- [Lock] Add `NullStore` | Q | A | ------------- | --- | Branch? | 7.2 | Bug fix? | no | New feature? | yes | Deprecations? | no | Issues | | License | MIT Commits ------- dd0721a add NullStore
diff --git a/src/Symfony/Component/Lock/CHANGELOG.md b/src/Symfony/Component/Lock/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+7.2
+---
+
+ * Add `NullStore`
+
 7.0
 ---
 
diff --git a/src/Symfony/Component/Lock/Store/NullStore.php b/src/Symfony/Component/Lock/Store/NullStore.php
@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Lock\Store;
+
+use Symfony\Component\Lock\BlockingSharedLockStoreInterface;
+use Symfony\Component\Lock\Key;
+
+class NullStore implements BlockingSharedLockStoreInterface
+{
+    public function save(Key $key): void
+    {
+    }
+
+    public function delete(Key $key): void
+    {
+    }
+
+    public function exists(Key $key): bool
+    {
+        return false;
+    }
+
+    public function putOffExpiration(Key $key, float $ttl): void
+    {
+    }
+
+    public function saveRead(Key $key): void
+    {
+    }
+
+    public function waitAndSaveRead(Key $key): void
+    {
+    }
+}
diff --git a/src/Symfony/Component/Lock/Store/StoreFactory.php b/src/Symfony/Component/Lock/Store/StoreFactory.php
@@ -106,6 +106,9 @@ public static function createStore(#[\SensitiveParameter] object|string $connect
 
             case 'in-memory' === $connection:
                 return new InMemoryStore();
+
+            case 'null' === $connection:
+                return new NullStore();
         }
 
         throw new InvalidArgumentException(\sprintf('Unsupported Connection: "%s".', $connection));
diff --git a/src/Symfony/Component/Lock/Tests/Store/StoreFactoryTest.php b/src/Symfony/Component/Lock/Tests/Store/StoreFactoryTest.php
@@ -20,6 +20,7 @@
 use Symfony\Component\Lock\Store\FlockStore;
 use Symfony\Component\Lock\Store\InMemoryStore;
 use Symfony\Component\Lock\Store\MemcachedStore;
+use Symfony\Component\Lock\Store\NullStore;
 use Symfony\Component\Lock\Store\PdoStore;
 use Symfony\Component\Lock\Store\PostgreSqlStore;
 use Symfony\Component\Lock\Store\RedisStore;
@@ -92,5 +93,7 @@ public static function validConnections(): \Generator
 
         yield ['flock', FlockStore::class];
         yield ['flock://'.sys_get_temp_dir(), FlockStore::class];
+
+        yield ['null', NullStore::class];
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -106,6 +106,9 @@ public static function createStore(#[\SensitiveParameter] object\|string $connect`
`106`	`106`
`107`	`107`	`case 'in-memory' === $connection:`
`108`	`108`	`return new InMemoryStore();`
	`109`	`+`
	`110`	`+ case 'null' === $connection:`
	`111`	`+ return new NullStore();`
`109`	`112`	`}`
`110`	`113`
`111`	`114`	`throw new InvalidArgumentException(\sprintf('Unsupported Connection: "%s".', $connection));`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@`
`20`	`20`	`use Symfony\Component\Lock\Store\FlockStore;`
`21`	`21`	`use Symfony\Component\Lock\Store\InMemoryStore;`
`22`	`22`	`use Symfony\Component\Lock\Store\MemcachedStore;`
	`23`	`+use Symfony\Component\Lock\Store\NullStore;`
`23`	`24`	`use Symfony\Component\Lock\Store\PdoStore;`
`24`	`25`	`use Symfony\Component\Lock\Store\PostgreSqlStore;`
`25`	`26`	`use Symfony\Component\Lock\Store\RedisStore;`
`@@ -92,5 +93,7 @@ public static function validConnections(): \Generator`
`92`	`93`
`93`	`94`	`yield ['flock', FlockStore::class];`
`94`	`95`	`yield ['flock://'.sys_get_temp_dir(), FlockStore::class];`
	`96`	`+`
	`97`	`+ yield ['null', NullStore::class];`
`95`	`98`	`}`
`96`	`99`	`}`