ReadWritePropertiesExtension is not respected with readonly property

[noemi-salaun]

Bug report

I have Doctrine entities with an $id properties that are never initialized in my code. I made PHPStan aware of it with a ReadWritePropertiesExtension and it works perfectly.

But if I add the new readonly keyword on my property, PHPStan give me this error

Class MyEntity has an uninitialized readonly property $id. Assign it in the constructor.

Code snippet that reproduces the problem

#[ORM\Entity]
class MyEntity
{
    #[ORM\Column, ORM\Id, ORM\GeneratedValue]
    private readonly int $id;

    #[ORM\Column]
    private string $name;

    public function __construct(string $name)
    {
        $this->name = $name;
    }
}

Expected output

I expect no error from PHPStan, since the extension tell it that the property is always initialized

[mergeable]

This bug report is missing a link to reproduction on phpstan.org.

It will most likely be closed after manual review.

[noemi-salaun]

I think I cannot reproduce it on the playground since it needs an Extension

[ondrejmirtes]

I'm not sure about the nature of this problem. Do you experience this with phpstan-doctrine, or with your own custom ReadWritePropertiesExtension?

[noemi-salaun]

It's my own ReadWritePropertiesExtension

final class DoctrineEntityPropertiesExtension implements ReadWritePropertiesExtension
{
    public function isAlwaysRead(PropertyReflection $property, string $propertyName): bool
    {
        return $this->hasDoctrineAnnotation($property);
    }

    public function isAlwaysWritten(PropertyReflection $property, string $propertyName): bool
    {
        return $this->hasDoctrineAnnotation($property);
    }

    public function isInitialized(PropertyReflection $property, string $propertyName): bool
    {
        return $this->hasDoctrineAnnotation($property);
    }

    private function hasDoctrineAnnotation(PropertyReflection $property): bool
    {
        if (!$property instanceof \PHPStan\Reflection\Php\PhpPropertyReflection) {
            return false;
        }

        $attributes = $property->getNativeReflection()->getAttributes();
        foreach ($attributes as $attribute) {
            if (str_starts_with($attribute->getName(), 'Doctrine\ORM')) {
                return true;
            }
        }

        return false;
    }
}

[ondrejmirtes]

Looks like MissingReadOnlyPropertyAssignRule doesn't work with ReadWritePropertiesExtension but should.

@herndlm Could you please try reproducing the problem with a new RuleTestCase child class (that allows you to register a custom extension in getAdditionalConfigFiles()) and see why it doesn't work? Thanks :)

[ondrejmirtes]

@herndlm This looks very similar #7337 and is actually about phpstan-doctrine. I'd love if you could find some time to fix this, thanks :)

[herndlm]

Sure, is on my virtual list to be looked at next.

[ondrejmirtes]

Fixed: phpstan/phpstan-src#1357

[herndlm]

@noemi-salaun did you check already if this is working for you now? Just asking, because we seem to be still having a related problem in the phpstan-doctrine extension and this might tell me already if phpstan or phpstan-doctrine is the cause.

[noemi-salaun]

@herndlm I did not, sorry. I was on a extended weekend :)
I think I'll be able to check it today.
Is there a new stable version I can use to test it, or do I have to use a dev version ?

[ondrejmirtes]

It's been released already https://github.com/phpstan/phpstan/releases/tag/1.7.3.

[noemi-salaun]

It looks good :)

PHPStan warns me about an unused "Ignored error pattern"

        -
            message: '#Class .* has an uninitialized readonly property \$.*\. Assign it in the constructor\.#'
            paths:
                - src/Entity

Thanks for the awesome job ;)

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.