[Backport][2.2] Admin Grid column ordering/positioning not working when single store mode set On #17512

pavelshulgabi · 2018-08-11T01:19:48Z

added component status based filtering

Description

New functionality filters out all disabled UI components (based on internal logic some components are not applicable when the store has single store mode enabled) as it affects children length comparison and different useful UX behaviours.

Fixed Issues

M2.2.0 Admin Grid column ordering/positioning not working when single store mode set On #12070 M2.2.0 Admin Grid column ordering/positioning not working when single store mode set On

Manual testing scenarios

Install Magento
Ensure single store mode on
View sales order grid
Launch Browser development tools and monitor network traffic.
Move a column. If there is an AJAX call after each column move, then the fix has worked. Without the fix, there will be no AJAX calls for each column move.

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 on Travis CI are green)

…single store mode set On * added component status based filtering

magento-cicd2 · 2018-08-11T01:19:50Z

All committers have signed the CLA.

magento-engcom-team · 2018-08-11T01:19:54Z

Hi @pavelshulga. 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-engcom-team give me test instance - deploy test instance based on PR changes
@magento-engcom-team give me {$VERSION} instance - deploy vanilla Magento instance

For more details, please, review the Magento Contributor Assistant documentation

gwharton · 2018-08-11T09:10:05Z

Looking at the code, this would appear to fix the original problem, but column ordering is still not working for me, even though I have applied this fix. There is obviously something else going on. Will investigate.

Column ordering seems to no longer work regardless of whether single store mode is on or not, which suggests there is a new unrelated issue affecting column ordering.

gwharton · 2018-08-11T09:11:07Z

@magento-engcom-team give me test instance

magento-engcom-team · 2018-08-11T09:11:07Z

Hi @gwharton. Thank you for your request. I'm working on Magento instance for you

magento-engcom-team · 2018-08-11T09:11:49Z

Hi @gwharton, here is your new Magento instance.
Admin access: https://pr-17512.engcom.dev.magento.com/admin
Login: admin Password: 123123q

gwharton · 2018-08-11T09:25:27Z

Here is a video of column ordering not working on the test instance.

https://www.youtube.com/watch?v=d_pH8U9NayE

pavelshulgabi · 2018-08-11T09:54:22Z

There should not be a dependency on single store mode configuration. Could you please check whether Magento is saving the column order via AJAX call after any rearranging action using browser developer tool?

On Sat, 11 Aug 2018 at 7:25 pm, gwharton ***@***.***> wrote: Here is a video of column ordering not working on the test instance. https://www.youtube.com/watch?v=d_pH8U9NayE — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#17512 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AdwG18Qahqn98tagg_x3oqIETOyTULDbks5uPqMfgaJpZM4V4-tc> .

-- "Please excuse any typos"

pavelshulgabi · 2018-08-11T10:03:01Z

@gwharton , thanks for sharing credentials to the instance. I was able to log in and check the functionality and the solution.

I used the sales order grid and was able to successfully reorganise columns. After each change, Magento sends AJAX call to save all the changes (URL /admin/mui/bookmark/save/?isAjax=true).

gwharton · 2018-08-11T10:20:14Z

If I move a column, i immediately get an ajax call to save the position. In my case I see the following data in the Ajax call.

"positions":{"ids":0,"billing_name":1,"signifyd_guarantee_status":2,"created_at":3,"shipping_name":4,"grand_total":5,"base_grand_total":6,"increment_id":7,"billing_address":8,"shipping_address":9,"shipping_information":10,"customer_email":11,"customer_group":12,"customer_name":13,"subtotal":14,"status":15,"payment_method":16,"total_refunded":17,"shipping_and_handling":18,"actions":19}
The column positions in the AJAX call match whats on screen.

If I then just click refresh, the page reloads, and somewhere amongst the loading is another ajax call to save the bookmark positions again.

"positions":{"ids":0,"billing_name":1,"signifyd_guarantee_status":2,"created_at":3,"shipping_name":4,"grand_total":5,"base_grand_total":6,"increment_id":7,"billing_address":8,"shipping_address":9,"shipping_information":10,"customer_email":11,"customer_group":12,"subtotal":13,"customer_name":14,"status":15,"payment_method":16,"total_refunded":17,"shipping_and_handling":18,"actions":19}

The order has changed.

Please try yourself, log in to the test instance, go to sales order grid, move customer name column one position to the left, so it is customer email, group, name and then subtotal. Then refresh the page and check again.

pavelshulgabi · 2018-08-12T23:15:07Z

@gwharton

