Implemented UrlFilterApplier component #28932

gabrieldagama · 2020-06-30T09:52:19Z

Description (*)

Implemented a new component to apply filters on a grid via GET URL parameter. Added the component to the product, cms_page, and cms_block grids.

Related Pull Requests

Fixed Issues (if relevant)

Fixes Add ability to set the filters on UI grid via GET parameters of request adobe-stock-integration#1501

Manual testing scenarios (*)

Open one of the grids mentioned above
Add the filters parameter to the URL, example for product: ?filters[name]=product123
The grid should be loaded with a name active filter with value = product123

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 · 2020-06-30T09:52:22Z

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

gabrieldagama · 2020-06-30T09:53:41Z

@magento run all tests

gabrieldagama · 2020-07-01T16:25:25Z

@magento run all tests

gabrieldagama · 2020-07-02T09:30:37Z

@magento run all tests

gabrieldagama · 2020-07-02T11:42:50Z

@magento run all tests

sivaschenko

Great contribution @gabrieldagama ! Thanks for the double test coverage! Please take a look at my comments

sivaschenko · 2020-07-02T11:58:17Z

app/code/Magento/Catalog/Test/Mftf/Test/AdminProductGridUrlFilterApplierTest.xml

+            <title value="Verify that filter is applied on product grid when filters parameter is set on url"/>
+            <description value="Accessing product grid url with filters parameter"/>
+            <severity value="MAJOR"/>
+            <testCaseId value="to-be-added"/>


Test case id needs to be added

sivaschenko · 2020-07-02T11:59:03Z

app/code/Magento/Catalog/Test/Mftf/Test/AdminProductGridUrlFilterApplierTest.xml

+        <see selector="{{AdminProductGridSection.productGridNameProduct($$createSimpleProduct.name$$)}}" userInput="$$createSimpleProduct.name$$" stepKey="seeProduct"/>
+        <seeElement selector="{{AdminProductGridFilterSection.enabledFilters}}" stepKey="seeEnabledFilters"/>
+        <see selector="{{AdminProductGridFilterSection.enabledFilters}}" userInput="Name: $$createSimpleProduct.name$$" stepKey="seeProductNameFilter"/>
+        <actionGroup ref="ClearFiltersAdminDataGridActionGroup" stepKey="clearGridFilter"/>


I'd move this action group to after section

sivaschenko · 2020-07-02T11:59:37Z

app/code/Magento/Cms/Test/Mftf/Test/AdminCmsBlockGridUrlFilterApplierTest.xml

+            <title value="Verify that filter is applied on block grid when filters parameter is set on url"/>
+            <description value="Accessing block grid url with filters parameter"/>
+            <severity value="MAJOR"/>
+            <testCaseId value="to-be-added"/>


Test case need to be added

Yes, @chalov-anton can you provide the test cases for this issue?

sivaschenko · 2020-07-02T11:59:53Z

app/code/Magento/Cms/Test/Mftf/Test/AdminCmsPageGridUrlFilterApplierTest.xml

+        <see selector="{{CmsPagesPageActionsSection.pagesGridRowByTitle($$createPage.title$$)}}" userInput="$$createPage.title$$" stepKey="seePage"/>
+        <seeElement selector="{{CmsPagesPageActionsSection.activeFilter}}" stepKey="seeEnabledFilters"/>
+        <see selector="{{CmsPagesPageActionsSection.activeFilter}}" userInput="Title: $$createPage.title$$" stepKey="seePageTitleFilter"/>
+        <actionGroup ref="ClearFiltersAdminDataGridActionGroup" stepKey="clearGridFilter"/>


I'd move this action group to after section

sivaschenko · 2020-07-02T12:01:21Z

app/code/Magento/Ui/view/base/web/js/grid/url-filter-applier.js

