Skip to content

Add handful of events to the Segment.io whitelist #263

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rlucioni merged 4 commits into from
Jun 26, 2013
Merged

Add handful of events to the Segment.io whitelist #263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bcbce3e
Add handful of events to the Segment.io whitelist
rlucioni Jun 24, 2013
84f4361
Avoid changing format of data sent to our logs, and prevent problem_c…
rlucioni Jun 25, 2013
881d63d
Fixed Jasmine tests in light of Logger changes, and wrote test to cov…
rlucioni Jun 25, 2013
3f49da3
Swap Logger call from check_fd to check
rlucioni Jun 25, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion common/lib/xmodule/xmodule/js/src/capa/display.coffee
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,8 @@ class @Problem
# maybe preferable to consolidate all dispatches to use FormData
###
check_fd: =>
Logger.log 'problem_check', @answers
# Calling check from check_fd will result in firing the 'problem_check' event twice, since it is also called in the check function.
#Logger.log 'problem_check', @answers

# If there are no file inputs in the problem, we can fall back on @check
if $('input:file').length == 0
Expand Down
9 changes: 7 additions & 2 deletions common/static/coffee/spec/logger_spec.coffee
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,15 @@ 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'
Expand Down
10 changes: 7 additions & 3 deletions common/static/coffee/src/logger.coffee
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
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) ->
# 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',
event_type: event_type
Expand Down