Thanks for the detailed information regarding your testing. Could you please review the video of my test attempt and advise what should be adjusted as the outcomes seem perfectly fine for me?
https://drive.google.com/open?id=1dkfUS52IppEMUoxJsm-0Vh0e2Wq4_9s8

Possibly the issue with the testing is due to racing between two concurrent AJAX requests during your test run which overwrite changes of each other (case when earlier started request is being process after later one).

gwharton · 2018-08-13T11:06:52Z

Hi there @pavelshulga

I've done a bit more debug on my own freshly deployed 2.2.5 test instance with your PR applied.

The following happened

Login to admin
Sales order grid
Enable all columns
Check browser column order with current bookmark in database -> OK
ACTION : Move a column
Check AJAX call with browser column order -> OK
Check browser column order with current bookmark in database -> OK
ACTION : Refresh Browser
Check browser column order unchanged -> OK
Check browser column order with current bookmark in database -> OK
ACTION : Move a column
Check AJAX call with browser column order -> OK
Check browser column order with current bookmark in database -> OK
ACTION : Refresh Browser
Check browser column order unchanged -> OK
Check browser column order with current bookmark in database -> OK
ACTION : Move a column
Check AJAX call with browser column order -> OK
Check browser column order with current bookmark in database -> OK
ACTION : Refresh Browser
Check browser column order unchanged -> OK
Check browser column order with current bookmark in database -> OK
ACTION : Move a column
Check AJAX call with browser column order -> OK
Check browser column order with current bookmark in database -> OK
ACTION : Move a column
Check AJAX call with browser column order -> OK
Check browser column order with current bookmark in database -> OK
ACTION : Hide a column
Check AJAX call with browser column order -> OK (still includes hidden column)
Check browser column order with current bookmark in database -> OK (still includes hidden column)
ACTION : Move a column
Check AJAX call with browser column order -> OK
Check browser column order with current bookmark in database -> OK
ACTION : Refresh Browser
During the page refresh an AJAX Call is made with incorrect column ordering
Check browser column order unchanged -> FAIL - new column ordering matches the above AJAX call
Check browser column order with current bookmark in database -> OK database matches above AJAX call
ACTION : Refresh Browser
During the page refresh an AJAX Call is made with incorrect column ordering
Check browser column order unchanged -> FAIL - new column ordering matches the above AJAX call
Check browser column order with current bookmark in database -> OK database matches above AJAX call
ACTION : Refresh Browser
During the page refresh an AJAX Call is made with incorrect column ordering
Check browser column order unchanged -> FAIL - new column ordering matches the above AJAX call
Check browser column order with current bookmark in database -> OK database matches above AJAX call

Log of ajax calls and database content.txt

You can see that during a normal refresh when the column ordering is correct, there is no AJAX call during the page refresh. Once it starts going wrong, an AJAX call is made during the page refresh which is what is incorrectly adjusting the column ordering.

I notice in your video, that you also saw an AJAX call during your page refresh, although the resulting column ordering did still appear correct. Perhaps it was moving a column that wasnt visible in your example. Try again with all columns visible and keep watching for AJAX calls made during the page refresh.

gwharton · 2018-08-13T18:00:25Z

@pavelshulga. Im pretty confident there are two independent issues.

When this issue was raised column ordering only failed when single store mode was on. This is the first bug and is the one you fixed with this PR. Sometime after raising the issue column ordering also stopped working when single store was set to off. I think this is bug no.2 and is what we are seeing here as you have fixed bug no.1. Bug no.2 appears in all modes and seems related to the extra erroneous ajax call during page load/refresh.

pavelshulgabi · 2018-08-14T03:29:41Z

@gwharton
Thanks for the detailed feedback.

Could you please add steps to reproduce the bug 2 (for future reference)? In meantime, I'll work on investigation/resolution.

gwharton · 2018-08-14T16:16:23Z

I'm struggling to get a definitive set of steps to 100% reproduce the bug, apart from "move columns around at random, and it normally occurs within 5 or 6 attempts.

I have done some digging though,

In file Magento_Ui/js/grid/listing.js initElement() gets called for each column as it is created on page load. Once all columns are loaded a call is made to initPositions() to set the positions.

If I run require('uiRegistry').get("sales_order_grid.sales_order_grid.sales_order_columns") just prior to the initPositions call, the order of the columns in the _elems array that is returned is in the default order.

If you re-run require('uiRegistry').get("sales_order_grid.sales_order_grid.sales_order_columns") just after the initPositions call, the order of the columns in the _elems array is correct and should match what should be rendered to the screen (usually, aslong as the bug is not occurring)

I don't fully understand whats going on in the initPositions call, but it looks like it retrieves the column ordering from the local storage/uiRegistry.

For some reason, when this bug is occurring, on a page refresh, if I break execution just after the initPositions call and if I run require('uiRegistry').get("sales_order_grid.sales_order_grid.sales_order_columns") ,the order of the columns in the _elems array is incorrect and is not what was expected. For some reason, the incorrect column ordering is obtained from local storage/uiRegistry.

The code knows that the column ordering it has just retrieved is not the same (somehow) and it triggers off the change event which ultimately results in the firing off, of the AJAX call with the wrong ordering in it.

Might give some clues as to where to look.......

gwharton · 2018-08-19T10:01:49Z

I did some testing on all versions from 2.2.0 to 2.2.5

Magento Version	Single Store Mode	PR#17512 Applied	Column Ordering Test	Notes
2.2.0-2.2.5	OFF	NO	FAILED	We see BUG 2, extra AJAX calls on refresh
2.2.0-2.2.5	ON	NO	FAILED	No Ajax call on column move - BUG 1
2.2.0-2.2.5	OFF	YES	FAILED	We see BUG 2, extra AJAX calls on refresh
2.2.0-2.2.5	ON	YES	FAILED	Confirm BUG 1 fixed by PR#17512. We see BUG 2, extra AJAX calls on refresh

It shows that PR #17512 does indeed fix BUG 1, which is the original issue #12070

It also shows that the other bug (BUG 2) happens regardless of single store mode.

I am going to create a new issue to track BUG 2, as they are independent issues. This way PR 17512 can go forward as the fix for issue #12070 while the resolution to BUG 2 is worked on.

gwharton · 2018-08-22T15:59:47Z

@rogyar

