Update functionality to prevent caching of models with relationships that are not cachable.

Author: mikebronner

CHANGELOG.md

@@ -4,6 +4,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.7.2] - 2019-10-12
+### Fixed
+- improper caching of non-cachable eagerloaded relationships. Now any query with non-cachable eagerloaded relationships will not be cached in its entirety to prevent stale data. Special thanks to @Hornet-Wing for his help in this.
+
+## [0.7.1] - 2019-10-02
+### Fixed
+- dependency version constraints.
+### Added
+- various tests.
+
+## [0.7.0] - 2019-08-28
+### Added
+- Laravel 6.0 support.
+
 ## [0.6.3] - 2019-08-27
 ### Fixed
 - caching of methods that could pass field names as string or array.

src/Traits/Caching.php

@@ -273,9 +273,37 @@ public function isCachable() : bool
         $isCacheDisabled = ! Container::getInstance()
             ->make("config")
             ->get("laravel-model-caching.enabled");
+        $allRelationshipsAreCachable = true;
+
+        if (property_exists($this, "eagerLoad")
+            && $this->eagerLoad
+        ) {
+            $allRelationshipsAreCachable = collect($this
+                ->eagerLoad)
+                ->keys()
+                ->reduce(function ($carry, $related) {
+                    if (! method_exists($this, $related)
+                        || $carry === false
+                    ) {
+                        return $carry;
+                    }
+        
+                    $relatedModel = $this->model->$related()->getRelated();
+
+                    if (! method_exists($relatedModel, "isCachable")
+                        || ! $relatedModel->isCachable()
+                    ) {
+                        return false;
+                    }
+
+                    return true;
+                })
+                ?? true;
+        }
 
         return $this->isCachable
-            && ! $isCacheDisabled;
+            && ! $isCacheDisabled
+            && $allRelationshipsAreCachable;
     }
 
     protected function setCacheCooldownSavedAtTimestamp(Model $instance)

tests/Fixtures/Book.php

@@ -52,11 +52,6 @@ public function stores() : BelongsToMany
         return $this->belongsToMany(Store::class);
     }
 
