feat: enhance setting cache manager

Author: devmiguelangel

ProcessMaker/Cache/CacheInterface.php

@@ -8,11 +8,23 @@ interface CacheInterface
      * Fetches a value from the cache.
      *
      * @param string $key     The unique key of this item in the cache.
+     * @param mixed  $default Default value to return if the key does not exist.
+     *
+     * @return mixed The value of the item from the cache, or $default in case of cache miss.
+     */
+    public function get(string $key, mixed $default = null): mixed;
+
+    /**
+     * Fetches a value from the cache, or stores the value from the callback if the key exists.
+     *
+     * @param string $key The unique key of this item in the cache.
      * @param callable $callback The callback that will return the value to store in the cache.
      *
      * @return mixed The value of the item from the cache, or $default in case of cache miss.
+     *
+     * @throws \InvalidArgumentException
      */
-    public function get(string $key, callable $callback = null): mixed;
+    public function getOrCache(string $key, callable $callback): mixed;
 
     /**
      * Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time.

ProcessMaker/Cache/Settings/SettingCacheManager.php

@@ -2,9 +2,7 @@
 
 namespace ProcessMaker\Cache\Settings;
 
-use Exception;
 use Illuminate\Cache\CacheManager;
-use Illuminate\Support\Facades\Log;
 use ProcessMaker\Cache\CacheInterface;
 
 class SettingCacheManager implements CacheInterface
@@ -32,28 +30,45 @@ public function __call($method, $arguments): mixed
      * Get a value from the settings cache.
      *
      * @param string $key
-     * @param callable|null $callback
+     * @param mixed $default
      *
      * @return mixed
      */
-    public function get(string $key, callable $callback = null): mixed
+    public function get(string $key, mixed $default = null): mixed
     {
-        $value = $this->cacheManager->get($key);
+        return $this->cacheManager->get($key, $default);
+    }
 
-        if ($value) {
-            return $value;
-        }
+    /**
+     * Get a value from the settings cache, or store the value from the callback if the key exists.
+     *
+     * @param string $key
+     * @param callable $callback
+     *
+     * @return mixed
+     *
+     * @throws \InvalidArgumentException
+     */
+    public function getOrCache(string $key, callable $callback): mixed
+    {
+        $value = $this->get($key);
 
-        if ($callback === null) {
-            return null;
+        if ($value !== null) {
+            return $value;
         }
 
-        $value = $callback();
+        try {
+            $value = $callback();
 
-        if ($value === null) {
+            if ($value === null) {
+                throw new \InvalidArgumentException('The key does not exist.');
+            }
+        } catch (\Exception $e) {
             throw new \InvalidArgumentException('The key does not exist.');
         }
 
+        $this->set($key, $value);
+
         return $value;
     }
 

ProcessMaker/Models/Setting.php

@@ -142,22 +142,16 @@ public static function messages()
      * Get setting by key
      *
      * @param  string  $key
-     * @param  bool  $withCallback
      *
      * @return \ProcessMaker\Models\Setting|null
      * @throws \Exception
      */
-    public static function byKey(string $key, bool $withCallback = false)
+    public static function byKey(string $key)
     {
-        $callback = null;
+        $setting = \SettingCache::get($key);
 
-        if ($withCallback) {
-            $callback = fn() => (new self)->where('key', $key)->first();
-        }
-
-        $setting = \SettingCache::get($key, $callback);
-
-        if (!is_null($setting)) {
+        if ($setting === null) {
+            $setting = (new self)->where('key', $key)->first();
             \SettingCache::set($key, $setting);
         }
 

tests/Feature/Cache/SettingCacheTest.php

@@ -13,11 +13,6 @@ class SettingCacheTest extends TestCase
     use RequestHelper;
     use RefreshDatabase;
 
-    /* public function setUp(): void
-    {
-        parent::setUp();
-    } */
-
     private function upgrade()
     {
         $this->artisan('migrate', [
@@ -65,12 +60,11 @@ public function testGetSettingByKeyCached(): void
     public function testGetSettingByKeyNotCached(): void
     {
         $key = 'password-policies.uppercase';
-        \SettingCache::delete($key);
 
         $this->upgrade();
         $this->trackQueries();
 
-        $setting = Setting::byKey($key, true);
+        $setting = Setting::byKey($key);
 
         $this->assertEquals(1, self::getQueryCount());
         $this->assertEquals($key, $setting->key);
@@ -86,12 +80,11 @@ public function testGetSettingByKeyNotCached(): void
     public function testGetSettingByKeyCachedAfterUpdate(): void
     {
         $key = 'password-policies.special';
-        \SettingCache::delete($key);
 
         $this->upgrade();
         $this->trackQueries();
 
-        $setting = Setting::byKey($key, true);
+        $setting = Setting::byKey($key);
 
         $this->assertEquals(1, self::getQueryCount());
         $this->assertEquals($key, $setting->key);
@@ -116,7 +109,8 @@ public function testGetSettingByNotExistingKey()
         $key = 'non-existing-key';
 
         $this->expectException(\InvalidArgumentException::class);
-        $setting = Setting::byKey($key, true);
+        $callback = fn() => Setting::where('key', $key)->first();
+        $setting = \SettingCache::getOrCache($key, $callback);
 
         $this->assertNull($setting);
     }