I have created a new issue to capture the second bug mentioned above (#17691).

The testing that I have done on this issue shows that this PR does indeed fix the first bug (#12070) and can therefore proceed accordingly.

It can easily be tested as without this fix in single store mode, there are no AJAX calls made from the browser to the backend when you move any columns. With this PR applied, the AJAX calls are made every time and can easily be inspected to contain the correct information.

…ine after vars.

gwharton · 2018-10-05T15:54:49Z

Manual Testing Scenareo.

Install Magento
Ensure single store mode on
View sales order grid
Launch Browser development tools and monitor network traffic.
Move a column. If there is an AJAX call after each column move, then the fix has worked. Without the fix, there will be no AJAX calls for each column move.

gwharton · 2018-10-05T16:28:26Z

2.3-develop PR is here #18405

gwharton · 2018-10-05T16:46:24Z

Note, if during testing you see that column positioning is not working properly, you may also be running into issue #17691 which remains unfixed. This PR addresses only the issue of the missing AJAX calls.

magento-engcom-team · 2018-10-06T10:42:47Z

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

gwharton · 2018-10-17T13:42:57Z

Duplicate of #18561

amitmaurya191 · 2020-03-28T19:34:40Z

I did some testing on all versions from 2.2.0 to 2.2.5
Magento Version Single Store Mode PR#17512 Applied Column Ordering Test Notes
2.2.0-2.2.5 OFF NO FAILED We see BUG 2, extra AJAX calls on refresh
2.2.0-2.2.5 ON NO FAILED No Ajax call on column move - BUG 1
2.2.0-2.2.5 OFF YES FAILED We see BUG 2, extra AJAX calls on refresh
2.2.0-2.2.5 ON YES FAILED Confirm BUG 1 fixed by PR#17512. We see BUG 2, extra AJAX calls on refresh

It shows that PR #17512 does indeed fix BUG 1, which is the original issue #12070

It also shows that the other bug (BUG 2) happens regardless of single store mode.

I am going to create a new issue to track BUG 2, as they are independent issues. This way PR 17512 can go forward as the fix for issue #12070 while the resolution to BUG 2 is worked on.

As I am using magento 2.2, I am also facing the ajax call issue on sales order grid issue. Just wanted to know,did you get any solution for this issue. If yes, please share with us also. Thanks

gwharton · 2020-03-28T19:38:33Z

Bug 2 still present in 2.4-develop. #23889

amitmaurya191 · 2020-03-28T19:46:32Z

Bug 2 still presebt in 2.4-develop. #23889

As I can see, This issue is not present in 2.3.4.

gwharton · 2020-03-28T19:48:05Z

I certainly see it in 2.3.4. I can reproduce with stock 2.3.4.

12070 M2.2.0 Admin Grid column ordering/positioning not working when …

c96a6a0

…single store mode set On * added component status based filtering

magento-engcom-team added partners-contribution Pull Request is created by Magento Partner Partner: Balance Internet labels Aug 11, 2018

magento-engcom-team added Area: Frontend Component: Ui Release Line: 2.2 labels Aug 11, 2018

pavelshulgabi mentioned this pull request Aug 11, 2018

M2.2.0 Admin Grid column ordering/positioning not working when single store mode set On #12070

Closed

dmanners added the Event: balance-cd label Aug 11, 2018

rogyar self-assigned this Aug 11, 2018

magento-engcom-team added this to the Release: 2.2.7 milestone Aug 11, 2018

magento-engcom-team added the Area: Frontend label Aug 11, 2018

rogyar added the Progress: needs update label Aug 13, 2018

gwharton mentioned this pull request Aug 19, 2018

[2.2.*] Admin Grid column ordering/positioning not working #17691

Closed

gwharton added 5 commits October 4, 2018 19:59

Fixed && issue moving to end of line

47acced

Moved location of var definition to beginning of function. Added newl…

a11082b

…ine after vars.

Consistent indentation in build function

612d543

Fixed whitespace violations

b69e954

Fixed whitespace coding standards violations

10e06ca

gwharton removed the Progress: needs update label Oct 5, 2018

gwharton changed the title ~~#12070 M2.2.0 Admin Grid column ordering/positioning not working when single store mode set On~~ [2.2] Admin Grid column ordering/positioning not working when single store mode set On Oct 5, 2018

gwharton mentioned this pull request Oct 5, 2018

[2.3] Admin Grid column ordering/positioning not working when single store mode set On #18405

Merged

4 tasks

gwharton changed the title ~~[2.2] Admin Grid column ordering/positioning not working when single store mode set On~~ [Backport][2.2] Admin Grid column ordering/positioning not working when single store mode set On Oct 5, 2018

josefbehr approved these changes Oct 6, 2018

View reviewed changes

magento-engcom-team assigned josefbehr Oct 6, 2018

magento-engcom-team modified the milestones: Release: 2.2.7, Release: 2.2.8 Oct 6, 2018

josefbehr closed this Oct 7, 2018

okorshenko reopened this Oct 7, 2018

josefbehr added the Progress: accept label Oct 8, 2018

gwharton marked this as a duplicate of #18561 Oct 17, 2018

gwharton closed this Oct 17, 2018

[Backport][2.2] Admin Grid column ordering/positioning not working when single store mode set On #17512

[Backport][2.2] Admin Grid column ordering/positioning not working when single store mode set On #17512

Uh oh!

Conversation

pavelshulgabi commented Aug 11, 2018 • edited by gwharton Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Fixed Issues

Manual testing scenarios

Contribution checklist

Uh oh!

magento-cicd2 commented Aug 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

magento-engcom-team commented Aug 11, 2018

Uh oh!

gwharton commented Aug 11, 2018

Uh oh!

gwharton commented Aug 11, 2018

Uh oh!

magento-engcom-team commented Aug 11, 2018

Uh oh!

magento-engcom-team commented Aug 11, 2018

Uh oh!

gwharton commented Aug 11, 2018

Uh oh!

pavelshulgabi commented Aug 11, 2018 via email

Uh oh!

pavelshulgabi commented Aug 11, 2018

Uh oh!

gwharton commented Aug 11, 2018

Uh oh!

pavelshulgabi commented Aug 12, 2018

Uh oh!

gwharton commented Aug 13, 2018

Uh oh!

gwharton commented Aug 13, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pavelshulgabi commented Aug 14, 2018

Uh oh!

gwharton commented Aug 14, 2018

Uh oh!

gwharton commented Aug 19, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gwharton commented Aug 22, 2018

Uh oh!

gwharton commented Oct 5, 2018

Uh oh!

gwharton commented Oct 5, 2018

Uh oh!

gwharton commented Oct 5, 2018

Uh oh!

magento-engcom-team commented Oct 6, 2018

Uh oh!

gwharton commented Oct 17, 2018

Uh oh!

amitmaurya191 commented Mar 28, 2020

Uh oh!

gwharton commented Mar 28, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

amitmaurya191 commented Mar 28, 2020

Uh oh!

gwharton commented Mar 28, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

pavelshulgabi commented Aug 11, 2018 •

edited by gwharton

Loading

magento-cicd2 commented Aug 11, 2018 •

edited

Loading

gwharton commented Aug 13, 2018 •

edited

Loading

gwharton commented Aug 19, 2018 •

edited

Loading

gwharton commented Mar 28, 2020 •

edited

Loading