Add doctrine/orm 3 support

.github/workflows/test.yaml

@@ -37,6 +37,7 @@ jobs:
                 allowed-to-fail: [false]
                 symfony-require: ['']
                 variant: [normal]
+                stability: [stable]
                 include:
                     - php-version: '8.0'
                       dependencies: lowest
@@ -57,6 +58,11 @@ jobs:
                       allowed-to-fail: false
                       symfony-require: 6.3.*
                       variant: symfony/symfony:"6.3.*"
+                    - php-version: '8.2'
+                      dependencies: highest
+                      allowed-to-fail: true
+                      symfony-require: normal
+                      stability: dev
 
         steps:
             - name: Checkout
@@ -67,16 +73,14 @@ jobs:
               with:
                   php-version: ${{ matrix.php-version }}
                   coverage: pcov
-                  tools: composer:v2
+                  tools: composer:v2, flex
 
             - name: Add PHPUnit matcher
               run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
 
-            - name: Globally install symfony/flex
-              if: matrix.symfony-require != ''
-              run: |
-                  composer global config --no-plugins allow-plugins.symfony/flex true
-                  composer global require --no-progress --no-scripts --no-plugins symfony/flex
+            - name: Use dev stability
+              if: matrix.stability == 'dev'
+              run: composer config prefer-stable false
 
             - name: Install variant
               if: matrix.variant != 'normal' && !startsWith(matrix.variant, 'symfony/symfony')

composer.json

@@ -13,7 +13,7 @@
         "doctrine/collections": "^1.8 || ^2.0",
         "doctrine/dbal": "^3.4",
         "doctrine/event-manager": "^1.2 || ^2.0",
-        "doctrine/orm": "^2.14",
+        "doctrine/orm": "^2.14 || ^3.0",
         "doctrine/persistence": "^3.0",
         "psr/clock": "^1.0",
         "symfony/config": "^5.4 || ^6.2",

phpstan-baseline.neon

@@ -3,3 +3,9 @@ parameters:
         # The class "AuditController" is deprecated and extends a class that is only supported in "symfony/http-foundation" < 5.
         # NEXT_MAJOR: Remove these files
         - src/Controller/AuditController.php
+    ignoreErrors:
+        # For compatibility with doctrine/orm 2 and 3
+        - '#.+ has invalid type Doctrine\\ORM\\Mapping\\AssociationMapping\.$#'
+        - '#^Property SimpleThings\\EntityAudit\\Collection\\AuditedCollection\:\:\$associationDefinition has unknown class Doctrine\\ORM\\Mapping\\AssociationMapping as its type\.$#'
+        - '#^Cannot access offset ''relationToSourceKey…'' on array\<string, mixed\>\|Doctrine\\ORM\\Mapping\\AssociationMapping\.$#'
+        - '#^Cannot access offset ''relationToTargetKey…'' on array\<string, mixed\>\|Doctrine\\ORM\\Mapping\\AssociationMapping\.$#'

psalm-baseline.xml

@@ -1,9 +1,16 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="4.11.1@e33492398bd4e5e2ab60e331d445979bd83feecd">
+<files psalm-version="5.15.0@5c774aca4746caf3d239d9c8cadb9f882ca29352">
     <!-- NEXT_MAJOR: Remove this file -->
     <file src="src/Controller/AuditController.php">
         <UndefinedClass occurrences="1">
             <code>Controller</code>
         </UndefinedClass>
     </file>
+    <!-- For compatibility with doctrine/orm 2 and 3 -->
+    <file src="src/EventListener/LogRevisionsListener.php">
+        <UndefinedClass>
+            <code><![CDATA[array<string, mixed>|AssociationMapping]]></code>
+            <code><![CDATA[array<string, mixed>|AssociationMapping]]></code>
+        </UndefinedClass>
+    </file>
 </files>

src/AuditConfiguration.php

@@ -14,7 +14,7 @@
 namespace SimpleThings\EntityAudit;
 
 use Doctrine\DBAL\Types\Types;
-use Doctrine\ORM\Mapping\ClassMetadataInfo;
+use Doctrine\ORM\Mapping\ClassMetadata;
 use SimpleThings\EntityAudit\Metadata\MetadataFactory;
 
 class AuditConfiguration
@@ -66,11 +66,11 @@ public static function forEntities(array $classes)
     }
 
     /**
-     * @param ClassMetadataInfo<object> $metadata
+     * @param ClassMetadata<object> $metadata
      *
      * @return string
      */
