Merge branch 'snowplow-attrs-helper' into 'master'

Add snowplow haml attr helper

Closes #7827

See merge request gitlab-org/gitlab-ee!13302

app/helpers/tracking_helper.rb

+# frozen_string_literal: true
+
+module TrackingHelper
+  def tracking_attrs(label, event, property)
+    {} # CE has no tracking features
+  end
+end
+
+TrackingHelper.prepend(EE::TrackingHelper)

app/views/projects/_import_project_pane.html.haml

@@ -8,58 +8,58 @@
     .import-buttons
       - if gitlab_project_import_enabled?
         .import_gitlab_project.has-tooltip{ data: { container: 'body' } }
-          = link_to new_import_gitlab_project_path, class: 'btn btn_import_gitlab_project project-submit', data: { track_label: "#{track_label}", track_event: "click_button", track_property: "gitlab_export" } do
+          = link_to new_import_gitlab_project_path, class: 'btn btn_import_gitlab_project project-submit', **tracking_attrs(track_label, 'click_button', 'gitlab_export') do
             = icon('gitlab', text: 'GitLab export')
 
       - if github_import_enabled?
         %div
-          = link_to new_import_github_path, class: 'btn js-import-github', data: { track_label: "#{track_label}", track_event: "click_button", track_property: "github" } do
+          = link_to new_import_github_path, class: 'btn js-import-github', **tracking_attrs(track_label, 'click_button', 'github') do
             = icon('github', text: 'GitHub')
 
       - if bitbucket_import_enabled?
         %div
           = link_to status_import_bitbucket_path, class: "btn import_bitbucket #{'how_to_import_link' unless bitbucket_import_configured?}",
-          data: { track_label: "#{track_label}", track_event: "click_button", track_property: "bitbucket_cloud" } do
+          **tracking_attrs(track_label, 'click_button', 'bitbucket_cloud') do
             = icon('bitbucket', text: 'Bitbucket Cloud')
           - unless bitbucket_import_configured?
             = render 'bitbucket_import_modal'
       - if bitbucket_server_import_enabled?
         %div
-          = link_to status_import_bitbucket_server_path, class: "btn import_bitbucket", data: { track_label: "#{track_label}", track_event: "click_button", track_property: "bitbucket_server" } do
+          = link_to status_import_bitbucket_server_path, class: "btn import_bitbucket", **tracking_attrs(track_label, 'click_button', 'bitbucket_server') do
             = icon('bitbucket-square', text: 'Bitbucket Server')
         %div
       - if gitlab_import_enabled?
         %div
           = link_to status_import_gitlab_path, class: "btn import_gitlab #{'how_to_import_link' unless gitlab_import_configured?}",
-          data: { track_label: "#{track_label}", track_event: "click_button", track_property: "gitlab_com" } do
+          **tracking_attrs(track_label, 'click_button', 'gitlab_com') do
             = icon('gitlab', text: 'GitLab.com')
           - unless gitlab_import_configured?
             = render 'gitlab_import_modal'
 
       - if google_code_import_enabled?
         %div
-          = link_to new_import_google_code_path, class: 'btn import_google_code', data: { track_label: "#{track_label}", track_event: "click_button", track_property: "google_code" } do
+          = link_to new_import_google_code_path, class: 'btn import_google_code', **tracking_attrs(track_label, 'click_button', 'google_code') do
             = icon('google', text: 'Google Code')
 
       - if fogbugz_import_enabled?
         %div
-          = link_to new_import_fogbugz_path, class: 'btn import_fogbugz', data: { track_label: "#{track_label}", track_event: "click_button", track_property: "fogbugz" } do
+          = link_to new_import_fogbugz_path, class: 'btn import_fogbugz', **tracking_attrs(track_label, 'click_button', 'fogbugz') do
             = icon('bug', text: 'Fogbugz')
 
       - if gitea_import_enabled?
         %div
-          = link_to new_import_gitea_path, class: 'btn import_gitea', data: { track_label: "#{track_label}", track_event: "click_button", track_property: "gitea" } do
+          = link_to new_import_gitea_path, class: 'btn import_gitea', **tracking_attrs(track_label, 'click_button', 'gitea') do
             = custom_icon('gitea_logo')
             Gitea
 
       - if git_import_enabled?
         %div
-          %button.btn.js-toggle-button.js-import-git-toggle-button{ type: "button", data: { toggle_open_class: 'active', track_label: "#{track_label}" , track_event: "click_button", track_property: "repo_url" } }
+          %button.btn.js-toggle-button.js-import-git-toggle-button{ type: "button", data: { toggle_open_class: 'active' }, **tracking_attrs(track_label, 'click_button', 'repo_url') }
             = icon('git', text: 'Repo by URL')
 
       - if manifest_import_enabled?
         %div
-          = link_to new_import_manifest_path, class: 'btn import_manifest', data: { track_label: "#{track_label}", track_event: "click_button", track_property: "manifest_file" } do
+          = link_to new_import_manifest_path, class: 'btn import_manifest', **tracking_attrs(track_label, 'click_button', 'manifest_file') do
             = icon('file-text-o', text: 'Manifest file')
 
       - if phabricator_import_enabled?

ee/app/helpers/ee/tracking_helper.rb

+# frozen_string_literal: true
+
+module EE
+  module TrackingHelper
+    extend ::Gitlab::Utils::Override
+
+    override :tracking_attrs
+    def tracking_attrs(label, event, property)
+      return {} unless snowplow_enabled?
+
+      {
+        data: {
+          track_label: label,
+          track_event: event,
+          track_property: property
+        }
+      }
+    end
+
+    private
+
+    def snowplow_enabled?
+      ::Gitlab::CurrentSettings.snowplow_enabled?
+    end
+  end
+end

ee/spec/helpers/ee/tracking_helper_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe EE::TrackingHelper do
+  describe '#tracking_attrs' do
+    it 'returns a hash of snowplow data attrs if snowplow is enabled' do
+      stub_application_setting(snowplow_enabled: true)
+
+      expect(helper.tracking_attrs('a', 'b', 'c')).to eq(data: { track_label: 'a', track_event: 'b', track_property: 'c' })
+    end
+
+    it 'returns an empty hash if snowplow is disabled' do
+      stub_application_setting(snowplow_enabled: false)
+
+      expect(helper.tracking_attrs('a', 'b', 'c')).to eq({})
+    end
+  end
+end

spec/helpers/tracking_helper_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe TrackingHelper do
+  describe '#tracking_attrs' do
+    it 'returns an empty hash' do
+      expect(helper.tracking_attrs('a', 'b', 'c')).to eq({})
+    end
+  end
+end