Merge pull request #181 from edx/renzo/segment-io-sequentials

Instrument sequentials with segment-io

common/static/coffee/spec/logger_spec.coffee

@@ -3,6 +3,11 @@ describe 'Logger', ->
     expect(window.log_event).toBe Logger.log
 
   describe 'log', ->
+    it 'sends an event to Segment.io, if the event is whitelisted', ->
+      spyOn(analytics, 'track')
+      Logger.log 'seq_goto', 'data'
+      expect(analytics.track).toHaveBeenCalledWith 'seq_goto', 'data'
+
     it 'send a request to log event', ->
       spyOn $, 'getWithPrefix'
       Logger.log 'example', 'data'

common/static/coffee/src/logger.coffee

 class @Logger
+  # events we want sent to Segment.io for tracking
+  SEGMENT_IO_WHITELIST = ["seq_goto", "seq_next", "seq_prev"]
+
   @log: (event_type, data) ->
+    if event_type in SEGMENT_IO_WHITELIST
+      # Segment.io event tracking
+      analytics.track event_type, data
+
     $.getWithPrefix '/event',
       event_type: event_type
       event: JSON.stringify(data)

common/templates/jasmine/jasmine_test_runner.html.erb

@@ -26,6 +26,8 @@
   <script type="text/javascript" src="<%= common_js_root %>/vendor/tiny_mce/tiny_mce.js"></script>
   <script type="text/javascript" src="<%= common_js_root %>/vendor/mathjax-MathJax-c9db6ac/MathJax.js?config=default"></script>
   <script type="text/javascript" src="<%= common_js_root %>/vendor/jquery.timeago.js"></script>
+  <script type="text/javascript" src="<%= common_js_root %>/vendor/sinon-1.7.1.js"></script>
+  <script type="text/javascript" src="<%= common_js_root %>/vendor/analytics.js"></script>
   <script type="text/javascript">
     AjaxPrefix.addAjaxPrefix(jQuery, function() {
        return "";

lms/envs/common.py

@@ -102,7 +102,7 @@ MITX_FEATURES = {
     # Staff Debug tool.
     'ENABLE_STUDENT_HISTORY_VIEW': True,
 
-    # segment.io for LMS--need to explicitly turn it on on production.
+    # segment.io for LMS--need to explicitly turn it on for production.
     'SEGMENT_IO_LMS': False,
 
     # Enables the student notes API and UI.