Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix grouping grid sorting - ACL grids #16529

Open
wants to merge 3 commits into
base: 3.x
Choose a base branch
from

Conversation

smg6511
Copy link
Collaborator

@smg6511 smg6511 commented Feb 20, 2024

What does it do?

Adds new grouping logic to ACL GetList processors and config props in the corresponding Ext grid classes.

Why is it needed?

Aside from the Settings grid,* other grouping grids (such as the ACL ones) neither group properly, nor sort within groups properly.

How to test

  1. Rebuild may be necessary and compress_js must be off.
  2. Create a variety of ACL entries so there are at least a few main items to group (this is the Minimum Role, which is what all ACLs are grouped by as a default [can be changed in the column menu]), and a few entries within those groups (meaning you'll need multiple contexts, namespaces, resource groups, media sources, and element categories created ahead of time to assign these roles to).
  3. Verify that items are grouped as expected.
  4. Verify that sorting on each column works as expected.

Related issue(s)/PR(s)

No related issue.

  • The settings grid does not group correctly if the grouping field is changed. That will be addressed in a different PR.

Jim Graham and others added 3 commits February 18, 2024 01:34
Remove stale lines brought in during rebase
Formatting, var naming,  and other stylistic changes only; no functional changes.
Copy link

codecov bot commented Feb 20, 2024

Codecov Report

Attention: 115 lines in your changes are missing coverage. Please review.

Comparison is base (f197da7) 21.57% compared to head (331bce5) 21.52%.

Files Patch % Lines
...urity/Access/UserGroup/AccessNamespace/GetList.php 0.00% 22 Missing ⚠️
...ors/Security/Access/UserGroup/Category/GetList.php 0.00% 22 Missing ⚠️
...ecurity/Access/UserGroup/ResourceGroup/GetList.php 0.00% 22 Missing ⚠️
...ssors/Security/Access/UserGroup/Source/GetList.php 0.00% 22 Missing ⚠️
...sors/Security/Access/UserGroup/Context/GetList.php 0.00% 18 Missing ⚠️
...c/Revolution/Processors/Model/GetListProcessor.php 25.00% 9 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##                3.x   #16529      +/-   ##
============================================
- Coverage     21.57%   21.52%   -0.06%     
- Complexity    10566    10603      +37     
============================================
  Files           561      561              
  Lines         31940    32030      +90     
============================================
+ Hits           6892     6895       +3     
- Misses        25048    25135      +87     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

added later in the getData method.
*/
switch ($gridCategory) {
case 'usergroup-acl':
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this logic be in the generic GetListProcessor or something ACL related?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I chose the placement of the logic based on looking to support other grouping grids down the road (e.g., the Settings one [which could use some work as mentioned in the opening comments], or any Extras that might make use of that type of grid). That said, let me know if you think there's a more appropriate place; perhaps a new processor extending the main GetListProcessor.

Copy link
Collaborator Author

@smg6511 smg6511 Mar 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Mark-H - Hey, it's been a while since you made this comment; let me know what your thoughts are on my response above... Thx ;-)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If there needs to be an extra hook in the base getlist processor I don't have objections to that, but I do still think it's kinda weird to have a switch with values for specific implementations in a base class. That just seems like it's not architected properly.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree it's not ideal; honestly there's a fair amount of wonkiness in the arch of the processors in general (e.g., there's inconsistency in how get data is handled [ two ways that I've come across ]) that makes it difficult to keep things DRY.

I can take a look at adding an intermediate class if you prefer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants