AddParamArrayDocblockFromDimFetchAccessRector conflicts with vendor interface

[stephanvierkant]

Bug Report

Subject	Details
Rector version	2.2.1

I'm trying to raise my TypeCoverageDocblockLevel from Rector 2.2, thanks for that great feature!

AddParamArrayDocblockFromDimFetchAccessRector adds a @param to a method, but that leads to this phpstan error:

Parameter #3 $context (array<string, mixed>) of method App\Services\Attachment\AttachmentNormalizer::supportsNormalization() should be contravariant with parameter $context (array) of method Symfony\Component\Serializer\Normalizer\NormalizerInterface::supportsNormalization()

\Symfony\Component\Serializer\Normalizer\NormalizerInterface::supportsNormalization has just array as type, without extra info from a docblock.

Minimal PHP Code Causing Issue

+ /**
+ * @param array<string, mixed> $context
+ */
#[\Override]
public function supportsNormalization(mixed $data, ?string $format = null, array $context = []) : bool
{
    return $data instanceof Attachment && in_array('foobar', $context['groups'], true);
}

Expected Behaviour

I've got similar problems with other Rectors, such as DocblockVarArrayFromPropertyDefaultsRector. Maybe there should be an option to exclude adding/updating docblocks if a method implements an interface (or extends a class) that's in the vendor dir?

[TomasVotruba]

Thank you for your report!

We'll need an isolated failing demo link from: http://getrector.com/demo,
that way we can reproduce the bug. Ideally with the relevant parent interface in the code snippet.

[stephanvierkant]

Thank you for your report!

We'll need an isolated failing demo link from: http://getrector.com/demo, that way we can reproduce the bug. Ideally with the relevant parent interface in the code snippet.

https://getrector.com/demo/1c751fd3-2320-4c0f-94b8-7bb0e2c3c936

[stephanvierkant]

https://getrector.com/demo/bee525c0-13cc-479e-951e-82fc06e29c1b

Other Rector, but maybe a similar problem: the interface already has array<int, string>, so adding string[] makes no sense.

[TomasVotruba]

Thanks for sharing.

• https://getrector.com/demo/1c751fd3-2320-4c0f-94b8-7bb0e2c3c936

Types like * @param mixed $data Data to normalize have zero value and can be removed. Everything is mixed by default, so no need to type it explicitly. This is correct improvement.

• https://getrector.com/demo/bee525c0-13cc-479e-951e-82fc06e29c1b

Here we can improve it. Learn about required type from parent and fill it, as it's more precised.

[TomasVotruba]

getrector.com/demo/bee525c0-13cc-479e-951e-82fc06e29c1b

Other Rector, but maybe a similar problem: the interface already has array<int, string>, so adding string[] makes no sense.

This should be fixed, I'm looking into it.

[TomasVotruba]

Covered in rectorphp/rector-src#7495

[TomasVotruba]

Maybe there should be an option to exclude adding/updating docblocks if a method implements an interface (or extends a class) that's in the vendor dir?

Sounds reasonable. I'm looking into it.

[TomasVotruba]

Fixed in rectorphp/rector-src#7496

[TomasVotruba]

I've skipped any changes that are guarded by parent interface/class method, to avoid conflicting types.

I'm closing this one as both issues are resolved. If you come across another, and I'm sure there will be, make a new issue with responsible rule + http://getrector.com/demo link, where it fails. That way we can improve it one issue at a time :)

Thanks