Detect invalid indexBy configuration in the SchemaValidator

src/Tools/SchemaValidator.php

@@ -24,6 +24,7 @@
 use ReflectionEnum;
 use ReflectionNamedType;
 
+use function array_column;
 use function array_diff;
 use function array_filter;
 use function array_key_exists;
@@ -276,6 +277,22 @@
                     }
                 }
             }
+
+            if ($assoc->isIndexed()) {
+                $joinColumns = array_column($targetMetadata->getAssociationMappings(), 'joinColumns');
+                $joinColumns = array_column($joinColumns, 0);
+                $joinColumns = array_column($joinColumns, 'name');
+
+                $allAvailableIndexNames = [
+                    ...$joinColumns,
+                    ...$targetMetadata->getColumnNames(),
+                ];
+
+                if (! in_array($assoc->indexBy(), $allAvailableIndexNames, true)) {
+                    $ce[] = 'The association ' . $class->name . '#' . $fieldName . ' is indexed by a field ' .
+                        $assoc->indexBy() . ' on ' . $targetMetadata->name . ', but the field doesn\'t exist.';
+                }
+            }
         }
 
         if (

tests/Tests/ORM/Functional/SchemaValidatorTest.php

@@ -10,6 +10,7 @@
 use Doctrine\Tests\DbalTypes\CustomIdObjectType;
 use Doctrine\Tests\DbalTypes\NegativeToPositiveType;
 use Doctrine\Tests\DbalTypes\UpperCaseStringType;
+use Doctrine\Tests\ORM\Functional\Ticket\GH11608\GH11608Test;
 use Doctrine\Tests\OrmFunctionalTestCase;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Group;
@@ -52,6 +53,18 @@ public static function dataValidateModelSets(): array
         $modelSets = [];
 
         foreach (array_keys(self::$modelSets) as $modelSet) {
+
+            /**
+             * GH11608 Tests whether the Schema validator picks up on invalid mapping. The entities are intentionally
+             * invalid, and so for the purpose of this test case, those entities should be ignored.
+             *
+             * @see GH11608Test
+             * @see https://github.com/doctrine/orm/issues/11608
+             */
+            if ($modelSet === GH11608Test::class) {
+                continue;
+            }
+
             $modelSets[$modelSet] = [$modelSet];
         }
 

tests/Tests/ORM/Functional/Ticket/GH11608/ConnectingEntity.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Tests\ORM\Functional\Ticket\GH11608;
+
+use Doctrine\ORM\Mapping\Column;
+use Doctrine\ORM\Mapping\Entity;
+use Doctrine\ORM\Mapping\GeneratedValue;
+use Doctrine\ORM\Mapping\Id;
+use Doctrine\ORM\Mapping\JoinColumn;
+use Doctrine\ORM\Mapping\ManyToOne;
+
+#[Entity]
+class ConnectingEntity
+{
+    #[Id]
+    #[Column(type: 'integer')]
+    #[GeneratedValue]
+    public int $id;
+
+    #[ManyToOne(inversedBy: 'validRightSideEntities')]
+    #[JoinColumn(nullable: false)]
+    public LeftSideEntity $validLeftSideMappedByAssociation;
+
+    #[ManyToOne(inversedBy: 'invalidRightSideEntities')]
+    #[JoinColumn(nullable: false)]
+    public LeftSideEntity $invalidLeftSideMappedByAssociation;
+
+    #[ManyToOne(inversedBy: 'validConnections')]
+    #[JoinColumn(nullable: false)]
+    public LeftSideEntity $validLeftSideMappedByColumn;
+
+    #[ManyToOne(inversedBy: 'invalidConnections')]
+    #[JoinColumn(nullable: false)]
+    public LeftSideEntity $invalidLeftSideMappedByColumn;
+
+    #[ManyToOne(inversedBy: 'leftSideEntities')]
+    #[JoinColumn(name: 'right_side_id', nullable: false)]
+    public RightSideEntity $rightSide;
+
+    #[Column(type: 'text', nullable: false)]
+    public string $arbitraryValue;
+}

tests/Tests/ORM/Functional/Ticket/GH11608/GH11608Test.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Tests\ORM\Functional\Ticket\GH11608;
+
+use Doctrine\ORM\Mapping\UnderscoreNamingStrategy;
+use Doctrine\ORM\Tools\SchemaValidator;
+use Doctrine\Tests\OrmFunctionalTestCase;
+use Generator;
+use PHPUnit\Framework\Attributes\DataProvider;
+
+use function var_dump;
+
+class GH11608Test extends OrmFunctionalTestCase
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->useModelSet(self::class);
+        $this->_em->getConfiguration()->setNamingStrategy(new UnderscoreNamingStrategy());
+    }
+
+    public function testOneToManyIndexByErrorDetected(): void
+    {
+        $validator = new SchemaValidator($this->_em);
+
+        $errors = $validator->validateClass($this->_em->getClassMetadata(LeftSideEntity::class));
+
+        self::assertCount(2, $errors);
+
+        self::assertStringContainsStringIgnoringCase('invalidRightSideEntities is indexed by a field right_side_id_that_doesnt_exist', $errors[0]);
+        self::assertStringContainsStringIgnoringCase('invalidConnections is indexed by a field arbitrary_value_that_doesnt_exist', $errors[1]);
+    }
+
+    #[DataProvider('provideValidEntitiesCauseNoErrors')]
+    public function testValidEntitiesCauseNoErrors(string $className): void
+    {
+        $validator = new SchemaValidator($this->_em);
+
+        $errors = $validator->validateClass($this->_em->getClassMetadata($className));
+
+        self::assertEmpty($errors);
+    }
+
+    public static function provideValidEntitiesCauseNoErrors(): Generator
+    {
+        yield [ConnectingEntity::class];
+        yield [RightSideEntity::class];
+    }
+}

