fix: 🐛 Self-heal cache when corrupted non-Collection value is detected. (#207)

Author: mikebronner

src/ProviderAndDumperAggregator.php

@@ -341,13 +341,18 @@ protected function getProvidersFromConfiguration(Collection $providers) : array
     }
 
     protected function preventCacheKeyHashCollision(
-        array $result,
+        mixed $result,
         string $hashedCacheKey,
         string $cacheKey,
         array $queryElements,
-        string $queryType
-    ) {
-        if ($result["key"] === $cacheKey) {
+        string $queryType,
+    ): Collection {
+        $isValid = is_array($result)
+            && isset($result["key"], $result["value"])
+            && $result["key"] === $cacheKey
+            && $result["value"] instanceof Collection;
+
+        if ($isValid) {
             return $result["value"];
         }
 
@@ -358,9 +363,13 @@ protected function preventCacheKeyHashCollision(
         return $this->cacheRequest($cacheKey, $queryElements, $queryType);
     }
 
-    protected function removeEmptyCacheEntry(Collection $result, string $cacheKey)
+    protected function removeEmptyCacheEntry(mixed $result, string $cacheKey)
     {
-        if ($result && $result->isEmpty()) {
+        if (! $result instanceof Collection) {
+            return;
+        }
+
+        if ($result->isEmpty()) {
             app('cache')
                 ->store(config('geocoder.cache.store'))
                 ->forget($cacheKey);

tests/Feature/Providers/GeocoderServiceTest.php

@@ -353,3 +353,22 @@
     expect($store->get($positiveKey)['key'])->toBe('45.473282-73.834721');
     Http::assertSentCount(2);
 });
+
+it('self-heals when a cached entry has a non-Collection value', function () {
+    $address = '1600 Pennsylvania Ave NW, Washington, DC 20500, USA';
+    $providerName = app('geocoder')->getProvider()->getName();
+    $cacheKey = Str::slug(strtolower(urlencode($address)));
+    $hashedCacheKey = sha1("{$providerName}-{$cacheKey}");
+    $store = app('cache')->store(config('geocoder.cache.store'));
+
+    $store->put($hashedCacheKey, [
+        'key' => $cacheKey,
+        'value' => 'corrupted-not-a-collection',
+    ], 999999);
+
+    $results = app('geocoder')->geocode($address)->get();
+
+    expect($results)->toBeInstanceOf(Collection::class);
+    expect($results->isNotEmpty())->toBeTrue();
+    expect($store->get($hashedCacheKey)['value'])->toBeInstanceOf(Collection::class);
+});