Send tracking code JS by email #14569

katebutler · 2019-06-24T21:53:55Z

Have implemented this for the "no data tracked yet" page and page 7 of the installation process. Now trying to figure out an elegant solution for the tracking codes page in the admin panel - the JS is generated dynamically on the client-side here so would need to update the mailto body dynamically too, also seems like some of the other content from the email would be unneeded in this case.

Fixes #12630

…and no data tracked yet page

tsteur · 2019-06-25T06:17:48Z

plugins/SitesManager/templates/_displayJavascriptCode.twig

-    {{ postEvent('Template.endTrackingHelpPage') }}
+    {% set emailSubject = 'Matomo' ~ 'General_JsTrackingTag'|translate %}
+    <a class="btn"
+       href="mailto:?subject={{ emailSubject|url_encode }}&body={{ emailBody|replace({">\n<": "><"})|url_encode }}">


haven't really looked at the PR yet. Would it be possible to not use this replace here and instead directly remove the HTML in _trackingCodeEmail.twig?

It's stripping out the newlines between tags - I could minify the template instead but I think that would make it very hard to read.

What I meant is it's not possible to add HTML tags in a mailto link anyway? And the line breaks can be taken over from the twig template?

katebutler · 2019-06-25T21:54:47Z

I've written a spec for the no data page (which provide coverage for the template) - but none for the tracking code generator yet. This seems to have pretty minimal coverage (just one spec in UIIntegration to check that the page loads) so maybe I should add some more while I'm here?

katebutler · 2019-06-27T22:02:07Z

Works in Thunderbird but some email clients (e.g. Outlook, Apple Mail) print the actual HTML tags in the message body rather than rendering it. This answer suggests a solution that works for Outlook but will still not work intuitively in Apple. The RFC says that the body is intended to be plaintext only, so I don't think it is actually possible to use a mailto link to generate an email that will render as HTML in all clients.
Instead I think we are going to need a much simpler email (just the actual JavaScript and maybe one link to the tracker code generator). The <script type="text/javascript"> will need to be removed off the JS block due to the inconsistency between clients - if they are escaped then Apple Mail prints the escaped version, but if they aren't then Thunderbird renders it like an actual <script> tag so that it doesn't appear in the message body.

tsteur · 2019-06-28T04:36:29Z

Would it help to put a "

" around it? We would then need to say something like "Without the " though... but at least we could have maybe the full tag in there?

tsteur · 2019-07-16T23:15:41Z

@katebutler is this still WIP or can it be reviewed?

katebutler · 2019-07-22T21:52:26Z

Have rewritten the email templates in plain text.

tsteur

Left a few comments @katebutler

Wondering in general how we can make this button more visible? Maybe would somehow need to show it next the the headline on the right?

Eg

vs

and here maybe have the button next to the headline and in the bottom?

and here we show it only in the top?

Not sure how easy it is to show this button next to the title.

tsteur · 2019-07-29T03:49:59Z

core/Tracker/TrackerCodeGenerator.php

