Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix AttributeReader:getPropertyAnnotation AttributeReader:getMethodAnnotation #1404

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

andriinavrotskii
Copy link

| Bug fix? | yes

@scyzoryck
Copy link
Collaborator

Hello @andriinavrotskii !

Thank you for your PR! Could you tell a bit more about the issue that is solves? Is it possible to add some unit tests that was not working before this changes?

Best, Marcin.

@andriinavrotskii
Copy link
Author

Hello @andriinavrotskii !

Thank you for your PR! Could you tell a bit more about the issue that is solves? Is it possible to add some unit tests that was not working before this changes?

Best, Marcin.

Hi, Marcin.

Problem:

Doctrine\Common\Annotations\PsrCachedReader::getClassAnnotation(): Argument #1 ($class) must be of type ReflectionClass, ReflectionProperty given, called in /var/www/vendor/jms/serializer/src/Metadata/Driver/AttributeDriver/AttributeReader.php on line 68

Method Doctrine\Common\Annotations\Reader::getClassAnnotation(ReflectionClass $class, $annotationName) has attribute "$class" typehinted as ReflectionClass

Method JMS\Serializer\Metadata\Driver\AttributeDriver\AttributeReader::getPropertyAnnotation(ReflectionProperty $property, $annotationName) got "$property" typehinted as ReflectionProperty

Same for getMethodAnnotation - we try to send instance of ReflectionMethod to method getClassAnnotation which expect instance of ReflectionClass

@goetas
Copy link
Collaborator

goetas commented May 11, 2022

is there a way to provide a test case for this?

@ixarlie
Copy link

ixarlie commented Jan 10, 2023

Looking closer at the AttributeReader class it seems the getMethodAnnotation and getPropertyAnnotation are not using their counterparts from the delegated reader.

I think the solution from this commit is not correct because when you call getMethodAnnotation or getPropertyAnnotation you expect to get the annotation instance from the method or from the property respectively, not from the class annotations.

IMO the fix is to call to the delegated reader with the same method names.

public function getMethodAnnotation(ReflectionMethod $method, $annotationName): ?object
{
    $attributes = $method->getAttributes($annotationName);

    return $this->reader->getMethodAnnotation($method, $annotationName) ?? $this->buildAnnotation($attributes);
}

public function getPropertyAnnotation(ReflectionProperty $property, $annotationName): ?object
{
    $attributes = $property->getAttributes($annotationName);

    return $this->reader->getPropertyAnnotation($property, $annotationName) ?? $this->buildAnnotation($attributes);
}

Comment on lines +49 to +50
return $this->reader->getClassAnnotation(new ReflectionClass($method->class), $annotationName)
?? $this->buildAnnotation($attributes);
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
return $this->reader->getClassAnnotation(new ReflectionClass($method->class), $annotationName)
?? $this->buildAnnotation($attributes);
return $this->reader->getMethodAnnotation($method, $annotationName) ?? $this->buildAnnotation($attributes);

Comment on lines +64 to +65
return $this->reader->getClassAnnotation(new ReflectionClass($property->class), $annotationName)
?? $this->buildAnnotation($attributes);
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
return $this->reader->getClassAnnotation(new ReflectionClass($property->class), $annotationName)
?? $this->buildAnnotation($attributes);
return $this->reader->getPropertyAnnotation($property, $annotationName) ?? $this->buildAnnotation($attributes);

@goetas goetas closed this Feb 3, 2023
@goetas goetas reopened this Feb 3, 2023
@goetas
Copy link
Collaborator

goetas commented Feb 3, 2023

@mbabker you have worked on this area...would you mind having a look at this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants