Admin panel navigation improvement #33824

marcin-dykas · 2021-08-17T12:58:30Z

Hello Magento Team

This is new kind of feature for admin panel. It adds additional links for products in several grids following [Customizable Options] grid.

Description (*)

Functionality for Magento 2 adds missing links in the admin panel for product edit pages. Code follows an idea from the [Customizable Options] section where is [Import options] product grid. [Import options] product grid contains URLs to product's edit page. Unfortunately, in other grids, there is no way to navigate to product edit pages easily. It adds edit URL links to all grids where navigation is needed to open product edit page in new tab.

Benefits

The administrator saves precious time while working with a large number of products. While adding options to products each time, there is a need to open grid with additional product items. There is no way to go to their edit pages without opening additional browser tabs and searching in other grids. It's complicated and time-consuming. So it adds edit links to the admin panel grids. After clicking in additional link product edit page is opened in a new tab.

Related Pull Requests

Fixed Issues (if relevant)

Fixes magento/magento2#<issue_number>

Manual testing scenarios (*)

Open admin panel and go to Catalog -> Products
Edit simple product
Go to Related Products, Up-Sells, and Cross-Sells section
Click Add Related Products
Grid should contain links. After clicking product edit page is opened in new tab.
Click Up-Sell Products
Grid should contain links. After clicking product edit page is opened in new tab.
Click Cross-Sell Products
Grid should contain links. After clicking product edit page is opened in new tab.
After saving all three grids for Related, Up-Sell and Cross-Sell grids should contain links. After clicking product edit page is opened in new tab.
Go back to Catalog -> Products
Open bundle product
Go to Bundle Items section
Open Add Option -> Add Product to Option
Grid should contain links. After clicking product edit page is opened in new tab.
After saving all options grids should have links. After clicking product edit page is opened in new tab.
Go back to Catalog -> Products
Open grouped product
Go to Grouped Products section
Add Products to Group grid should contain links for products. After clicking product edit page is opened in new tab.
After saving Grouped Products grid should contain links for products. After clicking product edit page is opened in new tab.
Go back to Catalog -> Products
Open Configurable product
Go to Configurations section
Add Products Manually product grid should contain links. After clicking product edit page is opened in new tab.
After saving Configurations grid should contain links. After clicking product edit page is opened in new tab.
Go to Customizable Options section
Import Options grid should contain links. After clicking product edit page is opened in new tab.

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)

m2-assistant · 2021-08-17T12:58:33Z

Hi @marcin-dykas. Thank you for your contribution
Here are 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
Semantic Version Checker

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.

⚠️ According to the Magento Contribution requirements, all Pull Requests 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 Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please 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

bgorski · 2021-08-17T22:47:10Z

@marcin-dykas thank you for your contribution! However, before we can proceed with reviewing the code and prioritizing the PR, you need to sign the Adobe Contributor License agreement. Can you do that please? You can find it here: https://opensource.adobe.com/cla.html
Please leave a comment when it's done. Thanks!

marcin-dykas · 2021-08-19T10:59:41Z

Hello @bgorski

I've just signed CLA.

Thanks.

bgorski · 2021-08-23T11:22:44Z

@magento run all tests

magento-automated-testing · 2021-08-23T11:22:51Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

BarnyShergold

Good submission!

However there are a lot of failed tests in the areas this PR covers. Please check and fix the failed tests.

There are quite a few new classes and new methods on existing classes yet there are no Unit Tests or MFTF tests. Please look into how your new functionality can be covered by testing.

BarnyShergold · 2021-08-24T00:31:58Z

AddUrlToName.php

@@ -0,0 +1,105 @@
+<?php
+


Missing copyright notice

Fixed by adding copyright notice

BarnyShergold · 2021-08-24T00:32:21Z

ConfigurableDataProvider.php

+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\ConfigurableProduct\Ui\DataProvider\Product;


Missing - declare(strict_types=1);

Fixed by adding declare(strict_types=1);

BarnyShergold · 2021-08-24T00:33:28Z

ConfigurableDataProvider.php

+use Magento\Catalog\Model\ResourceModel\Product\CollectionFactory;
+use Magento\Catalog\Ui\DataProvider\Product\ProductDataProvider;
+use Magento\Ui\DataProvider\Modifier\PoolInterface;
+


