fix: Normalize class names #300 (#301)

Co-authored-by: Grégoire Paris <postmaster@greg0ire.fr>

psalm.phpstub

@@ -0,0 +1,12 @@
+<?php
+/**
+ * Workaround for psalm to return a class-string when used with a class string
+ * Can be removed when https://github.com/vimeo/psalm/pull/8219 is released
+ *
+ * @psalm-pure
+ *
+ * @return ($string is class-string ? ($characters is '\\' ? class-string : string) : string)
+ *
+ * @psalm-flow ($string) -> return
+ */
+function ltrim(string $string, string $characters = " \t\n\r\0\x0B") : string {}

psalm.xml

@@ -57,4 +57,7 @@
             </errorLevel>
         </ArgumentTypeCoercion>
     </issueHandlers>
+    <stubs>
+        <file name="psalm.phpstub" />
+    </stubs>
 </psalm>

src/Persistence/Mapping/AbstractClassMetadataFactory.php

@@ -17,6 +17,7 @@
 use function array_unshift;
 use function assert;
 use function class_exists;
+use function ltrim;
 use function str_replace;
 use function strpos;
 use function strrpos;
@@ -153,6 +154,21 @@ abstract protected function initializeReflection(
      */
     abstract protected function isEntity(ClassMetadata $class);
 
+    /**
+     * Removes the prepended backslash of a class string to conform with how php outputs class names
+     *
+     * @psalm-param class-string $className
+     *
+     * @psalm-return class-string
+     */
+    private function normalizeClassName(string $className): string
+    {
+        /**
+         * @phpstan-ignore-next-line
+         */
+        return ltrim($className, '\\');
+    }
+
     /**
      * {@inheritDoc}
      *
@@ -161,6 +177,8 @@ abstract protected function isEntity(ClassMetadata $class);
      */
     public function getMetadataFor(string $className)
     {
+        $className = $this->normalizeClassName($className);
+
         if (isset($this->loadedMetadata[$className])) {
             return $this->loadedMetadata[$className];
         }
@@ -232,6 +250,8 @@ public function getMetadataFor(string $className)
      */
     public function hasMetadataFor(string $className)
     {
+        $className = $this->normalizeClassName($className);
+
         return isset($this->loadedMetadata[$className]);
     }
 
@@ -240,13 +260,14 @@ public function hasMetadataFor(string $className)
      *
      * NOTE: This is only useful in very special cases, like when generating proxy classes.
      *
+     * @psalm-param class-string $className
      * @psalm-param CMTemplate $class
      *
      * @return void
      */
     public function setMetadataFor(string $className, ClassMetadata $class)
     {
-        $this->loadedMetadata[$className] = $class;
+        $this->loadedMetadata[$this->normalizeClassName($className)] = $class;
     }
 
     /**

tests/Persistence/Mapping/AbstractClassMetadataFactoryTest.php

@@ -78,6 +78,22 @@ public function testItThrowsWhenAttemptingToCheckTransientForShortAlias(): void
         // @phpstan-ignore-next-line
         $cmf->isTransient('App:Test');
     }
+
+    public function testItGetsTheSameMetadataForBackslashedClassName(): void
+    {
+        $cmf = $this->getMockForAbstractClass(AbstractClassMetadataFactory::class);
+        $cmf
+            ->method('newClassMetadataInstance')
+            ->with(SomeOtherEntity::class)
+            ->willReturn(
+                $this->createStub(ClassMetadata::class)
+            );
+
+        /**
+         * @psalm-suppress ArgumentTypeCoercion
+         */
+        self::assertSame($cmf->getMetadataFor(SomeOtherEntity::class), $cmf->getMetadataFor('\\' . SomeOtherEntity::class));
+    }
 }
 
 class SomeGrandParentEntity
@@ -91,3 +107,7 @@ class SomeParentEntity extends SomeGrandParentEntity
 final class SomeEntity extends SomeParentEntity
 {
 }
+
+final class SomeOtherEntity
+{
+}