Unable to audit entity that contains a composite foreign key

[manuelbosi]

Environment

Sonata packages

show

$ composer show --latest 'sonata-project/*'
Direct dependencies required in composer.json:
sonata-project/entity-audit-bundle 1.18.0 1.18.0 Audit for Doctrine Entities

Transitive dependencies not required in composer.json:
Everything up to date

Symfony packages

show

$ composer show --latest 'symfony/*'
Direct dependencies required in composer.json:
symfony/apache-pack                v1.0.1  v1.0.1  A pack for Apache support in Symfony
symfony/asset                      v6.4.8  v7.1.1  Manages URL generation and versioning of web assets such as CSS stylesheets, JavaScript files and image files
symfony/cache                      v6.4.8  v7.1.5  Provides extended PSR-6, PSR-16 (and tags) implementations
symfony/console                    v6.4.8  v7.1.5  Eases the creation of beautiful and testable command line interfaces
symfony/doctrine-bridge            v6.4.8  v7.1.5  Provides integration for Doctrine with various Symfony components
symfony/dotenv                     v6.4.8  v7.1.5  Registers environment variables from a .env file
symfony/expression-language        v6.4.8  v7.1.4  Provides an engine that can compile and evaluate expressions
symfony/flex                       v2.4.5  v2.4.7  Composer plugin for Symfony
symfony/framework-bundle           v6.4.8  v7.1.5  Provides a tight integration between Symfony components and the Symfony full-stack framework
symfony/http-foundation            v6.4.8  v7.1.5  Defines an object-oriented layer for the HTTP specification
symfony/mailer                     v6.4.8  v7.1.5  Helps sending emails
symfony/maker-bundle               v1.59.1 v1.61.0 Symfony Maker helps you create empty commands, controllers, form classes, tests and more so you can forget about writi...
symfony/mime                       v6.4.8  v7.1.5  Allows manipulating MIME messages
symfony/monolog-bundle             v3.10.0 v3.10.0 Symfony MonologBundle
symfony/runtime                    v6.4.8  v7.1.1  Enables decoupling PHP applications from global state
symfony/security-bundle            v6.4.8  v7.1.4  Provides a tight integration of the Security component into the Symfony full-stack framework
symfony/serializer                 v6.4.8  v7.1.5  Handles serializing and deserializing data structures, including object graphs, into array structures or other formats...
symfony/twig-bundle                v6.4.8  v7.1.5  Provides a tight integration of Twig into the Symfony full-stack framework
symfony/validator                  v6.4.8  v7.1.5  Provides tools to validate values
symfony/yaml                       v6.4.8  v7.1.5  Loads and dumps YAML files

