1 files changed, 85 insertions, 134 deletions

diff --git a/spec/lib/gitlab/error_tracking_spec.rb b/spec/lib/gitlab/error_tracking_spec.rb
index 764478ad1d7..a905b9f8d40 100644
--- a/spec/lib/gitlab/error_tracking_spec.rb
+++ b/spec/lib/gitlab/error_tracking_spec.rb
@@ -8,116 +8,55 @@ RSpec.describe Gitlab::ErrorTracking do
   let(:exception) { RuntimeError.new('boom') }
   let(:issue_url) { 'http://gitlab.com/gitlab-org/gitlab-foss/issues/1' }
 
-  let(:expected_payload_includes) do
-    [
-      { 'exception.class' => 'RuntimeError' },
-      { 'exception.message' => 'boom' },
-      { 'tags.correlation_id' => 'cid' },
-      { 'extra.some_other_info' => 'info' },
-      { 'extra.issue_url' => 'http://gitlab.com/gitlab-org/gitlab-foss/issues/1' }
-    ]
+  let(:user) { create(:user) }
+
+  let(:sentry_payload) do
+    {
+      tags: {
+        program: 'test',
+        locale: 'en',
+        feature_category: 'feature_a',
+        correlation_id: 'cid'
+      },
+      user: {
+        username: user.username
+      },
+      extra: {
+        some_other_info: 'info',
+        issue_url: 'http://gitlab.com/gitlab-org/gitlab-foss/issues/1'
+      }
+    }
   end
 
-  let(:sentry_event) { Gitlab::Json.parse(Raven.client.transport.events.last[1]) }
+  let(:logger_payload) do
+    {
+      'exception.class' => 'RuntimeError',
+      'exception.message' => 'boom',
+      'tags.program' => 'test',
+      'tags.locale' => 'en',
+      'tags.feature_category' => 'feature_a',
+      'tags.correlation_id' => 'cid',
+      'user.username' => user.username,
+      'extra.some_other_info' => 'info',
+      'extra.issue_url' => 'http://gitlab.com/gitlab-org/gitlab-foss/issues/1'
+    }
+  end
 
   before do
     stub_sentry_settings
 
     allow(described_class).to receive(:sentry_dsn).and_return(Gitlab.config.sentry.dsn)
     allow(Labkit::Correlation::CorrelationId).to receive(:current_id).and_return('cid')
+    allow(I18n).to receive(:locale).and_return('en')
 
     described_class.configure do |config|
       config.encoding = 'json'
     end
   end
 
-  describe '.configure' do
-    context 'default tags from GITLAB_SENTRY_EXTRA_TAGS' do
-      context 'when the value is a JSON hash' do
-        it 'includes those tags in all events' do
-          stub_env('GITLAB_SENTRY_EXTRA_TAGS', { foo: 'bar', baz: 'quux' }.to_json)
-
-          described_class.configure do |config|
-            config.encoding = 'json'
-          end
-
-          described_class.track_exception(StandardError.new)
-
-          expect(sentry_event['tags'].except('correlation_id', 'locale', 'program'))
-            .to eq('foo' => 'bar', 'baz' => 'quux')
-        end
-      end
-
-      context 'when the value is not set' do
-        before do
-          stub_env('GITLAB_SENTRY_EXTRA_TAGS', nil)
-        end
-
-        it 'does not log an error' do
-          expect(Gitlab::AppLogger).not_to receive(:debug)
-
-          described_class.configure do |config|
-            config.encoding = 'json'
-          end
-        end
-
-        it 'does not send any extra tags' do
-          described_class.configure do |config|
-            config.encoding = 'json'
-          end
-
-          described_class.track_exception(StandardError.new)
-
-          expect(sentry_event['tags'].keys).to contain_exactly('correlation_id', 'locale', 'program')
-        end
-      end
-
-      context 'when the value is not a JSON hash' do
-        using RSpec::Parameterized::TableSyntax
-
-        where(:env_var, :error) do
-          { foo: 'bar', baz: 'quux' }.inspect | 'JSON::ParserError'
-          [].to_json | 'NoMethodError'
-          [%w[foo bar]].to_json | 'NoMethodError'
-          %w[foo bar].to_json | 'NoMethodError'
-          '"string"' | 'NoMethodError'
-        end
-
-        with_them do
-          before do
-            stub_env('GITLAB_SENTRY_EXTRA_TAGS', env_var)
-          end
-
-          it 'does not include any extra tags' do
-            described_class.configure do |config|
-              config.encoding = 'json'
-            end
-
-            described_class.track_exception(StandardError.new)
-
-            expect(sentry_event['tags'].except('correlation_id', 'locale', 'program'))
-              .to be_empty
-          end
-
-          it 'logs the error class' do
-            expect(Gitlab::AppLogger).to receive(:debug).with(a_string_matching(error))
-
-            described_class.configure do |config|
-              config.encoding = 'json'
-            end
-          end
-        end
-      end
-    end
-  end
-
-  describe '.with_context' do
-    it 'adds the expected tags' do
-      described_class.with_context {}
-
-      expect(Raven.tags_context[:locale].to_s).to eq(I18n.locale.to_s)
-      expect(Raven.tags_context[Labkit::Correlation::CorrelationId::LOG_KEY.to_sym].to_s)
-        .to eq('cid')
+  around do |example|
+    Gitlab::ApplicationContext.with_context(user: user, feature_category: 'feature_a') do
+      example.run
     end
   end
 
