Add reflection typed no default property class #24

sspat · 2019-12-02T14:26:17Z

Implementation for issue #23
See discussion in doctrine/orm#7857

As suggested by @beberlei, the \Doctrine\Common\Reflection\TypedNoDefaultReflectionProperty class was introduced.
It will be returned in doctrine/persistence package class RuntimeReflectionService::getAccessibleProperty if the property is typed and has no default value. Something like this:

/**
 * {@inheritDoc}
 */
public function getAccessibleProperty(string $class, string $property) : ?ReflectionProperty
{
    $reflectionProperty = new ReflectionProperty($class, $property);

    if (! array_key_exists($property, $this->getClass($class)->getDefaultProperties())) {
        $reflectionProperty = new TypedNoDefaultReflectionProperty($class, $property);
    } elseif ($reflectionProperty->isPublic()) {
        $reflectionProperty = new RuntimePublicReflectionProperty($class, $property);
    }

    $reflectionProperty->setAccessible(true);

    return $reflectionProperty;
}

Also updated phpunit config as suggested in the discussion in the same issue #23.
This allows skipping tests containing php 7.4 specific syntax on builds with lesser php versions.
Also updated travis-ci.yml Lint job to ignore such tests by phpstan analysis, if the php version is less than 7.4

alcaeus

Logic LGTM, not sure about changes to the PHPStan build stage on travis-ci.

alcaeus · 2019-12-02T15:36:27Z

.travis.yml


    - stage: Lint
-      script: vendor/bin/phpstan analyse -l 3 -c phpstan.neon lib tests
+      before_script: if grep -si 7.4 <<< "$TRAVIS_PHP_VERSION"; then export TESTS_PATH="tests/Doctrine/Tests tests/Doctrine/Tests_PHP74"; else export TESTS_PATH=tests/Doctrine/Tests; fi


Is there a way to avoid this conditional? Does PHPStan stumble over these test files?

Yes, now as I think of it, there is a better way to solve this.

The problem is, that the PHPStan version currently used depends on an older version of nikic/php-parser that does not know the new php 7.4 tokens.

So another solution is to update PHPStan with it's dependecies.

I reverted the changes to the Lint stage of the CI config and updated the packages.
Also fixed two issues that the new version detected.

alcaeus · 2019-12-02T20:30:15Z

@sspat see #25 - feel free to ignore phpstan for now. I can take care of it when merging everything, just want to figure out #11 first.

sspat · 2019-12-02T20:32:03Z

@alcaeus ok, just updated PHPStan myself, I'll revert those changes then?

alcaeus · 2019-12-02T20:32:42Z

Yep, no further work necessary on phpstan for now, I'll figure this out when merging.

Ocramius · 2019-12-02T20:34:31Z

lib/Doctrine/Common/Reflection/TypedNoDefaultReflectionProperty.php

