Add ApplicationSetting for Snowplow Iglu Registry

Adds snowplow_iglu_registry_url to ApplicationSettings.

The Iglu Schema Registry is used for Contextual Snowplow events.

app/helpers/application_settings_helper.rb

@@ -290,6 +290,7 @@ module ApplicationSettingsHelper
       :snowplow_cookie_domain,
       :snowplow_enabled,
       :snowplow_site_id,
+      :snowplow_iglu_registry_url,
       :push_event_hooks_limit,
       :push_event_activities_limit,
       :custom_http_clone_url_root,

app/models/application_setting.rb

@@ -104,6 +104,11 @@ class ApplicationSetting < ApplicationRecord
             hostname: true,
             if: :snowplow_enabled
 
+  validates :snowplow_iglu_registry_url,
+            addressable_url: true,
+            allow_blank: true,
+            if: :snowplow_enabled
+
   validates :pendo_url,
             presence: true,
             public_url: true,

app/models/application_setting_implementation.rb

@@ -129,6 +129,7 @@ module ApplicationSettingImplementation
         snowplow_cookie_domain: nil,
         snowplow_enabled: false,
         snowplow_site_id: nil,
+        snowplow_iglu_registry_url: nil,
         custom_http_clone_url_root: nil,
         pendo_enabled: false,
         pendo_url: nil

app/views/admin/application_settings/_snowplow.html.haml

@@ -26,5 +26,8 @@
         .form-group
           = f.label :snowplow_cookie_domain, _('Cookie domain'), class: 'label-light'
           = f.text_field :snowplow_cookie_domain, class: 'form-control'
+        .form-group
+          = f.label :snowplow_iglu_registry_url, _('Iglu registry URL (optional)'), class: 'label-light'
+          = f.text_field :snowplow_iglu_registry_url, class: 'form-control'
 
       = f.submit _('Save changes'), class: 'btn btn-success'

changelogs/unreleased/add-snowplow-iglu-registry-application-setting.yml

+---
+title: Add ApplicationSetting for snowplow_iglu_registry_url
+merge_request: 18449
+author:
+type: added

db/migrate/20191010174846_add_snowplow_iglu_registry_url_to_application_settings.rb

+# frozen_string_literal: true
+
+class AddSnowplowIgluRegistryUrlToApplicationSettings < ActiveRecord::Migration[5.2]
+  DOWNTIME = false
+
+  def change
+    add_column :application_settings, :snowplow_iglu_registry_url, :string, limit: 255
+  end
+end

db/schema.rb

@@ -338,6 +338,7 @@ ActiveRecord::Schema.define(version: 2019_10_26_124116) do
     t.boolean "throttle_incident_management_notification_enabled", default: false, null: false
     t.integer "throttle_incident_management_notification_period_in_seconds", default: 3600
     t.integer "throttle_incident_management_notification_per_period", default: 3600
+    t.string "snowplow_iglu_registry_url", limit: 255
     t.integer "push_event_hooks_limit", default: 3, null: false
     t.integer "push_event_activities_limit", default: 3, null: false
     t.string "custom_http_clone_url_root", limit: 511

doc/api/settings.md

@@ -316,6 +316,7 @@ are listed in the descriptions of the relevant settings.
 | `snowplow_cookie_domain`                 | string           | no                                   | The Snowplow cookie domain. (e.g. `.gitlab.com`) |
 | `snowplow_enabled`                       | boolean          | no                                   | Enable snowplow tracking. |
 | `snowplow_site_id`                       | string           | no                                   | The Snowplow site name / application id. (e.g. `gitlab`) |
+| `snowplow_iglu_registry_url`             | string           | no                                   | The Snowplow base Iglu Schema Registry URL to use for custom context and self describing events'|
 | `pendo_url`                              | string           | required by: `pendo_enabled`         | The Pendo endpoint url with js snippet. (e.g. `https://cdn.pendo.io/agent/static/your-api-key/pendo.js`) |
 | `pendo_enabled`                          | boolean          | no                                   | Enable pendo tracking. |
 | `terminal_max_session_time`              | integer          | no                                   | Maximum time for web terminal websocket connection (in seconds). Set to `0` for unlimited time. |

