Merge release 5.4.1 into 5.5.x #920

Merge release 5.4.1 into 5.5.x

Author: GromNaN

phpcs.xml.dist

@@ -31,8 +31,13 @@
         <exclude name="SlevomatCodingStandard.TypeHints.UnionTypeHintFormat.DisallowedShortNullable" />
     </rule>
 
+    <rule ref="SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint">
+        <exclude-pattern>src/Validator/Constraints/Unique.php</exclude-pattern>
+    </rule>
+
     <rule ref="PSR1.Classes.ClassDeclaration.MultipleClasses">
         <exclude-pattern>tests/*</exclude-pattern>
+        <exclude-pattern>src/Validator/Constraints/Unique.php</exclude-pattern>
     </rule>
 
     <rule ref="Squiz.Classes.ClassFileName.NoMatch">

phpstan-baseline.neon

@@ -210,6 +210,12 @@ parameters:
 			count: 1
 			path: src/DependencyInjection/Configuration.php
 
+		-
+			message: '#^Call to function method_exists\(\) with ''Doctrine\\\\ODM\\\\MongoDB\\\\Configuration'' and ''setAutoEncryption'' will always evaluate to true\.$#'
+			identifier: function.alreadyNarrowedType
+			count: 1
+			path: src/DependencyInjection/DoctrineMongoDBExtension.php
+
 		-
 			message: '#^Call to function method_exists\(\) with ''Doctrine\\\\ODM\\\\MongoDB\\\\Configuration'' and ''setUseTransactional…'' will always evaluate to true\.$#'
 			identifier: function.alreadyNarrowedType
@@ -414,12 +420,6 @@ parameters:
 			count: 1
 			path: src/Repository/ContainerRepositoryFactory.php
 
-		-
-			message: '#^Method Doctrine\\Bundle\\MongoDBBundle\\Validator\\Constraints\\Unique\:\:__construct\(\) has parameter \$options with no value type specified in iterable type array\.$#'
-			identifier: missingType.iterableValue
-			count: 1
-			path: src/Validator/Constraints/Unique.php
-
 		-
 			message: '#^Call to method PHPUnit\\Framework\\Assert\:\:assertFalse\(\) with false will always evaluate to false\.$#'
 			identifier: method.impossibleType
@@ -534,24 +534,6 @@ parameters:
 			count: 1
 			path: tests/DependencyInjection/ConfigurationTest.php
 
-		-
-			message: '#^Call to an undefined method Doctrine\\ODM\\MongoDB\\Configuration\:\:getDefaultKmsProvider\(\)\.$#'
-			identifier: method.notFound
-			count: 3
-			path: tests/DependencyInjection/DoctrineMongoDBExtensionTest.php
-
-		-
-			message: '#^Call to an undefined method Doctrine\\ODM\\MongoDB\\Configuration\:\:getDefaultMasterKey\(\)\.$#'
-			identifier: method.notFound
-			count: 3
-			path: tests/DependencyInjection/DoctrineMongoDBExtensionTest.php
-
-		-
-			message: '#^Call to an undefined method Doctrine\\ODM\\MongoDB\\Configuration\:\:getDriverOptions\(\)\.$#'
-			identifier: method.notFound
-			count: 7
-			path: tests/DependencyInjection/DoctrineMongoDBExtensionTest.php
-
 		-
 			message: '#^Method Doctrine\\Bundle\\MongoDBBundle\\Tests\\DependencyInjection\\DoctrineMongoDBExtensionTest\:\:assertDICDefinitionMethodCall\(\) has parameter \$params with no value type specified in iterable type array\.$#'
 			identifier: missingType.iterableValue
@@ -791,9 +773,3 @@ parameters:
 			identifier: argument.type
 			count: 1
 			path: tests/ServiceRepositoryTest.php
-
-		-
-			message: '#^Property Doctrine\\Bundle\\MongoDBBundle\\Tests\\Validator\\Constraints\\UniqueDocumentDummyOne\:\:\$email is unused\.$#'
-			identifier: property.unused
-			count: 1
-			path: tests/Validator/Constraints/UniqueTest.php

phpstan.neon.dist

@@ -8,6 +8,9 @@ parameters:
         - config
         - src
         - tests
+    excludePaths:
+        # Error "overriding property ... should also have native type" is not ignorable
+        - src/Validator/Constraints/Unique.php
 
     ignoreErrors:
         - message: '# with generic class Doctrine\\ODM\\MongoDB\\Mapping\\ClassMetadata#'

src/Validator/Constraints/Unique.php

@@ -5,46 +5,33 @@
 namespace Doctrine\Bundle\MongoDBBundle\Validator\Constraints;
 
 use Attribute;
+use ReflectionProperty;
 use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
 
-/**
- * Constraint for the unique document validator
- *
- * @Annotation
- * @Target({"CLASS", "ANNOTATION"})
- */
-#[Attribute(Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
-class Unique extends UniqueEntity
-{
+if ((new ReflectionProperty(UniqueEntity::class, 'service'))->hasType()) {
     /**
-     * @param string[]|string      $fields     The combination of fields that must contain unique values or a set of options
-     * @param bool|string[]|string $ignoreNull The combination of fields that ignore null values
+     * Constraint for the unique document validator
+     *
+     * @Annotation
+     * @Target({"CLASS", "ANNOTATION"})
      */
-    public function __construct(
-        array|string $fields,
-        ?string $message = null,
-        string $service = 'doctrine_odm.mongodb.unique',
-        ?string $em = null,
-        ?string $entityClass = null,
-        ?string $repositoryMethod = null,
-        ?string $errorPath = null,
-        bool|array|string|null $ignoreNull = null,
-        ?array $groups = null,
-        mixed $payload = null,
-        array $options = [],
-    ) {
-        parent::__construct(
-            $fields,
-            $message,
-            $service,
-            $em,
-            $entityClass,
-            $repositoryMethod,
-            $errorPath,
-            $ignoreNull,
-            $groups,
-            $payload,
-            $options,
-        );
+    #[Attribute(Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
+    class Unique extends UniqueEntity
+    {
+        public string $service = 'doctrine_odm.mongodb.unique';
+    }
+} else {
+    // Compatibility for symfony/doctrine-bridge < 7.0
+    /**
+     * Constraint for the unique document validator
+     *
+     * @Annotation
+     * @Target({"CLASS", "ANNOTATION"})
+     */
+    #[Attribute(Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
+    class Unique extends UniqueEntity
+    {
+        /** @var string $service */
+        public $service = 'doctrine_odm.mongodb.unique';
     }
 }

tests/Validator/Constraints/UniqueTest.php

@@ -4,6 +4,8 @@
 
 namespace Doctrine\Bundle\MongoDBBundle\Tests\Validator\Constraints;
 
+use Composer\InstalledVersions;
+use Composer\Semver\VersionParser;
 use Doctrine\Bundle\MongoDBBundle\Validator\Constraints\Unique;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Validator\Mapping\ClassMetadata;
@@ -23,11 +25,71 @@ public function testWithDefaultProperty(): void
         self::assertInstanceOf(Unique::class, $constraint);
         self::assertSame(['email'], $constraint->fields);
         self::assertSame('doctrine_odm.mongodb.unique', $constraint->validatedBy());
+        self::assertNull($constraint->em);
+    }
+
+    public function testWithGroups(): void
+    {
+        $metadata = new ClassMetadata(UniqueDocumentWithGroups::class);
+
+        $loader = new AttributeLoader();
+        self::assertTrue($loader->loadClassMetadata($metadata));
+
+        [$constraint] = $metadata->getConstraints();
+        self::assertInstanceOf(Unique::class, $constraint);
+        self::assertSame(['email'], (array) $constraint->fields);
+        self::assertSame(['group1'], $constraint->groups);
+        self::assertSame('doctrine_odm.mongodb.unique', $constraint->validatedBy());
+        self::assertNull($constraint->em);
+    }
+
+    public function testWithIdentifierFieldNames(): void
+    {
+        if (! InstalledVersions::satisfies(new VersionParser(), 'symfony/doctrine-bridge', '>= 7.3')) {
+            self::markTestSkipped('Requires symfony/doctrine-bridge 7.3 or higher, with $identifierFieldNames field');
+        }
+
+        $metadata = new ClassMetadata(UniqueDocumentWithIdentifierFieldNames::class);
+
+        $loader = new AttributeLoader();
+
+        self::assertTrue($loader->loadClassMetadata($metadata));
+
+        [$constraint] = $metadata->getConstraints();
+        self::assertInstanceOf(Unique::class, $constraint);
+        self::assertSame(['email'], $constraint->fields);
+        self::assertSame('Custom message', $constraint->message);
+        self::assertSame('custom_em', $constraint->em);
+        self::assertFalse($constraint->ignoreNull);
+        self::assertSame(['id', 'name'], $constraint->identifierFieldNames);
+        self::assertSame(['group1', 'group2'], $constraint->groups);
+        self::assertSame('doctrine_odm.mongodb.unique', $constraint->validatedBy());
     }
 }
 
 #[Unique(['email'])]
 class UniqueDocumentDummyOne
 {
-    private string $email;
+    public string $email;
+}
+
+#[Unique(fields: 'email', groups: ['group1'])]
+class UniqueDocumentWithGroups
+{
+    public string $email;
+}
+
+#[Unique(
+    ['email'],
+    'Custom message',
+    em: 'custom_em',
+    ignoreNull: false,
+    identifierFieldNames: ['id', 'name'],
+    groups: ['group1', 'group2'],
+)]
+class UniqueDocumentWithIdentifierFieldNames
+{
+    public string $name;
+
+    public string $email;
 }