feat: Show Building if a segment is new or updated but not yet rebuilt

[driskell]

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?	🟢

Description

When creating a new segment with filters, it displays immediately "No Contacts". This can be confusing to new users as it does not indicate there is an action waiting to build the new segment. Additionally, once build begins, you will see "123 Contacts" - however, the build may not be finished yet. The only way a user can know it is finished is to keep refreshing the page until the count does not change for a minute. It's not really easy to know if it's completed.

Similarly, when editing a segment, for example if you realised you captured too many due to a typo, after saving you just see the same contact count. There is no indication that a rebuild is waiting that might substantially change the count (even potentially reducing it to "No Contacts"). Neither is there indication of progress or when it completes. So again you are left refreshing the page waiting for it to stop changing. In cases where the change is 0 it is then even more difficult as you cannot know if it just didn't get around to rebuilding yet or if it did rebuild but it was 0 change because of an error in your filters.

This PR adds in additional statuses, bringing the list to:

• Building - Displayed for a new segment that has filters which is not yet built
• No Contacts - Displayed for a segment with filters that has been successfully built at least once since creation or last modification
• Building (X Contacts) - Displayed for a segment with filters that has been modified since it was last built
• X Contacts - Displayed for a segment with filters that has been successfully built at least once since creation or last modification

Screenshot for a new segment:

After mautic:segments:update passes over it:

After it is modified by a user:

This then returns to the previous screen after mautic:segments:update passes over it.

📋 Steps to test this PR:

1. Open this PR on Gitpod or pull down for testing locally (see docs on testing PRs here)
2. Create a new segment without filters. It will display No Contacts.
3. Create a new segment with filters. It will display Building.
4. Run mautic:segments:update. It will now display No Contacts or X Contacts depending on the filters.
5. Edit the segment's filters. It will display either Building or Building (X Contacts) depending on the previous filters.
6. Run mautic:segments:update. It will now display No Contacts or X Contacts depending on the filters.

I did deprecate the Mautic\LeadBundle\Entity\LeadList::initializeLastBuiltDate as we need to allow null last built date for new segments. Previously it would be set to a last built date of now for a new segment which was incorrect. The field was always nullable though so it's hard to say how bad a BC change this would be. I left the method in place as it was public, and marked it @deprecated.

My sponsoring organisation here is Other Media

[driskell]

I have some other work pending that hopefully I can follow up with later. Specifically there is one where I made mautic:segments:update accept a parameter to say only update new or modified segments. Running this as a new cron allows the Building labels to be rapidly removed and provides a massive benefit to users as they don't need to wait ages for the update to eventually reach their segment - in parallel we specifically run updates for new or modified.

[driskell]

Will check tests in some time. Looks like I was gonna add test for the class changes in the AJX and forgot! Will look at it when I can but welcome feedback in the interim

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 63.73%. Comparing base (e837fc7) to head (78827dd).

Additional details and impacted files

@@             Coverage Diff              @@
##                6.x   #14431      +/-   ##
============================================
- Coverage     63.74%   63.73%   -0.01%     
- Complexity    34646    34651       +5     
============================================
  Files          2279     2279              
  Lines        103739   103746       +7     
============================================
+ Hits          66126    66127       +1     
- Misses        37613    37619       +6     

Files with missing lines	Coverage Δ
...p/bundles/LeadBundle/Controller/AjaxController.php	19.87% <100.00%> (+0.69%)	⬆️
app/bundles/LeadBundle/Entity/LeadList.php	97.27% <100.00%> (+0.05%)	⬆️

... and 1 file with indirect coverage changes

[driskell]

Fixed the tests and added missing CSS classes test.
Not sure what the CS Fixer failure is as it seems completely unrelated to the code so possible an existing test failure.

[andersonjeccel]

Hey @driskell, could you rebase your branch and change the target to 6.x?

5.2 is receiving only bug fixes at this time

[driskell]

Hey @driskell, could you rebase your branch and change the target to 6.x?

5.2 is receiving only bug fixes at this time

Ah is there no 5.3 due then? (I targeted 5.x not 5.2)

I rebased to 6.x anyway but it looks like it cleanly applies to both with exception of 1 line in the AjaxController so easy to cherry if there was going to be a 5.3 and it was deemed useful.

[andersonjeccel]

@driskell We're moving all new enhancements and features to 6.x without 5.3. As the release calendar is many months late, Mautic will skip some versions until we get up to date :)

[andersonjeccel]

@driskell Re. the failing tests, could you check PHUnit?

[driskell]

I think bogus - looks like a random fail due to time or something and the baseline never was changed. I’ll push again to force rerun as perhaps it ran it on the push before I changed the base and didn’t rerun

[driskell]

@andersonjeccel Looks good now!

btw do you know is there a way for me to get onto the development slack? I think the register is locked for external users at the moment.

[driskell]

I think the needs-rebase tag can be removed now

[andersonjeccel]

Before running command with contacts added manually to dynamic segment

Recently set filter:

After running update command:

It seems to be working and it's good for UX

[andersonjeccel]

@driskell btw, could you ping me in the Mautic Slack? I'm there as aj

[driskell]

@driskell btw, could you ping me in the Mautic Slack? I'm there as aj

I tried to register but I think searching forums there's an invite limit that might be reached. If I click https://mau.tc/slack-invite it only allows Mautic domains for the email registration.

[andersonjeccel]

@driskell Asked the lead to update, could you try again using the same link?

[andersonjeccel]

@escopecz Would you like to finish code review?

[driskell]

Thanks for the review @escopecz - all need some changes to clear them up and will aim to look at that in next couple days.

[andersonjeccel]

@driskell is this PR something that will need retesting?

[driskell]

@driskell is this PR something that will need retesting?

Yes it will - the code changes per code review so needs a retest