+    {
+        // Strip off open and close <script> tag and comments so that JS will be displayed in ALL mail clients
+        $rawJsTag = html_entity_decode($jsTrackingCode);
+        $rawJsTag = preg_replace('/<[^>]+>/', '', $rawJsTag);


@katebutler any reason to not directly use strip_tags?

ping @katebutler also maybe it's not needed anymore so much? I reckon the problem with strip tags is that it removes the content itself?

tsteur · 2019-07-29T03:52:47Z

plugins/SitesManager/templates/siteWithoutData.twig

@@ -89,6 +89,11 @@
            <a href="{{ linkTo({module: 'SitesManager', action: 'ignoreNoDataMessage'}) }}"
               class="btn ignoreSitesWithoutData">{{ 'SitesManager_SiteWithoutDataIgnoreMessage'|translate }}</a>

+            <a class="btn" id="emailTrackingCodeBtn"
+               href="mailto:?subject={{ 'SitesManager_EmailInstructionsSubject'|translate|url_encode|e('html_attr') }}&body={{ emailBody|replace({">\n<": "><"})|url_encode|e('html_attr') }}">


Is the replace still needed now?

Is the replace still needed?

tsteur · 2019-07-29T03:53:55Z

plugins/SitesManager/templates/_displayJavascriptCode.twig

@@ -31,6 +31,10 @@
    <p>{{ 'CoreAdminHome_HttpTrackingApiDescription'|translate('<a href="https://developer.matomo.org/api-reference/tracking-api" rel="noreferrer noopener" target="_blank">','</a>')|raw }}</p>
    <p></p>

-    {{ postEvent('Template.endTrackingHelpPage') }}
+    <a class="btn"


not sure why but there seems to be a dot and a space missing as part of the first sentence:

@katebutler not sure if you checked out?

tsteur · 2019-07-29T04:07:31Z

plugins/SitesManager/templates/siteWithoutData.twig

@@ -89,6 +89,11 @@
            <a href="{{ linkTo({module: 'SitesManager', action: 'ignoreNoDataMessage'}) }}"
               class="btn ignoreSitesWithoutData">{{ 'SitesManager_SiteWithoutDataIgnoreMessage'|translate }}</a>

+            <a class="btn" id="emailTrackingCodeBtn"


This is what the mail looks for me here:

There seem to be some escaped HTML elements, and some closing </p> elements visible.

We should probably remove the link You can customise this tracking code at https://... because the developer might not have access to it? Could also leave it there though.

In general it be great if we could also mention the alternative tracking methods in all the different tracking code emails like:

....Here the text we already have in the mail.... ------------------------------ ** Further ways of tracking *** Integrations In most websites, blogs, CMS, etc. you can use a pre-made plugin to do the technical work for you: https://matomo.org/integrate/ *** Log Analytics If the JavaScript tracking method isn’t feasible, you can use server log analytics as an alternative method for tracking your website’s users. https://matomo.org/log-analytics/ *** Mobile apps and SDKs Not tracking a website? You can alternatively track a mobile app or any other type of application using one of the available SDKs. https://matomo.org/integrate/#programming-language-platforms-and-frameworks *** HTTP Tracking API The HTTP Tracking API allows you to track anything. This may be useful if you are using a programming language for which no SDK exists yet. It may also be useful when you want to track devices or application in a special way. https://developer.matomo.org/api-reference/tracking-api

To keep things simple let's maybe not use the Tag Manager for now since a developer would likely not have access to configure things anyway. We will instead need eventually a different email button for Tag Manager.

@katebutler WhiteLabel has a setting to remove links named removeLinksToMatomo. We will need to test what happens if this is enabled. I suppose the links wouldn't be removed in this case since it is plain HTML. At the same time you can't know in core if this setting is enabled or not. We may need an event that WhiteLabel can listen to like:

$showDifferentWaysOfTracking = true; Piwik::postEvent('SitesManager.showDifferentWaysOfTrackingInTrackingCodeMail', array(&$showDifferentWaysOfTracking)); // then only include the different ways if `$showDifferentWaysOfTracking === true`

tsteur · 2019-08-08T01:16:10Z

@katebutler not sure you had a look at this comment? #14569 (comment) just tried it and it wasn't showing any more text than before

# Conflicts: # tests/UI/expected-screenshots/EmptySite_emptySiteDashboard.png # tests/UI/expected-screenshots/OneClickUpdate_login.png

Button to email standard install instructions on installation page 7 …

f0e6e78

…and no data tracked yet page

katebutler added the Pull Request WIP Indicates the current pull request is still work in progress and not ready yet for a review. label Jun 24, 2019

katebutler added this to the 3.11.0 milestone Jun 24, 2019

tsteur reviewed Jun 25, 2019

View reviewed changes

katebutler added 2 commits June 26, 2019 09:35

Send tracking code email from the tracking code generator page

5fb961d

Merge remote-tracking branch 'origin/3.x-dev' into 12630

061377d

katebutler added 3 commits July 18, 2019 16:57

Escape HTML tags

0044a7d

Merge remote-tracking branch 'origin/3.x-dev' into 12630

e767800

Send email in plain text

9583f95

katebutler added Needs Review PRs that need a code review and removed Pull Request WIP Indicates the current pull request is still work in progress and not ready yet for a review. labels Jul 22, 2019

mattab modified the milestones: 3.11.0, 3.12.0 Jul 23, 2019

tsteur requested changes Jul 29, 2019

View reviewed changes

katebutler added 4 commits August 1, 2019 13:51

Move email button next to header

9e41cf6

Merge remote-tracking branch 'origin/3.x-dev' into 12630

0ca2ce5

Fix width of header div

22ffdcf

Update reference screenshots

4a9df6f

katebutler and others added 6 commits August 13, 2019 09:45

PR fixes

96066fa

Expand tracking code email template

b122ace

Merge remote-tracking branch 'origin/3.x-dev' into 12630

1f85260

# Conflicts: # tests/UI/expected-screenshots/EmptySite_emptySiteDashboard.png # tests/UI/expected-screenshots/OneClickUpdate_login.png

Fix double escaping of message

fff0ebd

Hide links to Matomo for whitelabel, fix missing space

dca4c09

ignore event in documentation

0650e16

katebutler and others added 8 commits August 21, 2019 10:57

Update reference screenshots

4aefa8c

Merge branch '12630' of https://github.com/matomo-org/matomo into 12630

d7e8fdc

Changes to email template

fea0d20

fix missing translation key

23c58e8

Add idsite and tracking url to email template

0963ac3

Merge branch '12630' of https://github.com/matomo-org/matomo into 12630

22e5a7f

Fix extra slash in URL

2d07ec9

Update UI test

a944765

tsteur merged commit 64bcf78 into 3.x-dev Aug 25, 2019

tsteur deleted the 12630 branch August 25, 2019 22:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Send tracking code JS by email #14569

Send tracking code JS by email #14569

katebutler commented Jun 24, 2019

tsteur Jun 25, 2019

katebutler Jun 25, 2019

tsteur Jun 26, 2019

katebutler commented Jun 25, 2019

katebutler commented Jun 27, 2019

tsteur commented Jun 28, 2019

tsteur commented Jul 16, 2019

katebutler commented Jul 22, 2019

tsteur left a comment

tsteur Jul 29, 2019

tsteur Aug 8, 2019

tsteur Jul 29, 2019

tsteur Aug 8, 2019

tsteur Jul 29, 2019

tsteur Aug 8, 2019

tsteur Jul 29, 2019

tsteur commented Aug 8, 2019

Send tracking code JS by email #14569

Send tracking code JS by email #14569

Conversation

katebutler commented Jun 24, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

katebutler commented Jun 25, 2019

katebutler commented Jun 27, 2019

tsteur commented Jun 28, 2019

tsteur commented Jul 16, 2019

katebutler commented Jul 22, 2019

tsteur left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tsteur commented Aug 8, 2019