@@ -128,10 +67,15 @@ RSpec.describe Gitlab::ErrorTracking do
       end
 
       it 'raises the exception' do
-        expect(Raven).to receive(:capture_exception)
-
-        expect { described_class.track_and_raise_for_dev_exception(exception) }
-          .to raise_error(RuntimeError)
+        expect(Raven).to receive(:capture_exception).with(exception, sentry_payload)
+
+        expect do
+          described_class.track_and_raise_for_dev_exception(
+            exception,
+            issue_url: issue_url,
+            some_other_info: 'info'
+          )
+        end.to raise_error(RuntimeError, /boom/)
       end
     end
 
@@ -141,19 +85,7 @@ RSpec.describe Gitlab::ErrorTracking do
       end
 
       it 'logs the exception with all attributes passed' do
-        expected_extras = {
-          some_other_info: 'info',
-          issue_url: 'http://gitlab.com/gitlab-org/gitlab-foss/issues/1'
-        }
-
-        expected_tags = {
-          correlation_id: 'cid'
-        }
-
-        expect(Raven).to receive(:capture_exception)
-                           .with(exception,
-                            tags: a_hash_including(expected_tags),
-                            extra: a_hash_including(expected_extras))
+        expect(Raven).to receive(:capture_exception).with(exception, sentry_payload)
 
         described_class.track_and_raise_for_dev_exception(
           exception,
@@ -163,8 +95,7 @@ RSpec.describe Gitlab::ErrorTracking do
       end
 
       it 'calls Gitlab::ErrorTracking::Logger.error with formatted payload' do
-        expect(Gitlab::ErrorTracking::Logger).to receive(:error)
-          .with(a_hash_including(*expected_payload_includes))
+        expect(Gitlab::ErrorTracking::Logger).to receive(:error).with(logger_payload)
 
         described_class.track_and_raise_for_dev_exception(
           exception,
@@ -177,15 +108,19 @@ RSpec.describe Gitlab::ErrorTracking do
 
   describe '.track_and_raise_exception' do
     it 'always raises the exception' do
-      expect(Raven).to receive(:capture_exception)
+      expect(Raven).to receive(:capture_exception).with(exception, sentry_payload)
 
-      expect { described_class.track_and_raise_exception(exception) }
-        .to raise_error(RuntimeError)
+      expect do
+        described_class.track_and_raise_for_dev_exception(
+          exception,
+          issue_url: issue_url,
+          some_other_info: 'info'
+        )
+      end.to raise_error(RuntimeError, /boom/)
     end
 
     it 'calls Gitlab::ErrorTracking::Logger.error with formatted payload' do
-      expect(Gitlab::ErrorTracking::Logger).to receive(:error)
-        .with(a_hash_including(*expected_payload_includes))
+      expect(Gitlab::ErrorTracking::Logger).to receive(:error).with(logger_payload)
 
       expect do
         described_class.track_and_raise_exception(
@@ -210,17 +145,16 @@ RSpec.describe Gitlab::ErrorTracking do
     it 'calls Raven.capture_exception' do
       track_exception
 
-      expect(Raven).to have_received(:capture_exception)
-                   .with(exception,
-                         tags: a_hash_including(correlation_id: 'cid'),
-                         extra: a_hash_including(some_other_info: 'info', issue_url: issue_url))
+      expect(Raven).to have_received(:capture_exception).with(
+        exception,
+        sentry_payload
+      )
     end
 
     it 'calls Gitlab::ErrorTracking::Logger.error with formatted payload' do
       track_exception
 
-      expect(Gitlab::ErrorTracking::Logger).to have_received(:error)
-                                           .with(a_hash_including(*expected_payload_includes))
+      expect(Gitlab::ErrorTracking::Logger).to have_received(:error).with(logger_payload)
     end
 
     context 'with filterable parameters' do
@@ -229,8 +163,9 @@ RSpec.describe Gitlab::ErrorTracking do
       it 'filters parameters' do
         track_exception
 
-        expect(Gitlab::ErrorTracking::Logger).to have_received(:error)
-                                             .with(hash_including({ 'extra.test' => 1, 'extra.my_token' => '[FILTERED]' }))
+        expect(Gitlab::ErrorTracking::Logger).to have_received(:error).with(
+          hash_including({ 'extra.test' => 1, 'extra.my_token' => '[FILTERED]' })
+        )
       end
     end
 
@@ -241,8 +176,9 @@ RSpec.describe Gitlab::ErrorTracking do
       it 'includes the extra data from the exception in the tracking information' do
         track_exception
 
-        expect(Raven).to have_received(:capture_exception)
-                     .with(exception, a_hash_including(extra: a_hash_including(extra_info)))
+        expect(Raven).to have_received(:capture_exception).with(
+          exception, a_hash_including(extra: a_hash_including(extra_info))
+        )
       end
     end
 
@@ -253,8 +189,9 @@ RSpec.describe Gitlab::ErrorTracking do
       it 'just includes the other extra info' do
         track_exception
 
-        expect(Raven).to have_received(:capture_exception)
-                     .with(exception, a_hash_including(extra: a_hash_including(extra)))
+        expect(Raven).to have_received(:capture_exception).with(
+          exception, a_hash_including(extra: a_hash_including(extra))
+        )
       end
     end
 
@@ -266,7 +203,13 @@ RSpec.describe Gitlab::ErrorTracking do
           track_exception
 
           expect(Gitlab::ErrorTracking::Logger).to have_received(:error).with(
-            hash_including({ 'extra.sidekiq' => { 'class' => 'PostReceive', 'args' => ['1', '{"id"=>2, "name"=>"hello"}', 'some-value', 'another-value'] } }))
+            hash_including(
+              'extra.sidekiq' => {
+                'class' => 'PostReceive',
+                'args' => ['1', '{"id"=>2, "name"=>"hello"}', 'some-value', 'another-value']
+              }
+            )
+          )
         end
       end
 
@@ -276,9 +219,17 @@ RSpec.describe Gitlab::ErrorTracking do
         it 'filters sensitive arguments before sending' do
           track_exception
 
+          sentry_event = Gitlab::Json.parse(Raven.client.transport.events.last[1])
+
           expect(sentry_event.dig('extra', 'sidekiq', 'args')).to eq(['[FILTERED]', 1, 2])
           expect(Gitlab::ErrorTracking::Logger).to have_received(:error).with(
-            hash_including('extra.sidekiq' => { 'class' => 'UnknownWorker', 'args' => ['[FILTERED]', '1', '2'] }))
+            hash_including(
+              'extra.sidekiq' => {
+                'class' => 'UnknownWorker',
+                'args' => ['[FILTERED]', '1', '2']
+              }
+            )
+          )
         end
       end
     end