Transitive dependencies not required in composer.json:
symfony/cache-contracts            v3.5.0  v3.5.0  Generic abstractions related to caching
symfony/clock                      v6.4.8  v7.1.1  Decouples applications from the system clock
symfony/config                     v6.4.8  v7.1.1  Helps you find, load, combine, autofill and validate configuration values of any kind
symfony/css-selector               v6.4.8  v7.1.1  Converts CSS selectors to XPath expressions
symfony/dependency-injection       v6.4.8  v7.1.5  Allows you to standardize and centralize the way objects are constructed in your application
symfony/deprecation-contracts      v3.5.0  v3.5.0  A generic function and convention to trigger deprecation notices
symfony/error-handler              v6.4.8  v7.1.3  Provides tools to manage errors and ease debugging PHP code
symfony/event-dispatcher           v6.4.8  v7.1.1  Provides tools that allow your application components to communicate with each other by dispatching events and listeni...
symfony/event-dispatcher-contracts v3.5.0  v3.5.0  Generic abstractions related to dispatching event
symfony/filesystem                 v6.4.8  v7.1.5  Provides basic utilities for the filesystem
symfony/finder                     v6.4.8  v7.1.4  Finds files and directories via an intuitive fluent interface
symfony/http-kernel                v6.4.8  v7.1.5  Provides a structured process for converting a Request into a Response
symfony/monolog-bridge             v6.4.8  v7.1.1  Provides integration for Monolog with various Symfony components
symfony/options-resolver           v6.4.8  v7.1.1  Provides an improved replacement for the array_replace PHP function
symfony/password-hasher            v6.4.8  v7.1.1  Provides password hashing utilities
symfony/polyfill-intl-grapheme     v1.30.0 v1.31.0 Symfony polyfill for intl's grapheme_* functions
symfony/polyfill-intl-idn          v1.31.0 v1.31.0 Symfony polyfill for intl's idn_to_ascii and idn_to_utf8 functions
symfony/polyfill-intl-normalizer   v1.30.0 v1.31.0 Symfony polyfill for intl's Normalizer class and related functions
symfony/polyfill-mbstring          v1.30.0 v1.31.0 Symfony polyfill for the Mbstring extension
symfony/polyfill-php83             v1.30.0 v1.31.0 Symfony polyfill backporting some PHP 8.3+ features to lower PHP versions
symfony/process                    v6.4.8  v7.1.5  Executes commands in sub-processes
symfony/property-access            v6.4.8  v7.1.4  Provides functions to read and write from/to an object or array using a simple string notation
symfony/property-info              v6.4.8  v7.1.3  Extracts information about PHP class' properties using metadata of popular sources
symfony/routing                    v6.4.8  v7.1.4  Maps an HTTP request to a set of configuration variables
symfony/security-core              v6.4.8  v7.1.5  Symfony Security Component - Core Library
symfony/security-csrf              v6.4.8  v7.1.1  Symfony Security Component - CSRF Library
symfony/security-http              v6.4.8  v7.1.5  Symfony Security Component - HTTP Integration
symfony/service-contracts          v3.5.0  v3.5.0  Generic abstractions related to writing services
symfony/stopwatch                  v6.4.8  v7.1.1  Provides a way to profile code
symfony/string                     v6.4.8  v7.1.5  Provides an object-oriented API to strings and deals with bytes, UTF-8 code points and grapheme clusters in a unified way
symfony/translation-contracts      v3.5.0  v3.5.0  Generic abstractions related to translation
symfony/twig-bridge                v6.4.8  v7.1.5  Provides integration for Twig with various Symfony components
symfony/var-dumper                 v6.4.8  v7.1.5  Provides mechanisms for walking through any arbitrary PHP variable
symfony/var-exporter               v6.4.8  v7.1.2  Allows exporting any serializable PHP data structure to plain PHP code

PHP version

$ php -v
PHP 8.2.21 (cli) (built: Jul  6 2024 01:41:16) (NTS)
Copyright (c) The PHP Group
Zend Engine v4.2.21, Copyright (c) Zend Technologies
    with Zend OPcache v8.2.21, Copyright (c), by Zend Technologies
    with Xdebug v3.3.2, Copyright (c) 2002-2024, by Derick Rethans

Subject

We are using this bundle to save historical updates of some entities inside our symfony project and in our flow we need to create a relationship between our entity Operation and another entity Shop audit table.
To do that we first create an entity ShopAudit that contains the exact mapping of the _audit table created by the library, and then we setup the relationship on the Operation entity using the ShopAudit entity as targetEntity and a multiple join column, so now the Operation entity contains a composite foreign key done using the id,rev columns from the _audit table.
We also map the revisions table from the library in a Revision entity class, and excluded all entities mapped manually (ShopAudit, Revision) from doctrine migrations.

When we try to persist or update the Operation entity and call the flush() method from the entity manager the library tries to create an audit record but breaks with an ErrorException and the message Warning: Undefined array key "rev".

With the configuration above, just for debug purpose we also tried to comment out Operation entity from the audited_entities config and the entity was persisted without any errors but without an audit record.

