DataObjectProcessor reflection is not using FQN for return types

[MeCapron]

Preconditions (*)

1. Magento 2.4.2-p2

Steps to reproduce (*)

1. Add an extension attribute to the CustomerInterface with a specific Model :

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="urn:magento:framework:Api/etc/extension_attributes.xsd">
    <extension_attributes for="Magento\Customer\Api\Data\CustomerInterface">
        <attribute code="myObj" type="Vendor\Merchant\Model\Response"/>
    </extension_attributes>
</config>

<?php

declare(strict_types=1);

namespace Vendor\Merchant\Model;

class MyObj
{
    private InnerAttribute $myAttribute;

    /**
     * @return InnerAttribute
     */
    public function getMyAttribute(): InnerAttribute
    {
        return $this->myAttribute;
    }

    /**
     * @param InnerAttribute $myAttribute
     */
    public function setMyAttribute(InnerAttribute $myAttribute): void
    {
        $this->myAttribute = $myAttribute;
    }
}

With InnerAttribute defined in the same folder :

<?php

declare(strict_types=1);

namespace Vendor\Merchant\Model;

class InnerAttribute
{

}

3. Class will not be instantied in Reflection and you will get an error from vendor/magento/framework/Reflection/DataObjectProcessor.php

4. While the getParamType from vendor/magento/framework/Reflection/TypeProcessor.php resolves the FQN when not specified, the function getGetterReturnType is not resolving the FQN which leads to an error.

Expected result (*)

1. Reflection should be made on FQN and not on relative class name

Actual result (*)

1. Error is thrown "Class InnerAttribute does not exist"

As a quick fix, I made the function resolving the FQN as the param does :

https://github.com/magento/magento2/blob/2.4.2-p2/lib/internal/Magento/Framework/Reflection/TypeProcessor.php#L285

    public function getGetterReturnType($methodReflection)
    {
        $returnAnnotation = $this->getMethodReturnAnnotation($methodReflection);
        $types = $returnAnnotation->getTypes();
        $returnType = null;
        foreach ($types as $type) {
            if ($type !== 'null') {
                $returnType = $type;
                break;
            }
        }

        $returnType = $this->resolveFullyQualifiedClassName($methodReflection->getDeclaringClass(), $returnType);

        $nullable = in_array('null', $types);

        return [
            'type'           => $returnType,
            'isRequired'     => !$nullable,
            'description'    => $returnAnnotation->getDescription(),
            'parameterCount' => $methodReflection->getNumberOfRequiredParameters()
        ];
    }

---

Please provide Severity assessment for the Issue as Reporter. This information will help during Confirmation and Issue triage processes.

• Severity: S0 - Affects critical data or functionality and leaves users without workaround.
• Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
• Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
• Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
• Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.

[m2-assistant]

Hi @MeCapron. Thank you for your report.
To speed up processing of this issue, make sure that you provided the following information:

• Summary of the issue
• Information on your environment
• Steps to reproduce
• Expected and actual results

Make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, Add a comment to the issue:

@magento give me 2.4-develop instance - upcoming 2.4.x release

For more details, review the Magento Contributor Assistant documentation.

Add a comment to assign the issue: @magento I am working on this

To learn more about issue processing workflow, refer to the Code Contributions.

---

• Join Magento Community Engineering Slack and ask your questions in #github channel.

⚠️ According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

[m2-assistant]

Hi @engcom-Delta. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).

  Details

  If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.

• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.

• 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

• 4. Verify that the issue is reproducible on 2.4-develop branch

  Details

  - Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!

• 5. Add label Issue: Confirmed once verification is complete.

• 6. Make sure that automatic system confirms that report has been added to the backlog.

[m2-assistant]

Hi @engcom-Hotel. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).

  Details

  If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.

• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.

• 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

• 4. Verify that the issue is reproducible on 2.4-develop branch

  Details

  - Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!

• 5. Add label Issue: Confirmed once verification is complete.

• 6. Make sure that automatic system confirms that report has been added to the backlog.

[ihor-sviziev]

Hi @MeCapron,
If you already have the fix for this issue - could you please send it as a Pull Request?

[m2-assistant]

Hi @engcom-Echo. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
     Details

     If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.
• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.
• 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.
• 4. Verify that the issue is reproducible on 2.4-develop branch
     Details

     - Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
     - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
     - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!

---

• Join Magento Community Engineering Slack and ask your questions in #github channel.

[engcom-Echo]

Hi @MeCapron,

Thank you for reporting the issue.

However, we tried to reproduce it on Magento 2.4-dev but the issue is not reproducible.

Steps followed to reproduce issue:

1. Installed the fresh Magento 2.4-dev instance.
2. Added the following code to the extension_attributes.xml file.

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Api/etc/extension_attributes.xsd">
    <extension_attributes for="Magento\Customer\Api\Data\CustomerInterface">
        <attribute code="myObj" type="cptest\Mymodule\Model\Response"/>
    </extension_attributes>
</config>

Cleard cache and run di:compile to generate new files.
bin/magento c:c
bin/magento setup:di:compile

Following code generated after execution of di:compile under file “generated/code/Magento/Customer/Api/Data/CustomerExtensionInterface.php”

<?php
namespace Magento\Customer\Api\Data;
/**
 * ExtensionInterface class for @see \Magento\Customer\Api\Data\CustomerInterface
 */

interface CustomerExtensionInterface extends \Magento\Framework\Api\ExtensionAttributesInterface
{
    /**
     * @return \cptest\Mymodule\Model\Response|null
     */
    public function getMyObj();
    /**
     * @param \cptest\Mymodule\Model\Response $myObj
     * @return $this
     */
    public function setMyObj(\cptest\Mymodule\Model\Response $myObj);
}

3. Tested the generated code by using the below mentioned code

$extension = $customerDataObject->getExtensionAttributes();
$extension->setMyObj(new \cptest\Mymodule\Model\Response());
print_r($extension->getMyObj());

4. The above code was run successfully, without any error. (See the attached output screenshot).

If the issue still persists at your end then please provide some more details or provide the exact steps, accordingly, I’ll try to reproduce it again.

Thanks