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

DPMMA-2222 Email click heatmap #12696

Merged
merged 12 commits into from Sep 6, 2023

Conversation

patrykgruszka
Copy link
Member

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

Description:

This PR adds click heatmap visualization to emails in Mautic admin panel.

Preview:
image

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 email with some links
  3. Send the email to contacts and generate some clicks
  4. Open the email view and select the Click heatmap from the dropdown next to the email controls:
    image
  5. Test that everything is displayed correctly

@codecov
Copy link

codecov bot commented Sep 5, 2023

Codecov Report

Merging #12696 (86f022b) into 5.x (c86f0ee) will increase coverage by 0.10%.
Report is 222 commits behind head on 5.x.
The diff coverage is 85.00%.

Impacted file tree graph

@@             Coverage Diff              @@
##                5.x   #12696      +/-   ##
============================================
+ Coverage     58.45%   58.56%   +0.10%     
- Complexity    33597    33607      +10     
============================================
  Files          2183     2180       -3     
  Lines        101716   101698      -18     
============================================
+ Hits          59454    59555     +101     
+ Misses        42262    42143     -119     
Files Changed Coverage Δ
.../bundles/EmailBundle/Controller/AjaxController.php 62.75% <85.00%> (+3.55%) ⬆️

... and 59 files with indirect coverage changes

@patrykgruszka patrykgruszka added T1 Low difficulty to fix (issue) or test (PR) user-interface Anything related to appearance, layout, and interactivity ready-to-test PR's that are ready to test code-review-needed PR's that require a code review before merging user-experience Anything related to related to workflows, feedback, and navigation enhancement Any improvement to an existing feature or functionality email Anything related to email javascript Pull requests that update Javascript code and removed user-interface Anything related to appearance, layout, and interactivity labels Sep 5, 2023
Copy link

@PatrickJenkner PatrickJenkner left a comment

Choose a reason for hiding this comment

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

Just tested it and everything works as described (and looks great)!
Only one small thing: If there are multiple links linking to the same URL, both of them get the same statistics.
PR12696 Screenshot
I never actually clicked on the left one. This is probably intentional, just wanted to mention it.

@PatrickJenkner PatrickJenkner added pending-test-confirmation PR's that require one test before they can be merged and removed ready-to-test PR's that are ready to test labels Sep 6, 2023
@patrykgruszka
Copy link
Member Author

@PatrickJenkner thanks for your review! Yes, at the moment Mautic doesn't track the same links in emails individually and this PR doesn't change this behaviour. I've come across this problem during my analysis and there is an option to track the same link by adding some parameters to the link.

Copy link
Sponsor Member

@escopecz escopecz left a comment

Choose a reason for hiding this comment

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

Please check if my comments make sense.

app/bundles/EmailBundle/Controller/AjaxController.php Outdated Show resolved Hide resolved
app/bundles/EmailBundle/Controller/AjaxController.php Outdated Show resolved Hide resolved
app/bundles/EmailBundle/Controller/AjaxController.php Outdated Show resolved Hide resolved
app/bundles/EmailBundle/Controller/AjaxController.php Outdated Show resolved Hide resolved
@escopecz escopecz added the pending-feedback PR's and issues that are awaiting feedback from the author label Sep 6, 2023
@patrykgruszka
Copy link
Member Author

@escopecz makes sense. I have made the changes.

@patrykgruszka patrykgruszka removed the pending-feedback PR's and issues that are awaiting feedback from the author label Sep 6, 2023
Copy link
Sponsor Member

@escopecz escopecz left a comment

Choose a reason for hiding this comment

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

Seems to be working fine and the code looks neat too.

Screenshot 2023-09-06 at 15 14 47

@escopecz 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 pending-test-confirmation PR's that require one test before they can be merged labels Sep 6, 2023
@escopecz escopecz added this to the 5.0-Release Candidate milestone Sep 6, 2023
@escopecz escopecz merged commit bfbf0a5 into mautic:5.x Sep 6, 2023
14 checks passed
@RCheesley
Copy link
Sponsor Member

@patrykgruszka or @PatrickJenkner would you be up for making a PR to https://github.com/mautic/user-documentation on the 5.x branch to add the detail about this feature?

@mautibot
Copy link

This pull request has been mentioned on Mautic Forums. There might be relevant details there:

https://forum.mautic.org/t/announcing-the-mautic-5-release-candidate/29967/1

@mautibot
Copy link

This pull request has been mentioned on Mautic Forums. There might be relevant details there:

https://forum.mautic.org/t/mautic-5-beyond-expectations-beyond-limits/30459/1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code-review-passed PRs which have passed code review email Anything related to email enhancement Any improvement to an existing feature or functionality javascript Pull requests that update Javascript code T1 Low difficulty to fix (issue) or test (PR) user-experience Anything related to related to workflows, feedback, and navigation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

5 participants