Throw exception NotSupported Exception for UuidGenerator with doctrine/dbal:3.x.

Generating `getGuidExpression` has been removed in doctrine/dbal:3.x.

Partially fixes #8884

Author: scyzoryck

.github/workflows/continuous-integration.yml

@@ -40,14 +40,14 @@ jobs:
 
       - name: "Run PHPUnit"
         continue-on-error: true
-        run: "vendor/bin/phpunit -c ci/github/phpunit/sqlite.xml --coverage-clover=coverage-no-cache.xml"
+        run: "vendor/bin/phpunit -c ci/github/phpunit/sqlite.xml --coverage-clover=coverage-no-cache.xml --exclude-group performance,locking_functional,dbal2"
         env:
             ENABLE_SECOND_LEVEL_CACHE: 0
 
       - name: "Run PHPUnit with Second Level Cache"
         id: "phpunit-run-slc"
         continue-on-error: true
-        run: "vendor/bin/phpunit -c ci/github/phpunit/sqlite.xml --exclude-group performance,non-cacheable,locking_functional --coverage-clover=coverage-cache.xml"
+        run: "vendor/bin/phpunit -c ci/github/phpunit/sqlite.xml --exclude-group performance,non-cacheable,locking_functional,dbal2 --coverage-clover=coverage-cache.xml"
         env:
             ENABLE_SECOND_LEVEL_CACHE: 1
 
@@ -93,7 +93,7 @@ jobs:
             ENABLE_SECOND_LEVEL_CACHE: 0
 
       - name: "Run PHPUnit with Second Level Cache"
-        run: "vendor/bin/phpunit -c ci/github/phpunit/sqlite.xml --exclude-group performance,non-cacheable,locking_functional --coverage-clover=coverage-cache.xml"
+        run: "vendor/bin/phpunit -c ci/github/phpunit/sqlite.xml --exclude-group performance,non-cacheable,locking_functional,dbal3 --coverage-clover=coverage-cache.xml"
         env:
             ENABLE_SECOND_LEVEL_CACHE: 1
 
@@ -261,7 +261,7 @@ jobs:
             ENABLE_SECOND_LEVEL_CACHE: 0
 
       - name: "Run PHPUnit with Second Level Cache"
-        run: "vendor/bin/phpunit -c ci/github/phpunit/${{ matrix.extension }}.xml --exclude-group performance,non-cacheable,locking_functional --coverage-clover=coverage-no-cache.xml"
+        run: "vendor/bin/phpunit -c ci/github/phpunit/${{ matrix.extension }}.xml --exclude-group performance,non-cacheable,locking_functional,dbal3 --coverage-clover=coverage-no-cache.xml"
         env:
             ENABLE_SECOND_LEVEL_CACHE: 1
 

ci/github/phpunit/mysqli.xml

@@ -33,6 +33,7 @@
         <exclude>
             <group>performance</group>
             <group>locking_functional</group>
+            <group>dbal3</group>
         </exclude>
     </groups>
 </phpunit>

ci/github/phpunit/pdo_mysql.xml

@@ -34,6 +34,7 @@
         <exclude>
             <group>performance</group>
             <group>locking_functional</group>
+            <group>dbal3</group>
         </exclude>
     </groups>
 </phpunit>

ci/github/phpunit/pdo_pgsql.xml

@@ -33,6 +33,7 @@
         <exclude>
             <group>performance</group>
             <group>locking_functional</group>
+            <group>dbal3</group>
         </exclude>
     </groups>
 </phpunit>

ci/github/phpunit/sqlite.xml

@@ -31,6 +31,7 @@
         <exclude>
             <group>performance</group>
             <group>locking_functional</group>
+            <group>dbal3</group>
         </exclude>
     </groups>
 </phpunit>

lib/Doctrine/ORM/Exception/NotSupported.php

@@ -10,4 +10,9 @@ public static function create(): self
     {
         return new self('This behaviour is (currently) not supported by Doctrine 2');
     }
