Fix for the issue #24547 Magento\Customer\Model\Account\Redirect::setRedirectCookie() not properly working

[sashas777]

Description (*)

Added metadata to the setRedirectCookie and clearRedirectCookie functions.

Fixed Issues (if relevant)

1. Magento\Customer\Model\Account\Redirect::setRedirectCookie() not properly working #24547: Magento\Customer\Model\Account\Redirect::setRedirectCookie() not properly working

Manual testing scenarios (*)

1. Call method Magento\Customer\Model\Account\Redirect::setRedirectCookie()

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)
• All automated tests passed successfully (all builds are green)

[m2-assistant]

Hi @sashas777. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

• @magento give me test instance - deploy test instance based on PR changes
• @magento give me 2.3-develop instance - deploy vanilla Magento instance

For more details, please, review the Magento Contributor Guide documentation.

[sashas777]

@paliarush can you advise how to avoid these errors, please?

/var/www/html/app/code/Magento/Customer/Model/Account/Redirect.php:28	The class Magento\Customer\Model\Account\Redirect uses sessions or cookies while not being a part of HTML Presentation layer
/var/www/html/app/code/Magento/Customer/Model/Account/Redirect.php:103	The method __construct has 10 parameters. Consider reducing the number of parameters to less than 10.
/var/www/html/app/code/Magento/Customer/Model/RedirectCookieManager.php:14	The class Magento\Customer\Model\RedirectCookieManager uses sessions or cookies while not being a part of HTML Presentation layer

Failed asserting that 2 matches expected 0.```

[drpayyne]

Hello @sashas777

The method __construct has 10 parameters. Consider reducing the number of parameters to less than 10

is common and can be suppressed by adding @SuppressWarnings(PHPMD.ExcessiveParameterList) to the method's PHPDoc Blocks.

The class Magento\Customer\Model\RedirectCookieManager uses sessions or cookies while not being a part of HTML Presentation layer

can be suppressed by adding @SuppressWarnings(PHPMD.CookieAndSessionMisuse) to both the classes' PHPDoc Blocks.

Although, changing the constructor signature isn't backward compatible. Please refer to Backward compatible development for your issues.

[odubovyk]

Public cookie metadata is used. What will be the behavior and is it appropriate in the case if connection is secured?

[dyushkin]

Hello @sashas777!
Thank you for your contribution.
Methods getCookieManager, setCookieManager, getRedirectCookie, setRedirectCookie, clearRedirectCookie provided in Magento\Customer\Model\Account\Redirect class looks very legacy, and created with one purpose - to pass login_redirect cookie from Magento/Checkout/view/frontend/web/js/sidebar.js to backend for processing, and creating a redirect url.
Considering this, it is not much of use cases for these public methods, to create the implementation with its own single class. Can you please tag public methods I mentioned before as deprecated with the proper comment, and remove the Magento/Customer/Model/RedirectCookieManager. Please recheck suppress warnings are necessary.
Thank you,

[sashas777]

@dyushkin Updated. Does it look correct now?

[dyushkin]

@sashas777, thank you for quick updates, looks fine for me.

[engcom-Golf]

@magento run all tests

[magento-engcom-team]

Hi @lenaorobei, thank you for the review.
ENGCOM-6891 has been created to process this Pull Request

[dyushkin]

All changes are correct.

[engcom-Delta]

✔️ QA passed

[m2-assistant]

Hi @sashas777, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.