+
+    return Component.extend({
+        defaults: {
+            filterProvider: 'componentType = filters',


how this component is behaving on a page with multiple grids?
I.e. media gallery + adobe stock

Good point, will have a look on this, probably will have to introduce a parameter to handle the component namespace.

app/code/Magento/Ui/view/base/web/js/grid/url-filter-applier.js

sivaschenko · 2020-07-02T12:04:19Z

app/code/Magento/Cms/Test/Mftf/Test/AdminCmsPageGridUrlFilterApplierTest.xml

+            <title value="Verify that filter is applied on page grid when filters parameter is set on url"/>
+            <description value="Accessing page grid url with filters parameter"/>
+            <severity value="MAJOR"/>
+            <testCaseId value="to-be-added"/>


Test case needs to be added

gabrieldagama · 2020-07-02T15:46:07Z

@magento run all tests

magento-engcom-team · 2020-07-03T11:27:47Z

Hi @sivaschenko, thank you for the review.
ENGCOM-7778 has been created to process this Pull Request
✳️ @sivaschenko, could you please add one of the following labels to the Pull Request?

Label	Description
`Auto-Tests: Covered`	All changes in Pull Request is covered by auto-tests
`Auto-Tests: Not Covered`	Changes in Pull Request requires coverage by auto-tests
`Auto-Tests: Not Required`	Changes in Pull Request does not require coverage by auto-tests

engcom-Bravo · 2020-07-03T13:17:26Z

✔️ QA Passed

Manual scenario on Cucumber Studio - https://studio.cucumber.io/projects/131313/test-plan/folders/1320712/scenarios/4931106

engcom-Charlie · 2020-07-06T11:18:37Z

@magento run all tests

konarshankar07 · 2020-07-09T12:54:55Z

app/code/Magento/Cms/view/adminhtml/layout/cms_block_index.xml

@@ -9,6 +9,7 @@
    <body>
        <referenceContainer name="content">
            <uiComponent name="cms_block_listing"/>
+            <block class="Magento\Backend\Block\Template" template="Magento_Cms::url_filter_applier.phtml" />


I think we can add Urlfilter component in ui_component instead of creating a new block. Please check the similar implementation
https://github.com/magento/adobe-stock-integration/blob/f8f7257d30bf54646536491ad5366ae082c13570/AdobeStockImageAdminUi/view/adminhtml/ui_component/adobe_stock_images_listing.xml#L55-L70
Let me know your thoughts
Thanks

@konarshankar07 I think both approaches are fine

@sivaschenko ... Yes, you are right but my concerns is the namespace are hard coded in the url_filter_applier.phtml file which can be easily exported using ui_component.

m2-assistant · 2020-07-16T00:52:36Z

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

Added url filter applier

be428f7

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

magento-engcom-team added Area: Frontend Component: Ui Release Line: 2.4 labels Jun 30, 2020

Simplified PR to a JS only approach

984dab1

gabrieldagama marked this pull request as draft June 30, 2020 15:48

gabrieldagama changed the title ~~Implemented UrlFilterApplier component~~ [WIP] Implemented UrlFilterApplier component Jun 30, 2020

Gabriel Galvao da Gama added 7 commits July 1, 2020 11:56

Added jasmine tests

5531f50

Added url filter applier to product grid

1574740

Added url filter applier to cms grids

607aed6

Added mftf for product grid

22c2be9

Added cms page mftf tests

58158aa

Added mftf block test

1467c6e

Using existing action group

273607c

gabrieldagama marked this pull request as ready for review July 1, 2020 16:25

gabrieldagama changed the title ~~[WIP] Implemented UrlFilterApplier component~~ Implemented UrlFilterApplier component Jul 1, 2020

Gabriel Galvao da Gama added 2 commits July 2, 2020 10:19

Fixed static tests

8660c73

Fixed static tests

a8c3f67

Added block names

96e6752

sivaschenko requested changes Jul 2, 2020

View reviewed changes

ghost assigned sivaschenko Jul 2, 2020

ghost added Progress: needs update and removed Progress: pending review labels Jul 2, 2020

ghost assigned gabrieldagama Jul 2, 2020

Added escape for block argument

b4b16ff

sivaschenko approved these changes Jul 3, 2020

View reviewed changes

ghost added Progress: ready for testing and removed Progress: needs update labels Jul 3, 2020

magento-engcom-team added Component: Catalog Component: Cms labels Jul 3, 2020

chalov-anton self-assigned this Jul 3, 2020

ghost added Progress: testing in progress and removed Progress: ready for testing labels Jul 3, 2020

engcom-Bravo added the QA: Added to Regression Scope Scenario was analysed and added to Regression Testing Scope label Jul 3, 2020

ghost added Progress: extended testing and removed Progress: testing in progress labels Jul 3, 2020

engcom-Charlie self-assigned this Jul 3, 2020

add testCaseId

8af0f46

engcom-Charlie added the Auto-Tests: Covered All changes in Pull Request is covered by auto-tests label Jul 6, 2020

ghost added Progress: accept and removed Progress: extended testing labels Jul 6, 2020

sivaschenko added Priority: P1 Once P0 defects have been fixed, a defect having this priority is the next candidate for fixing. Severity: S1 Affects critical data or functionality and forces users to employ a workaround. labels Jul 6, 2020

lenaorobei added this to the 2.4.1 milestone Jul 6, 2020

konarshankar07 reviewed Jul 9, 2020

View reviewed changes

sivaschenko mentioned this pull request Jul 14, 2020

Add links to grids to the image details panel magento/adobe-stock-integration#1503

Closed

magento-engcom-team mentioned this pull request Jul 16, 2020

magento2\lib\internal\Magento\Framework\Webapi\Rest\Request.php line:144 #1501

Closed

magento-engcom-team pushed a commit that referenced this pull request Jul 16, 2020

ENGCOM-7778: Implemented UrlFilterApplier component #28932

24e74cc

magento-engcom-team merged commit 807bada into magento:2.4-develop Jul 16, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implemented UrlFilterApplier component #28932

Implemented UrlFilterApplier component #28932

gabrieldagama commented Jun 30, 2020 •

edited

Loading

m2-assistant bot commented Jun 30, 2020

gabrieldagama commented Jun 30, 2020

gabrieldagama commented Jul 1, 2020

gabrieldagama commented Jul 2, 2020

gabrieldagama commented Jul 2, 2020

sivaschenko left a comment

sivaschenko Jul 2, 2020

sivaschenko Jul 2, 2020

sivaschenko Jul 2, 2020

gabrieldagama Jul 2, 2020

sivaschenko Jul 2, 2020

sivaschenko Jul 2, 2020

gabrieldagama Jul 2, 2020

sivaschenko Jul 2, 2020

gabrieldagama commented Jul 2, 2020

magento-engcom-team commented Jul 3, 2020

engcom-Bravo commented Jul 3, 2020

engcom-Charlie commented Jul 6, 2020

konarshankar07 Jul 9, 2020 •

edited

Loading

sivaschenko Jul 9, 2020

konarshankar07 Jul 9, 2020

m2-assistant bot commented Jul 16, 2020

Implemented UrlFilterApplier component #28932

Implemented UrlFilterApplier component #28932

Conversation

gabrieldagama commented Jun 30, 2020 • edited Loading

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

m2-assistant bot commented Jun 30, 2020

gabrieldagama commented Jun 30, 2020

gabrieldagama commented Jul 1, 2020

gabrieldagama commented Jul 2, 2020

gabrieldagama commented Jul 2, 2020

sivaschenko 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

gabrieldagama commented Jul 2, 2020

magento-engcom-team commented Jul 3, 2020

engcom-Bravo commented Jul 3, 2020

engcom-Charlie commented Jul 6, 2020

konarshankar07 Jul 9, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

m2-assistant bot commented Jul 16, 2020

gabrieldagama commented Jun 30, 2020 •

edited

Loading

konarshankar07 Jul 9, 2020 •

edited

Loading