Refactor - cleanup unnecessary around plugins #28767

lewisvoncken · 2020-06-17T20:23:56Z

Description (*)

Changed the following around plugins to before and after plugins:

after:

        \Magento\GroupedProduct\Helper\Product\Configuration\Plugin\Grouped::afterGetOptions
        \Magento\ConfigurableProduct\Helper\Product\Configuration\Plugin::afterGetOptions
        \Magento\AdvancedSearch\Model\Indexer\Fulltext\Plugin\CustomerGroup::afterSave
        \Magento\Catalog\Model\Indexer\Product\Price\Plugin\CustomerGroup::afterSave
        \Magento\CatalogSearch\Model\Attribute\SearchWeight::afterSave
        \Magento\CatalogUrlRewrite\Model\Category\Plugin\Category\Remove::afterDelete
        \Magento\ConfigurableProduct\Model\Entity\Product\Attribute\Group\AttributeMapper\Plugin::afterMap
        \Magento\ConfigurableProduct\Plugin\Model\ResourceModel\Product::afterDelete
        \Magento\Customer\Model\Plugin\CustomerFlushFormKey::afterExecute
        \Magento\GroupedProduct\Model\ResourceModel\Product\Link\RelationPersister::afterDeleteProductLink
        \Magento\Theme\Model\Indexer\Design\Config\Plugin\Store::afterSave
        \Magento\Theme\Model\Indexer\Design\Config\Plugin\Website::afterSave

before:

        \Magento\CatalogInventory\Plugin\MassUpdateProductAttribute::beforeExecute

Starting from Magento 2.2 it is no longer necessary to use around plugins in cases which you now could just use an after which also contains the parameters.

This refactor is because of performance reasons:

source:
https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html#around-methods

Fixed Issues (if relevant)

Fixes Probably unnecessary use of around plugin #27912

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)

after: \Magento\GroupedProduct\Helper\Product\Configuration\Plugin\Grouped::afterGetOptions \Magento\ConfigurableProduct\Helper\Product\Configuration\Plugin::afterGetOptions \Magento\AdvancedSearch\Model\Indexer\Fulltext\Plugin\CustomerGroup::afterSave \Magento\Catalog\Model\Indexer\Product\Price\Plugin\CustomerGroup::afterSave \Magento\CatalogSearch\Model\Attribute\SearchWeight::afterSave \Magento\CatalogUrlRewrite\Model\Category\Plugin\Category\Remove::afterDelete \Magento\ConfigurableProduct\Model\Entity\Product\Attribute\Group\AttributeMapper\Plugin::afterMap \Magento\ConfigurableProduct\Plugin\Model\ResourceModel\Product::afterDelete \Magento\Customer\Model\Plugin\CustomerFlushFormKey::afterExecute \Magento\GroupedProduct\Model\ResourceModel\Product\Link\RelationPersister::afterDeleteProductLink \Magento\Theme\Model\Indexer\Design\Config\Plugin\Store::afterSave \Magento\Theme\Model\Indexer\Design\Config\Plugin\Website::afterSave before: \Magento\CatalogInventory\Plugin\MassUpdateProductAttribute::beforeExecute

m2-assistant · 2020-06-17T20:23:59Z

Hi @lewisvoncken. 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

❗ Automated tests can be triggered manually with an appropriate comment:

@magento run all tests - run or re-run all required tests against the PR changes
@magento run <test-build(s)> - run or re-run specific test build(s)
For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

Database Compare
Functional Tests CE
Functional Tests EE,
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
WebAPI Tests

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

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

lewisvoncken · 2020-06-17T20:24:58Z

@magento run all tests

ihor-sviziev · 2020-06-19T07:22:40Z

@magento run all tests

ihor-sviziev · 2020-06-19T07:24:04Z

app/code/Magento/AdvancedSearch/Test/Unit/Model/Indexer/Fulltext/Plugin/CustomerGroupTest.php

@@ -118,7 +118,7 @@ public function testAroundSave(
     *
     * @return array
     */
-    public function aroundSaveDataProvider(): array
+    public function afterSaveDataProvider(): array


This is data provider, please update place where it is used

ihor-sviziev · 2020-06-19T07:28:38Z

app/code/Magento/CatalogInventory/Plugin/MassUpdateProductAttribute.php

     */
-    public function aroundExecute(Save $subject, callable $proceed)
+    public function beforeExecute(Save $subject)


We don't really need to change arguments for "save", so it's better to use void return type here and not use return statement at all

Suggested change

public function beforeExecute(Save $subject)

public function beforeExecute(Save $subject): void

ihor-sviziev · 2020-06-19T07:28:45Z

app/code/Magento/CatalogInventory/Plugin/MassUpdateProductAttribute.php

@@ -101,16 +100,16 @@ public function aroundExecute(Save $subject, callable $proceed)
                $this->updateInventoryInProducts($productIds, $websiteId, $inventoryData);
            }

-            return $proceed();
+            return [];


Suggested change

return [];

ihor-sviziev · 2020-06-19T07:28:52Z

