Merge branch 'master' into HEAD

common/static/coffee/spec/logger_spec.coffee

@@ -3,15 +3,20 @@ describe 'Logger', ->
     expect(window.log_event).toBe Logger.log
 
   describe 'log', ->
-    it 'sends an event to Segment.io, if the event is whitelisted', ->
+    it 'sends an event to Segment.io, if the event is whitelisted and the data is not a dictionary', ->
       spyOn(analytics, 'track')
       Logger.log 'seq_goto', 'data'
-      expect(analytics.track).toHaveBeenCalledWith 'seq_goto', 'data'
+      expect(analytics.track).toHaveBeenCalledWith 'seq_goto', value: 'data'
+
+    it 'sends an event to Segment.io, if the event is whitelisted and the data is a dictionary', ->
+      spyOn(analytics, 'track')
+      Logger.log 'seq_goto', value: 'data'
+      expect(analytics.track).toHaveBeenCalledWith 'seq_goto', value: 'data'
 
     it 'send a request to log event', ->
-      spyOn $, 'getWithPrefix'
+      spyOn $, 'postWithPrefix'
       Logger.log 'example', 'data'
-      expect($.getWithPrefix).toHaveBeenCalledWith '/event',
+      expect($.postWithPrefix).toHaveBeenCalledWith '/event',
         event_type: 'example'
         event: '"data"'
         page: window.location.href

common/static/coffee/src/logger.coffee

@@ -1,17 +1,49 @@
 class @Logger
+
   # events we want sent to Segment.io for tracking
-  SEGMENT_IO_WHITELIST = ["seq_goto", "seq_next", "seq_prev"]
+  SEGMENT_IO_WHITELIST = ["seq_goto", "seq_next", "seq_prev", "problem_check", "problem_reset", "problem_show", "problem_save"]
 
-  @log: (event_type, data) ->
+  # listeners[event_type][element] -> list of callbacks
+  listeners = {}
+  @log: (event_type, data, element = null) ->
+    # Segment.io event tracking
     if event_type in SEGMENT_IO_WHITELIST
-      # Segment.io event tracking
-      analytics.track event_type, data
+      # to avoid changing the format of data sent to our servers, we only massage it here
+      if typeof data isnt 'object' or data is null
+        analytics.track event_type, value: data
+      else
+        analytics.track event_type, data
 
-    $.getWithPrefix '/event',
+    # Check to see if we're listening for the event type.
+    if event_type of listeners
+      # Cool.  Do the elements also match?
+      # null element in the listener dictionary means any element will do.
+      # null element in the @log call means we don't know the element name.
+      if null of listeners[event_type]
+        # Make the callbacks.
+        for callback in listeners[event_type][null]
+          callback(event_type, data, element)
+      else if element of listeners[event_type]
+        for callback in listeners[event_type][element]
+          callback(event_type, data, element)
+
+    # Regardless of whether any callbacks were made, log this event.
+    $.postWithPrefix '/event',
       event_type: event_type
       event: JSON.stringify(data)
       page: window.location.href
 
+  @listen: (event_type, element, callback) ->
+    # Add a listener.  If you want any element to trigger this listener,
+    # do element = null
+    if event_type not of listeners
+      listeners[event_type] = {}
+    if element not of listeners[event_type]
+      listeners[event_type][element] = [callback]
+    else
+      listeners[event_type][element].push callback
+
+
   @bind: ->
     window.onunload = ->
       $.ajaxWithPrefix