Up psalm to level 2

psalm.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<psalm xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://getpsalm.org/schema/config" xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd" errorLevel="3" errorBaseline="psalm-baseline.xml" findUnusedPsalmSuppress="true" findUnusedBaselineEntry="true" findUnusedCode="false" resolveFromConfigFile="true">
+<psalm xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://getpsalm.org/schema/config" xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd" errorLevel="2" errorBaseline="psalm-baseline.xml" findUnusedPsalmSuppress="true" findUnusedBaselineEntry="true" findUnusedCode="false" resolveFromConfigFile="true">
     <projectFiles>
         <directory name="src"/>
         <directory name="tests"/>
@@ -12,4 +12,9 @@
         <pluginClass class="Psalm\SymfonyPsalmPlugin\Plugin"/>
         <pluginClass class="Weirdan\DoctrinePsalmPlugin\Plugin"/>
     </plugins>
+    <issueHandlers>
+        <!-- Psalm equivalent of PHPStan config `treatPhpDocTypesAsCertain: false` -->
+        <DocblockTypeContradiction errorLevel="suppress"/>
+        <RedundantConditionGivenDocblockType errorLevel="suppress"/>
+    </issueHandlers>
 </psalm>

rector.php

@@ -39,7 +39,9 @@
         CountOnNullRector::class,
         ExceptionHandlerTypehintRector::class,
         UnionTypesRector::class => [
+            __DIR__.'/src/AuditConfigurator.php',
             __DIR__.'/src/AuditReader.php',
+            __DIR__.'/src/Controller/AuditController.php',
             __DIR__.'/src/EventListener/LogRevisionsListener.php',
             __DIR__.'/src/Revision.php',
         ],

src/AuditConfiguration.php

