Explicitly Call Connection::connect in Configuration

lib/Doctrine/DBAL/Migrations/Configuration/Configuration.php

@@ -20,6 +20,7 @@
 namespace Doctrine\DBAL\Migrations\Configuration;
 
 use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\Connections\MasterSlaveConnection;
 use Doctrine\DBAL\Migrations\Finder\MigrationDeepFinderInterface;
 use Doctrine\DBAL\Migrations\MigrationException;
 use Doctrine\DBAL\Migrations\OutputWriter;
@@ -495,6 +496,7 @@ public function hasVersion($version)
      */
     public function hasVersionMigrated(Version $version)
     {
+        $this->connect();
         $this->createMigrationTable();
 
         $version = $this->connection->fetchColumn(
@@ -512,6 +514,7 @@ public function hasVersionMigrated(Version $version)
      */
     public function getMigratedVersions()
     {
+        $this->connect();
         $this->createMigrationTable();
 
         $ret = $this->connection->fetchAll("SELECT " . $this->migrationsColumnName . " FROM " . $this->migrationsTableName);
@@ -546,6 +549,7 @@ public function getAvailableVersions()
      */
     public function getCurrentVersion()
     {
+        $this->connect();
         $this->createMigrationTable();
 
         if (empty($this->migrations)) {
@@ -662,6 +666,7 @@ public function resolveVersionAlias($alias)
      */
     public function getNumberOfExecutedMigrations()
     {
+        $this->connect();
         $this->createMigrationTable();
 
         $result = $this->connection->fetchColumn("SELECT COUNT(" . $this->migrationsColumnName . ") FROM " . $this->migrationsTableName);
@@ -713,6 +718,7 @@ public function createMigrationTable()
             return false;
         }
 
+        $this->connect();
         if ($this->connection->getSchemaManager()->tablesExist([$this->migrationsTableName])) {
             $this->migrationTableCreated = true;
 
@@ -815,6 +821,24 @@ public function generateVersionNumber(\DateTimeInterface $now=null)
         return $now->format(self::VERSION_FORMAT);
     }
 
+    /**
+     * Explicitely opens the database connection. This is done to play nice
+     * with DBAL's MasterSlaveConnection. Which, in some cases, connects to a
+     * follower when fetching the executed migrations. If a follower is lagging
+     * significantly behind that means the migrations system may see unexecuted
+     * migrations that were actually executed earlier.
+     *
+     * @return bool The same value returned from the `connect` method
+     */
+    protected function connect()
+    {
+        if ($this->connection instanceof MasterSlaveConnection) {
+            return $this->connection->connect('master');
+        }
+
+        return $this->connection->connect();
+    }
+
     /**
      * @throws MigrationException
      */

tests/Doctrine/DBAL/Migrations/Tests/Configuration/ConfigurationTest.php

@@ -3,6 +3,9 @@
 namespace Doctrine\DBAL\Migrations\Tests\Configuration;
 
 use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\Connections\MasterSlaveConnection;
+use Doctrine\DBAL\Platforms\SqlitePlatform;
+use Doctrine\DBAL\Schema\AbstractSchemaManager;
 use Doctrine\DBAL\Migrations\Configuration\Configuration;
 use Doctrine\DBAL\Migrations\Migration;
 use Doctrine\DBAL\Migrations\MigrationException;
@@ -171,6 +174,41 @@ public function testGenerateVersionNumberWithoutNowUsesTheCurrentTime()
         $this->assertRegExp(sprintf('/^%s\d{2}$/', $now->format('YmdHi')), $version);
     }
 
+    /**
+     * Connection is tested via the `getMigratedVersions` method which is the
+     * simplest to set up for.
+     *
+     * @see https://github.com/doctrine/migrations/issues/336
+     */
+    public function testMasterSlaveConnectionAlwaysConnectsToMaster()
+    {
+        $sm = $this->getMockForAbstractClass(AbstractSchemaManager::class, [], '', false, true, true, ['tablesExist']);
+        $sm->expects($this->once())
+            ->method('tablesExist')
+            ->willReturn(true);
+        $conn = $this->getMockBuilder(MasterSlaveConnection::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $conn->expects($this->atLeastOnce())
+            ->method('connect')
+            ->with('master')
+            ->willReturn(true);
+        $conn->expects($this->any())
+            ->method('getSchemaManager')
+            ->willReturn($sm);
+        $conn->expects($this->once())
+            ->method('fetchAll')
+            ->willReturn([
+                ['version' => '2016070600000'],
+            ]);
+
+        $config = new Configuration($conn);
+        $config->setMigrationsNamespace(str_replace('\Version1Test', '', Version1Test::class));
+        $config->setMigrationsDirectory(__DIR__ . '/../Stub/Configuration/AutoloadVersions');
+
+        $config->getMigratedVersions();
+    }
+
     public function methodsThatNeedsVersionsLoadedWithAlreadyMigratedMigrations()
     {
         return [