Skip tests broken by ORM bug and add one working testcase for each

Author: janedbal

tests/EntityPreloadBlogManyHasOneDeepTest.php

@@ -98,6 +98,7 @@ public function testManyHasOneDeepWithFetchJoin(DbalType $primaryKey): void
     public function testManyHasOneDeepWithEagerFetchMode(DbalType $primaryKey): void
     {
         $this->skipIfDoctrineOrmHasBrokenUnhandledMatchCase();
+        $this->skipIfDoctrineOrmHasBrokenEagerFetch($primaryKey);
         $this->createDummyBlogData($primaryKey, categoryCount: 5, categoryParentsCount: 5, articleInEachCategoryCount: 5);
 
         $articles = $this->getEntityManager()->createQueryBuilder()

tests/EntityPreloadBlogManyHasOneTest.php

@@ -84,6 +84,7 @@ public function testManyHasOneWithFetchJoin(DbalType $primaryKey): void
     public function testManyHasOneWithEagerFetchMode(DbalType $primaryKey): void
     {
         $this->skipIfDoctrineOrmHasBrokenUnhandledMatchCase();
+        $this->skipIfDoctrineOrmHasBrokenEagerFetch($primaryKey);
         $this->createDummyBlogData($primaryKey, categoryCount: 5, articleInEachCategoryCount: 5);
 
         $articles = $this->getEntityManager()->createQueryBuilder()

tests/EntityPreloadBlogOneHasManyAbstractTest.php

@@ -52,6 +52,7 @@ public function testOneHasManyAbstractWithFetchJoin(DbalType $primaryKey): void
     public function testOneHasManyAbstractWithEagerFetchMode(DbalType $primaryKey): void
     {
         $this->skipIfDoctrineOrmHasBrokenUnhandledMatchCase();
+        $this->skipIfDoctrineOrmHasBrokenEagerFetch($primaryKey);
         $this->createDummyBlogData($primaryKey, categoryCount: 1, articleInEachCategoryCount: 5, commentForEachArticleCount: 5);
 
         $articles = $this->getEntityManager()->createQueryBuilder()

tests/EntityPreloadBlogOneHasManyDeepTest.php

@@ -104,6 +104,7 @@ public function testOneHasManyDeepWithFetchJoin(DbalType $primaryKey): void
     public function testOneHasManyDeepWithEagerFetchMode(DbalType $primaryKey): void
     {
         $this->skipIfDoctrineOrmHasBrokenUnhandledMatchCase();
+        $this->skipIfDoctrineOrmHasBrokenEagerFetch($primaryKey);
         $this->createCategoryTree($primaryKey, depth: 5, branchingFactor: 5);
 
         $rootCategories = $this->getEntityManager()->createQueryBuilder()

tests/EntityPreloadBlogOneHasManyTest.php

@@ -105,6 +105,7 @@ public function testOneHasManyWithFetchJoin(DbalType $primaryKey): void
     public function testOneHasManyWithEagerFetchMode(DbalType $primaryKey): void
     {
         $this->skipIfDoctrineOrmHasBrokenUnhandledMatchCase();
+        $this->skipIfDoctrineOrmHasBrokenEagerFetch($primaryKey); // here the test it green, but emits PHP warning
         $this->createDummyBlogData($primaryKey, categoryCount: 5, articleInEachCategoryCount: 5);
 
         $categories = $this->getEntityManager()->createQueryBuilder()

tests/Fixtures/Blog/PrimaryKey.php

@@ -2,7 +2,7 @@
 
 namespace ShipMonkTests\DoctrineEntityPreloader\Fixtures\Blog;
 
-use function md5;
+use function base64_encode;
 use function random_int;
 
 class PrimaryKey
@@ -33,7 +33,7 @@ public function getData(): int
 
     public function __toString(): string
     {
-        return md5((string) $this->data); // intentionally not matching any internal PK representation
+        return base64_encode((string) $this->data); // intentionally not matching any internal PK representation
     }
 
 }

tests/Fixtures/Blog/Type/PrimaryKeyBase64StringType.php

@@ -0,0 +1,75 @@
+<?php declare(strict_types = 1);
+
+namespace ShipMonkTests\DoctrineEntityPreloader\Fixtures\Blog\Type;
+
+use Doctrine\DBAL\ParameterType;
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\Type;
+use LogicException;
+use ShipMonkTests\DoctrineEntityPreloader\Fixtures\Blog\PrimaryKey;
+use ShipMonkTests\DoctrineEntityPreloader\Fixtures\Compat\CompatibilityType;
+use function base64_decode;
+use function base64_encode;
+use function get_debug_type;
+use function is_string;
+
+/**
+ * This type exists only to have SOME working version of tests that are failing due to ORM bug https://github.com/doctrine/orm/pull/12130
+ * - the key feature here is that convertToDatabaseValue return value equals to PrimaryKey::__toString()
+ */
+final class PrimaryKeyBase64StringType extends Type
+{
+
+    use CompatibilityType;
+
+    public function convertToPHPValue(
+        mixed $value,
+        AbstractPlatform $platform,
+    ): ?PrimaryKey
+    {
+        if ($value === null) {
+            return null;
+        }
+
+        if (is_string($value)) {
+            return new PrimaryKey((int) base64_decode($value, true));
+        }
+
+        throw new LogicException('Unexpected value: ' . get_debug_type($value));
+    }
+
+    public function convertToDatabaseValue(
+        mixed $value,
+        AbstractPlatform $platform,
+    ): ?string
+    {
+        if ($value === null) {
+            return null;
+
+        } elseif ($value instanceof PrimaryKey) {
+            return base64_encode((string) $value->getData());
+
+        } else {
+            throw new LogicException('Unexpected value: ' . $value);
+        }
+    }
+
+    public function getSQLDeclaration(
+        array $column,
+        AbstractPlatform $platform,
+    ): string
+    {
+        return $platform->getStringTypeDeclarationSQL([]);
+    }
+
+    public function getName(): string
+    {
+        return PrimaryKey::DOCTRINE_TYPE_NAME;
+    }
+
+    public function doGetBindingType(): ParameterType|int // @phpstan-ignore return.unusedType (old dbal compat)
+    {
+        return ParameterType::STRING;
+    }
+
+}

tests/Lib/TestCase.php

@@ -27,6 +27,7 @@
 use ShipMonkTests\DoctrineEntityPreloader\Fixtures\Blog\Comment;
 use ShipMonkTests\DoctrineEntityPreloader\Fixtures\Blog\PrimaryKey;
 use ShipMonkTests\DoctrineEntityPreloader\Fixtures\Blog\Tag;
+use ShipMonkTests\DoctrineEntityPreloader\Fixtures\Blog\Type\PrimaryKeyBase64StringType;
 use ShipMonkTests\DoctrineEntityPreloader\Fixtures\Blog\Type\PrimaryKeyBinaryType;
 use ShipMonkTests\DoctrineEntityPreloader\Fixtures\Blog\Type\PrimaryKeyIntegerType;
 use ShipMonkTests\DoctrineEntityPreloader\Fixtures\Blog\Type\PrimaryKeyStringType;
@@ -55,6 +56,7 @@ public static function providePrimaryKeyTypes(): iterable
         yield 'binary' => [new PrimaryKeyBinaryType()];
         yield 'string' => [new PrimaryKeyStringType()];
         yield 'integer' => [new PrimaryKeyIntegerType()];
+        yield 'base64string' => [new PrimaryKeyBase64StringType()];
     }
 
     protected function setUp(): void
@@ -293,6 +295,13 @@ protected function skipIfDoctrineOrmHasBrokenUnhandledMatchCase(): void
         }
     }
 
+    protected function skipIfDoctrineOrmHasBrokenEagerFetch(DbalType $primaryKey): void
+    {
+        if (!$primaryKey instanceof PrimaryKeyBase64StringType) {
+            self::markTestSkipped('Unable to run test due to https://github.com/doctrine/orm/pull/12130');
+        }
+    }
+
     protected function initializeEntityManager(
         DbalType $primaryKey,
         QueryLogger $queryLogger,