Does the library supports auditing entities that contain a composite foreign key or requires some updates to handle that?

Entities definition

App\Entity\Operation

<?php

namespace App\Entity;

#[ORM\Table(name: 'operations')]
class Operation
{

    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column]
    #[DoctrineFilter\Expose]
    protected ?int $id = null;

    // ...

    #[ORM\ManyToOne(targetEntity: ShopAudit::class)]
    #[ORM\JoinColumn(name: "shop_id", referencedColumnName: 'id', nullable: false)]
    #[ORM\JoinColumn(name: "shop_rev_id", referencedColumnName: 'rev', nullable: false)]
    protected ShopAudit $shop;
    
    public function getShop(): ShopAudit
    {
        return $this->shop;
    }

    public function setShop(ShopAudit $shop): void
    {
        $this->shop = $shop;
    }

    public function getId(): ?int
    {
        return $this->id;
    }

}

App\Entity\ShopAudit

<?php

namespace App\Entity;

#[ORM\Table(name: "shops_audit")]
class ShopAudit
{

    #[ORM\Id]
    #[ORM\Column]
    private ?int $id = null;

    // ...

    #[ORM\Id]
    #[ORM\OneToOne(targetEntity: Revision::class)]
    #[ORM\JoinColumn(name: "rev", referencedColumnName: "id")]
    private Revision $rev;

    #[ORM\Column(name: "revtype", type: Types::STRING)]
    private string $revType;

    public function getId(): ?int
    {
        return $this->id;
    }

    public function getRev(): Revision
    {
        return $this->rev;
    }

    public function getRevType(): string
    {
        return $this->revType;
    }

}

App\Entity\Revision

<?php

namespace App\Entity;

#[ORM\Table(name: 'revisions')]
class Revision
{
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column]
    private ?int $id = null;

    #[ORM\Column(type: Types::DATETIME_MUTABLE)]
    private DateTime $timestamp;

    #[ORM\Column(type: Types::STRING, nullable: true)]
    private string $username;

    public function getId(): ?int
    {
        return $this->id;
    }

    public function getTimestamp(): DateTime
    {
        return $this->timestamp;
    }

    public function setTimestamp(DateTime $timestamp): Revision
    {
        $this->timestamp = $timestamp;
        return $this;
    }

    public function getUsername(): string
    {
        return $this->username;
    }

    public function setUsername(string $username): Revision
    {
        $this->username = $username;
        return $this;
    }
}

Steps to reproduce

1. Create an empty symfony project
2. Configure the database connection
3. Install this library: composer require sonata-project/entity-audit-bundle
4. Add the entities: Operation, ShopAudit and Revision
5. Exclude ShopAudit and Revision from doctrine migrations adding FQCN into the orm.schema_ignore_classes doctrine configuration
6. Create migration php bin/console make:migration
7. Run migration php bin/console do:mi:mi
8. Try to persist a new Operation entity and the error should appears.

Expected results

Audit entities that also contains composite foreign keys defined using multiple doctrine JoinColumn.

Actual results

Exception dump

