Fix: Ignore cache when sticky configuration is false (#17)

* Fix: Ignore cache when sticky configuration is false

* Test: Add unit tests

* Test: Add feature test

* Doc: Update config suggestion in README

Author: mpyw

README.md

@@ -112,7 +112,7 @@ return [
                 'host' => env('DB_HOST_READONLY'),
             ] : null,
             'write' => [],
-            'sticky' => true,
+            'sticky' => (bool)env('DB_HOST_READONLY'),
             'stickiness_ttl' => 3, // Set the stickiness TTL to 3 seconds
             'driver' => 'mysql',
             'host' => env('DB_HOST', '127.0.0.1'),

src/StickinessEventListener.php

@@ -91,7 +91,9 @@ public function onConnectionCreated(ConnectionCreated $event): void
             $this->currentJobInitialization->initializeOnNewConnection($this->currentJobProcessingEvent, $event);
         }
 
-        $this->stickiness->resolveRecordsModified($event->connection);
+        if ($event->connection->getConfig('sticky')) {
+            $this->stickiness->resolveRecordsModified($event->connection);
+        }
     }
 
     /**
@@ -105,6 +107,8 @@ public function onRecordsHaveBeenModified(RecordsHaveBeenModified $event): void
             $this->currentJobInitialization->dontRevokeEffectsOn($event->connection);
         }
 
-        $this->stickiness->markAsModified($event->connection);
+        if ($event->connection->getConfig('sticky')) {
+            $this->stickiness->markAsModified($event->connection);
+        }
     }
 }

tests/Feature/CachingTest.php

@@ -6,6 +6,7 @@
 use Closure;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Cache;
+use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\DB;
 use Mpyw\LaravelCachedDatabaseStickiness\ConnectionServiceProvider;
 use Mpyw\LaravelCachedDatabaseStickiness\StickinessServiceProvider;
@@ -105,4 +106,24 @@ public function testAffectingStatement(): void
 
         $this->assertNull(Cache::get('database-stickiness:connection=test,resolver=ip,ip=192.168.0.1'));
     }
+
+    public function testAffectingStatementWhenStickyDisabled(): void
+    {
+        // Stickiness caching should be disabled when sticky configuration is false
+        Config::set('database.connections.test.sticky', false);
+
+        Carbon::setTestNow('2020-01-01 00:00:00');
+
+        $this->assertInstanceOf(Closure::class, $this->getReadPdoViaReflection());
+        $this->assertInstanceOf(Closure::class, $this->getWritePdoViaReflection());
+
+        /* @var \Illuminate\Database\Connection $connection */
+        $connection = DB::connection();
+        $connection->statement('select 1'); // This is a fake of insert/update/delete
+
+        $this->assertInstanceOf(Closure::class, $this->getReadPdoViaReflection());
+        $this->assertInstanceOf(PDO::class, $this->getWritePdoViaReflection());
+
+        $this->assertNull(Cache::get('database-stickiness:connection=test,resolver=ip,ip=192.168.0.1'));
+    }
 }

tests/Feature/ResolvingTest.php

@@ -5,6 +5,7 @@
 use Closure;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Cache;
+use Illuminate\Support\Facades\Config;
 use Illuminate\Support\Facades\DB;
 use Mpyw\LaravelCachedDatabaseStickiness\ConnectionServiceProvider;
 use Mpyw\LaravelCachedDatabaseStickiness\StickinessServiceProvider;
@@ -89,6 +90,21 @@ public function testNonAffectingStatementWhenCacheExists(): void
         $this->assertInstanceOf(PDO::class, $this->getWritePdoViaReflection());
     }
 
