ProviderCache: Add option to separate cache between providers (#1045)

Add option to separate cache

Author: AntoineLemaire

src/Provider/Cache/ProviderCache.php

@@ -40,16 +40,22 @@ class ProviderCache implements Provider
      */
     protected $lifetime;
 
+    /**
+     * If true, include the real provider name into the cache key
+     */
+    private bool $separateCache;
+
     /**
      * @param Provider       $realProvider
      * @param CacheInterface $cache
      * @param int            $lifetime
      */
-    final public function __construct(Provider $realProvider, CacheInterface $cache, int $lifetime = null)
+    final public function __construct(Provider $realProvider, CacheInterface $cache, int $lifetime = null, bool $separateCache = false)
     {
         $this->realProvider = $realProvider;
         $this->cache = $cache;
         $this->lifetime = $lifetime;
+        $this->separateCache = $separateCache;
     }
 
     /**
@@ -104,7 +110,8 @@ final public function __call($method, $args)
      */
     protected function getCacheKey($query): string
     {
-        // Include the major version number of the geocoder to avoid issues unserializing.
-        return 'v4'.sha1((string) $query);
+        // Include the major version number of the geocoder to avoid issues unserializing
+        // and real provider name if we want to separate cache
+        return 'v4'.sha1((string) $query.($this->separateCache ? $this->realProvider->getName() : ''));
     }
 }

src/Provider/Cache/Tests/ProviderCacheTest.php

@@ -157,4 +157,33 @@ public function testReverseHit()
         $providerCache = new ProviderCache($this->providerMock, $this->cacheMock, $ttl);
         $providerCache->reverseQuery($query);
     }
+
+    public function testCacheSeparation()
+    {
+        $query = GeocodeQuery::create('foo');
+        $ttl = 4711;
+
+        $this->providerMock->expects($this->any())
+            ->method('getName')
+            ->willReturn('foo');
+
+        $getCacheKey = self::getMethod('getCacheKey');
+
+        $providerCache = new ProviderCache($this->providerMock, $this->cacheMock, $ttl);
+        $providerCacheWithSeparation = new ProviderCache($this->providerMock, $this->cacheMock, $ttl, true);
+
+        $this->assertNotEquals(
+            $getCacheKey->invokeArgs($providerCache, [$query]),
+            $getCacheKey->invokeArgs($providerCacheWithSeparation, [$query])
+        );
+    }
+
+    protected static function getMethod($name)
+    {
+        $class = new \ReflectionClass(ProviderCache::class);
+        $method = $class->getMethod($name);
+        $method->setAccessible(true);
+
+        return $method;
+    }
 }