[Issue] add missing PaymentMethodInterface

[m2-assistant]

This issue is automatically created based on existing pull request: #33003: add missing PaymentMethodInterface

---

Description (*)

During checkout payment information details can be requested via
https://github.com/magento/magento2/blob/2.4-develop/app/code/Magento/Checkout/Model/PaymentInformationManagement.php#L185

which uses

        $paymentDetails->setPaymentMethods($this->paymentMethodManagement->getList($cartId));

According to https://github.com/magento/magento2/blob/2.4-develop/app/code/Magento/Checkout/Api/Data/PaymentDetailsInterface.php#L25 this should be an array of \Magento\Quote\Api\Data\PaymentMethodInterface

Any Payment Methods based on https://github.com/magento/magento2/blob/2.4-develop/app/code/Magento/Payment/Model/Method/Adapter.php would technically not be valid due to the missing interface. The interface methods are already implemented. As the Adapter class already includes these methods this should not be a breaking change.

Related Pull Requests

Fixed Issues (if relevant)

1. Fixes N/A

Manual testing scenarios (*)

1. Test checkout with different payment methods

Additional Information to reproduce the issue

we have tried to debug the code. According to the interface app/code/Magento/Checkout/Api/Data/PaymentDetailsInterface.php:

magento2/app/code/Magento/Checkout/Api/Data/PaymentDetailsInterface.php

Lines 24 to 27 in 84e7dfa

	/**
	* @return \Magento\Quote\Api\Data\PaymentMethodInterface[]
	*/
	public function getPaymentMethods();

The overriding/implemented method should return the object of the class \Magento\Quote\Api\Data\PaymentMethodInterface[]. And we can see it is implemented in the below class:

magento2/app/code/Magento/Checkout/Model/PaymentDetails.php

Lines 17 to 20 in 84e7dfa

	public function getPaymentMethods()
	{
	return $this->getData(self::PAYMENT_METHODS);
	}

Which internally calls the $this->getData(self::PAYMENT_METHODS);:

magento2/lib/internal/Magento/Framework/Model/AbstractExtensibleModel.php

Lines 276 to 305 in 84e7dfa

	public function getData($key = '', $index = null)
	{
	if ($key === self::CUSTOM_ATTRIBUTES) {
	throw new \LogicException("Custom attributes array should be retrieved via getCustomAttributes() only.");
	} elseif ($key === '') {
	/** Represent model data and custom attributes as a flat array */
	$customAttributes = isset($this->_data[self::CUSTOM_ATTRIBUTES])
	? $this->_data[self::CUSTOM_ATTRIBUTES]
	: [];
	$this->convertCustomAttributeValues($customAttributes);
	$data = array_merge($this->_data, $customAttributes);
	unset($data[self::CUSTOM_ATTRIBUTES]);
	} else {
	$data = parent::getData($key, $index);
	if ($data === null) {
	/** Try to find necessary data in custom attributes */
	$data = isset($this->_data[self::CUSTOM_ATTRIBUTES][$key])
	? $this->_data[self::CUSTOM_ATTRIBUTES][$key]
	: null;
	if ($data instanceof \Magento\Framework\Api\AttributeValue) {
	$data = $data->getValue();
	}
	if (null !== $index && isset($data[$index])) {
	return $data[$index];
	}
	}
	}
	return $data;
	}

Which is returning the mixed array as shown in the below screenshot:

I think you are talking about the same thing it should return the object of \Magento\Quote\Api\Data\PaymentMethodInterface[] but it is returning the mixed array.

Questions or comments

Contribution checklist (*)

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All new or changed code is covered with unit/integration tests (if applicable)
• README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
• All automated tests passed successfully (all builds are green)

[engcom-Hotel]

Hello @fooman,

Thanks for the report and collaboration!

We appreciate it if you provide the below information related to this issue:

• Information on your environment
• Steps to reproduce
• Expected and actual results

Thanks

@engcom-Hotel thanks for checking in on this.

To answer your questions:

environment
all supported Magento versions