tests/Tests/ORM/Functional/Ticket/GH11608/LeftSideEntity.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Tests\ORM\Functional\Ticket\GH11608;
+
+use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\Common\Collections\Collection;
+use Doctrine\ORM\Mapping\Column;
+use Doctrine\ORM\Mapping\Entity;
+use Doctrine\ORM\Mapping\GeneratedValue;
+use Doctrine\ORM\Mapping\Id;
+use Doctrine\ORM\Mapping\OneToMany;
+
+#[Entity]
+class LeftSideEntity
+{
+    #[Id]
+    #[Column(type: 'integer')]
+    #[GeneratedValue]
+    public int $id;
+
+    #[OneToMany(targetEntity: ConnectingEntity::class, mappedBy: 'validLeftSideMappedByAssociation', indexBy: 'right_side_id')]
+    public Collection $validRightSideEntities;
+
+    #[OneToMany(targetEntity: ConnectingEntity::class, mappedBy: 'invalidLeftSideMappedByAssociation', indexBy: 'right_side_id_that_doesnt_exist')]
+    public Collection $invalidRightSideEntities;
+
+    #[OneToMany(targetEntity: ConnectingEntity::class, mappedBy: 'validLeftSideMappedByColumn', indexBy: 'arbitrary_value')]
+    public Collection $validConnections;
+
+    #[OneToMany(targetEntity: ConnectingEntity::class, mappedBy: 'invalidLeftSideMappedByColumn', indexBy: 'arbitrary_value_that_doesnt_exist')]
+    public Collection $invalidConnections;
+
+    public function __construct()
+    {
+        $this->validRightSideEntities   = new ArrayCollection();
+        $this->invalidRightSideEntities = new ArrayCollection();
+    }
+}

tests/Tests/ORM/Functional/Ticket/GH11608/RightSideEntity.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Doctrine\Tests\ORM\Functional\Ticket\GH11608;
+
+use Doctrine\Common\Collections\ArrayCollection;
+use Doctrine\Common\Collections\Collection;
+use Doctrine\ORM\Mapping\Column;
+use Doctrine\ORM\Mapping\Entity;
+use Doctrine\ORM\Mapping\GeneratedValue;
+use Doctrine\ORM\Mapping\Id;
+use Doctrine\ORM\Mapping\OneToMany;
+
+#[Entity]
+class RightSideEntity
+{
+    #[Id]
+    #[Column(type: 'integer')]
+    #[GeneratedValue]
+    public int $id;
+
+    #[OneToMany(targetEntity: ConnectingEntity::class, mappedBy: 'rightSide', indexBy: 'id')]
+    public Collection $leftSideEntities;
+
+    public function __construct()
+    {
+        $this->leftSideEntities = new ArrayCollection();
+    }
+}

tests/Tests/OrmFunctionalTestCase.php

@@ -167,6 +167,7 @@
 use Doctrine\Tests\Models\ValueConversionType\OwningOneToOneEntity;
 use Doctrine\Tests\Models\VersionedManyToOne\Article;
 use Doctrine\Tests\Models\VersionedManyToOne\Category;
+use Doctrine\Tests\ORM\Functional\Ticket\GH11608;
 use Exception;
 use PHPUnit\Framework\AssertionFailedError;
 use PHPUnit\Framework\Constraint\Count;
@@ -483,6 +484,11 @@ abstract class OrmFunctionalTestCase extends OrmTestCase
             Models\Issue9300\Issue9300Child::class,
             Models\Issue9300\Issue9300Parent::class,
         ],
+        GH11608\GH11608Test::class => [
+            GH11608\LeftSideEntity::class,
+            GH11608\RightSideEntity::class,
+            GH11608\ConnectingEntity::class,
+        ],
     ];
 
     /** @param class-string ...$models */