[UI] List toolbar - select all to perform batch action #14392

laurielim · 2024-12-18T10:08:08Z

Q	A
Bug fix? (use the a.b branch)	🔴
New feature/enhancement? (use the a.x branch)	🟢
Deprecations?	🔴
BC breaks? (use the c.x branch)	🔴
Automated tests included?	🟢
Related user documentation PR URL	mautic/user-documentation#...
Related developer documentation PR URL	mautic/developer-documentation-new#...
Issue(s) addressed	Fixes #...

Description

This branch is based off [UI] Toolbar batch actions #14306
Created a select all button that when clicked, also "selects" paginated items (as opposed to the checkall checkbox which only selects items on the rendered page)
Created batchDeleteService which perform batch delete for batchDeleteActions in various entity controllers
Created CannotBeDeletedInterface for models where entity cannot be deleted if there are dependencies or in the case of custom fields, the entity is "fixed".

📋 Steps to test this PR:

Open this PR on Gitpod or pull down for testing locally (see docs on testing PRs here)
Generate dummy data for testing with ddev exec bin/console doctrine:fixtures:load
Go to the different entity lists and see that batch actions still work when selecting individual checkboxes and when clicking on "select all".
See that the select all button shows how many items there are in total
See that the # of selected items match the total items when you click on select all

See that Segments that segments used in other segments cannot be deleted unless you're deleting all segments

Same for roles with users
See that you can't delete your own user account
See that you can't delete fixed custom fields

Install custom plugins Clearbit and FullContact and see that they still work for both person and company lookup

app/bundles/CoreBundle/Config/config.php

app/bundles/CoreBundle/Service/BatchDeleteService.php

escopecz · 2024-12-18T12:07:58Z

app/bundles/CoreBundle/Controller/AbstractStandardFormController.php

+                $postActionVars,
+                $this->getSessionBase(),
+                $this->getModelName(),
+                [$this, 'isLocked'],


I would create another service for this isLocked method but that can be done in the second step.

andersonjeccel · 2024-12-18T13:03:28Z

On the current state, while we can see the button for selecting all, only contacts from the page you're on receive the batch action, right?

Screencast.From.2024-12-18.10-02-36.mp4

laurielim · 2024-12-19T08:06:18Z

On the current state, while we can see the button for selecting all, only contacts from the page you're on receive the batch action, right?

@andersonjeccel The select all should work for contacts batch actions already. I reckon you might need to clear browser cache as there's JS changes.

andersonjeccel · 2024-12-19T15:59:23Z

@laurielim Definitely working great! I'm happy to see this feature ready :)

When checking the branch locally, the command ddev exec composer install was needed as I was working on 6.x branches before
it downgraded some packages (which makes me think that you changed the target on GitHub but missed rebasing it)

You can try rebasing the branch using the last version of #14275 to avoid dealing with conflicts, or invite me to your fork so I can help you if needed

laurielim · 2024-12-27T09:43:46Z

@andersonjeccel yep the branch was outdated, based my branch off #14306 which i've now rebased so should have latest packages now. Also this is now ready for review. I did add you as collaborator though in case.

kuzmany

It works at overal. I did some tests.
If I am trying change tags on all selected, it return no ids

kuzmany

It works at overal. I did some tests.
If I am trying change tags on all selected, it return no ids

laurielim · 2024-12-31T09:46:26Z

@kuzmany could you provide a step by step please? I am not able to reproduce.

shinde-rahul · 2025-01-03T01:02:24Z

@laurielim, please resolve the conflicts.

jos0405

I tested with multiple lists, and worked really well!
Also in tags. Couldn't reproduce the previously mentioned error.

…odel; Use BatchDeleteService in FieldController

…eleted expected return

…dInterface in UserModel

…dInterface in RoleModel

…Deleted

…d in cannotBeDeleted fn

andersonjeccel · 2025-01-21T13:21:41Z

@laurielim Hm, would you say that rebasing was successful?

I'm wondering if something broke along the way to result on the failing tests

…gerBundle

escopecz reviewed Dec 18, 2024

View reviewed changes

laurielim marked this pull request as draft December 18, 2024 17:54

andersonjeccel added this to the 6.0 milestone Dec 18, 2024

andersonjeccel added needs-rebase PR's that need to be rebased feature A new feature for inclusion in minor or major releases and removed enhancement Any improvement to an existing feature or functionality labels Dec 19, 2024

laurielim marked this pull request as ready for review December 27, 2024 09:43

laurielim changed the title ~~WIP [UI] List toolbar - select all to perform batch action~~ [UI] List toolbar - select all to perform batch action Dec 27, 2024

