Add connection name to cache prefix

Fixes #99
mikebronner · Mar 10, 2018 · b4e003d · b4e003d
1 parent e9210ff
commit b4e003d
Show file tree

Hide file tree

Showing 11 changed files with 202 additions and 181 deletions.
diff --git a/src/CacheKey.php b/src/CacheKey.php
@@ -1,23 +1,18 @@
 <?php namespace GeneaLabs\LaravelModelCaching;
 
+use GeneaLabs\LaravelModelCaching\Traits\CachePrefixing;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Query\Builder;
 use Illuminate\Support\Collection;
 
 class CacheKey
 {
+    use CachePrefixing;
+
     protected $eagerLoad;
     protected $model;
     protected $query;
 
-    protected function getCachePrefix() : string
-    {
-        return "genealabs:laravel-model-caching:"
-            . (config("laravel-model-caching.cache-prefix")
-                ? config("laravel-model-caching.cache-prefix", "") . ":"
-                : "");
-    }
-
     public function __construct(
         array $eagerLoad,
         Model $model,

diff --git a/src/CacheTags.php b/src/CacheTags.php
@@ -1,26 +1,27 @@
 <?php namespace GeneaLabs\LaravelModelCaching;
 
 use GeneaLabs\LaravelModelCaching\CachedBuilder;
+use GeneaLabs\LaravelModelCaching\Traits\CachePrefixing;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\Relation;
+use Illuminate\Database\Query\Builder;
 
 class CacheTags
 {
+    use CachePrefixing;
+
     protected $eagerLoad;
     protected $model;
+    protected $query;
 
-    public function __construct(array $eagerLoad, Model $model)
-    {
+    public function __construct(
+        array $eagerLoad,
+        Model $model,
+        Builder $query
+    ) {
         $this->eagerLoad = $eagerLoad;
         $this->model = $model;
-    }
-
-    protected function getCachePrefix() : string
-    {
-        return "genealabs:laravel-model-caching:"
-            . (config('laravel-model-caching.cache-prefix')
-                ? config('laravel-model-caching.cache-prefix', '') . ":"
-                : "");
+        $this->query = $query;
     }
 
     public function make() : array

diff --git a/src/Console/Commands/Flush.php b/src/Console/Commands/Flush.php
@@ -49,8 +49,10 @@ protected function flushModelCache(string $option) : int
         return 0;
     }
 
-    protected function getAllTraitsUsedByClass(string $classname, bool $autoload = true) : Collection
-    {
+    protected function getAllTraitsUsedByClass(
+        string $classname,
+        bool $autoload = true
+    ) : Collection {
         $traits = collect();
 
         if (class_exists($classname, $autoload)) {
@@ -60,7 +62,8 @@ protected function getAllTraitsUsedByClass(string $classname, bool $autoload = t
         $parentClass = get_parent_class($classname);
 
         if ($parentClass) {
-            $traits = $traits->merge($this->getAllTraitsUsedByClass($parentClass, $autoload));
+            $traits = $traits
+                ->merge($this->getAllTraitsUsedByClass($parentClass, $autoload));
         }
 
         return $traits;

diff --git a/src/Traits/CachePrefixing.php b/src/Traits/CachePrefixing.php
@@ -0,0 +1,18 @@
+<?php namespace GeneaLabs\LaravelModelCaching\Traits;
+
+trait CachePrefixing
+{
+    protected function getCachePrefix() : string
+    {
+        return "genealabs:laravel-model-caching:"
+            . $this->getDatabaseConnectionName() . ":"
+            . (config("laravel-model-caching.cache-prefix")
+                ? config("laravel-model-caching.cache-prefix", "") . ":"
+                : "");
+    }
+
+    protected function getDatabaseConnectionName() : string
+    {
+        return $this->query->connection->getName();
+    }
+}
diff --git a/src/Traits/Caching.php b/src/Traits/Caching.php
@@ -77,7 +77,11 @@ protected function makeCacheKey(
 
     protected function makeCacheTags() : array
     {
-        $tags = (new CacheTags($this->eagerLoad ?? [], $this->model ?? $this))
+        $eagerLoad = $this->eagerLoad ?? [];
+        $model = $this->model ?? $this;
+        $query = $this->query ?? app(Builder::class);
+
+        $tags = (new CacheTags($eagerLoad, $model, $query))
             ->make();
 
         return $tags;

diff --git a/tests/Integration/CachedBuilderPaginationTest.php b/tests/Integration/CachedBuilderPaginationTest.php
@@ -27,9 +27,9 @@ public function testPaginationIsCached()
         $authors = (new Author)
             ->paginate(3);
 
-        $key = sha1('genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor-paginate_by_3_page_1');
+        $key = sha1('genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor-paginate_by_3_page_1');
         $tags = [
-            'genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor',
+            'genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor',
         ];
 
         $cachedResults = $this->cache()

diff --git a/tests/Integration/CachedBuilderTest.php b/tests/Integration/CachedBuilderTest.php
diff --git a/tests/Integration/CachedModelTest.php b/tests/Integration/CachedModelTest.php
@@ -21,9 +21,9 @@ class CachedModelTest extends IntegrationTestCase
     public function testAllModelResultsCreatesCache()
     {
         $authors = (new Author)->all();
-        $key = sha1('genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor');
+        $key = sha1('genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor');
         $tags = [
-            'genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor',
+            'genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor',
         ];
 
         $cachedResults = $this
@@ -39,8 +39,8 @@ public function testAllModelResultsCreatesCache()
 
     public function testScopeDisablesCaching()
     {
-        $key = sha1('genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor');
-        $tags = ['genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor'];
+        $key = sha1('genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor');
+        $tags = ['genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor'];
         $authors = (new Author)
             ->where("name", "Bruno")
             ->disableCache()
@@ -56,8 +56,8 @@ public function testScopeDisablesCaching()
 
     public function testScopeDisablesCachingWhenCalledOnModel()
     {
-        $key = sha1('genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor');
-        $tags = ['genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor'];
+        $key = sha1('genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor');
+        $tags = ['genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor'];
         $authors = (new PrefixedAuthor)
             ->disableCache()
             ->where("name", "Bruno")
@@ -74,8 +74,8 @@ public function testScopeDisablesCachingWhenCalledOnModel()
     public function testScopeDisableCacheDoesntCrashWhenCachingIsDisabledInConfig()
     {
         config(['laravel-model-caching.disabled' => true]);
-        $key = sha1('genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor');
-        $tags = ['genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor'];
+        $key = sha1('genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor');
+        $tags = ['genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor'];
         $authors = (new PrefixedAuthor)
             ->where("name", "Bruno")
             ->disableCache()
@@ -94,9 +94,9 @@ public function testAllMethodCachingCanBeDisabledViaConfig()
         config(['laravel-model-caching.disabled' => true]);
         $authors = (new Author)
             ->all();
-        $key = sha1('genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor');
+        $key = sha1('genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor');
         $tags = [
-            'genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor',
+            'genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor',
         ];
         config(['laravel-model-caching.disabled' => false]);
 
@@ -119,10 +119,10 @@ public function testWhereHasIsBeingCached()
             })
             ->get();
 
-        $key = sha1('genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesbook_exists_and_books.author_id_=_authors.id-id_=_1-author');
+        $key = sha1('genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesbook_exists_and_books.author_id_=_authors.id-id_=_1-author');
         $tags = [
-            'genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesbook',
-            'genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor',
+            'genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesbook',
+            'genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor',
         ];
 
         $cachedResults = $this

diff --git a/tests/Integration/Console/Commands/FlushTest.php b/tests/Integration/Console/Commands/FlushTest.php
@@ -17,8 +17,8 @@ class FlushTest extends IntegrationTestCase
     public function testGivenModelIsFlushed()
     {
         $authors = (new Author)->all();
-        $key = sha1('genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor');
-        $tags = ['genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor'];
+        $key = sha1('genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor');
+        $tags = ['genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor'];
 
         $cachedResults = $this->cache
             ->tags($tags)
@@ -38,8 +38,8 @@ public function testExtendedModelIsFlushed()
         $authors = (new PrefixedAuthor)
             ->get();
 
-        $key = sha1('genealabs:laravel-model-caching:test-prefix:genealabslaravelmodelcachingtestsfixturesprefixedauthor');
-        $tags = ['genealabs:laravel-model-caching:test-prefix:genealabslaravelmodelcachingtestsfixturesprefixedauthor'];
+        $key = sha1('genealabs:laravel-model-caching:testing:test-prefix:genealabslaravelmodelcachingtestsfixturesprefixedauthor');
+        $tags = ['genealabs:laravel-model-caching:testing:test-prefix:genealabslaravelmodelcachingtestsfixturesprefixedauthor'];
 
         $cachedResults = $this
             ->cache
@@ -59,10 +59,10 @@ public function testExtendedModelIsFlushed()
     public function testGivenModelWithRelationshipIsFlushed()
     {
         $authors = (new Author)->with('books')->get();
-        $key = sha1('genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor-books');
+        $key = sha1('genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor-books');
         $tags = [
-            'genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor',
-            'genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesbook',
+            'genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor',
+            'genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesbook',
         ];
 
         $cachedResults = $this->cache
@@ -97,18 +97,18 @@ public function testAllModelsAreFlushed()
         (new Book)->all();
         (new Store)->all();
 
-        $key = sha1('genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor');
-        $tags = ['genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor'];
+        $key = sha1('genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor');
+        $tags = ['genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor'];
         $cachedAuthors = $this->cache
             ->tags($tags)
             ->get($key)['value'];
-        $key = sha1('genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesbook');
-        $tags = ['genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesbook'];
+        $key = sha1('genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesbook');
+        $tags = ['genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesbook'];
         $cachedBooks = $this->cache
             ->tags($tags)
             ->get($key)['value'];
-        $key = sha1('genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesstore');
-        $tags = ['genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesstore'];
+        $key = sha1('genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesstore');
+        $tags = ['genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesstore'];
         $cachedStores = $this->cache
             ->tags($tags)
             ->get($key)['value'];
@@ -119,18 +119,18 @@ public function testAllModelsAreFlushed()
 
         $this->artisan('modelCache:flush');
 
-        $key = sha1('genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor');
-        $tags = ['genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor'];
+        $key = sha1('genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor');
+        $tags = ['genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor'];
         $cachedAuthors = $this->cache
             ->tags($tags)
             ->get($key)['value'];
-        $key = sha1('genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesbook');
-        $tags = ['genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesbook'];
+        $key = sha1('genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesbook');
+        $tags = ['genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesbook'];
         $cachedBooks = $this->cache
             ->tags($tags)
             ->get($key)['value'];
-        $key = sha1('genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesstore');
-        $tags = ['genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesstore'];
+        $key = sha1('genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesstore');
+        $tags = ['genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesstore'];
         $cachedStores = $this->cache
             ->tags($tags)
             ->get($key)['value'];

diff --git a/tests/Integration/DisabledCachedBuilderTest.php b/tests/Integration/DisabledCachedBuilderTest.php
@@ -315,9 +315,9 @@ public function testPaginationIsCached()
             ->disableCache()
             ->paginate(3);
 
-        $key = sha1('genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor-paginate_by_3_page_1');
+        $key = sha1('genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor-paginate_by_3_page_1');
         $tags = [
-            'genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor',
+            'genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor',
         ];
 
         $cachedResults = $this->cache()

diff --git a/tests/Integration/Traits/CachableTest.php b/tests/Integration/Traits/CachableTest.php
@@ -26,8 +26,8 @@ public function testSpecifyingAlternateCacheDriver()
         // TODO: make sure the alternate cache is actually loaded
         config(['cache.stores' => $configCacheStores]);
         config(['laravel-model-caching.store' => 'customCache']);
-        $key = sha1('genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor');
-        $tags = ['genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor'];
+        $key = sha1('genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor');
+        $tags = ['genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor'];
 
         $authors = (new Author)
             ->all();
@@ -53,9 +53,9 @@ public function testSetCachePrefixAttribute()
         $results = $this->
             cache()
             ->tags([
-                'genealabs:laravel-model-caching:test-prefix:genealabslaravelmodelcachingtestsfixturesprefixedauthor',
+                'genealabs:laravel-model-caching:testing:test-prefix:genealabslaravelmodelcachingtestsfixturesprefixedauthor',
             ])
-            ->get(sha1('genealabs:laravel-model-caching:test-prefix:genealabslaravelmodelcachingtestsfixturesprefixedauthor'))['value'];
+            ->get(sha1('genealabs:laravel-model-caching:testing:test-prefix:genealabslaravelmodelcachingtestsfixturesprefixedauthor'))['value'];
 
         $this->assertNotNull($results);
     }
@@ -69,9 +69,9 @@ public function testAllReturnsCollection()
         $cachedResults = $this
             ->cache()
             ->tags([
-                'genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor',
+                'genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor',
             ])
-            ->get(sha1('genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor'))['value'];
+            ->get(sha1('genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor'))['value'];
         $liveResults = (new UncachedAuthor)->all();
 
         $this->assertInstanceOf(Collection::class, $authors);
@@ -87,9 +87,9 @@ public function testsCacheFlagDisablesCaching()
         $cachedAuthors = $this
             ->cache()
             ->tags([
-                'genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor',
+                'genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor',
             ])
-            ->get(sha1('genealabs:laravel-model-caching:genealabslaravelmodelcachingtestsfixturesauthor'));
+            ->get(sha1('genealabs:laravel-model-caching:testing:genealabslaravelmodelcachingtestsfixturesauthor'));
 
         config(['laravel-model-caching.disabled' => false]);