[ENG-44] Add google analytics tracking for when hypothesis side panel is opened #355

adlius · 2019-03-21T17:34:56Z

Ticket

https://openscience.atlassian.net/browse/ENG-44

Purpose

To add GA tracking to MFR to track when users click open the Hypothesis panel.

Changes

In mfr/extensions/pdf/templates/viewer.mako, we add GA tracking imports.
In mfr/server/static/js/mfr.child.hypothesis.js, we set window.hypothesisConfig to use the onLayoutChange() callback provided by hypothesis to watch for opening of annotation panel.
Add GA tracking ID to settings and use that in renderer.

Side effects

None

QA Notes

To test this, you'll need access to Google Analytics panel for staging server.
Check to make sure the event is only tracked when users open the panel for the first time on that page. Page refresh counts as a new page. User is counted by browser, not OSF User. So if the same OSFUser opens two browser and opens the panel in both, it counts as two events.

Deployment Notes

Add GOOGLE_ANALYTICS_TRACKING_ID for to staging/prod settings.

coveralls · 2019-03-21T18:06:41Z

Coverage increased (+0.03%) to 71.145% when pulling 3df7593 on adlius:feature/google-analytics into 1c9b11d on CenterForOpenScience:develop.

coveralls · 2019-03-21T18:06:41Z

Coverage increased (+0.03%) to 71.145% when pulling a539d45 on adlius:feature/google-analytics into 1c9b11d on CenterForOpenScience:develop.

cslzchen

LGTM, just one minor style suggestion and two general questions @adlius Thanks!

Pass this PR on to @felliott for final review (I haven't tested the code locally.)

mfr/extensions/pdf/render.py

cslzchen · 2019-03-27T14:00:56Z

mfr/server/static/js/mfr.child.hypothesis.js


+            var sidePanelOpened = false;
+            var sendAnalyticsIfExpanded = function (expanded) { 
+                if (expanded && !sidePanelOpened) {


Probably a dumb question about hypothesis configuration. What is expanded (or layout.expanded a few lines below more specifically)?

layout.expanded denotes whether the hypothesis side panel is expanded when onLayoutChanged() is called.

cslzchen · 2019-03-27T14:03:14Z

mfr/settings.py



 SENTRY_DSN = config.get_nullable('SENTRY_DSN', None)
+GOOGLE_ANALYTICS_TRACKING_ID = config.get_nullable('GOOGLE_ANALYTICS_TRACKING_ID', None)


Can GA script handle None tracking ID? I guess so but just want to double check with you.

I am not sure. It'll probably throw an error.

@cslzchen Confirmed that it would not cause an error when tracking ID is None.

cslzchen

LG and RTM

felliott · 2019-03-28T00:40:42Z

mfr/server/static/js/mfr.child.hypothesis.js

+                    ga('send', 'event', {
+                        eventCategory: 'Hypothesis',
+                        eventAction: 'Open Hypothesis Panel',
+                        eventLabel: window.DEFAULT_URL.split('/')[5],


What is this value? Could you add a comment saying what this is expected to be?

eventLabel should be the preprint guid.

A follow-up question, is it guaranteed that the GUID is always at index 5? Can we add some extra check before ga to parse window.DEFAULT_URL.split('/')[5] and handle unexpected URL format. In addition, having a comment on what the expected URL looks like will be very helpful as well.

There is no guarantee that window.DEFAULT_URL.split('/')[5] always return the preprint guid. However, if the rendered file is a preprint's primary file, window.DEFAULT_URL should be the WB link to the file on OSFStorage (e.g. https://files.us.staging2.osf.io/v1/resources/twq6d/providers/osfstorage/5c9cd1e3c8f5970017ed07d3?direct=&mode=render), and from which we can extract the guid of the preprint.
And since hypothesis is only enabled on a preprint's primary file, it should be fine.
I'll add some checks for unexpected URL and log to sentry when that happens.

Sounds good! Thanks for the explanation. This WB API rarely changes. If it ever changed, we would be informed right away.

@cslzchen PR updated.

adlius · 2019-03-28T13:33:27Z

@felliott Comment is added.

More specifically, this GA event tracks when users click open the Hypothesis side panel for each preprints.

The preprints GUID used by the GA tracking event is retreived from window.DEFAULT_URL, which is the third segment of the URL path.

cslzchen · 2019-03-29T12:27:33Z

mfr/server/static/js/mfr.child.hypothesis.js

+            var sidePanelOpened = false;
+            // window.DEFAULT_URL should be the wb link in this format:
+            // https://<wb-domain>/v1/resources/<preprint-guid>/providers/osfstorage/<file-id>?direct=&mode=render
+            // TODO: parse and validate the WB URL before retrieving the preprints GUID


I added a TODO comment to your code. Although the split you use here is unaware of the HTTP protocol, URL domain and path, I think for now it is good enough. A better way (probably a future improvement) is to fully parse and validate the URL.

[ENG-44] Closes: #355

cslzchen approved these changes Mar 27, 2019

View reviewed changes

cslzchen added the Ready To Merge label Mar 27, 2019

felliott reviewed Mar 28, 2019

View reviewed changes

adlius force-pushed the feature/google-analytics branch from 56fb047 to f72d3fa Compare March 28, 2019 15:49

Added google analytics tracking for MFR Hypothesis

06518bc

More specifically, this GA event tracks when users click open the Hypothesis side panel for each preprints.

cslzchen force-pushed the feature/google-analytics branch from f72d3fa to 111430d Compare March 29, 2019 12:02

Added a check with comments on obtaining and using preprints GUID

3df7593

The preprints GUID used by the GA tracking event is retreived from window.DEFAULT_URL, which is the third segment of the URL path.

cslzchen force-pushed the feature/google-analytics branch from 111430d to 3df7593 Compare March 29, 2019 12:17

cslzchen reviewed Mar 29, 2019

View reviewed changes

cslzchen merged commit 3df7593 into CenterForOpenScience:develop Mar 29, 2019

cslzchen added a commit that referenced this pull request Mar 29, 2019

Merge branch 'feature/google-analytics' into develop

b1fef7f

[ENG-44] Closes: #355

cslzchen removed the Ready To Merge label Mar 29, 2019



		SENTRY_DSN = config.get_nullable('SENTRY_DSN', None)
		GOOGLE_ANALYTICS_TRACKING_ID = config.get_nullable('GOOGLE_ANALYTICS_TRACKING_ID', None)

[ENG-44] Add google analytics tracking for when hypothesis side panel is opened #355

[ENG-44] Add google analytics tracking for when hypothesis side panel is opened #355

Uh oh!

Conversation

adlius commented Mar 21, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Ticket

Purpose

Changes

Side effects

QA Notes

Deployment Notes

Uh oh!

coveralls commented Mar 21, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coveralls commented Mar 21, 2019

Uh oh!

cslzchen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cslzchen left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adlius commented Mar 28, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

adlius commented Mar 21, 2019 •

edited

Loading

coveralls commented Mar 21, 2019 •

edited

Loading