Missing class DOCBLOCK

Fixed by adding DOCBLOCK

BarnyShergold · 2021-08-24T00:41:24Z

app/code/Magento/Bundle/Ui/DataProvider/Product/Form/Modifier/Composite.php

+    /**
+     * @var NameHelper
+     */
+    protected $nameHelper;


should be private

Fixed by changing to private

BarnyShergold · 2021-08-24T00:41:58Z

app/code/Magento/Catalog/Helper/Product/AddUrlToName.php

+    /**
+     * @var LocatorInterface
+     */
+    protected $locator;


class variables should be private

Fixed by changing to private

BarnyShergold · 2021-08-24T00:52:20Z

app/code/Magento/Catalog/Ui/DataProvider/Product/Related/AbstractDataProvider.php

+     *
+     * @return array
+     */
+    public function getData()


missing return type on prototype

Fixed by adding return type

BarnyShergold · 2021-08-24T00:54:31Z

app/code/Magento/ConfigurableProduct/Ui/DataProvider/Product/ConfigurableDataProvider.php

+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\ConfigurableProduct\Ui\DataProvider\Product;


missing declare(strict_types=1);

Fixed by adding declare(strict_types=1);

BarnyShergold · 2021-08-24T00:54:46Z

app/code/Magento/ConfigurableProduct/Ui/DataProvider/Product/ConfigurableDataProvider.php

+use Magento\Catalog\Model\ResourceModel\Product\CollectionFactory;
+use Magento\Catalog\Ui\DataProvider\Product\ProductDataProvider;
+use Magento\Ui\DataProvider\Modifier\PoolInterface;
+


Missing class DOCBLOCK

Fixed by adding DOCBLOCK

BarnyShergold · 2021-08-24T00:55:31Z

app/code/Magento/GroupedProduct/Ui/DataProvider/Product/Form/Modifier/Grouped.php

+    /**
+     * @var NameHelper
+     */
+    protected $nameHelper;


Fixed by changing to private

BarnyShergold · 2021-08-24T00:55:55Z

app/code/Magento/GroupedProduct/Ui/DataProvider/Product/Form/Modifier/Grouped.php

+     * @param int $sortOrder
+     * @return array
+     */
+    protected function getHtmlColumn($dataScope, $fit, Phrase $label, $sortOrder)


missing return type

Fixed by adding return type

…avigation

marcin-dykas · 2021-08-26T12:45:40Z

Hello @BarnyShergold

Thank you for CR

I resolved all issues and now I'll focus on tests.

Thank you

…ovider

BarnyShergold

Great test coverage from what I can see.
Just a few tidy ups

BarnyShergold · 2021-09-06T10:21:32Z

...gento/ConfigurableProduct/Test/Unit/Ui/DataProvider/Product/ConfigurableDataProviderTest.php

+    /**
+     * @var ObjectManager
+     */
+    protected $objectManager;


All protected should be private

Fixed by changing all protected to private

BarnyShergold · 2021-09-06T10:24:22Z

...gento/ConfigurableProduct/Test/Unit/Ui/DataProvider/Product/ConfigurableDataProviderTest.php

+    /**
+     * @return object
+     */
+    protected function getModel()


missing return type
should be private

Fixed by adding return type and changed to private

BarnyShergold · 2021-09-06T10:24:43Z

...gento/ConfigurableProduct/Test/Unit/Ui/DataProvider/Product/ConfigurableDataProviderTest.php

+    /**
+     * Test checks ConfigurableDataProvider type
+     */
+    public function testCheckType()


missing return type

Fixed by adding return type

BarnyShergold · 2021-09-06T10:24:48Z

...gento/ConfigurableProduct/Test/Unit/Ui/DataProvider/Product/ConfigurableDataProviderTest.php

+    /**
+     * Test checks collection type
+     */
+    public function testGetCollection()


missing return type

Usually it's good practice to put all the public methods first and then the private ones

Fixed by moving public functions first. Then protected then private ones at the end ....

BarnyShergold · 2021-09-20T09:06:41Z

@marcin-dykas - It's been 2 weeks since changes were requested on this PR for the tests and there is also a conflict to resolve. Can you please give us an update on progress and when you are likely to be able to complete this PR? Otherwise we may have to look at closing it. And we don't want to do that!

