Merge 1.x into 2.x

Author: SonataCI

CHANGELOG.md

@@ -2,6 +2,11 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.17.1](https://github.com/sonata-project/EntityAuditBundle/compare/1.17.0...1.17.1) - 2024-04-17
+### Fixed
+- [[#617](https://github.com/sonata-project/EntityAuditBundle/pull/617)] Fix getting table name when the table schema is an empty string ([@X-Coder264](https://github.com/X-Coder264))
+- [[#615](https://github.com/sonata-project/EntityAuditBundle/pull/615)] Allow multiple relationships to the same target entity. ([@mikeyudin](https://github.com/mikeyudin))
+
 ## [1.17.0](https://github.com/sonata-project/EntityAuditBundle/compare/1.16.1...1.17.0) - 2024-04-13
 ### Changed
 - [[#612](https://github.com/sonata-project/EntityAuditBundle/pull/612)] Multiple queries to tables have been replaced with a single one ([@SavageDays](https://github.com/SavageDays))

composer.json

@@ -47,8 +47,7 @@
         "symfony/security-bundle": "^5.4 || ^6.2 || ^7.0",
         "symfony/twig-bundle": "^5.4 || ^6.2 || ^7.0",
         "symfony/var-dumper": "^5.4 || ^6.2 || ^7.0",
-        "vimeo/psalm": "^5.7",
-        "weirdan/doctrine-psalm-plugin": "^2.8"
+        "vimeo/psalm": "^5.7"
     },
     "conflict": {
         "doctrine/doctrine-bundle": "<2.7",

psalm.xml

@@ -10,7 +10,6 @@
     <plugins>
         <pluginClass class="Psalm\PhpUnitPlugin\Plugin"/>
         <pluginClass class="Psalm\SymfonyPsalmPlugin\Plugin"/>
-        <pluginClass class="Weirdan\DoctrinePsalmPlugin\Plugin"/>
     </plugins>
     <issueHandlers>
         <!-- Psalm equivalent of PHPStan config `treatPhpDocTypesAsCertain: false` -->

src/AuditConfiguration.php

@@ -33,14 +33,19 @@ class AuditConfiguration
      */
     private array $globalIgnoreColumns = [];
 
+    /** @phpstan-var literal-string  */
     private string $tablePrefix = '';
 
+    /** @phpstan-var literal-string */
     private string $tableSuffix = '_audit';
 
+    /** @phpstan-var literal-string */
     private string $revisionTableName = 'revisions';
 
+    /** @phpstan-var literal-string */
     private string $revisionFieldName = 'rev';
 
+    /** @phpstan-var literal-string */
     private string $revisionTypeFieldName = 'revtype';
 
     private string $revisionIdFieldType = Types::INTEGER;
@@ -69,13 +74,19 @@ public static function forEntities(array $classes)
      * @param ClassMetadataInfo<object> $metadata
      *
      * @return string
+     *
+     * @phpstan-return literal-string
+     *
+     * @psalm-suppress MoreSpecificReturnType,LessSpecificReturnStatement https://github.com/vimeo/psalm/issues/10910
      */
     public function getTableName(ClassMetadataInfo $metadata)
     {
+        /** @var literal-string $tableName */
         $tableName = $metadata->getTableName();
-
-        if (null !== $metadata->getSchemaName()) {
-            $tableName = $metadata->getSchemaName().'.'.$tableName;
+        /** @var literal-string|null $schemaName */
+        $schemaName = $metadata->getSchemaName();
+        if (null !== $schemaName && '' !== $schemaName) {
+            $tableName = $schemaName.'.'.$tableName;
         }
 
         return $this->getTablePrefix().$tableName.$this->getTableSuffix();
@@ -93,6 +104,8 @@ public function setDisabledForeignKeys(bool $disabled): void
 
     /**
      * @return string
+     *
+     * @phpstan-return literal-string
      */
     public function getTablePrefix()
     {
@@ -101,6 +114,8 @@ public function getTablePrefix()
 
     /**
      * @param string $prefix
+     *
+     * @phpstan-param literal-string $prefix
      */
     public function setTablePrefix($prefix): void
     {
@@ -109,6 +124,8 @@ public function setTablePrefix($prefix): void
 
     /**
      * @return string
+     *
+     * @phpstan-return literal-string
      */
     public function getTableSuffix()
     {
@@ -117,6 +134,8 @@ public function getTableSuffix()
 
     /**
      * @param string $suffix
+     *
+     * @phpstan-param literal-string $suffix
      */
     public function setTableSuffix($suffix): void
     {
@@ -125,6 +144,8 @@ public function setTableSuffix($suffix): void
 
     /**
      * @return string
+     *
+     * @phpstan-return literal-string
      */
     public function getRevisionFieldName()
     {
@@ -133,6 +154,8 @@ public function getRevisionFieldName()
 
     /**
      * @param string $revisionFieldName
+     *
+     * @phpstan-param literal-string $revisionFieldName
      */
     public function setRevisionFieldName($revisionFieldName): void
     {
@@ -141,6 +164,8 @@ public function setRevisionFieldName($revisionFieldName): void
 
     /**
      * @return string
+     *
+     * @phpstan-return literal-string
      */
     public function getRevisionTypeFieldName()
     {
@@ -149,6 +174,8 @@ public function getRevisionTypeFieldName()
 
     /**
      * @param string $revisionTypeFieldName
+     *
+     * @phpstan-param literal-string $revisionTypeFieldName
      */
     public function setRevisionTypeFieldName($revisionTypeFieldName): void
     {
@@ -157,6 +184,8 @@ public function setRevisionTypeFieldName($revisionTypeFieldName): void
 
     /**
      * @return string
+     *
+     * @phpstan-return literal-string
      */
     public function getRevisionTableName()
     {
@@ -165,6 +194,8 @@ public function getRevisionTableName()
 
     /**
      * @param string $revisionTableName
+     *
+     * @phpstan-param literal-string $revisionTableName
      */
     public function setRevisionTableName($revisionTableName): void
     {

src/AuditReader.php

@@ -701,11 +701,14 @@ public function getEntityHistory($className, int|string|array $id)
             $id = [$classMetadata->identifier[0] => $id];
         }
 
+        /** @phpstan-var array<literal-string> $whereId */
         $whereId = [];
         foreach ($classMetadata->identifier as $idField) {
             if (isset($classMetadata->fieldMappings[$idField])) {
+                /** @phpstan-var literal-string $columnName */
                 $columnName = $classMetadata->fieldMappings[$idField]['columnName'];
             } elseif (isset($classMetadata->associationMappings[$idField]['joinColumns'])) {
+                /** @phpstan-var literal-string $columnName */
                 $columnName = $classMetadata->associationMappings[$idField]['joinColumns'][0]['name'];
             } else {
                 continue;
@@ -720,10 +723,14 @@ public function getEntityHistory($className, int|string|array $id)
 
         foreach ($classMetadata->fieldNames as $columnName => $field) {
             $type = Type::getType($classMetadata->fieldMappings[$field]['type']);
-            $columnList[] = $type->convertToPHPValueSQL(
+            /** @phpstan-var literal-string $sqlExpr */
+            $sqlExpr = $type->convertToPHPValueSQL(
                 $this->quoteStrategy->getColumnName($field, $classMetadata, $this->platform),
                 $this->platform
-            ).' AS '.$this->platform->quoteSingleIdentifier($field);
+            );
+            /** @phpstan-var literal-string $quotedField */
+            $quotedField = $this->platform->quoteSingleIdentifier($field);
+            $columnList[] = $sqlExpr.' AS '.$quotedField;
             $columnMap[$field] = $this->getSQLResultCasing($this->platform, $columnName);
         }
 
@@ -736,6 +743,7 @@ public function getEntityHistory($className, int|string|array $id)
                 continue;
             }
 
+            /** @phpstan-var literal-string $sourceCol */
             foreach ($assoc['targetToSourceKeyColumns'] as $sourceCol) {
                 $columnList[] = $sourceCol;
                 $columnMap[$sourceCol] = $this->getSQLResultCasing($this->platform, $sourceCol);
@@ -744,13 +752,11 @@ public function getEntityHistory($className, int|string|array $id)
 
         $values = array_values($id);
 
-        $query = sprintf(
-            'SELECT %s FROM %s e WHERE %s ORDER BY e.%s DESC',
-            implode(', ', $columnList),
-            $tableName,
-            $whereSQL,
-            $this->config->getRevisionFieldName()
-        );
+        $query =
+            'SELECT '.implode(', ', $columnList)
+            .' FROM '.$tableName.' e'
+            .' WHERE '.$whereSQL
+            .' ORDER BY e.'.$this->config->getRevisionFieldName().' DESC';
 
         $stmt = $this->em->getConnection()->executeQuery($query, $values);
 

src/Collection/AuditedCollection.php

@@ -80,7 +80,9 @@ public function __construct(
     }
 
     /**
-     * @return true
+     * @return void
+     *
+     * @phpstan-ignore-next-line https://github.com/phpstan/phpstan-doctrine/pull/560
      */
     #[\ReturnTypeWillChange]
     public function add(mixed $element)
@@ -293,9 +295,10 @@ public function exists(\Closure $p)
     /**
      * @return Collection<TKey, T>
      *
-     * @phpstan-param \Closure(T, int|string):bool $p
-     * @psalm-param \Closure(T=):bool $p
-     * @psalm-return Collection<TKey, T>
+     * @phpstan-param \Closure(T, TKey):bool $p
+     * @phpstan-return Collection<TKey, T>
+     *
+     * @psalm-suppress MoreSpecificImplementedParamType https://github.com/doctrine/collections/pull/411
      */
     #[\ReturnTypeWillChange]
     public function filter(\Closure $p)
@@ -323,9 +326,7 @@ public function forAll(\Closure $p)
      *
      * @phpstan-template U
      * @phpstan-param \Closure(T):U $func
-     * @psalm-return Collection<TKey, U>
-     *
-     * @psalm-suppress ImplementedParamTypeMismatch,InvalidArgument
+     * @phpstan-return Collection<TKey, U>
      */
     #[\ReturnTypeWillChange]
     public function map(\Closure $func)
@@ -339,7 +340,9 @@ public function map(\Closure $func)
      * @return array<Collection<TKey, T>>
      *
      * @phpstan-param \Closure(TKey, T):bool $p
-     * @psalm-return array{0: Collection<TKey, T>, 1: Collection<TKey, T>}
+     * @phpstan-return array{0: Collection<TKey, T>, 1: Collection<TKey, T>}
+     *
+     * @psalm-suppress MoreSpecificImplementedParamType https://github.com/doctrine/collections/pull/411
      */
     #[\ReturnTypeWillChange]
     public function partition(\Closure $p)
@@ -454,7 +457,6 @@ public function count()
      * @return T|null
      *
      * @phpstan-return T|null
-     * @psalm-return mixed|null
      */
     #[\ReturnTypeWillChange]
     public function findFirst(\Closure $p)