Add latest changes from gitlab-org/gitlab@13-10-stable-eev13.10.0-rc40

3 files changed, 292 insertions, 0 deletions

diff --git a/spec/lib/gitlab/error_tracking/context_payload_generator_spec.rb b/spec/lib/gitlab/error_tracking/context_payload_generator_spec.rb
new file mode 100644
index 00000000000..0e72dd7ec5e
--- /dev/null
+++ b/spec/lib/gitlab/error_tracking/context_payload_generator_spec.rb
@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+require 'fast_spec_helper'
+require 'rspec-parameterized'
+
+RSpec.describe Gitlab::ErrorTracking::ContextPayloadGenerator do
+  subject(:generator) { described_class.new }
+
+  let(:extra) do
+    {
+      some_other_info: 'info',
+      issue_url: 'http://gitlab.com/gitlab-org/gitlab-foss/-/issues/1'
+    }
+  end
+
+  let(:exception) { StandardError.new("Dummy exception") }
+
+  before do
+    allow(Labkit::Correlation::CorrelationId).to receive(:current_id).and_return('cid')
+    allow(I18n).to receive(:locale).and_return('en')
+  end
+
+  context 'user metadata' do
+    let(:user) { create(:user) }
+
+    it 'appends user metadata to the payload' do
+      payload = {}
+
+      Gitlab::ApplicationContext.with_context(user: user) do
+        payload = generator.generate(exception, extra)
+      end
+
+      expect(payload[:user]).to eql(
+        username: user.username
+      )
+    end
+  end
+
+  context 'tags metadata' do
+    context 'when the GITLAB_SENTRY_EXTRA_TAGS env is not set' do
+      before do
+        stub_env('GITLAB_SENTRY_EXTRA_TAGS', nil)
+      end
+
+      it 'does not log into AppLogger' do
+        expect(Gitlab::AppLogger).not_to receive(:debug)
+
+        generator.generate(exception, extra)
+      end
+
+      it 'does not send any extra tags' do
+        payload = {}
+
+        Gitlab::ApplicationContext.with_context(feature_category: 'feature_a') do
+          payload = generator.generate(exception, extra)
+        end
+
+        expect(payload[:tags]).to eql(
+          correlation_id: 'cid',
+          locale: 'en',
+          program: 'test',
+          feature_category: 'feature_a'
+        )
+      end
+    end
+
+    context 'when the GITLAB_SENTRY_EXTRA_TAGS env 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)
+        payload = {}
+
+        Gitlab::ApplicationContext.with_context(feature_category: 'feature_a') do
+          payload = generator.generate(exception, extra)
+        end
+
+        expect(payload[:tags]).to eql(
+          correlation_id: 'cid',
+          locale: 'en',
+          program: 'test',
+          feature_category: 'feature_a',
+          'foo' => 'bar',
+          'baz' => 'quux'
+        )
+      end
+
+      it 'does not log into AppLogger' do
+        expect(Gitlab::AppLogger).not_to receive(:debug)
+
+        generator.generate(exception, extra)
+      end
+    end
+
+    context 'when the GITLAB_SENTRY_EXTRA_TAGS env 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 'logs into AppLogger' do
+          expect(Gitlab::AppLogger).to receive(:debug).with(a_string_matching(error))
+
+          generator.generate({})
+        end
+
+        it 'does not include any extra tags' do
+          payload = {}
+
+          Gitlab::ApplicationContext.with_context(feature_category: 'feature_a') do
+            payload = generator.generate(exception, extra)
+          end
+
+          expect(payload[:tags]).to eql(
+            correlation_id: 'cid',
+            locale: 'en',
+            program: 'test',
+            feature_category: 'feature_a'
+          )
+        end
+      end
+    end
+  end
+
+  context 'extra metadata' do
+    it 'appends extra metadata to the payload' do
+      payload = generator.generate(exception, extra)
+
+      expect(payload[:extra]).to eql(
+        some_other_info: 'info',
+        issue_url: 'http://gitlab.com/gitlab-org/gitlab-foss/-/issues/1'
+      )
+    end
+
+    it 'appends exception embedded extra metadata to the payload' do
+      allow(exception).to receive(:sentry_extra_data).and_return(
+        some_other_info: 'another_info',
+        mr_url: 'https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/1'
+      )
+
+      payload = generator.generate(exception, extra)
+
+      expect(payload[:extra]).to eql(
+        some_other_info: 'another_info',
+        issue_url: 'http://gitlab.com/gitlab-org/gitlab-foss/-/issues/1',
+        mr_url: 'https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/1'
+      )
+    end
+
+    it 'filters sensitive extra info' do
+      extra[:my_token] = '456'
+      allow(exception).to receive(:sentry_extra_data).and_return(
+        mr_url: 'https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/1',
+        another_token: '1234'
+      )
+
+      payload = generator.generate(exception, extra)
+
+      expect(payload[:extra]).to eql(
+        some_other_info: 'info',
+        issue_url: 'http://gitlab.com/gitlab-org/gitlab-foss/-/issues/1',
+        mr_url: 'https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/1',
+        my_token: '[FILTERED]',
+        another_token: '[FILTERED]'
+      )
+    end
+  end
+end
diff --git a/spec/lib/gitlab/error_tracking/log_formatter_spec.rb b/spec/lib/gitlab/error_tracking/log_formatter_spec.rb
new file mode 100644
index 00000000000..188ccd000a1
--- /dev/null
+++ b/spec/lib/gitlab/error_tracking/log_formatter_spec.rb
@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'fast_spec_helper'
+
+RSpec.describe Gitlab::ErrorTracking::LogFormatter do
+  let(:exception) { StandardError.new('boom') }
+  let(:context_payload) do
+    {
+      server: 'local-hostname-of-the-server',
+      user: {
+        ip_address: '127.0.0.1',
+        username: 'root'
+      },
+      tags: {
+        locale: 'en',
+        feature_category: 'category_a'
+      },
+      extra: {
+        some_other_info: 'other_info',
+        sidekiq: {
+          'class' => 'HelloWorker',
+          'args' => ['senstive string', 1, 2],
+          'another_field' => 'field'
+        }
+      }
+    }
+  end
+
+  before do
+    Raven.context.user[:user_flag] = 'flag'
+    Raven.context.tags[:shard] = 'catchall'
+    Raven.context.extra[:some_info] = 'info'
+
+    allow(exception).to receive(:backtrace).and_return(
+      [
+        'lib/gitlab/file_a.rb:1',
+        'lib/gitlab/file_b.rb:2'
+      ]
+    )
+  end
+
+  after do
+    ::Raven::Context.clear!
+  end
+
+  it 'appends error-related log fields and filters sensitive Sidekiq arguments' do
+    payload = described_class.new.generate_log(exception, context_payload)
+
+    expect(payload).to eql(
+      'exception.class' => 'StandardError',
+      'exception.message' => 'boom',
+      'exception.backtrace' => [
+        'lib/gitlab/file_a.rb:1',
+        'lib/gitlab/file_b.rb:2'
+      ],
+      'user.ip_address' => '127.0.0.1',
+      'user.username' => 'root',
+      'user.user_flag' => 'flag',
+      'tags.locale' => 'en',
+      'tags.feature_category' => 'category_a',
+      'tags.shard' => 'catchall',
+      'extra.some_other_info' => 'other_info',
+      'extra.some_info' => 'info',
+      "extra.sidekiq" => {
+        "another_field" => "field",
+        "args" => ["[FILTERED]", "1", "2"],
+        "class" => "HelloWorker"
+      }
+    )
+  end
+end
diff --git a/spec/lib/gitlab/error_tracking/processor/context_payload_processor_spec.rb b/spec/lib/gitlab/error_tracking/processor/context_payload_processor_spec.rb
new file mode 100644
index 00000000000..0db40eca989
--- /dev/null
+++ b/spec/lib/gitlab/error_tracking/processor/context_payload_processor_spec.rb
@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'fast_spec_helper'
+
+RSpec.describe Gitlab::ErrorTracking::Processor::ContextPayloadProcessor do
+  subject(:processor) { described_class.new }
+
+  before do
+    allow_next_instance_of(Gitlab::ErrorTracking::ContextPayloadGenerator) do |generator|
+      allow(generator).to receive(:generate).and_return(
+        user: { username: 'root' },
+        tags: { locale: 'en', program: 'test', feature_category: 'feature_a', correlation_id: 'cid' },
+        extra: { some_info: 'info' }
+      )
+    end
+  end
+
+  it 'merges the context payload into event payload' do
+    payload = {
+      user: { ip_address: '127.0.0.1' },
+      tags: { priority: 'high' },
+      extra: { sidekiq: { class: 'SomeWorker', args: ['[FILTERED]', 1, 2] } }
+    }
+
+    processor.process(payload)
+
+    expect(payload).to eql(
+      user: {
+        ip_address: '127.0.0.1',
+        username: 'root'
+      },
+      tags: {
+        priority: 'high',
+        locale: 'en',
+        program: 'test',
+        feature_category: 'feature_a',
+        correlation_id: 'cid'
+      },
+      extra: {
+        some_info: 'info',
+        sidekiq: { class: 'SomeWorker', args: ['[FILTERED]', 1, 2] }
+      }
+    )
+  end
+end