marcin-dykas · 2021-09-23T16:10:32Z

Hello @BarnyShergold

I've just added last missing unit tests. Now I'll tidy up things to run tests again here.

…o feature/improve-admin-panel-navigation

marcin-dykas · 2021-09-23T16:49:08Z

@magento run Unit Tests

magento-automated-testing · 2021-09-23T16:49:15Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

marcin-dykas · 2021-09-24T11:05:45Z

I've run unit tests here and there are two same errors from Jsunit (B2B) and Jsunit (EE)

Interception cache generation... 6/9 [========>----] 66% 54 secs 400.0 MiBErrors during compilation:
Magento\PricePermissions\Ui\DataProvider\Product\Form\Modifier\Grouped
Missed required argument nameHelper in parent::__construct call. File: /var/www/html/app/code/Magento/PricePermissions/Ui/DataProvider/Product/Form/Modifier/Grouped.php
Magento\PricePermissions\Ui\DataProvider\Product\Form\Modifier\Related
Incompatible argument type: Required type: \Magento\Catalog\Helper\Product\AddUrlToName. Actual type: string; File:
/var/www/html/app/code/Magento/PricePermissions/Ui/DataProvider/Product/Form/Modifier/Related.php

This is because EE version has Magento_PricePermissions which is not present in CE.

In this module there are classes like app/code/Magento/PricePermissions/Ui/DataProvider/Product/Form/Modifier/Grouped.php and app/code/Magento/PricePermissions/Ui/DataProvider/Product/Form/Modifier/Related.php.

They extend \Magento\GroupedProduct\Ui\DataProvider\Product\Form\Modifier\Grouped and \Magento\Catalog\Ui\DataProvider\Product\Form\Modifier\Related where I added one new parameter to constructor.

It should be easy to fix these errors. We just have to add new parameters in parent::_construct calls.

I don't have access to EE repository and I wonder now how to solve it. @BarnyShergold what is procedure in such case ? Is there any ? Will we leave it as is or are we going to create PR to EE repo ? Could you please advise ?

Thank you

marcin-dykas · 2021-10-07T15:38:51Z

@magento run all tests

magento-automated-testing · 2021-10-07T15:39:00Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

…ove-admin-panel-navigation

…rm\Modifier\Data\AssociatedProductsTest::testAddManuallyConfigurationsWithNotFilterableInGridAttribute

app/code/Magento/Catalog/Ui/DataProvider/Product/Related/AbstractDataProvider.php app/code/Magento/GroupedProduct/Ui/DataProvider/Product/GroupedProductDataProvider.php

marcin-dykas · 2021-11-23T17:07:38Z

@magento run all tests

magento-automated-testing · 2021-11-23T17:07:44Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

marcin-dykas · 2021-11-30T13:17:51Z

Still 9 checks are not successful but most of them fails because EE PricePermission module.

Error says:

Interception cache generation... 6/9 [========>----]  66% 1 min 444.0 MiBErrors during compilation:
	Magento\PricePermissions\Ui\DataProvider\Product\Form\Modifier\Grouped
		Missed required argument nameHelper in parent::__construct call. File: /var/www/html/app/code/Magento/PricePermissions/Ui/DataProvider/Product/Form/Modifier/Grouped.php
	Magento\PricePermissions\Ui\DataProvider\Product\Form\Modifier\Related
		Incompatible argument type: Required type: \Magento\Catalog\Helper\Product\AddUrlToName. Actual type: string; File:
/var/www/html/app/code/Magento/PricePermissions/Ui/DataProvider/Product/Form/Modifier/Related.php

Since I don't have access to EE repository I can't fix it. I decided to provided patch to this module which solves this issue.

EE_PricePermissions_module_patch.zip

…ove-admin-panel-navigation

Admin panel navigation improvement

fb74c69

magento-engcom-team added Area: Frontend Component: Bundle Component: Catalog Component: ConfigurableProduct Component: GroupedProduct Release Line: 2.4 labels Aug 17, 2021

BarnyShergold requested changes Aug 24, 2021

View reviewed changes

m2-community-project bot assigned BarnyShergold Aug 24, 2021

m2-community-project bot added this to Changes Requested in Pull Requests Dashboard Aug 24, 2021

