Calling setAssociationOverride in prePersist/preUpdate throws an exception

[jkabat]

Bug Report

After upgrade to v3 I'm facing following exception "Typed property Doctrine\ORM\Mapping\ClassMetadata::$namingStrategy must not be accessed before initialization"

It might be caused by the fact naming strategy service is removed in compiler pass?

Q	A
Version	3.3.2
Previous working version	2.20.2

[jkabat]

During debugging I've found out removal of following config resolves the issue

    doctrine:
        orm:
            metadata_cache_driver:
                type: pool
                pool: doctrine.system_cache_pool

I will do more tests, but in the past I had to keep the setting for one of my bundles.

@ostrolucky could it be a problem with DoctrineBundle?
Also removing metadata_cache_driver can lead to performance degradation?

[ostrolucky]

I don't think accessing uninitialized property is a problem with a bundle

[jkabat]

@ostrolucky thank you for quick response

[jkabat]

metadata_cache_driver removal was false positive. Sometimes it works, sometimes it is not and since it only happens in PROD environment I cant easily find the logic behind it.

My containers are having cache cleared before first usage. When I'm debugging, after running cache:warmup and reloading of phpfpm (clearing opcode cache), I saw few times that ClassMetadata had namingStrategy properly instantiated and everything worked. By repeating the request it failed again.

EDIT:

• seems like after cache:warmup it works all the time, after cache:clear never.
• cache:warmup is only one time go, next request fails again

Any clues @greg0ire ?

[jkabat]

I realized doctrine metadata are using 2 cache drivers in my production environment (depends of the cache driver setup): APC and PHPArray. When class metadata are reloaded from APC cache, "namingStrategy" property was not warmed up/instantiated, hence the exception.

Typed property Doctrine\ORM\Mapping\ClassMetadata::$namingStrategy must not be accessed before initialization

It happens on line https://github.com/doctrine/orm/blob/3.3.x/src/Mapping/ClassMetadata.php#L1396

However disabling of APC cache did not solve the problem. I wonder how come nobody has not found the issue yet...

[greg0ire]

I'm reproducing the bug by adding $addressMetadata = unserialize(serialize($addressMetadata)); here:

orm/tests/Tests/ORM/Mapping/ClassMetadataTest.php

Line 776 in 05c8c5f

The "bug" is slightly different if I try it on 2.x (it complains about the object being null, because there is no property type).

I'm using quotes because nobody ever complained about this on 2.x, where the code is quite different and maybe mapField and setAttributeOverride on 2.x are never called on a class metadata pulled from the cache, and maybe I failed to preserve this while refactoring this for 3.x 🤔

It would be great if you could get a stack trace for your error, so that we can understand which method calls _validateAndCompleteAssociationMapping

[Bryce-Colton]

We are experiencing a similar issue.

We have some code that manipulate metadata to add some relation at runtime (to handle custom fields).
Here is the sample :

$metadata->mapOneToOne([
                    'fieldName' => $entityField,
                    'targetEntity' => $refClassName,
                    'joinColumns' => [[
                        'name' => $databaseField,
                        'referencedColumnName' => 'id',
                        'nullable' => true,
                    ]],
                ]);

If container running in

• APP_ENV=dev
• APP_DEBUG=0

We got "Typed property Doctrine\ORM\Mapping\ClassMetadata::$namingStrategy must not be accessed before initialization"

If container running in

• APP_ENV=dev
• APP_DEBUG=1

It works like expected.

NB : Clear cache command is executed each time container are recreated with env changes. We have reproduced on remote staging server and on local machine (where cache files are mounted to the container).

We hope this helps you identify the root cause of these bugs.

Here the stack trace from profiler (see Request/Response => exception)

Html report : doctrine-orm-stack-trace.txt

[greg0ire]

@jkabat are you maybe manipulating metadata at runtime as well?

@Bryce-Colton why does it need to be at runtime in your case? Seems inefficient 🤔

[jkabat]

@greg0ire yes, I'm overriding association before specific PERSIST/UPDATE. Unfortunately I couldn't find proper way to make it work without this "hack" (default association is OK for all hydrate operations).

Exception happens in this method:

        $md->setAssociationOverride('callPhone', [
            'joinColumns' => [[
                'name' => $columnName,
                'unique' => false,
                'nullable' => true,
                'onDelete' => null,
                'columnDefinition' => null,
                'referencedColumnName' => 'number',
            ]],
        ]);

...and then in https://github.com/doctrine/orm/blob/3.3.x/src/Mapping/ClassMetadata.php#L1396 as said before.

Temporary solution for me is to bind namingStrategy property of ClassMetadata with the value from doctrine configuration just before calling setAssociationOverride.

[greg0ire]

How / why was it working in 2.x ? Maybe it was because the naming strategy, which was, I think, null, was never actually used in code triggered by setAssociationOverride? I guess that code includes _validateAndCompleteAssociationMapping at some point?

[jkabat]

Yes, setAssociationOverride triggers _validateAndCompleteAssociationMapping. In v2 was not all properties strict typed and maybe in case of NULL, default namingStrategy was used. Hence no exception.

[Bryce-Colton]

I can confirm that the bug only occurs when attempting to modify the metadata by calling methods that internally trigger _validateAndCompleteAssociationMapping() (e.g. setAssociationOverride(), mapOneToOne(), etc.).

Like @jkabat, I implemented a workaround to ensure that the namingStrategy property is initialized before calling these methods.

Here is the patch I applied: gist

And an example of how I use it in my code:

$metadata = $this->entityManager->getClassMetadata($entityClassName);
$namingStrategy = $this->entityManager->getConfiguration()->getNamingStrategy();
DoctrineMetadataPatcher::ensureNamingStrategy($metadata, $namingStrategy);

$metadata->mapOneToOne(...);

@greg0ire : Thank you in advance for the work you're doing on this — it’s not an easy one, but your contribution is really appreciated.

[jkabat]

Thanks for sharing your workaround @Bryce-Colton

I used closure bind technique (🙈) to initialize private property (until I get rid of setAssociationOverride or the issue gets a proper fix).

    private function bindNamingStrategy(ClassMetadata $md, EntityManagerInterface $entityManager): void
    {
        $function = function (NamingStrategy $namingStrategy): void {
            /** @phpstan-ignore-next-line */
            $this->namingStrategy = $namingStrategy;
        };

        $closure = \Closure::bind($function, $md, $md);
        $closure($entityManager->getConfiguration()->getNamingStrategy());
    }