lib/api/settings.rb

@@ -135,6 +135,7 @@ module API
       optional :local_markdown_version, type: Integer, desc: 'Local markdown version, increase this value when any cached markdown should be invalidated'
       optional :allow_local_requests_from_hooks_and_services, type: Boolean, desc: 'Deprecated: Use :allow_local_requests_from_web_hooks_and_services instead. Allow requests to the local network from hooks and services.' # support legacy names, can be removed in v5
       optional :snowplow_enabled, type: Grape::API::Boolean, desc: 'Enable Snowplow tracking'
+      optional :snowplow_iglu_registry_url, type: String, desc: 'The Snowplow base Iglu Schema Registry URL to use for custom context and self describing events'
       given snowplow_enabled: ->(val) { val } do
         requires :snowplow_collector_hostname, type: String, desc: 'The Snowplow collector hostname'
         optional :snowplow_cookie_domain, type: String, desc: 'The Snowplow cookie domain'

lib/gitlab/tracking.rb

@@ -47,7 +47,8 @@ module Gitlab
           cookie_domain: Gitlab::CurrentSettings.snowplow_cookie_domain,
           app_id: Gitlab::CurrentSettings.snowplow_site_id,
           form_tracking: additional_features,
-          link_click_tracking: additional_features
+          link_click_tracking: additional_features,
+          iglu_registry_url: Gitlab::CurrentSettings.snowplow_iglu_registry_url
         }.transform_keys! { |key| key.to_s.camelize(:lower).to_sym }
       end
 

locale/gitlab.pot

@@ -8848,6 +8848,9 @@ msgstr ""
 msgid "If your HTTP repository is not publicly accessible, add your credentials."
 msgstr ""
 
+msgid "Iglu registry URL (optional)"
+msgstr ""
+
 msgid "ImageDiffViewer|2-up"
 msgstr ""
 

spec/lib/gitlab/tracking_spec.rb

@@ -9,6 +9,7 @@ describe Gitlab::Tracking do
     stub_application_setting(snowplow_collector_hostname: 'gitfoo.com')
     stub_application_setting(snowplow_cookie_domain: '.gitfoo.com')
     stub_application_setting(snowplow_site_id: '_abc123_')
+    stub_application_setting(snowplow_iglu_registry_url: 'https://example.org')
   end
 
   describe '.snowplow_options' do
@@ -19,7 +20,8 @@ describe Gitlab::Tracking do
         cookieDomain: '.gitfoo.com',
         appId: '_abc123_',
         formTracking: true,
-        linkClickTracking: true
+        linkClickTracking: true,
+        igluRegistryUrl: 'https://example.org'
       }
 
       expect(subject.snowplow_options(nil)).to match(expected_fields)

spec/models/application_setting_spec.rb

@@ -72,10 +72,14 @@ describe ApplicationSetting do
       it { is_expected.not_to allow_value(nil).for(:snowplow_collector_hostname) }
       it { is_expected.to allow_value("snowplow.gitlab.com").for(:snowplow_collector_hostname) }
       it { is_expected.not_to allow_value('/example').for(:snowplow_collector_hostname) }
+      it { is_expected.to allow_value('https://example.org').for(:snowplow_iglu_registry_url) }
+      it { is_expected.not_to allow_value('not-a-url').for(:snowplow_iglu_registry_url) }
+      it { is_expected.to allow_value(nil).for(:snowplow_iglu_registry_url) }
     end
 
     context 'when snowplow is not enabled' do
       it { is_expected.to allow_value(nil).for(:snowplow_collector_hostname) }
+      it { is_expected.to allow_value(nil).for(:snowplow_iglu_registry_url) }
     end
 
     context 'when pendo is enabled' do

spec/requests/api/settings_spec.rb

@@ -178,7 +178,8 @@ describe API::Settings, 'Settings' do
           snowplow_collector_hostname: "snowplow.example.com",
           snowplow_cookie_domain: ".example.com",
           snowplow_enabled: true,
-          snowplow_site_id: "site_id"
+          snowplow_site_id: "site_id",
+          snowplow_iglu_registry_url: 'https://example.com'
         }
       end