object(ErrorException)[1374]
  protected 'message' => string 'Warning: Undefined array key "rev"' (length=34)
  private string 'string' (Exception) => string '' (length=0)
  protected 'code' => int 0
  protected string 'file' => string '/var/www/vendor/sonata-project/entity-audit-bundle/src/EventListener/LogRevisionsListener.php' (length=93)
  protected int 'line' => int 549
  private array 'trace' (Exception) => 
    array (size=14)
      0 => 
        array (size=6)
          'file' => string '/var/www/vendor/sonata-project/entity-audit-bundle/src/EventListener/LogRevisionsListener.php' (length=93)
          'line' => int 231
          'function' => string 'saveRevisionEntityData' (length=22)
          'class' => string 'SimpleThings\EntityAudit\EventListener\LogRevisionsListener' (length=59)
          'type' => string '->' (length=2)
          'args' => 
            array (size=4)
              ...
      1 => 
        array (size=6)
          'file' => string '/var/www/vendor/symfony/doctrine-bridge/ContainerAwareEventManager.php' (length=70)
          'line' => int 63
          'function' => string 'postPersist' (length=11)
          'class' => string 'SimpleThings\EntityAudit\EventListener\LogRevisionsListener' (length=59)
          'type' => string '->' (length=2)
          'args' => 
            array (size=1)
              ...
      2 => 
        array (size=6)
          'file' => string '/var/www/vendor/doctrine/orm/src/Event/ListenersInvoker.php' (length=59)
          'line' => int 95
          'function' => string 'dispatchEvent' (length=13)
          'class' => string 'Symfony\Bridge\Doctrine\ContainerAwareEventManager' (length=50)
          'type' => string '->' (length=2)
          'args' => 
            array (size=2)
              ...
      3 => 
        array (size=6)
          'file' => string '/var/www/vendor/doctrine/orm/src/UnitOfWork.php' (length=47)
          'line' => int 1066
          'function' => string 'invoke' (length=6)
          'class' => string 'Doctrine\ORM\Event\ListenersInvoker' (length=35)
          'type' => string '->' (length=2)
          'args' => 
            array (size=5)
              ...
      4 => 
        array (size=6)
          'file' => string '/var/www/vendor/doctrine/orm/src/UnitOfWork.php' (length=47)
          'line' => int 399
          'function' => string 'executeInserts' (length=14)
          'class' => string 'Doctrine\ORM\UnitOfWork' (length=23)
          'type' => string '->' (length=2)
          'args' => 
            array (size=0)
      5 => 
        array (size=6)
          'file' => string '/var/www/vendor/doctrine/orm/src/EntityManager.php' (length=50)
          'line' => int 259
          'function' => string 'commit' (length=6)
          'class' => string 'Doctrine\ORM\UnitOfWork' (length=23)
          'type' => string '->' (length=2)
          'args' => 
            array (size=0)
      6 => 
        array (size=6)
          'file' => string '/var/www/src/Service/OperationService.php' (length=41)
          'line' => int 122
          'function' => string 'flush' (length=5)
          'class' => string 'Doctrine\ORM\EntityManager' (length=26)
          'type' => string '->' (length=2)
          'args' => 
            array (size=0)
      7 => 
        array (size=6)
          'file' => string '/var/www/src/Controller/OperationController.php' (length=47)
          'line' => int 72
          'function' => string 'createOperation' (length=15)
          'class' => string 'App\Service\OperationService' (length=28)
          'type' => string '->' (length=2)
          'args' => 
            array (size=1)
              ...
      8 => 
        array (size=6)
          'file' => string '/var/www/vendor/symfony/http-kernel/HttpKernel.php' (length=50)
          'line' => int 181
          'function' => string 'create' (length=6)
          'class' => string 'App\Controller\OperationController' (length=34)
          'type' => string '->' (length=2)
          'args' => 
            array (size=1)
              ...
      9 => 
        array (size=6)
          'file' => string '/var/www/vendor/symfony/http-kernel/HttpKernel.php' (length=50)
          'line' => int 76
          'function' => string 'handleRaw' (length=9)
          'class' => string 'Symfony\Component\HttpKernel\HttpKernel' (length=39)
          'type' => string '->' (length=2)
          'args' => 
            array (size=2)
              ...
      10 => 
        array (size=6)
          'file' => string '/var/www/vendor/symfony/http-kernel/Kernel.php' (length=46)
          'line' => int 197
          'function' => string 'handle' (length=6)
          'class' => string 'Symfony\Component\HttpKernel\HttpKernel' (length=39)
          'type' => string '->' (length=2)
          'args' => 
            array (size=3)
              ...
      11 => 
        array (size=6)
          'file' => string '/var/www/vendor/symfony/runtime/Runner/Symfony/HttpKernelRunner.php' (length=67)
          'line' => int 35
          'function' => string 'handle' (length=6)
          'class' => string 'Symfony\Component\HttpKernel\Kernel' (length=35)
          'type' => string '->' (length=2)
          'args' => 
            array (size=1)
              ...
      12 => 
        array (size=6)
          'file' => string '/var/www/vendor/autoload_runtime.php' (length=36)
          'line' => int 29
          'function' => string 'run' (length=3)
          'class' => string 'Symfony\Component\Runtime\Runner\Symfony\HttpKernelRunner' (length=57)
          'type' => string '->' (length=2)
          'args' => 
            array (size=0)
      13 => 
        array (size=4)
          'file' => string '/var/www/public/index.php' (length=25)
          'line' => int 5
          'args' => 
            array (size=1)
              ...
          'function' => string 'require_once' (length=12)
  private ?Throwable 'previous' (Exception) => null
  protected int 'severity' => int 2