app/code/Magento/CatalogInventory/Plugin/MassUpdateProductAttribute.php

        } catch (\Magento\Framework\Exception\LocalizedException $e) {
            $this->messageManager->addErrorMessage($e->getMessage());
-            return $proceed();
+            return [];


Suggested change

return [];

ihor-sviziev · 2020-06-19T07:29:00Z

app/code/Magento/CatalogInventory/Plugin/MassUpdateProductAttribute.php

        } catch (\Exception $e) {
            $this->messageManager->addExceptionMessage(
                $e,
                __('Something went wrong while updating the product(s) attributes.')
            );
-            return $proceed();
+            return [];


Suggested change

return [];

ihor-sviziev · 2020-06-19T07:30:55Z

app/code/Magento/CatalogSearch/Model/Attribute/SearchWeight.php

        \Magento\Catalog\Model\ResourceModel\Attribute $subject,
-        \Closure $proceed,
+        \Magento\Catalog\Model\ResourceModel\Attribute $result,
        \Magento\Framework\Model\AbstractModel $attribute
    ) {
        $isNew = $attribute->isObjectNew();


I think after save it will be always "false", probably that's why we had there "around" plugin. Could you double check it?

ihor-sviziev · 2020-06-19T07:56:04Z

app/code/Magento/ConfigurableProduct/Plugin/Model/ResourceModel/Product.php

        \Magento\Catalog\Model\ResourceModel\Product $subject,
-        \Closure $proceed,
+        \Magento\Catalog\Model\ResourceModel\Product $result,
        \Magento\Catalog\Model\Product $product
    ) {
        $configurableProductIds = $this->configurable->getParentIdsByChild($product->getId());


not sure this still will be available after deleting product. Please double check it

ihor-sviziev · 2020-06-19T07:58:32Z

app/code/Magento/GroupedProduct/Model/ResourceModel/Product/Link/RelationPersister.php

     */
-    public function aroundDeleteProductLink(Link $subject, \Closure $proceed, $linkId)
+    public function afterDeleteProductLink(Link $subject, Link $result, $linkId)
    {
        /** @var \Magento\Catalog\Model\ProductLink\Link $link */
        $link = $this->linkFactory->create();
        $subject->load($link, $linkId, $subject->getIdFieldName());


I think it will not work after deleting

ihor-sviziev · 2020-06-19T07:59:06Z

app/code/Magento/Theme/Model/Indexer/Design/Config/Plugin/Store.php

     * @return StoreStore
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
-    public function aroundSave(StoreStore $subject, \Closure $proceed)
+    public function afterSave(StoreStore $subject, StoreStore $result)
    {
        $isObjectNew = $subject->getId() == 0;


Looks liike this will be always false, as object already saved and have id

ihor-sviziev · 2020-06-19T07:59:15Z

app/code/Magento/Theme/Model/Indexer/Design/Config/Plugin/Website.php

     * @return StoreWebsite
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     */
-    public function aroundSave(StoreWebsite $subject, \Closure $proceed)
+    public function afterSave(StoreWebsite $subject, StoreWebsite $result)
    {
        $isObjectNew = $subject->getId() == 0;


Looks liike this will be always false, as object already saved and have id

ihor-sviziev · 2020-07-10T11:00:59Z

Hi @lewisvoncken,
Will you be able to update your PR?

ihor-sviziev · 2020-07-17T06:44:08Z

@lewisvoncken I am closing this PR now due to inactivity.
Please reopen and update if you wish to continue.
Thank you for the collaboration!

m2-assistant · 2020-07-17T06:44:10Z

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

lewisvoncken added 2 commits June 17, 2020 22:21

[REFACTOR] Added check to prevent unnecessary foreach

bcdfa8c

ghost added the Progress: pending review label Jun 17, 2020

ihor-sviziev self-assigned this Jun 19, 2020

ihor-sviziev requested changes Jun 19, 2020

View reviewed changes

ghost added Progress: needs update and removed Progress: pending review labels Jun 19, 2020

ihor-sviziev added the Severity: S3 Affects non-critical data or functionality and does not force users to employ a workaround. label Jun 22, 2020

ihor-sviziev closed this Jul 17, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor - cleanup unnecessary around plugins #28767

Refactor - cleanup unnecessary around plugins #28767

lewisvoncken commented Jun 17, 2020 •

edited

Loading

m2-assistant bot commented Jun 17, 2020

lewisvoncken commented Jun 17, 2020

ihor-sviziev commented Jun 19, 2020

ihor-sviziev Jun 19, 2020

ihor-sviziev Jun 19, 2020

ihor-sviziev Jun 19, 2020

ihor-sviziev Jun 19, 2020

ihor-sviziev Jun 19, 2020

ihor-sviziev Jun 19, 2020

ihor-sviziev Jun 19, 2020

ihor-sviziev Jun 19, 2020

ihor-sviziev Jun 19, 2020

ihor-sviziev Jun 19, 2020

ihor-sviziev commented Jul 10, 2020

ihor-sviziev commented Jul 17, 2020

m2-assistant bot commented Jul 17, 2020

	public function beforeExecute(Save $subject)
	public function beforeExecute(Save $subject): void

Refactor - cleanup unnecessary around plugins #28767

Refactor - cleanup unnecessary around plugins #28767

Conversation

lewisvoncken commented Jun 17, 2020 • edited Loading

Description (*)

Fixed Issues (if relevant)

Contribution checklist (*)

m2-assistant bot commented Jun 17, 2020

lewisvoncken commented Jun 17, 2020

ihor-sviziev commented Jun 19, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ihor-sviziev commented Jul 10, 2020

ihor-sviziev commented Jul 17, 2020

m2-assistant bot commented Jul 17, 2020

lewisvoncken commented Jun 17, 2020 •

edited

Loading