[DoctrineBridge] Extend type guessing on enum fields

[Sajito]

Q	A
Branch?	4.4
Bug fix?	yes
New feature?	no
Deprecations?	no
Tickets	-
License	MIT
Doc PR	-

Doctrine supports enumType on array values, while the current implementation always assumes the value to be an enum object, if enumType is set.

If $typeOfField is json_array the collectionKeyType will still be null, while collectionValueType will be filled. That's because we have no way to determine from doctrine metadata, if the key is string or int. Yet I don't know if that's a valid thing to do, otherwise we should return null in that case.

[carsonbot]

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has a contribution guide which I suggest you to read.

In short:

• Always add tests
• Keep backward compatibility (see https://symfony.com/bc).
• Bug fixes must be submitted against the lowest maintained branch where they apply (see https://symfony.com/releases)
• Features and deprecations must be submitted against the 6.2 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

[carsonbot]

It looks like you unchecked the "Allow edits from maintainer" box. That is fine, but please note that if you have multiple commits, you'll need to squash your commits into one before this can be merged. Or, you can check the "Allow edits from maintainers" box and the maintainer can squash for you.

Cheers!

Carsonbot

[dunglas]

I would indeed return null instead of an incomplete type.

[Sajito]

Returning null now instead of a type without collectionKeyType.

[norkunas]

I also use just json field to declare array of enums, could we support that?

[Sajito]

Actually that's the reason for this PR. There is no way the DoctrineExtractor can guess the correct type from doctrine json field metadata. But that's not a problem, since getPhpType does not handle json fields, therefore will already return null for those cases. So another extractor will handle those cases.

[nicolas-grekas]

Thank you @Sajito.

[nicolas-grekas]

I may have merged to fast here.
@Sajito is the missing break before this line on purpose? Can you please send a PR that adds either the "break" or the "no break" comment, with a test case ideally?

[Sajito]

I have sent a new PR here: #46713.
I didn't know a "no break" comment would be required here, as I took these lines as a reference:

symfony/src/Symfony/Bridge/Doctrine/PropertyInfo/DoctrineExtractor.php

Lines 169 to 175 in 7fc7acb

	switch ($typeOfField) {
	case self::$useDeprecatedConstants ? DBALType::DATE : Types::DATE_MUTABLE:
	case self::$useDeprecatedConstants ? DBALType::DATETIME : Types::DATETIME_MUTABLE:
	case self::$useDeprecatedConstants ? DBALType::DATETIMETZ : Types::DATETIMETZ_MUTABLE:
	case 'vardatetime':
	case self::$useDeprecatedConstants ? DBALType::TIME : Types::TIME_MUTABLE:
	return [new Type(Type::BUILTIN_TYPE_OBJECT, $nullable, 'DateTime')];

Hope it's fine with the new PR.

[nicolas-grekas]

It looks like I failed at merging this PR into branch 5.4. There, the added test fails. Could you please have a look @Sajito?

Here is the failure on branch 5.4:

1) Symfony\Bridge\Doctrine\Tests\PropertyInfo\DoctrineExtractorTest::testExtractEnum
Failed asserting that two arrays are equal.
--- Expected
+++ Actual
@@ @@
         'collectionKeyType' => Array (...)
         'collectionValueType' => Array (
             0 => Symfony\Component\PropertyInfo\Type Object (
-                'builtinType' => 'object'
+                'builtinType' => 'string'
                 'nullable' => false
-                'class' => 'Symfony\Bridge\Doctrine\Tests...numInt'
+                'class' => null
                 'collection' => false
                 'collectionKeyType' => Array ()
                 'collectionValueType' => Array ()

~/Code/symfony/src/Symfony/Bridge/Doctrine/Tests/PropertyInfo/DoctrineExtractorTest.php:142

[Sajito]

I created another pull request to fix the issue on the 5.4 branch.