steps to reproduce
write a plugin to change the title of a payment method during checkout targeting
\Magento\Quote\Api\Data\PaymentMethodInterface::getTitle()

expected results
I can change the title of all payment methods that follow Magento best practices. According to https://github.com/magento/magento2/blob/2.4-develop/app/code/Magento/Checkout/Api/Data/PaymentDetailsInterface.php#L25 this should be an array of \Magento\Quote\Api\Data\PaymentMethodInterface

actual results
I can only change payment methods using the old approach (that extend \Magento\Payment\Model\Method\AbstractMethod) https://github.com/magento/magento2/blob/2.4-develop/app/code/Magento/Payment/Model/Method/AbstractMethod.php#L27

however payment methods using
\Magento\Payment\Model\Method\Adapter
like Braintree do not work due to the missing interface so the documented return for PaymentDetailsInterface::getPaymentMethods() is not accurate.

[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.

[engcom-Hotel]

Hello @fooman,

Thanks for the reply!

I request you please try to reproduce the issue in the latest Magento 2.4-develop branch and let us know if the issue is still reproducible for you.

Thanks

@engcom-Hotel the above code links point to 2.4-develop and the issue is still observable there.

[engcom-Hotel]

Hello @fooman,

I am trying to understand the issue. So as per your comment, we have tried to debug the code. According to the interface app/code/Magento/Checkout/Api/Data/PaymentDetailsInterface.php:

magento2/app/code/Magento/Checkout/Api/Data/PaymentDetailsInterface.php

Lines 24 to 27 in 84e7dfa

	/**
	* @return \Magento\Quote\Api\Data\PaymentMethodInterface[]
	*/
	public function getPaymentMethods();

The overriding/implemented method should return the object of the class \Magento\Quote\Api\Data\PaymentMethodInterface[]. And we can see it is implemented in the below class:

magento2/app/code/Magento/Checkout/Model/PaymentDetails.php

Lines 17 to 20 in 84e7dfa

	public function getPaymentMethods()
	{
	return $this->getData(self::PAYMENT_METHODS);
	}

Which internall calls the $this->getData(self::PAYMENT_METHODS);:

magento2/lib/internal/Magento/Framework/Model/AbstractExtensibleModel.php

Lines 276 to 305 in 84e7dfa

	public function getData($key = '', $index = null)
	{
	if ($key === self::CUSTOM_ATTRIBUTES) {
	throw new \LogicException("Custom attributes array should be retrieved via getCustomAttributes() only.");
	} elseif ($key === '') {
	/** Represent model data and custom attributes as a flat array */
	$customAttributes = isset($this->_data[self::CUSTOM_ATTRIBUTES])
	? $this->_data[self::CUSTOM_ATTRIBUTES]
	: [];
	$this->convertCustomAttributeValues($customAttributes);
	$data = array_merge($this->_data, $customAttributes);
	unset($data[self::CUSTOM_ATTRIBUTES]);
	} else {
	$data = parent::getData($key, $index);
	if ($data === null) {
	/** Try to find necessary data in custom attributes */
	$data = isset($this->_data[self::CUSTOM_ATTRIBUTES][$key])
	? $this->_data[self::CUSTOM_ATTRIBUTES][$key]
	: null;
	if ($data instanceof \Magento\Framework\Api\AttributeValue) {
	$data = $data->getValue();
	}
	if (null !== $index && isset($data[$index])) {
	return $data[$index];
	}
	}
	}
	return $data;
	}

Which is returning the mixed array as shown in the below screenshot:

I think you are talking about the same thing it should return the object of \Magento\Quote\Api\Data\PaymentMethodInterface[] but it is returning the mixed array.

Please confirm.

Thanks

@engcom-Hotel thanks for taking a look. Yes this is indeed the issue. If you look at the individual classes Checkmo and Purchaseorder both extend \Magento\Payment\Model\Method\AbstractMethod which implements Magento\Quote\Api\Data\PaymentMethodInterface however the last one Magento\Payment\Model\Method\Adapter does not.