summaryrefslogtreecommitdiff
path: root/spec/lib/gitlab/error_tracking/processor/grpc_error_processor_spec.rb
blob: 6076e525f06465533b3b03925e914e5b992f53e3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Gitlab::ErrorTracking::Processor::GrpcErrorProcessor do
  describe '.call' do
    let(:required_options) do
      {
        configuration: Raven.configuration,
        context: Raven.context,
        breadcrumbs: Raven.breadcrumbs
      }
    end

    let(:event) { Raven::Event.from_exception(exception, required_options.merge(data)) }
    let(:result_hash) { described_class.call(event).to_hash }

    context 'when there is no GRPC exception' do
      let(:exception) { RuntimeError.new }
      let(:data) { { fingerprint: ['ArgumentError', 'Missing arguments'] } }

      it 'leaves data unchanged' do
        expect(result_hash).to include(data)
      end
    end

    context 'when there is a GPRC exception with a debug string' do
      let(:exception) { GRPC::DeadlineExceeded.new('Deadline Exceeded', {}, '{"hello":1}') }

      let(:data) do
        {
          extra: {
            caller: 'test'
          },
          fingerprint: [
            'GRPC::DeadlineExceeded',
            '4:Deadline Exceeded. debug_error_string:{"created":"@1598938192.005782000","description":"Error received from peer unix:/home/git/gitalypraefect.socket","file":"src/core/lib/surface/call.cc","file_line":1055,"grpc_message":"Deadline Exceeded","grpc_status":4}'
          ]
        }
      end

      it 'removes the debug error string and stores it as an extra field' do
        expect(result_hash[:fingerprint])
          .to eq(['GRPC::DeadlineExceeded', '4:Deadline Exceeded.'])

        expect(result_hash[:exception][:values].first)
          .to include(type: 'GRPC::DeadlineExceeded', value: '4:Deadline Exceeded.')

        expect(result_hash[:extra])
          .to include(caller: 'test', grpc_debug_error_string: '{"hello":1}')
      end

      context 'with no custom fingerprint' do
        let(:data) do
          { extra: { caller: 'test' } }
        end

        it 'removes the debug error string and stores it as an extra field' do
          expect(result_hash).not_to include(:fingerprint)

          expect(result_hash[:exception][:values].first)
            .to include(type: 'GRPC::DeadlineExceeded', value: '4:Deadline Exceeded.')

          expect(result_hash[:extra])
            .to include(caller: 'test', grpc_debug_error_string: '{"hello":1}')
        end
      end
    end
  end
end