Remove ServerInfoAwareConnection#requiresQueryForServerVersion() as a…

…n implementation detail

Testing the implementations of this method requires partial mocking of the implementing class which makes it impossible to make them `final` (doctrine#3590).

Additionally, this API breaks the encapsulation of the driver layer: instead of exposing the fact of whether the connection will perform a query to detect the server version, the driver should just instantiate a platform corresponding to a connection.

The rationale behind introducing this method (doctrine#487) is really questionable:

> This is also required for drivers that cannot return the database server version without an additional query (performance reasons).

1. There's no evidence that an underlying driver that exposes the server version via its API doesn't make a request of any kind to the server.
2. For an application that works with any realistic database, a query like `SELECT VERSION()` wouldn't be a performance bottleneck.
3. Even if it was, it's always possible to specify the platform version upfront. Otherwise, the current logic of falling back to a default platform may cause undefined behavior of the application (we don't test the compatibility of the lowest level of the DBAL platform with all supported server versions). Remember, “If it doesn’t work, it doesn’t matter how fast it doesn’t work.”

UPGRADE.md

@@ -1,5 +1,9 @@
 # Upgrade to 3.0
 
+## BC BREAK: `ServerInfoAwareConnection::requiresQueryForServerVersion()` is removed.
+
+The `ServerInfoAwareConnection::requiresQueryForServerVersion()` method has been removed as an implementation detail which is the same for all supported drivers.
+
 ## BC BREAK Changes in driver exceptions
 
 1. The `Doctrine\DBAL\Driver\DriverException::getErrorCode()` method is removed. In order to obtain the driver error code, please use `::getCode()` or `::getSQLState()`.

src/Connection.php

@@ -396,7 +396,7 @@ private function getServerVersion()
         $connection = $this->getWrappedConnection();
 
         // Automatic platform version detection.
-        if ($connection instanceof ServerInfoAwareConnection && ! $connection->requiresQueryForServerVersion()) {
+        if ($connection instanceof ServerInfoAwareConnection) {
             return $connection->getServerVersion();
         }
 

src/Driver/IBMDB2/DB2Connection.php

@@ -73,14 +73,6 @@ public function getServerVersion()
         return $serverInfo->DBMS_VER;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function requiresQueryForServerVersion()
-    {
-        return false;
-    }
-
     public function prepare(string $sql): DriverStatement
     {
         $stmt = @db2_prepare($this->conn, $sql);

src/Driver/Mysqli/MysqliConnection.php

@@ -96,14 +96,6 @@ public function getServerVersion()
         return $majorVersion . '.' . $minorVersion . '.' . $patchVersion;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function requiresQueryForServerVersion()
-    {
-        return false;
-    }
-
     public function prepare(string $sql): DriverStatement
     {
         return new Statement($this->conn, $sql);

src/Driver/OCI8/OCI8Connection.php

@@ -97,14 +97,6 @@ public function getServerVersion()
         return $matches[1];
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function requiresQueryForServerVersion()
-    {
-        return false;
-    }
-
     public function prepare(string $sql): DriverStatement
     {
         return new Statement($this->dbh, $sql, $this->executionMode);

src/Driver/PDOConnection.php

@@ -112,14 +112,6 @@ public function lastInsertId($name = null)
         }
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function requiresQueryForServerVersion()
-    {
-        return false;
-    }
-
     /**
      * Creates a wrapped statement
      */

src/Driver/SQLSrv/SQLSrvConnection.php

@@ -66,14 +66,6 @@ public function getServerVersion()
         return $serverInfo['SQLServerVersion'];
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function requiresQueryForServerVersion()
-    {
-        return false;
-    }
-
     public function prepare(string $sql): DriverStatement
     {
         return new Statement($this->conn, $sql, $this->lastInsertId);

src/Driver/ServerInfoAwareConnection.php

@@ -13,11 +13,4 @@ interface ServerInfoAwareConnection extends Connection
      * @return string
      */
     public function getServerVersion();
-
-    /**
-     * Checks whether a query is required to retrieve the database server version.
-     *
-     * @return bool True if a query is required to retrieve the database server version, false otherwise.
-     */
-    public function requiresQueryForServerVersion();
 }

tests/ConnectionTest.php

@@ -661,10 +661,6 @@ public function testPlatformDetectionIsTriggerOnlyOnceOnRetrievingPlatform(): vo
             ->method('connect')
             ->will(self::returnValue($driverConnectionMock));
 
-        $driverConnectionMock->expects(self::once())
-            ->method('requiresQueryForServerVersion')
-            ->will(self::returnValue(false));
-
         $driverConnectionMock->expects(self::once())
             ->method('getServerVersion')
             ->will(self::returnValue('6.6.6'));

tests/Driver/Mysqli/MysqliConnectionTest.php

@@ -4,42 +4,19 @@
 
 use Doctrine\DBAL\Driver\Mysqli\Driver;
 use Doctrine\DBAL\Driver\Mysqli\HostRequired;
-use Doctrine\DBAL\Driver\Mysqli\MysqliConnection;
-use Doctrine\DBAL\Platforms\MySqlPlatform;
 use Doctrine\DBAL\Tests\FunctionalTestCase;
-use PHPUnit\Framework\MockObject\MockObject;
 
 use function extension_loaded;
 
 class MysqliConnectionTest extends FunctionalTestCase
 {
-    /**
-     * The mysqli driver connection mock under test.
-     *
-     * @var MysqliConnection|MockObject
-     */
-    private $connectionMock;
-
     protected function setUp(): void
     {
         if (! extension_loaded('mysqli')) {
             self::markTestSkipped('mysqli is not installed.');
         }
 
         parent::setUp();
-
-        if (! $this->connection->getDatabasePlatform() instanceof MySqlPlatform) {
-            $this->markTestSkipped('MySQL only test.');
-        }
-
-        $this->connectionMock = $this->getMockBuilder(MysqliConnection::class)
-            ->disableOriginalConstructor()
-            ->getMockForAbstractClass();
-    }
-
-    public function testDoesNotRequireQueryForServerVersion(): void
-    {
-        self::assertFalse($this->connectionMock->requiresQueryForServerVersion());
     }
 
     public function testHostnameIsRequiredForPersistentConnection(): void

tests/Functional/Driver/PDO/ConnectionTest.php

@@ -45,11 +45,6 @@ protected function tearDown(): void
         parent::tearDown();
     }
 
-    public function testDoesNotRequireQueryForServerVersion(): void
-    {
-        self::assertFalse($this->driverConnection->requiresQueryForServerVersion());
-    }
-
     public function testThrowsWrappedExceptionOnConstruct(): void
     {
         $this->expectException(Exception::class);