fix: sessions were not cleared in some cases

colopl · Aug 17, 2023 · 0a90d21 · 0a90d21
1 parent 5783cc4
commit 0a90d21
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 25 deletions.
diff --git a/src/Connection.php b/src/Connection.php
@@ -107,7 +107,7 @@ class Connection extends BaseConnection
      * @param string $instanceId instance ID
      * @param string $database
      * @param string $tablePrefix
-     * @param array $config
+     * @param array<string, mixed> $config
      * @param CacheItemPoolInterface|null $authCache
      * @param SessionPoolInterface|null $sessionPool
      */

diff --git a/tests/Concerns/ManagesDataDefinitionsTest.php b/tests/Concerns/ManagesDataDefinitionsTest.php
@@ -51,6 +51,7 @@ public function test_createDatabase_with_statements(): void
         if (!empty(getenv('SPANNER_EMULATOR_HOST'))) {
             $this->setUpEmulatorInstance($conn);
         }
+        $this->beforeApplicationDestroyed(fn () => $conn->clearSessionPool());
 
         $conn->setEventDispatcher($events);
         $conn->enableQueryLog();

diff --git a/tests/ConnectionTest.php b/tests/ConnectionTest.php
@@ -290,7 +290,8 @@ public function test_AuthCache_works(): void
         $config = $this->app['config']->get('database.connections.main');
 
         $authCache = new ArrayAdapter();
-        $conn = new Connection($config['instance'], $config['database'], '', $config, $authCache);
+        $sessionPool = new CacheSessionPool(new ArrayAdapter());
+        $conn = new Connection($config['instance'], $config['database'], '', $config, $authCache, $sessionPool);
         $this->setUpDatabaseOnce($conn);
 
         $conn->selectOne('SELECT 1');
@@ -312,13 +313,14 @@ public function test_AuthCache_with_FileSystemAdapter(): void
         self::assertSame('0644', substr(sprintf('%o', fileperms($outputPath)), -4));
     }
 
-    public function testSessionPool(): void
+    public function test_session_pool(): void
     {
         $config = $this->app['config']->get('database.connections.main');
 
         $cacheItemPool = new ArrayAdapter();
         $cacheSessionPool = new CacheSessionPool($cacheItemPool);
         $conn = new Connection($config['instance'], $config['database'], '', $config, null, $cacheSessionPool);
+        $this->setUpDatabaseOnce($conn);
         $this->assertInstanceOf(Connection::class, $conn);
 
         $conn->selectOne('SELECT 1');
@@ -359,7 +361,7 @@ public function test_listSessions(): void
         $this->assertInstanceOf(SessionInfo::class, $sessions[0]);
     }
 
-    public function testStaleReads(): void
+    public function test_stale_reads(): void
     {
         $conn = $this->getDefaultConnection();
         $tableName = self::TABLE_NAME_USER;
@@ -373,6 +375,7 @@ public function testStaleReads(): void
             $tx->executeUpdate("INSERT INTO ${tableName} (`userId`, `name`) VALUES ('${uuid}', '${name}')");
             $timestamp = $tx->commit();
         });
+        $db->close();
         $this->assertNotEmpty($timestamp);
 
         $timestampBound = new StrongRead();

diff --git a/tests/SessionNotFoundTest.php b/tests/SessionNotFoundTest.php
@@ -41,7 +41,6 @@ private function getSessionNotFoundConnection(string $sessionNotFoundErrorMode):
         $cacheItemPool = new ArrayAdapter();
         $cacheSessionPool = new CacheSessionPool($cacheItemPool);
         $conn = new Connection($config['instance'], $config['database'], '', $config, null, $cacheSessionPool);
-
         $this->setUpDatabaseOnce($conn);
         return $conn;
     }
@@ -170,7 +169,13 @@ public function testSessionNotFoundUnhandledError(): void
         // if google changes it then string should be changed in Connection::SESSION_NOT_FOUND_CONDITION
         $this->expectExceptionMessage($conn::SESSION_NOT_FOUND_CONDITION);
 
-        $conn->selectOne('SELECT 1');
+        try {
+            $conn->selectOne('SELECT 1');
+        } catch (QueryException $e) {
+            $conn->disconnect();
+            $conn->clearSessionPool();
+            throw $e;
+        }
     }
 
     public function testCursorSessionNotFoundUnhandledError(): void
@@ -188,7 +193,13 @@ public function testCursorSessionNotFoundUnhandledError(): void
         // if google changes it then string should be changed in Connection::SESSION_NOT_FOUND_CONDITION
         $this->expectExceptionMessage($conn::SESSION_NOT_FOUND_CONDITION);
 
-        iterator_to_array($cursor);
+        try {
+            iterator_to_array($cursor);
+        } catch (NotFoundException $e) {
+            $conn->disconnect();
+            $conn->clearSessionPool();
+            throw $e;
+        }
     }
 
     public function testInTransactionSessionNotFoundUnhandledError(): void

diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -18,6 +18,7 @@
 namespace Colopl\Spanner\Tests;
 
 use Colopl\Spanner\Connection;
+use Colopl\Spanner\Session\SessionInfo;
 use Colopl\Spanner\SpannerServiceProvider;
 use Google\Cloud\Spanner\Bytes;
 use Google\Cloud\Spanner\Date;
@@ -39,15 +40,6 @@ abstract class TestCase extends \Orchestra\Testbench\TestCase
     protected const TABLE_NAME_ITEM_TAG = 'ItemTag';
     protected const TABLE_NAME_ARRAY_TEST = 'ArrayTest';
 
-    /**
-     * @return void
-     */
-    protected function tearDown(): void
-    {
-        $this->cleanupDatabase();
-        parent::tearDown();
-    }
-
     /**
      * @return string
      */
@@ -118,31 +110,37 @@ protected function setUpEmulatorInstance(Connection $conn): void
 
     /**
      * @param Connection $conn
+     * @param bool $clearSessionPool
      * @return void
      */
-    protected function setUpDatabaseOnce(Connection $conn): void
+    protected function setUpDatabaseOnce(Connection $conn, bool $clearSessionPool = true): void
     {
         if (!empty(getenv('SPANNER_EMULATOR_HOST'))) {
             $this->setUpEmulatorInstance($conn);
         }
         if (!$conn->databaseExists()) {
             $conn->createDatabase($this->getTestDatabaseDDLs());
         }
+        if ($clearSessionPool) {
+            $this->beforeApplicationDestroyed(fn () => $this->cleanupDatabase($conn));
+        }
+        $sessions = $conn->listSessions();
+        if ($sessions->isNotEmpty()) {
+            dump($this->name());
+            dump($sessions);
+        }
     }
 
     /**
+     * @param Connection $conn
      * @return void
      */
-    protected function cleanupDatabase(): void
+    protected function cleanupDatabase(Connection $conn): void
     {
-        foreach ($this->app['db']->getConnections() as $conn) {
-            if ($conn instanceof Connection) {
-                foreach ($conn->select("SELECT t.table_name FROM information_schema.tables as t WHERE t.table_schema = ''") as $row) {
-                    $conn->table($row['table_name'])->truncate();
-                }
-                $conn->clearSessionPool();
-            }
+        foreach ($conn->select("SELECT t.table_name FROM information_schema.tables as t WHERE t.table_schema = ''") as $row) {
+            $conn->table($row['table_name'])->truncate();
         }
+        $conn->clearSessionPool();
     }
 
     /**