Trace

#0 /var/www/vendor/sonata-project/entity-audit-bundle/src/EventListener/LogRevisionsListener.php(231): SimpleThings\EntityAudit\EventListener\LogRevisionsListener->saveRevisionEntityData(Object(ContainerQNUoxDJ\EntityManagerGhostEbeb667), Object(Doctrine\ORM\Mapping\ClassMetadata), Array, 'INS')
#1 /var/www/vendor/symfony/doctrine-bridge/ContainerAwareEventManager.php(63): SimpleThings\EntityAudit\EventListener\LogRevisionsListener->postPersist(Object(Doctrine\ORM\Event\PostPersistEventArgs))
#2 /var/www/vendor/doctrine/orm/src/Event/ListenersInvoker.php(95): Symfony\Bridge\Doctrine\ContainerAwareEventManager->dispatchEvent('postPersist', Object(Doctrine\ORM\Event\PostPersistEventArgs))
#3 /var/www/vendor/doctrine/orm/src/UnitOfWork.php(1066): Doctrine\ORM\Event\ListenersInvoker->invoke(Object(Doctrine\ORM\Mapping\ClassMetadata), 'postPersist', Object(App\Entity\Operation), Object(Doctrine\ORM\Event\PostPersistEventArgs), 4)
#4 /var/www/vendor/doctrine/orm/src/UnitOfWork.php(399): Doctrine\ORM\UnitOfWork->executeInserts()
#5 /var/www/vendor/doctrine/orm/src/EntityManager.php(259): Doctrine\ORM\UnitOfWork->commit()
#6 /var/www/src/Service/OperationService.php(122): Doctrine\ORM\EntityManager->flush()
#7 /var/www/src/Controller/OperationController.php(72): App\Service\OperationService->createOperation(Object(App\Request\CreateOperationRequest))
#8 /var/www/vendor/symfony/http-kernel/HttpKernel.php(181): App\Controller\OperationController->create(Object(App\Request\CreateOperationRequest))
#9 /var/www/vendor/symfony/http-kernel/HttpKernel.php(76): Symfony\Component\HttpKernel\HttpKernel->handleRaw(Object(Symfony\Component\HttpFoundation\Request), 1)
#10 /var/www/vendor/symfony/http-kernel/Kernel.php(197): Symfony\Component\HttpKernel\HttpKernel->handle(Object(Symfony\Component\HttpFoundation\Request), 1, true)
#11 /var/www/vendor/symfony/runtime/Runner/Symfony/HttpKernelRunner.php(35): Symfony\Component\HttpKernel\Kernel->handle(Object(Symfony\Component\HttpFoundation\Request))
#12 /var/www/vendor/autoload_runtime.php(29): Symfony\Component\Runtime\Runner\Symfony\HttpKernelRunner->run()
#13 /var/www/public/index.php(5): require_once('/var/www/vendor...')
#14 {main}