-    public function getTableName(ClassMetadataInfo $metadata)
+    public function getTableName(ClassMetadata $metadata)
     {
         $tableName = $metadata->getTableName();
 

src/Collection/AuditedCollection.php

@@ -15,7 +15,8 @@
 
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
-use Doctrine\ORM\Mapping\ClassMetadataInfo;
+use Doctrine\ORM\Mapping\AssociationMapping;
+use Doctrine\ORM\Mapping\ClassMetadata;
 use SimpleThings\EntityAudit\AuditConfiguration;
 use SimpleThings\EntityAudit\AuditReader;
 use SimpleThings\EntityAudit\Exception\AuditedCollectionException;
@@ -64,13 +65,13 @@ class AuditedCollection implements Collection
      * @param string|int           $revision
      *
      * @phpstan-param class-string<T> $class
-     * @phpstan-param ClassMetadataInfo<T> $metadata
+     * @phpstan-param ClassMetadata<T> $metadata
      */
     public function __construct(
         protected AuditReader $auditReader,
         protected $class,
-        protected ClassMetadataInfo $metadata,
-        protected array $associationDefinition,
+        protected ClassMetadata $metadata,
+        protected array|AssociationMapping $associationDefinition,
         protected array $foreignKeys,
         protected $revision
     ) {

src/EventListener/CreateSchemaListener.php

@@ -19,7 +19,7 @@
 use Doctrine\DBAL\Schema\Table;
 use Doctrine\DBAL\Types\Type;
 use Doctrine\DBAL\Types\Types;
-use Doctrine\ORM\Mapping\ClassMetadataInfo;
+use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Tools\Event\GenerateSchemaEventArgs;
 use Doctrine\ORM\Tools\Event\GenerateSchemaTableEventArgs;
 use Doctrine\ORM\Tools\ToolEvents;
@@ -95,7 +95,7 @@ public function postGenerateSchemaTable(GenerateSchemaTableEventArgs $eventArgs)
         }
         $revisionTable->addColumn($this->config->getRevisionFieldName(), $this->config->getRevisionIdFieldType());
         $revisionTable->addColumn($this->config->getRevisionTypeFieldName(), Types::STRING, ['length' => 4]);
-        if (!\in_array($cm->inheritanceType, [ClassMetadataInfo::INHERITANCE_TYPE_NONE, ClassMetadataInfo::INHERITANCE_TYPE_JOINED, ClassMetadataInfo::INHERITANCE_TYPE_SINGLE_TABLE], true)) {
+        if (!\in_array($cm->inheritanceType, [ClassMetadata::INHERITANCE_TYPE_NONE, ClassMetadata::INHERITANCE_TYPE_JOINED, ClassMetadata::INHERITANCE_TYPE_SINGLE_TABLE], true)) {
             throw new \Exception(sprintf('Inheritance type "%s" is not yet supported', $cm->inheritanceType));
         }
 

src/EventListener/LogRevisionsListener.php

@@ -24,6 +24,7 @@
 use Doctrine\ORM\Event\PostPersistEventArgs;
 use Doctrine\ORM\Event\PostUpdateEventArgs;
 use Doctrine\ORM\Events;
+use Doctrine\ORM\Mapping\AssociationMapping;
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Persisters\Entity\EntityPersister;
 use Doctrine\ORM\UnitOfWork;
@@ -451,12 +452,15 @@ private function getInsertRevisionSQL(EntityManagerInterface $em, ClassMetadata
     }
 
     /**
-     * @param ClassMetadata<object> $class
-     * @param ClassMetadata<object> $targetClass
-     * @param array<string, mixed>  $assoc
+     * @param ClassMetadata<object>                   $class
+     * @param ClassMetadata<object>                   $targetClass
+     * @param array<string, mixed>|AssociationMapping $assoc
      */
-    private function getInsertJoinTableRevisionSQL(ClassMetadata $class, ClassMetadata $targetClass, array $assoc): string
-    {
+    private function getInsertJoinTableRevisionSQL(
+        ClassMetadata $class,
+        ClassMetadata $targetClass,
+        array|AssociationMapping $assoc
+    ): string {
         $cacheKey = $class->name.'.'.$targetClass->name;
         if (!isset($this->insertJoinTableRevisionSQL[$cacheKey])
             && isset($assoc['relationToSourceKeyColumns'], $assoc['relationToTargetKeyColumns'], $assoc['joinTable']['name'])) {
@@ -608,13 +612,20 @@ private function saveRevisionEntityData(EntityManagerInterface $em, ClassMetadat
     }
 
     /**
-     * @param array<string, mixed>  $assoc
-     * @param array<string, mixed>  $entityData
-     * @param ClassMetadata<object> $class
-     * @param ClassMetadata<object> $targetClass
+     * @param array<string, mixed>|AssociationMapping $assoc
+     * @param array<string, mixed>                    $entityData
+     * @param ClassMetadata<object>                   $class
+     * @param ClassMetadata<object>                   $targetClass
      */
-    private function recordRevisionForManyToManyEntity(object $relatedEntity, EntityManagerInterface $em, string $revType, array $entityData, array $assoc, ClassMetadata $class, ClassMetadata $targetClass): void
-    {
+    private function recordRevisionForManyToManyEntity(
+        object $relatedEntity,
+        EntityManagerInterface $em,
+        string $revType,
+        array $entityData,
+        array|AssociationMapping $assoc,
+        ClassMetadata $class,
+        ClassMetadata $targetClass
+    ): void {
         $conn = $em->getConnection();
         $joinTableParams = [$this->getRevisionId($conn), $revType];
         $joinTableTypes = [\PDO::PARAM_INT, \PDO::PARAM_STR];