@@ -214,7 +214,7 @@ public function getCurrentUsername()
     }
 
     /**
-     * @param callable $usernameCallable
+     * @param callable|null $usernameCallable
      */
     public function setUsernameCallable($usernameCallable): void
     {

src/Collection/AuditedCollection.php

@@ -84,7 +84,7 @@ public function __construct(
      * @return true
      */
     #[\ReturnTypeWillChange]
-    public function add($element)
+    public function add(mixed $element)
     {
         throw new AuditedCollectionException('The AuditedCollection is read-only');
     }
@@ -100,7 +100,7 @@ public function clear(): void
      * @return bool
      */
     #[\ReturnTypeWillChange]
-    public function contains($element)
+    public function contains(mixed $element)
     {
         $this->forceLoad();
 
@@ -123,6 +123,8 @@ public function isEmpty()
     }
 
     /**
+     * @param string|int $key
+     *
      * @return T|null
      */
     #[\ReturnTypeWillChange]
@@ -135,13 +137,17 @@ public function remove($key)
      * @return bool
      */
     #[\ReturnTypeWillChange]
-    public function removeElement($element)
+    public function removeElement(mixed $element)
     {
         throw new AuditedCollectionException('Audited collections does not support removal');
     }
 
     /**
+     * @param int|string $key
+     *
      * @return bool
+     *
+     * @phpstan-param TKey $key
      */
     #[\ReturnTypeWillChange]
     public function containsKey($key)
@@ -152,6 +158,8 @@ public function containsKey($key)
     }
 
     /**
+     * @param string|int $key
+     *
      * @return object
      *
      * @phpstan-return T
@@ -346,14 +354,17 @@ public function partition(\Closure $p)
      * @return TKey|false
      */
     #[\ReturnTypeWillChange]
-    public function indexOf($element)
+    public function indexOf(mixed $element)
     {
         $this->forceLoad();
 
         return $this->loadedEntities->indexOf($element);
     }
 
     /**
+     * @param int      $offset
+     * @param int|null $length
+     *
      * @return object[]
      *
      * @phpstan-return array<TKey,T>
@@ -381,7 +392,7 @@ public function getIterator()
      * @return bool
      */
     #[\ReturnTypeWillChange]
-    public function offsetExists($offset)
+    public function offsetExists(mixed $offset)
     {
         $this->forceLoad();
 
@@ -394,7 +405,7 @@ public function offsetExists($offset)
      * @phpstan-return T
      */
     #[\ReturnTypeWillChange]
-    public function offsetGet($offset)
+    public function offsetGet(mixed $offset)
     {
         if ($this->loadedEntities->offsetExists($offset)) {
             $entity = $this->loadedEntities->offsetGet($offset);
@@ -417,12 +428,12 @@ public function offsetGet($offset)
         return $resolvedEntity;
     }
 
-    public function offsetSet($offset, $value): void
+    public function offsetSet(mixed $offset, mixed $value): void
     {
         throw new AuditedCollectionException('AuditedCollection is read-only');
     }
 
-    public function offsetUnset($offset): void
+    public function offsetUnset(mixed $offset): void
     {
         throw new AuditedCollectionException('Audited collections does not support removal');
     }

src/EventListener/LogRevisionsListener.php

@@ -27,6 +27,7 @@
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Persisters\Entity\EntityPersister;
 use Doctrine\ORM\UnitOfWork;
+use Doctrine\ORM\Utility\PersisterHelper;
 use Doctrine\Persistence\Mapping\MappingException;
 use Psr\Clock\ClockInterface;
 use SimpleThings\EntityAudit\AuditConfiguration;
@@ -183,7 +184,7 @@ public function postFlush(PostFlushEventArgs $eventArgs): void
         foreach ($this->deferredChangedManyToManyEntityRevisionsToPersist as $deferredChangedManyToManyEntityRevisionToPersist) {
             $this->recordRevisionForManyToManyEntity(
                 $deferredChangedManyToManyEntityRevisionToPersist->getEntity(),
-                $em->getConnection(),
+                $em,
                 $deferredChangedManyToManyEntityRevisionToPersist->getRevType(),
                 $deferredChangedManyToManyEntityRevisionToPersist->getEntityData(),
                 $deferredChangedManyToManyEntityRevisionToPersist->getAssoc(),
@@ -361,12 +362,7 @@ private function getRevisionId(Connection $conn)
                 ]
             );
 
-            $platform = $conn->getDatabasePlatform();
-            $sequenceName = $platform->supportsSequences()
-                ? $platform->getIdentitySequenceName($this->config->getRevisionTableName(), 'id')
-                : null;
-
-            $revisionId = $conn->lastInsertId($sequenceName);
+            $revisionId = $conn->lastInsertId();
             if (false === $revisionId) {
                 throw new \RuntimeException('Unable to retrieve the last revision id.');
             }
@@ -545,7 +541,7 @@ private function saveRevisionEntityData(EntityManagerInterface $em, ClassMetadat
                                 // so we have to defer writing the revision record to the DB to the postFlush event by which point we know that the entity is gonna be flushed and have the ID assigned
                                 $this->deferredChangedManyToManyEntityRevisionsToPersist[] = new DeferredChangedManyToManyEntityRevisionToPersist($relatedEntity, $revType, $entityData, $assoc, $class, $targetClass);
                             } else {
-                                $this->recordRevisionForManyToManyEntity($relatedEntity, $conn, $revType, $entityData, $assoc, $class, $targetClass);
+                                $this->recordRevisionForManyToManyEntity($relatedEntity, $em, $revType, $entityData, $assoc, $class, $targetClass);
                             }
                         }
                     }
@@ -612,19 +608,20 @@ private function saveRevisionEntityData(EntityManagerInterface $em, ClassMetadat
      * @param ClassMetadata<object> $class
      * @param ClassMetadata<object> $targetClass
      */
-    private function recordRevisionForManyToManyEntity(object $relatedEntity, Connection $conn, string $revType, array $entityData, array $assoc, ClassMetadata $class, ClassMetadata $targetClass): void
+    private function recordRevisionForManyToManyEntity(object $relatedEntity, EntityManagerInterface $em, string $revType, array $entityData, array $assoc, ClassMetadata $class, ClassMetadata $targetClass): void
     {
+        $conn = $em->getConnection();
         $joinTableParams = [$this->getRevisionId($conn), $revType];
         $joinTableTypes = [\PDO::PARAM_INT, \PDO::PARAM_STR];
         foreach ($assoc['relationToSourceKeyColumns'] as $targetColumn) {
             $joinTableParams[] = $entityData[$class->fieldNames[$targetColumn]];
-            $joinTableTypes[] = $class->getTypeOfColumn($targetColumn);
+            $joinTableTypes[] = PersisterHelper::getTypeOfColumn($targetColumn, $class, $em);
         }
         foreach ($assoc['relationToTargetKeyColumns'] as $targetColumn) {
             $reflField = $targetClass->reflFields[$targetClass->fieldNames[$targetColumn]];
             \assert(null !== $reflField);
             $joinTableParams[] = $reflField->getValue($relatedEntity);
-            $joinTableTypes[] = $targetClass->getTypeOfColumn($targetColumn);
+            $joinTableTypes[] = PersisterHelper::getTypeOfColumn($targetColumn, $targetClass, $em);
         }
         $conn->executeStatement(
             $this->getInsertJoinTableRevisionSQL($class, $targetClass, $assoc),

tests/BaseTest.php

@@ -35,16 +35,11 @@ abstract class BaseTest extends TestCase
     protected static $conn;
 
     /**
-     * NEXT_MAJOR: Use `\Doctrine\ORM\EntityManagerInterface` instead.
-     *
-     * @var EntityManager
+     * NEXT_MAJOR: Change typehint to EntityManagerInterface.
      */
-    protected $em;
+    protected ?EntityManager $em = null;
 
-    /**
-     * @var AuditManager
-     */
-    protected $auditManager;
+    protected ?AuditManager $auditManager = null;
 
     /**
      * @var string[]
@@ -98,12 +93,7 @@ protected function getEntityManager(): EntityManager
             $mappingPaths[] = __DIR__.'/Fixtures/PHP81Issue';
         }
 
-        if (version_compare(\PHP_VERSION, '8.0.0', '>=')) {
-            $config = ORMSetup::createAttributeMetadataConfiguration($mappingPaths, true);
-        } else {
-            $config = ORMSetup::createAnnotationMetadataConfiguration($mappingPaths, true);
-        }
-
+        $config = ORMSetup::createAttributeMetadataConfiguration($mappingPaths, true);
         $connection = $this->_getConnection($config);
 
         $this->em = new EntityManager($connection, $config, new EventManager());
@@ -158,10 +148,10 @@ protected function getAuditManager(): AuditManager
         $auditConfig->setGlobalIgnoreColumns(['ignoreme']);
         $auditConfig->setUsernameCallable(static fn (): string => 'beberlei');
 
-        $auditManager = new AuditManager($auditConfig, $this->getClock());
-        $auditManager->registerEvents($this->getEntityManager()->getEventManager());
+        $this->auditManager = new AuditManager($auditConfig, $this->getClock());
+        $this->auditManager->registerEvents($this->getEntityManager()->getEventManager());
 
-        return $this->auditManager = $auditManager;
+        return $this->auditManager;
     }
 
     protected function getClock(): ?ClockInterface

tests/ClockTest.php

@@ -28,16 +28,18 @@ final class ClockTest extends BaseTest
 
     public function testFixedClockIsUsed(): void
     {
+        $em = $this->getEntityManager();
+
         $user = new Issue318User();
         $user->setAlias('alias');
-        $this->em->persist($user);
-        $this->em->flush();
+        $em->persist($user);
+        $em->flush();
 
         $userId = $user->getId();
 
         \assert(\is_int($userId));
 
-        $reader = $this->auditManager->createAuditReader($this->em);
+        $reader = $this->getAuditManager()->createAuditReader($em);
 
         $revisions = $reader->findRevisions(Issue318User::class, $userId);