summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGiorgenes Gelatti <ggelatti@gitlab.com>2019-09-12 11:18:12 +1000
committerGiorgenes Gelatti <ggelatti@gitlab.com>2019-09-12 11:18:12 +1000
commita74d936ac0155910ff27f4544a5d0d9dada028d2 (patch)
treeab54b549eae85f5f5da1f027a8544a061a6df56d
parent3c372d87a701b600f42fccbf4707eebd67ff7cac (diff)
downloadgitlab-ce-67307-adds-event-tracker-helper.tar.gz
Adds event tracker helper for controllers67307-adds-event-tracker-helper
-rw-r--r--app/controllers/application_controller.rb5
-rw-r--r--spec/controllers/application_controller_spec.rb34
2 files changed, 39 insertions, 0 deletions
diff --git a/app/controllers/application_controller.rb b/app/controllers/application_controller.rb
index 2f7ac41781a..76d02632f01 100644
--- a/app/controllers/application_controller.rb
+++ b/app/controllers/application_controller.rb
@@ -125,6 +125,11 @@ class ApplicationController < ActionController::Base
protected
+ def track_event(action = action_name, **args)
+ category = args.delete(:category) || self.class.name
+ Gitlab::Tracking.event(category, action.to_s, **args)
+ end
+
def workhorse_excluded_content_types
@workhorse_excluded_content_types ||= %w(text/html application/json)
end
diff --git a/spec/controllers/application_controller_spec.rb b/spec/controllers/application_controller_spec.rb
index 0b3833e6515..b2fdadb282b 100644
--- a/spec/controllers/application_controller_spec.rb
+++ b/spec/controllers/application_controller_spec.rb
@@ -57,6 +57,40 @@ describe ApplicationController do
end
end
+ describe '#track_event' do
+ before do
+ sign_in user
+ end
+
+ context 'with no params' do
+ controller(described_class) do
+ def index
+ track_event
+ head :ok
+ end
+ end
+
+ it 'tracks the action name' do
+ expect(Gitlab::Tracking).to receive(:event).with('AnonymousController', 'index', {})
+ get :index
+ end
+ end
+
+ context 'with params' do
+ controller(described_class) do
+ def index
+ track_event('some_event', category: 'SomeCategory', label: 'errorlabel')
+ head :ok
+ end
+ end
+
+ it 'tracks with the specified param' do
+ expect(Gitlab::Tracking).to receive(:event).with('SomeCategory', 'some_event', label: 'errorlabel')
+ get :index
+ end
+ end
+ end
+
describe '#add_gon_variables' do
before do
Gon.clear