m2-community-project bot added the Progress: needs update label Aug 24, 2021

mdykas-gorilla and others added 3 commits August 26, 2021 13:17

Removed wrong files

f54f3e1

Fixes after CR

f74a90b

Merge branch 'magento:2.4-develop' into feature/improve-admin-panel-n…

b49acde

…avigation

m2-community-project bot moved this from Changes Requested to Review in Progress in Pull Requests Dashboard Aug 26, 2021

m2-community-project bot added Progress: review and removed Progress: needs update labels Aug 26, 2021

mdykas-gorilla added 4 commits September 2, 2021 15:35

Adjusted existing unit tests

16348ae

Adjusted existing unit tests - added missing file

37560d1

Adjusted existing unit tests - added missing file

a9770b4

Adjusted existing unit tests - added test file for ConfigurableDataPr…

a38abcb

…ovider

BarnyShergold requested changes Sep 6, 2021

View reviewed changes

m2-community-project bot moved this from Review in Progress to Changes Requested in Pull Requests Dashboard Sep 6, 2021

m2-community-project bot removed the Progress: review label Sep 6, 2021

m2-community-project bot added the Progress: needs update label Sep 6, 2021

Added new unit tests for AddUrlToName method

c7e6b0d

mdykas-gorilla added 2 commits September 23, 2021 18:42

Fixes after last CR

e6e8645

Merge branch '2.4-develop' of https://github.com/magento/magento2 int…

247aac5

…o feature/improve-admin-panel-navigation

More fixes after last CR

829ba8c

m2-community-project bot moved this from Changes Requested to Review in Progress in Pull Requests Dashboard Sep 29, 2021

m2-community-project bot added Progress: review and removed Progress: needs update labels Sep 29, 2021

marcin-dykas requested a review from BarnyShergold October 4, 2021 07:18

sidolov added the Priority: P3 May be fixed according to the position in the backlog. label Oct 28, 2021

mdykas-gorilla added 6 commits November 23, 2021 15:35

Merge remote-tracking branch 'upstream/2.4-develop' into feature/impr…

a354516

…ove-admin-panel-navigation

Fixed problem with undeclared dependencies

a9563a2

Fixed error from Magento\Test\Php\LiveCodeTest::testCodeStyle

a815ef1

Fixed error from Magento\Test\Php\LiveCodeTest::testCodeStyle

335ccd5

Fixed error in Magento\ConfigurableProduct\Ui\DataProvider\Product\Fo…

7b252c7

…rm\Modifier\Data\AssociatedProductsTest::testAddManuallyConfigurationsWithNotFilterableInGridAttribute

Fixed error in Magento\Test\Php\LiveCodeTest::testPhpStan

36763ad

app/code/Magento/Catalog/Ui/DataProvider/Product/Related/AbstractDataProvider.php app/code/Magento/GroupedProduct/Ui/DataProvider/Product/GroupedProductDataProvider.php

Merge remote-tracking branch 'upstream/2.4-develop' into feature/impr…

91fb6dd

…ove-admin-panel-navigation

Admin panel navigation improvement #33824

Are you sure you want to change the base?

Admin panel navigation improvement #33824

Conversation

marcin-dykas commented Aug 17, 2021

Description (*)

Benefits

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

m2-assistant bot commented Aug 17, 2021

bgorski commented Aug 17, 2021 • edited

marcin-dykas commented Aug 19, 2021

bgorski commented Aug 23, 2021

magento-automated-testing bot commented Aug 23, 2021

BarnyShergold left a 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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcin-dykas commented Aug 26, 2021

BarnyShergold left a 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

Choose a reason for hiding this comment

BarnyShergold commented Sep 20, 2021

marcin-dykas commented Sep 23, 2021

marcin-dykas commented Sep 23, 2021

magento-automated-testing bot commented Sep 23, 2021

marcin-dykas commented Sep 24, 2021 • edited

marcin-dykas commented Oct 7, 2021

magento-automated-testing bot commented Oct 7, 2021

marcin-dykas commented Nov 23, 2021

magento-automated-testing bot commented Nov 23, 2021

marcin-dykas commented Nov 30, 2021

bgorski commented Aug 17, 2021 •

edited

marcin-dykas commented Sep 24, 2021 •

edited