Segment membership as a new filter for dynamic web content #13526

escopecz · 2024-03-07T10:21:59Z

Q	A
Bug fix?	Y
New feature?	Y
Automated tests included?	Y
Related user documentation PR URL
Related developer documentation PR URL
Issues addressed (#s or URLs)	#2856
BC breaks?
Deprecations?

Description:

Add ability to use segment filters in dynamic content.

Steps to test this PR:

Not needed in beta - Run dcp bin/console mautic:assets:generate if you don't want to use dev local env.
Create segment to match contact in step 5
Create dynamic content
- Is campaign based? = NO
- then click filter in the top > select Segment membership
- use existing segment in which is created contact added
Create dynamic content page in Components > Landing pages
- Fill required info
- Go to Builder
- Drag Dynamic content into page content
- Click on it
- In right box select your dynamic content by name and use test as requested slot name
- Close builder and save
- with url https://yourmautic.coml/test check landing page
- You 'll see content from step 5
Create form with possibility to add contact Components > Forms
- mapped and required fields Firstname, Lastname, Email
Use this form in anonymous browser session
- with url https://mautic-cloud.local/form/[ID] to add contact with criteria matching created segment in step 1
- keep this browser window open
- open new tab with landing page from step 3
- You'll see dynamic content defined in step 2

Other areas of Mautic that may be affected by the change:

CustomObjectsBundle\EventListener\DynamicContentSubscriber::evaluateFilters() is using stopPropagation method. This could eliminate further listeners from running if incorrect priority is set- https://github.com/mautic-inc/plugin-custom-objects/blob/b2ed6c064e3e256f2640fdb456bbf2cfb879300b/EventListener/DynamicContentSubscriber.php#L117

TODO

Frontend (form handling, js)
PHP Notice - Array to string conversion``$choice contains [] in

/vendor/symfony/form/ChoiceList/ArrayChoiceList.php:68 at

When saving form kwith operator empty/not empty. Selected value before is saved in the same way as in lead_list table

Landing pages are not working for me with DWC. John has no prob. Confirmed as working in my beta instance. Something wrong in my docker env. - ,Mistake in DC & landing page config
Implementation into landing pages
Unit tests
~~Functional test for landing page~~ removed here https://github.com/mautic-inc/mautic-cloud/pull/1037/commits/86ac47c73891ee6561caccf4589949920b4e514a. HTTP requests from local are blocked in staging.

MAUT 3809 - Use segment membership as a filter for dynamic content for web

MAUT-5498 EAB - Segment Membership Filter in Dynamic Content Breaks Landing Pages

codecov · 2024-03-07T13:47:13Z

Codecov Report

Attention: Patch coverage is 92.30769% with 7 lines in your changes are missing coverage. Please review.

Project coverage is 61.42%. Comparing base (5a7cd96) to head (3f1c84a).

Additional details and impacted files

@@             Coverage Diff              @@
##                5.x   #13526      +/-   ##
============================================
+ Coverage     61.39%   61.42%   +0.03%     
- Complexity    34035    34050      +15     
============================================
  Files          2240     2240              
  Lines        101719   101773      +54     
============================================
+ Hits          62450    62518      +68     
+ Misses        39269    39255      -14

Files	Coverage Δ
...tBundle/EventListener/DynamicContentSubscriber.php	`84.41% <100.00%> (ø)`
...micContentBundle/Form/Type/DwcEntryFiltersType.php	`95.65% <100.00%> (+0.19%)`	⬆️
...amicContentBundle/Form/Type/DynamicContentType.php	`95.78% <100.00%> (+0.23%)`	⬆️
...namicContentBundle/Helper/DynamicContentHelper.php	`79.76% <ø> (+11.90%)`	⬆️
...ndles/EmailBundle/Helper/StatsCollectionHelper.php	`6.66% <ø> (ø)`
app/bundles/EmailBundle/Model/EmailModel.php	`50.41% <ø> (-0.06%)`	⬇️
...pp/bundles/LeadBundle/Entity/OperatorListTrait.php	`91.66% <ø> (ø)`
...dBundle/EventListener/DynamicContentSubscriber.php	`100.00% <100.00%> (ø)`
...dBundle/EventListener/FilterOperatorSubscriber.php	`100.00% <100.00%> (ø)`
...le/Form/DataTransformer/FieldFilterTransformer.php	`87.09% <100.00%> (ø)`
... and 4 more

... and 2 files with indirect coverage changes

RCheesley

Testing this with sample data, when I search for a segment none are found:

RCheesley · 2024-04-19T14:44:58Z

I checked it on GitPod and I got something different - the ID rather than the name of the segment:

escopecz · 2024-04-22T08:47:23Z

Interesting. It works well for existing DWC but when creating one from scratch I also see this issue.

escopecz · 2024-04-22T08:54:13Z

It looks like it's not a bug in this PR but in general When loading the select type of filters when creating a DWC from scratch then all the values are switched with keys. See for example locale:

escopecz · 2024-04-22T13:28:17Z

Wow, this was quite a long trip to fix it all. The select type fields were broken and not only in 1 place but 3. Each different type of select field on a different place. It originates from Mautic 3 refactoring where we had to swap all select keys with labels and this was broken ever since. It suggests something about the usage of these fields in DWC as no one noticed for years?

Some field choices are generated via jS. so I fixed it there. Others are generated via HTML templates so I fixed it there. A special case is for States which use index instead of the normal key. The rest of the template fields are using keys.

And then there are custom field selects, multiselects and booleans. Those were swapped twice on one place so I removed the additional swap. It seems that the code is used only for DWC, not for segments anymore so it shouldn't break anything else.

Field types to test:

State
Preferred Locale
Preferred Timezone
Segment Membership
Custom selects, multiselects, boolean fields.

RCheesley · 2024-04-22T13:50:09Z

I reported the locale bug when it happened as we have had this issue since then in our download form on mautic.org/download. See #12851 :) Hurrah for fixing it finally!

escopecz · 2024-04-22T15:18:08Z

@RCheesley I'm not sure it will fix #12851 but it would be a nice side effect.

rohitp19

LGTM. Thanks @escopecz

RCheesley

Thanks for fixing those issues @escopecz - checked and it's indeed working as expected for include and exclude on segment membership and the other things.

Sadly it doesn't fix #12851 in forms but I guess it's a very similar issue responsible!

lukassykora and others added 2 commits March 7, 2024 10:03

MAUT-3602 / Operator list

6c79f54

Merge pull request mautic#1037 from mautic-inc/MAUT-3809-2

9ada9f6

MAUT 3809 - Use segment membership as a filter for dynamic content for web

escopecz requested a review from mabumusa1 as a code owner March 7, 2024 10:22

rohitp19 and others added 3 commits March 7, 2024 11:34

Merge pull request mautic#1339 from acquia/MAUT-5498

446dbc2

MAUT-5498 EAB - Segment Membership Filter in Dynamic Content Breaks Landing Pages

Changes needed after rebase to M5

243ba6a

CS fixes

faf1c5e

escopecz added feature A new feature for inclusion in minor or major releases segments Anything related to segments dynamic-content unforking Used for PRs in the Acquia's unforking initiative labels Mar 7, 2024

escopecz changed the title ~~Use segment membership as a filter for dynamic content for web~~ Segment membership as a new filter for dynamic web content Mar 7, 2024

escopecz added 2 commits March 7, 2024 14:32

Allow the segment membership filter to be used by DWC

04236ed

Test fixes

b9e2202

escopecz requested review from a team and rohitpavaskar and removed request for a team March 7, 2024 13:48

escopecz mentioned this pull request Mar 7, 2024

Segment membership as a new filter for dynamic email content #13528

Merged

rohitp19 approved these changes Mar 11, 2024

View reviewed changes

rohitpavaskar previously approved these changes Mar 11, 2024

View reviewed changes

Merge remote-tracking branch 'upstream/5.x' into segment-improvements

8810294

escopecz dismissed rohitpavaskar’s stale review via 8810294 April 19, 2024 14:30

RCheesley requested changes Apr 19, 2024

View reviewed changes

escopecz force-pushed the segment-improvements branch from b7fbc0f to 514b0ef Compare April 22, 2024 13:28

Fixing DWC select type filters

8686a76

escopecz force-pushed the segment-improvements branch from 514b0ef to 8686a76 Compare April 22, 2024 13:32

escopecz requested review from rohitp19 and RCheesley April 22, 2024 13:43

escopecz added the bug Issues or PR's relating to bugs label Apr 22, 2024

rohitp19 approved these changes Apr 24, 2024

View reviewed changes

escopecz added the pending-test-confirmation PR's that require one test before they can be merged label Apr 25, 2024

Merge branch '5.x' into segment-improvements

d7b85aa

RCheesley approved these changes Apr 25, 2024

View reviewed changes

RCheesley added user-testing-passed PRs which have been successfully tested by the required number of people. code-review-needed PR's that require a code review before merging and removed pending-test-confirmation PR's that require one test before they can be merged labels Apr 25, 2024

escopecz added code-review-passed PRs which have passed code review and removed code-review-needed PR's that require a code review before merging user-testing-passed PRs which have been successfully tested by the required number of people. labels Apr 26, 2024

escopecz added this to the 5.1.0 milestone Apr 26, 2024

Merge branch '5.x' into segment-improvements

3f1c84a

escopecz merged commit ba7529c into mautic:5.x Apr 26, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Segment membership as a new filter for dynamic web content #13526

Segment membership as a new filter for dynamic web content #13526

Uh oh!

escopecz commented Mar 7, 2024 •

edited

Loading

Uh oh!

codecov bot commented Mar 7, 2024 •

edited

Loading

Uh oh!

RCheesley left a comment

Uh oh!

RCheesley commented Apr 19, 2024

Uh oh!

escopecz commented Apr 22, 2024

Uh oh!

escopecz commented Apr 22, 2024

Uh oh!

escopecz commented Apr 22, 2024

Uh oh!

RCheesley commented Apr 22, 2024

Uh oh!

escopecz commented Apr 22, 2024

Uh oh!

rohitp19 left a comment

Uh oh!

RCheesley left a comment

Uh oh!

Uh oh!

Uh oh!

Segment membership as a new filter for dynamic web content #13526

Segment membership as a new filter for dynamic web content #13526

Uh oh!

Conversation

escopecz commented Mar 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Steps to test this PR:

Other areas of Mautic that may be affected by the change:

TODO

Uh oh!

codecov bot commented Mar 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

RCheesley left a comment

Choose a reason for hiding this comment

Uh oh!

RCheesley commented Apr 19, 2024

Uh oh!

escopecz commented Apr 22, 2024

Uh oh!

escopecz commented Apr 22, 2024

Uh oh!

escopecz commented Apr 22, 2024

Uh oh!

RCheesley commented Apr 22, 2024

Uh oh!

escopecz commented Apr 22, 2024

Uh oh!

rohitp19 left a comment

Choose a reason for hiding this comment

Uh oh!

RCheesley left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

escopecz commented Mar 7, 2024 •

edited

Loading

codecov bot commented Mar 7, 2024 •

edited

Loading