+     */
+    public function getValue($object = null)
+    {
+        $name = $this->getName();


This should most certainly be cached locally (in the instance). Alternatively, using $this->name in the expression below would work too.

Yes, it's horrible, but this is really performance sensitive

This should most certainly be cached locally (in the instance). Alternatively, using $this->name in the expression below would work too.

Yes, it's horrible, but this is really performance sensitive

But what about \Doctrine\Common\Reflection\RuntimePublicReflectionProperty? It is using the same mechanism and a public property on an entity is still a much more common scenario than a typed property, caching should be implemented there too. Maybe a separate issue for this?

And looking at the tests, adding caching would break the current behavior.
For example in

reflection/tests/Doctrine/Tests/Common/Reflection/RuntimePublicReflectionPropertyTest.php

Lines 13 to 24 in 7a2c95a

public function testGetValue() : void

{

$object = new RuntimePublicReflectionPropertyTestClass();

$reflProperty = new RuntimePublicReflectionProperty(RuntimePublicReflectionPropertyTestClass::class, 'test');

self::assertSame('testValue', $reflProperty->getValue($object));

unset($object->test);

self::assertNull($reflProperty->getValue($object));

}

The RuntimePublicReflectionProperty would not follow the changes to the reflected object's properties, if it was caching the value on first access to the property.

Also looking at

https://github.com/doctrine/persistence/blob/779661acceefe09bd0e709b4cfe65ec0213f0d5c/lib/Doctrine/Persistence/Mapping/RuntimeReflectionService.php#L60-L74

The class introduced in this PR will be returned from this method too, and if we add caching only to this new class, it will still break the behavior of the getAccessibleProperty method, as the reflection property classes returned by it would not cache and do track the reflected object changes for some properties and the opposite for other properties.

Ocramius · 2019-12-02T20:37:04Z

lib/Doctrine/Common/Reflection/TypedNoDefaultReflectionProperty.php

+    {
+        $name = $this->getName();
+
+        return isset($object->$name) ? parent::getValue($object) : null;


I think an isset($object->$name) will initialize that property starting from ORM 3, because ProxyManager intercepts isset() calls via __isset().

Instead, ReflectionProperty#isInitialized() should be used.

And yes: more performance impact :-(

I can do this, but again it looks to me as a separate issue, this behavior was copied from another class in the package \Doctrine\Common\Reflection\RuntimePublicReflectionProperty, it has issues then too.
Thanks for the review!

In general, accessing typed properties via isset() is not side-effect-free, and will break on anything declaring __isset (not just because of ProxyManager)

Yes, I understand the problem now, will fix it in the new class, it will also make it's purpose more explicit. Thank you!

Fixed

reflection/lib/Doctrine/Common/Reflection/TypedNoDefaultReflectionProperty.php

Lines 19 to 22 in f45415e

public function getValue($object = null)

{

return $object !== null && $this->isInitialized($object) ? parent::getValue($object) : null;

}

…value doctrine#23

… in php 7.4 syntax doctrine#23

…octrine#23

alcaeus · 2019-12-03T15:25:33Z

@sspat I've rebased your branch on top of master and dropped the phpstan update and revert commits.

@Ocramius can you please give this another look? Thanks!

alcaeus added this to the 1.1.0 milestone Dec 2, 2019

alcaeus self-assigned this Dec 2, 2019

alcaeus added the Improvement label Dec 2, 2019

alcaeus reviewed Dec 2, 2019

View reviewed changes

Ocramius suggested changes Dec 2, 2019

View reviewed changes

sspat added 7 commits December 3, 2019 16:22

Added reflection class for handling typed properties without default …

7070705

…value doctrine#23

Updated phpunit and travis configs to work with tests containing code…

0ac0da5

… in php 7.4 syntax doctrine#23

Added php 7.4 specific tests directory to composer autoloading config d…

6efdc3f

…octrine#23

Changed test assertion method doctrine#23

bbf9810

Changed dynamic property name access syntax doctrine#23

7fba840

Changed the property access syntax again doctrine#23

8299ca4

Replaced isset with ReflectionProperty::isInitialized doctrine#23

9acbb8c

alcaeus force-pushed the add_reflection_typed_no_default_property_class branch from f45415e to 9acbb8c Compare December 3, 2019 15:24

alcaeus requested a review from Ocramius December 3, 2019 15:25

beberlei approved these changes Jan 8, 2020

View reviewed changes

beberlei merged commit 9acbb8c into doctrine:master Jan 8, 2020

beberlei mentioned this pull request Jan 8, 2020

Add ReflectionTypedProperty that doesnt trigger unitialized value error. #29

Closed

alcaeus removed the request for review from Ocramius January 10, 2020 08:05

armpogart mentioned this pull request Feb 4, 2020

Typed property must not be accessed before initialization cycle/orm#67

Closed

greg0ire mentioned this pull request Jul 28, 2020

Deprecate static reflection #47

Closed

	public function testGetValue() : void
	{
	$object = new RuntimePublicReflectionPropertyTestClass();

	$reflProperty = new RuntimePublicReflectionProperty(RuntimePublicReflectionPropertyTestClass::class, 'test');

	self::assertSame('testValue', $reflProperty->getValue($object));

	unset($object->test);

	self::assertNull($reflProperty->getValue($object));
	}

	public function getValue($object = null)
	{
	return $object !== null && $this->isInitialized($object) ? parent::getValue($object) : null;
	}

Add reflection typed no default property class #24

Add reflection typed no default property class #24

Uh oh!

Conversation

sspat commented Dec 2, 2019

Uh oh!

alcaeus left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alcaeus commented Dec 2, 2019

Uh oh!

sspat commented Dec 2, 2019

Uh oh!

alcaeus commented Dec 2, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sspat Dec 3, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alcaeus commented Dec 3, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

sspat Dec 3, 2019 •

edited

Loading