-    public function uncachedStores() : BelongsToMany
-    {
-        return $this->belongsToMany(UncachedStore::class, "book_store", "book_id", "store_id");
-    }
-
     public function scopeStartsWith(Builder $query, string $startOfName) : Builder
     {
         return $query->where("name", "LIKE", "{$startOfName}%");

tests/Fixtures/BookWithUncachedStore.php

@@ -0,0 +1,65 @@
+<?php namespace GeneaLabs\LaravelModelCaching\Tests\Fixtures;
+
+use GeneaLabs\LaravelModelCaching\Traits\Cachable;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\MorphMany;
+use Illuminate\Database\Eloquent\Relations\BelongsToMany;
+use Illuminate\Database\Eloquent\Relations\MorphOne;
+
+class BookWithUncachedStore extends Model
+{
+    use Cachable;
+
+    protected $casts = [
+        'price' => 'float',
+    ];
+    protected $dates = [
+        'published_at',
+    ];
+    protected $fillable = [
+        "author_id",
+        'description',
+        'published_at',
+        'title',
+        "publisher_id",
+        'price',
+    ];
+    protected $table = "books";
+
+    public function author() : BelongsTo
+    {
+        return $this->belongsTo(Author::class);
+    }
+
+    public function comments() : MorphMany
+    {
+        return $this->morphMany(Comment::class, "commentable");
+    }
+
+    public function image() : MorphOne
+    {
+        return $this->morphOne(Image::class, "imagable");
+    }
+
+    public function publisher() : BelongsTo
+    {
+        return $this->belongsTo(Publisher::class);
+    }
+
+    public function stores() : BelongsToMany
+    {
+        return $this->belongsToMany(Store::class);
+    }
+
+    public function uncachedStores() : BelongsToMany
+    {
+        return $this->belongsToMany(UncachedStore::class, "book_store", "book_id", "store_id");
+    }
+
+    public function scopeStartsWith(Builder $query, string $startOfName) : Builder
+    {
+        return $query->where("name", "LIKE", "{$startOfName}%");
+    }
+}

tests/Integration/CachedBuilder/BelongsToManyTest.php

@@ -1,13 +1,10 @@
 <?php namespace GeneaLabs\LaravelModelCaching\Tests\Integration\CachedBuilder;
 
 use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Book;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\BookWithUncachedStore;
 use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Store;
 use GeneaLabs\LaravelModelCaching\Tests\Fixtures\UncachedBook;
 use GeneaLabs\LaravelModelCaching\Tests\IntegrationTestCase;
-use GeneaLabs\LaravelModelCaching\Tests\Fixtures\UncachedBookWithCachedStores;
-use GeneaLabs\LaravelModelCaching\Tests\Fixtures\StoreWithUncachedBooks;
-use GeneaLabs\LaravelModelCaching\Tests\Fixtures\BookWithUncachedStores;
-use GeneaLabs\LaravelModelCaching\Tests\Fixtures\UncachedBookWithStores;
 
 class BelongsToManyTest extends IntegrationTestCase
 {
@@ -147,7 +144,7 @@ public function testUncachedRelatedModelDoesntCache()
             "genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:genealabslaravelmodelcachingtestsfixturesuncachedstore",
         ];
 
-        $result = (new Book)
+        $result = (new BookWithUncachedStore)
             ->find($bookId)
             ->uncachedStores;
         $cachedResult = $this

tests/Integration/CachedBuilder/GetTest.php

@@ -8,7 +8,8 @@ class GetTest extends IntegrationTestCase
 {
     public function testGetModelResultsCreatesCache()
     {
-        $authors = (new Author)->with('books', 'profile')
+        $authors = (new Author)
+            ->with('books', 'profile')
             ->get();
         $key = sha1("genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:authors:genealabslaravelmodelcachingtestsfixturesauthor-authors.deleted_at_null-testing:{$this->testingSqlitePath}testing.sqlite:books-testing:{$this->testingSqlitePath}testing.sqlite:profile");
         $tags = [
@@ -17,9 +18,12 @@ public function testGetModelResultsCreatesCache()
             "genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:genealabslaravelmodelcachingtestsfixturesprofile",
         ];
 
-        $cachedResults = $this->cache()->tags($tags)
+        $cachedResults = $this
+            ->cache()
+            ->tags($tags)
             ->get($key)['value'];
-        $liveResults = (new UncachedAuthor)->with('books', 'profile')
+        $liveResults = (new UncachedAuthor)
+            ->with('books', 'profile')
             ->get();
 
         $this->assertEquals($authors, $cachedResults);

tests/Integration/CachedBuilder/WhereHasTest.php

@@ -1,6 +1,7 @@
 <?php namespace GeneaLabs\LaravelModelCaching\Tests\Integration\CachedBuilder;
 
 use GeneaLabs\LaravelModelCaching\Tests\Fixtures\Author;
+use GeneaLabs\LaravelModelCaching\Tests\Fixtures\BookWithUncachedStore;
 use GeneaLabs\LaravelModelCaching\Tests\Fixtures\UncachedAuthor;
 use GeneaLabs\LaravelModelCaching\Tests\IntegrationTestCase;
 
@@ -35,4 +36,26 @@ public function testNestedWhereHasClauses()
 
         $this->assertEquals($authors->pluck("id"), $uncachedAuthors->pluck("id"));
     }
+
+    public function testNonCachedRelationshipPreventsCaching()
+    {
+        $book = (new BookWithUncachedStore)
+            ->with("uncachedStores")
+            ->whereHas("uncachedStores")
+            ->get()
+            ->first();
+        $store = $book->uncachedStores->first();
+        $store->name = "Waterstones";
+        $store->save();
+        $results = $this->cache()->tags([
+                "genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:genealabslaravelmodelcachingtestsfixturesbook",
+                "genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:genealabslaravelmodelcachingtestsfixturesuncachedstore"
+            ])
+            ->get(sha1(
+                "genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:books:genealabslaravelmodelcachingtestsfixturesbook-exists-" .
+                "and_books.id_=_book_store.book_id-testing:{$this->testingSqlitePath}testing.sqlite:uncachedStores"
+            ));
+
+        $this->assertNull($results);
+    }
 }

tests/Integration/CachedBuilderRelationshipsTest.php

@@ -44,27 +44,4 @@ public function testWhereHasRelationship()
 
         $this->assertEquals($books->pluck("id"), $uncachedBooks->pluck("id"));
     }
-
-    public function testNonCacheableEagerLoadedRelationsAreCleared()
-    {
-        $book = Book::with("uncachedStores")
-            ->whereHas("uncachedStores")
-            ->get()
-            ->first();
-
-        $store = $book->uncachedStores->first();
-        $store->name = "Waterstones";
-        $store->save();
-
-        $results = $this->cache()->tags([
-                "genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:genealabslaravelmodelcachingtestsfixturesbook",
-                "genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:genealabslaravelmodelcachingtestsfixturesuncachedstore"
-            ])
-            ->get(sha1(
-                "genealabs:laravel-model-caching:testing:{$this->testingSqlitePath}testing.sqlite:books:genealabslaravelmodelcachingtestsfixturesbook-exists-" .
-                "and_books.id_=_book_store.book_id-testing:{$this->testingSqlitePath}testing.sqlite:uncachedStores"
-            ));
-
-        $this->assertNull($results);
-    }
 }