+    public function testNonAffectingStatementWhenStickyDisabled(): void
+    {
+        // Cached stickiness should be ignored when sticky configuration is false
+        Config::set('database.connections.test.sticky', false);
+
+        Cache::put('database-stickiness:connection=test,resolver=ip,ip=192.168.0.1', true, 5);
+
+        /* @var \Illuminate\Database\Connection $connection */
+        $connection = DB::connection();
+        $connection->select('select 1');
+
+        $this->assertInstanceOf(PDO::class, $this->getReadPdoViaReflection());
+        $this->assertInstanceOf(Closure::class, $this->getWritePdoViaReflection());
+    }
+
     public function testAffectingStatementWhenCacheDoesNotExist(): void
     {
         /* @var \Illuminate\Database\Connection $connection */

tests/Unit/StickinessEventListenerTest.php

@@ -137,6 +137,7 @@ public function onConnectionCreatedWithCurrentJob(): void
         $this->setCurrentJobInitialization($listener, $this->initialization);
 
         $this->initialization->shouldReceive('initializeOnNewConnection')->once()->with($event)->andReturnSelf();
+        $connection->shouldReceive('getConfig')->once()->with('sticky')->andReturnTrue();
         $this->stickiness->shouldReceive('resolveRecordsModified')->once();
 
         $listener->onConnectionCreated(new ConnectionCreated($connection));
@@ -152,11 +153,28 @@ public function onConnectionCreatedWithoutCurrentJob(): void
         $this->setCurrentJobInitialization($listener, null);
 
         $this->initialization->shouldNotReceive('initializeOnNewConnection');
+        $connection->shouldReceive('getConfig')->once()->with('sticky')->andReturnTrue();
         $this->stickiness->shouldReceive('resolveRecordsModified')->once();
 
         $listener->onConnectionCreated(new ConnectionCreated($connection));
     }
 
+    public function onConnectionCreatedWhenStickyDisabled(): void
+    {
+        $connection = Mockery::mock(Connection::class);
+
+        $listener = new StickinessEventListener($this->stickiness);
+
+        $this->setCurrentJobProcessingEvent($listener, null);
+        $this->setCurrentJobInitialization($listener, null);
+
+        $this->initialization->shouldNotReceive('initializeOnNewConnection');
+        $connection->shouldReceive('getConfig')->once()->with('sticky')->andReturnFalse();
+        $this->stickiness->shouldNotReceive('resolveRecordsModified');
+
+        $listener->onConnectionCreated(new ConnectionCreated($connection));
+    }
+
     public function testOnRecordsHaveBeenModifiedWithCurrentJob(): void
     {
         $connection = Mockery::mock(ConnectionInterface::class);
@@ -167,6 +185,7 @@ public function testOnRecordsHaveBeenModifiedWithCurrentJob(): void
         $this->setCurrentJobInitialization($listener, $this->initialization);
 
         $this->initialization->shouldReceive('dontRevokeEffectsOn')->once()->with($connection)->andReturnSelf();
+        $connection->shouldReceive('getConfig')->once()->with('sticky')->andReturnTrue();
         $this->stickiness->shouldReceive('markAsModified')->once()->with($connection);
 
         $listener->onRecordsHaveBeenModified(new RecordsHaveBeenModified($connection));
@@ -182,8 +201,25 @@ public function testOnRecordsHaveBeenModifiedWithoutCurrentJob(): void
         $this->setCurrentJobInitialization($listener, null);
 
         $this->initialization->shouldNotReceive('dontRevokeEffectsOn');
+        $connection->shouldReceive('getConfig')->once()->with('sticky')->andReturnTrue();
         $this->stickiness->shouldReceive('markAsModified')->once()->with($connection);
 
         $listener->onRecordsHaveBeenModified(new RecordsHaveBeenModified($connection));
     }
+
+    public function testOnRecordsHaveBeenModifiedWhenStickyDisabled(): void
+    {
+        $connection = Mockery::mock(ConnectionInterface::class);
+
+        $listener = new StickinessEventListener($this->stickiness);
+
+        $this->setCurrentJobProcessingEvent($listener, null);
+        $this->setCurrentJobInitialization($listener, null);
+
+        $this->initialization->shouldNotReceive('dontRevokeEffectsOn');
+        $connection->shouldReceive('getConfig')->once()->with('sticky')->andReturnFalse();
+        $this->stickiness->shouldNotReceive('markAsModified');
+
+        $listener->onRecordsHaveBeenModified(new RecordsHaveBeenModified($connection));
+    }
 }