laurielim added ready-to-test PR's that are ready to test code-review-needed PR's that require a code review before merging and removed needs-rebase PR's that need to be rebased labels Dec 27, 2024

laurielim requested review from escopecz and andersonjeccel December 27, 2024 14:15

andersonjeccel requested review from kuzmany, shinde-rahul and matbcvo December 28, 2024 17:06

kuzmany reviewed Dec 28, 2024

View reviewed changes

shinde-rahul added the has-conflicts Pull requests that cannot be merged until conflicts have been resolved label Jan 3, 2025

jos0405 approved these changes Jan 7, 2025

View reviewed changes

laurielim added 17 commits January 21, 2025 10:10

Use params ids and searchValue instead of request

2d224fd

Create tests for BatchDeleteService

ece54f9

Use BatchDeleteService for ListController::batchDeleteAction

911eaec

Create CannotBeDeletedInterface and implement in FIeldModel and ListM…

f44317f

…odel; Use BatchDeleteService in FieldController

Update LeadListModelTest based on CannotBeDeletedInterface::cannotBeD…

37b6fef

…eleted expected return

Update MonitoringController and TagController to use BatchDeleteService

d7e5646

Update BatchDeleteServiceTest to be DRY

b642006

Update CategoryController and StageController to use BatchDeleteService

2eb622a

Use BatchDeleteService in UserController and implement CannotBeDelete…

a1da587

…dInterface in UserModel

Use BatchDeleteService in RoleController and implement CannotBeDelete…

c45e002

…dInterface in RoleModel

Update FormController::batchRebuildHtmlAction to take all ids param

3ae7b4e

Use tagmanager.tag model for batchDeleteAction and implement cannotBe…

4dc032d

…Deleted

Update BatchEmailController to handle param ids === 'all'

68de319

Remove constant from trait

813e4e7

Update cannotBeDeleted output to flash msg and check if Field is fixe…

2c6c491

…d in cannotBeDeleted fn

Update BatchTagController to allow param all

59d7aa3

Update plugin batch lookup actions

2ff08db

laurielim force-pushed the ui-toolbar-select-all branch from 0f1379b to 2ff08db Compare January 21, 2025 08:18

laurielim and others added 4 commits January 21, 2025 10:20

Add missing declare(strict_types=1);

eabc3c7

Specify that return is array of int

c78aa48

Merge branch '6.x' into ui-toolbar-select-all

920f8b4

CS Fixer fix

e587b1b

andersonjeccel removed the has-conflicts Pull requests that cannot be merged until conflicts have been resolved label Jan 21, 2025

laurielim added 4 commits January 26, 2025 12:13

Add flash if a given id is not found

46e77f4

Update list segment error message

5034893

Update TagControllerTest nampespace to use MauticPlugin\MauticTagMana…

1dce399

…gerBundle

Merge branch '6.x' into ui-toolbar-select-all

bb9e1fc

laurielim force-pushed the ui-toolbar-select-all branch from 05de5da to bb9e1fc Compare January 26, 2025 11:34

Specify return types and param types

ba2ee0b

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[UI] List toolbar - select all to perform batch action #14392

[UI] List toolbar - select all to perform batch action #14392

laurielim commented Dec 18, 2024 •

edited

Loading

escopecz Dec 18, 2024

andersonjeccel commented Dec 18, 2024

laurielim commented Dec 19, 2024 •

edited

Loading

andersonjeccel commented Dec 19, 2024

laurielim commented Dec 27, 2024 •

edited

Loading

kuzmany left a comment

kuzmany left a comment

laurielim commented Dec 31, 2024

shinde-rahul commented Jan 3, 2025

jos0405 left a comment

andersonjeccel commented Jan 21, 2025

[UI] List toolbar - select all to perform batch action #14392

Are you sure you want to change the base?

[UI] List toolbar - select all to perform batch action #14392

Conversation

laurielim commented Dec 18, 2024 • edited Loading

Description

📋 Steps to test this PR:

escopecz Dec 18, 2024

Choose a reason for hiding this comment

andersonjeccel commented Dec 18, 2024

laurielim commented Dec 19, 2024 • edited Loading

andersonjeccel commented Dec 19, 2024

laurielim commented Dec 27, 2024 • edited Loading

kuzmany left a comment

Choose a reason for hiding this comment

kuzmany left a comment

Choose a reason for hiding this comment

laurielim commented Dec 31, 2024

shinde-rahul commented Jan 3, 2025

jos0405 left a comment

Choose a reason for hiding this comment

andersonjeccel commented Jan 21, 2025

laurielim commented Dec 18, 2024 •

edited

Loading

laurielim commented Dec 19, 2024 •

edited

Loading

laurielim commented Dec 27, 2024 •

edited

Loading