Reduce requirements for parameter in catalog product type factory #26821

hws47a · 2020-02-11T17:59:51Z

Description (*)

In the factory method, only API Interface method is used, but PHPDoc asks for the Product Model instead. Fix for this.

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 · 2020-02-11T17:59:54Z

Hi @hws47a. 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.4-develop instance - deploy vanilla Magento instance

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

novikor

Hi, @hws47a .
Thank you for your contribution.
Except the changes provided, I think it would be nice to execute some code cleanup - at least replace fully qualified class names with import, and probably add missing @throws tags.

…equirement

hws47a · 2020-02-11T20:33:47Z

Hi @novikor, thanks for your review.

My idea is opposite, I do small changes but which bother me.
For example in this case I won't need to a check in a level above for
$product instance of \Magento\Catalog\Model\Product
after loading product from repository, which will simplify the code for me.

I believe in every single core class there are plenty of code which could be cleaned up, but it'll take ages if I'll start.

So please accept the PR as it is if it passes checks.

novikor

@hws47a, As you wish

magento-engcom-team · 2020-02-12T19:53:39Z

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

engcom-Alfa · 2020-02-13T08:28:32Z

✔️ QA Passed

engcom-Golf · 2020-02-13T11:10:33Z

Failed functional tests not related to the changes in this PR.
SVC fail is not valid as only one type was changed, need to approve SVC failure.

novikor · 2020-02-13T17:40:11Z

Hmm. There were no SVC failures at the moment of approval.
2 new commits created after caused that.

novikor · 2020-02-13T17:42:58Z

@Nazar65, please do not add new commits to PRs which are already approved next time :)

novikor · 2020-02-13T17:45:33Z

Failed functional tests not related to the changes in this PR.
SVC fail is not valid as only one type was changed, need to approve SVC failure.

It seems that SVC false alarm happened. There are no methods return types changes by the fact.

hws47a · 2020-02-13T20:30:59Z

Thanks @novikor

slavvka · 2020-02-20T16:45:58Z

The ticket to SVC approval https://jira.corp.magento.com/browse/MC-31723

naydav · 2020-02-21T19:18:37Z

app/code/Magento/Catalog/Model/Product/Type.php

@@ -164,7 +161,7 @@ public function priceFactory($productType)
     * Get Product Price Info object
     *
     * @param Product $saleableItem
-     * @return \Magento\Framework\Pricing\PriceInfoInterface


Changing of input/return annotations in docblocks should be reverted (for all methods except construct).
Theoretically, this class can be used in WebAPI requests.

The current implementation of WebAPI "request/response" parser has a limitation:

Valid object types include a fully qualified class name or a fully qualified interface name.
https://devdocs.magento.com/guides/v2.3/extension-dev-guide/service-contracts/service-to-web-service.html

@hws47a Please make changes according to @naydav comment.

slavvka

Please fix the PR according to @naydav comment

Pull Request state was updated. Re-review required.

engcom-Golf · 2020-02-21T20:18:42Z

app/code/Magento/Catalog/Model/Product/Type.php

@@ -116,8 +113,8 @@ public function __construct(
    /**
     * Factory to product singleton product type instances
     *
-     * @param   \Magento\Catalog\Model\Product $product
-     * @return  \Magento\Catalog\Model\Product\Type\AbstractType
+     * @param ProductInterface $product


@slavvka is this type also might be reverted ? or we can leave Magento\Catalog\Api\Data\ProductInterface?

Use full qualified type for ProductInterface. Don't import it.

ok, i mean that in this case return type was changed from \Magento\Catalog\Model\Product to Magento\Catalog\Api\Data\ProductInterface

Exactly, without it there's no reason for making this PR

done ✔️

engcom-Golf · 2020-02-24T11:14:02Z

Hi @novikor could you please review this one again ?

magento-engcom-team · 2020-02-25T10:01:54Z

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

engcom-Alfa · 2020-02-25T10:06:30Z

✔️ QA Passed

…e factory #26821

m2-assistant · 2020-02-26T21:08:24Z

Hi @hws47a, 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.

Reduce requirements for parameter in catalog product type factory

6c62233

magento-engcom-team added Component: Catalog Release Line: 2.4 Partner: Monsoon partners-contribution Pull Request is created by Magento Partner labels Feb 11, 2020

novikor self-assigned this Feb 11, 2020

novikor requested changes Feb 11, 2020

View reviewed changes

ghost added the Progress: needs update label Feb 11, 2020

Merge branch '2.4-develop' into catalog-product-type-factory-reduce-r…

1bcf00a

…equirement

novikor approved these changes Feb 12, 2020

View reviewed changes

ghost added Progress: ready for testing and removed Progress: needs update labels Feb 12, 2020

novikor added the Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests label Feb 12, 2020

engcom-Alfa self-assigned this Feb 13, 2020

ghost added Progress: testing in progress and removed Progress: ready for testing labels Feb 13, 2020

engcom-Golf self-assigned this Feb 13, 2020

ghost added Progress: extended testing and removed Progress: testing in progress labels Feb 13, 2020

Nazar65 added 2 commits February 13, 2020 11:05

Code clenup

9aaf6c4

remove doc block from constants

4a5cf2f

slavvka added the Cleanup label Feb 20, 2020

ghost added Progress: pending approval and removed Progress: extended testing labels Feb 20, 2020

naydav reviewed Feb 21, 2020

View reviewed changes

ghost assigned naydav and slavvka Feb 21, 2020

slavvka requested a review from novikor February 21, 2020 20:08

slavvka previously requested changes Feb 21, 2020

View reviewed changes

ghost added Progress: needs update and removed Progress: pending approval labels Feb 21, 2020

engcom-Golf reviewed Feb 21, 2020

View reviewed changes

use full qualified name in annotaion for methods

e625497

novikor approved these changes Feb 25, 2020

View reviewed changes

ghost added Progress: ready for testing and removed Progress: needs update labels Feb 25, 2020

ghost added Progress: testing in progress and removed Progress: ready for testing labels Feb 25, 2020

ghost added Progress: extended testing Progress: accept and removed Progress: testing in progress Progress: extended testing labels Feb 25, 2020

magento-engcom-team pushed a commit that referenced this pull request Feb 26, 2020

ENGCOM-6883: Reduce requirements for parameter in catalog product typ…

05d7d0f

…e factory #26821

magento-engcom-team merged commit f0c64e5 into magento:2.4-develop Feb 26, 2020

engcom-Golf mentioned this pull request Mar 2, 2020

#26986 REST API Pagination issue #26988

Merged

4 tasks

Reduce requirements for parameter in catalog product type factory #26821

Reduce requirements for parameter in catalog product type factory #26821

Uh oh!

Conversation

hws47a commented Feb 11, 2020

Description (*)

Contribution checklist (*)

Uh oh!

m2-assistant bot commented Feb 11, 2020

Uh oh!

novikor left a comment

Choose a reason for hiding this comment

Uh oh!

hws47a commented Feb 11, 2020

Uh oh!

novikor left a comment

Choose a reason for hiding this comment

Uh oh!

magento-engcom-team commented Feb 12, 2020

Uh oh!

engcom-Alfa commented Feb 13, 2020

Uh oh!

engcom-Golf commented Feb 13, 2020

Uh oh!

novikor commented Feb 13, 2020

Uh oh!

novikor commented Feb 13, 2020

Uh oh!

novikor commented Feb 13, 2020

Uh oh!

hws47a commented Feb 13, 2020

Uh oh!

slavvka commented Feb 20, 2020

Uh oh!

naydav Feb 21, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

slavvka Feb 21, 2020

Choose a reason for hiding this comment

Uh oh!

slavvka left a comment

Choose a reason for hiding this comment

Uh oh!

engcom-Golf Feb 21, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

slavvka Feb 21, 2020

Choose a reason for hiding this comment

Uh oh!

engcom-Golf Feb 21, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

slavvka Feb 21, 2020

Choose a reason for hiding this comment

Uh oh!

engcom-Golf Feb 21, 2020

Choose a reason for hiding this comment

Uh oh!

engcom-Golf commented Feb 24, 2020

Uh oh!

magento-engcom-team commented Feb 25, 2020

Uh oh!

engcom-Alfa commented Feb 25, 2020

Uh oh!

m2-assistant bot commented Feb 26, 2020

Uh oh!

Uh oh!

naydav Feb 21, 2020 •

edited

Loading

engcom-Golf Feb 21, 2020 •

edited

Loading

engcom-Golf Feb 21, 2020 •

edited

Loading