Fix caching issues

Author: rubenvanassche

src/Events/SettingsLoaded.php

@@ -6,10 +6,7 @@
 
 class SettingsLoaded
 {
-    public Settings $settings;
-
-    public function __construct(Settings $settings)
+    public function __construct(public Settings $settings, public bool $loadedFromCache)
     {
-        $this->settings = $settings;
     }
 }

src/Settings.php

@@ -145,7 +145,8 @@ public function __serialize(): array
 
         return array_merge(
             $encrypted->map(fn ($value) => Crypto::encrypt($value))->all(),
-            $nonEncrypted->all()
+            $nonEncrypted->all(),
+            ['_settingsLoadedFromCache' => $this->config->isLoadedFromCache()]
         );
     }
 
@@ -155,6 +156,10 @@ public function __unserialize(array $data): void
 
         $this->ensureConfigIsLoaded();
 
+        $settingsLoadedFromCache = $data['_settingsLoadedFromCache'] ?? null;
+        unset($data['_settingsLoadedFromCache']);
+        $this->config->markLoadedFromCache($settingsLoadedFromCache ?? false);
+
         /** @var Collection $encrypted */
         /** @var Collection $nonEncrypted */
         [$encrypted, $nonEncrypted] = collect($data)->partition(
@@ -273,6 +278,13 @@ public function refresh(): self
         return $this;
     }
 
+    public function settingsConfig(): SettingsConfig
+    {
+        $this->ensureConfigIsLoaded();
+
+        return $this->config;
+    }
+
     private function loadValues(?array $values = null): self
     {
         if ($this->loaded) {
@@ -286,7 +298,7 @@ private function loadValues(?array $values = null): self
         $this->fill($values);
         $this->originalValues = collect($values);
 
-        event(new SettingsLoaded($this));
+        event(new SettingsLoaded($this, $this->config->isLoadedFromCache()));
 
         return $this;
     }

src/SettingsCache.php

@@ -2,62 +2,48 @@
 
 namespace Spatie\LaravelSettings;
 
+use DateInterval;
+use DateTimeInterface;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Cache;
 use Spatie\LaravelSettings\Exceptions\CouldNotUnserializeSettings;
 use Spatie\LaravelSettings\Exceptions\SettingsCacheDisabled;
 
 class SettingsCache
 {
-    private bool $enabled;
-
-    private ?string $store;
-
-    private ?string $prefix;
-
-    /** @var \DateTimeInterface|\DateInterval|int|null */
-    private $ttl;
-
     public function __construct(
-        bool $enabled,
-        ?string $store,
-        ?string $prefix,
-        $ttl = null
+        private bool $enabled,
+        private ?string $store,
+        private ?string $prefix,
+        private DateTimeInterface|DateInterval|int|null $ttl = null
     ) {
-        $this->enabled = $enabled;
-        $this->store = $store;
-        $this->prefix = $prefix;
-        $this->ttl = $ttl;
     }
 
     public function isEnabled(): bool
     {
         return $this->enabled;
     }
 
-    public function has(string $settingsClass): bool
-    {
-        if ($this->enabled === false) {
-            return false;
-        }
-
-        return Cache::store($this->store)->has($this->resolveCacheKey($settingsClass));
-    }
-
-    public function get(string $settingsClass): Settings
+    public function get(string $settingsClass): ?Settings
     {
         if ($this->enabled === false) {
             throw SettingsCacheDisabled::create();
         }
 
         $serialized = Cache::store($this->store)->get($this->resolveCacheKey($settingsClass));
 
+        if($serialized === null){
+            return null;
+        }
+
         $settings = unserialize($serialized);
 
         if (! $settings instanceof Settings) {
             throw new CouldNotUnserializeSettings();
         }
 
+        $settings->settingsConfig()->markLoadedFromCache(true);
+
         return $settings;
     }
 
@@ -67,6 +53,8 @@ public function put(Settings $settings): void
             return;
         }
 
+        $settings->settingsConfig()->markLoadedFromCache(true);
+
         $serialized = serialize($settings);
 
         Cache::store($this->store)->put(

src/SettingsConfig.php

@@ -33,6 +33,8 @@ class SettingsConfig
 
     private SettingsRepository $repository;
 
+    private bool $loadedFromCache = false;
+
     public function __construct(string $settingsClass)
     {
         if (! is_subclass_of($settingsClass, Settings::class)) {
@@ -151,4 +153,16 @@ public function clearCachedLockedProperties(): self
 
         return $this;
     }
+
+    public function markLoadedFromCache(bool $loadedFromCache): self
+    {
+        $this->loadedFromCache = $loadedFromCache;
+
+        return $this;
+    }
+
+    public function isLoadedFromCache(): bool
+    {
+        return $this->loadedFromCache;
+    }
 }

src/SettingsContainer.php

@@ -29,12 +29,18 @@ public function registerBindings(): void
             $this->container->scoped($settingClass, function () use ($cacheFactory, $settingClass) {
                 $cache = $cacheFactory->build($settingClass::repository());
 
-                if ($cache->isEnabled() && $cache->has($settingClass)) {
-                    try {
-                        return $cache->get($settingClass);
-                    } catch (CouldNotUnserializeSettings $exception) {
-                        Log::error("Could not unserialize settings class: `{$settingClass}` from cache");
+                if ($cache->isEnabled() === false) {
+                    return new $settingClass();
+                }
+
+                try {
+                    $settings = $cache->get($settingClass);
+
+                    if ($settings !== null) {
+                        return $settings;
                     }
+                } catch (CouldNotUnserializeSettings $exception) {
+                    Log::error("Could not unserialize settings class: `{$settingClass}` from cache");
                 }
 
                 return new $settingClass();
@@ -48,7 +54,7 @@ public function getSettingClasses(): Collection
             return self::$settingsClasses;
         }
 
-        $cachedDiscoveredSettings = config('settings.discovered_settings_cache_path') . '/settings.php';
+        $cachedDiscoveredSettings = config('settings.discovered_settings_cache_path').'/settings.php';
 
         if (file_exists($cachedDiscoveredSettings)) {
             $classes = require $cachedDiscoveredSettings;

src/SettingsEventSubscriber.php

@@ -16,7 +16,7 @@ public function __construct(SettingsCacheFactory $settingsCacheFactory)
         $this->settingsCacheFactory = $settingsCacheFactory;
     }
 
-    public function subscribe(Dispatcher $dispatcher)
+    public function subscribe(Dispatcher $dispatcher): void
     {
         $dispatcher->listen(
             SettingsSaved::class,
@@ -34,11 +34,15 @@ function (SettingsSaved $event) {
         $dispatcher->listen(
             SettingsLoaded::class,
             function (SettingsLoaded $event) {
+                if ($event->loadedFromCache) {
+                    return;
+                }
+
                 $cache = $this->settingsCacheFactory->build(
                     $event->settings::repository()
                 );
 
-                if ($cache->has(get_class($event->settings))) {
+                if ($cache->isEnabled() === false) {
                     return;
                 }