+
+    public static function createForDbal3(): self
+    {
+        return new self('This behaviour is not supported by doctrine/dbal:3.x, please use doctrine/dbal:2.x instead.');
+    }
 }

lib/Doctrine/ORM/Id/UuidGenerator.php

@@ -4,8 +4,12 @@
 
 namespace Doctrine\ORM\Id;
 
+use Doctrine\DBAL\Connection;
 use Doctrine\Deprecations\Deprecation;
 use Doctrine\ORM\EntityManager;
+use Doctrine\ORM\Exception\NotSupported;
+
+use function method_exists;
 
 /**
  * Represents an ID generator that uses the database UUID expression
@@ -22,10 +26,16 @@ public function __construct()
             '%s is deprecated with no replacement, use an application-side generator instead',
             self::class
         );
+
+        if (! method_exists(Connection::class, 'getGuidExpression')) {
+            throw NotSupported::createForDbal3();
+        }
     }
 
     /**
      * {@inheritDoc}
+     *
+     * @throws NotSupported
      */
     public function generate(EntityManager $em, $entity)
     {

phpunit.xml.dist

@@ -28,6 +28,7 @@
         <exclude>
             <group>performance</group>
             <group>locking_functional</group>
+            <group>dbal3</group>
         </exclude>
     </groups>
 

psalm.xml

@@ -47,5 +47,11 @@
                 <referencedClass name="Doctrine\Common\Cache\XcacheCache"/>
             </errorLevel>
         </UndefinedClass>
+        <UndefinedMethod>
+            <errorLevel type="suppress">
+                <!-- See https://github.com/doctrine/orm/issues/8884 -->
+                <referencedMethod name="Doctrine\DBAL\Platforms\AbstractPlatform::getGuidExpression"/>
+            </errorLevel>
+        </UndefinedMethod>
     </issueHandlers>
 </psalm>

tests/Doctrine/Tests/ORM/Functional/UUIDGeneratorTest.php

@@ -4,13 +4,16 @@
 
 namespace Doctrine\Tests\ORM\Functional;
 
+use Doctrine\DBAL\Connection;
 use Doctrine\Deprecations\PHPUnit\VerifyDeprecations;
+use Doctrine\ORM\Exception\NotSupported;
 use Doctrine\ORM\Mapping\Column;
 use Doctrine\ORM\Mapping\Entity;
 use Doctrine\ORM\Mapping\GeneratedValue;
 use Doctrine\ORM\Mapping\Id;
 use Doctrine\Tests\OrmFunctionalTestCase;
 
+use function method_exists;
 use function strlen;
 
 /**
@@ -20,18 +23,28 @@ class UUIDGeneratorTest extends OrmFunctionalTestCase
 {
     use VerifyDeprecations;
 
+    /**
+     * @group dbal2
+     */
     public function testItIsDeprecated(): void
     {
         $this->expectDeprecationWithIdentifier('https://github.com/doctrine/orm/issues/7312');
         $this->_em->getClassMetadata(UUIDEntity::class);
     }
 
+    /**
+     * @group dbal2
+     */
     public function testGenerateUUID(): void
     {
         if ($this->_em->getConnection()->getDatabasePlatform()->getName() !== 'mysql') {
             self::markTestSkipped('Currently restricted to MySQL platform.');
         }
 
+        if (! method_exists(Connection::class, 'getGuidExpression')) {
+            self::markTestSkipped('Test valid for doctrine/dbal:2.x only.');
+        }
+
         $this->_schemaTool->createSchema([
             $this->_em->getClassMetadata(UUIDEntity::class),
         ]);
@@ -41,6 +54,15 @@ public function testGenerateUUID(): void
         self::assertNotNull($entity->getId());
         self::assertTrue(strlen($entity->getId()) > 0);
     }
+
+    /**
+     * @group dbal3
+     */
+    public function testItCannotBeInitialised(): void
+    {
+        $this->expectException(NotSupported::class);
+        $this->_em->getClassMetadata(UUIDEntity::class);
+    }
 }
 
 /**