Merge pull request #8080 from edx/track/ga-label-shim

Add course_id as label for Google Analytics events

cms/envs/common.py

@@ -791,6 +791,9 @@ EVENT_TRACKING_BACKENDS = {
                     'OPTIONS': {
                         'whitelist': []
                     }
+                },
+                {
+                    'ENGINE': 'track.shim.GoogleAnalyticsProcessor'
                 }
             ]
         }

common/djangoapps/track/shim.py

@@ -166,3 +166,18 @@ class VideoEventProcessor(object):
                 event['page'] = page
 
         event['event'] = json.dumps(payload)
+
+
+class GoogleAnalyticsProcessor(object):
+    """Adds course_id as label, and sets nonInteraction property"""
+
+    # documentation of fields here: https://segment.com/docs/integrations/google-analytics/
+    # this should *only* be used on events destined for segment.com and eventually google analytics
+    def __call__(self, event):
+        context = event.get('context', {})
+        course_id = context.get('course_id')
+
+        if course_id is not None:
+            event['label'] = course_id
+
+        event['nonInteraction'] = 1

common/djangoapps/track/tests/test_shim.py

@@ -13,6 +13,12 @@ LEGACY_SHIM_PROCESSOR = [
     }
 ]
 
+GOOGLE_ANALYTICS_PROCESSOR = [
+    {
+        'ENGINE': 'track.shim.GoogleAnalyticsProcessor'
+    }
+]
+
 
 @override_settings(
     EVENT_TRACKING_PROCESSORS=LEGACY_SHIM_PROCESSOR,
@@ -87,3 +93,59 @@ class LegacyFieldMappingProcessorTestCase(EventTrackingTestCase):
             'session': '',
         }
         assert_events_equal(expected_event, emitted_event)
+
+
+@override_settings(
+    EVENT_TRACKING_PROCESSORS=GOOGLE_ANALYTICS_PROCESSOR,
+)
+class GoogleAnalyticsProcessorTestCase(EventTrackingTestCase):
+    """Ensure emitted events contain the fields necessary for Google Analytics."""
+
+    def test_event_fields(self):
+        """ Test that course_id is added as the label if present, and nonInteraction is set. """
+        data = {sentinel.key: sentinel.value}
+
+        context = {
+            'path': sentinel.path,
+            'user_id': sentinel.user_id,
+            'course_id': sentinel.course_id,
+            'org_id': sentinel.org_id,
+            'client_id': sentinel.client_id,
+        }
+        with self.tracker.context('test', context):
+            self.tracker.emit(sentinel.name, data)
+
+        emitted_event = self.get_event()
+
+        expected_event = {
+            'context': context,
+            'data': data,
+            'label': sentinel.course_id,
+            'name': sentinel.name,
+            'nonInteraction': 1,
+            'timestamp': FROZEN_TIME,
+        }
+        assert_events_equal(expected_event, emitted_event)
+
+    def test_no_course_id(self):
+        """ Test that a label is not added if course_id is not specified, but nonInteraction is still set. """
+        data = {sentinel.key: sentinel.value}
+
+        context = {
+            'path': sentinel.path,
+            'user_id': sentinel.user_id,
+            'client_id': sentinel.client_id,
+        }
+        with self.tracker.context('test', context):
+            self.tracker.emit(sentinel.name, data)
+
+        emitted_event = self.get_event()
+
+        expected_event = {
+            'context': context,
+            'data': data,
+            'name': sentinel.name,
+            'nonInteraction': 1,
+            'timestamp': FROZEN_TIME,
+        }
+        assert_events_equal(expected_event, emitted_event)

lms/envs/common.py

@@ -632,6 +632,9 @@ EVENT_TRACKING_BACKENDS = {
                     'OPTIONS': {
                         'whitelist': []
                     }
+                },
+                {
+                    'ENGINE': 'track.shim.GoogleAnalyticsProcessor'
                 }
             ]
         }