summaryrefslogtreecommitdiff
path: root/spec/lib/peek/views/active_record_spec.rb
blob: c89f6a21b356ddbd481f5acfb9f344f433117cc7 (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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Peek::Views::ActiveRecord, :request_store do
  subject { Peek.views.find { |v| v.instance_of?(Peek::Views::ActiveRecord) } }

  let(:connection_replica) { double(:connection_replica) }
  let(:connection_primary_1) { double(:connection_primary) }
  let(:connection_primary_2) { double(:connection_primary) }
  let(:connection_unknown) { double(:connection_unknown) }

  let(:event_1) do
    {
      name: 'SQL',
      sql: 'SELECT * FROM users WHERE id = 10',
      cached: false,
      connection: connection_primary_1
    }
  end

  let(:event_2) do
    {
      name: 'SQL',
      sql: 'SELECT * FROM users WHERE id = 10',
      cached: true,
      connection: connection_replica
    }
  end

  let(:event_3) do
    {
      name: 'SQL',
      sql: 'UPDATE users SET admin = true WHERE id = 10',
      cached: false,
      connection: connection_primary_2
    }
  end

  let(:event_4) do
    {
      name: 'SCHEMA',
      sql: 'SELECT VERSION()',
      cached: false,
      connection: connection_unknown
    }
  end

  before do
    allow(Gitlab::PerformanceBar).to receive(:enabled_for_request?).and_return(true)
    allow(connection_replica).to receive(:transaction_open?).and_return(false)
    allow(connection_primary_1).to receive(:transaction_open?).and_return(false)
    allow(connection_primary_2).to receive(:transaction_open?).and_return(true)
    allow(connection_unknown).to receive(:transaction_open?).and_return(false)
    allow(::Gitlab::Database).to receive(:db_config_name).and_return('the_db_config_name')

    allow(Gitlab::Database::LoadBalancing).to receive(:db_role_for_connection).with(connection_replica).and_return(:replica)
    allow(Gitlab::Database::LoadBalancing).to receive(:db_role_for_connection).with(connection_primary_1).and_return(:primary)
    allow(Gitlab::Database::LoadBalancing).to receive(:db_role_for_connection).with(connection_primary_2).and_return(:primary)
    allow(Gitlab::Database::LoadBalancing).to receive(:db_role_for_connection).with(connection_unknown).and_return(nil)
  end

  it 'includes db role data and db_config_name name' do
    Timecop.freeze(2021, 2, 23, 10, 0) do
      ActiveSupport::Notifications.publish('sql.active_record', Time.current, Time.current + 1.second, '1', event_1)
      ActiveSupport::Notifications.publish('sql.active_record', Time.current, Time.current + 2.seconds, '2', event_2)
      ActiveSupport::Notifications.publish('sql.active_record', Time.current, Time.current + 3.seconds, '3', event_3)
      ActiveSupport::Notifications.publish('sql.active_record', Time.current, Time.current + 4.seconds, '4', event_4)
    end

    expect(subject.results).to match(
      calls: 4,
      summary: {
        "Cached" => 1,
        "In a transaction" => 1,
        "Role: Primary" => 2,
        "Role: Replica" => 1,
        "Role: Unknown" => 1
      },
      duration: '10000.00ms',
      warnings: ["active-record duration: 10000.0 over 3000"],
      details: contain_exactly(
        a_hash_including(
          start: be_a(Time),
          cached: '',
          transaction: '',
          duration: 1000.0,
          sql: 'SELECT * FROM users WHERE id = 10',
          db_role: 'Role: Primary',
          db_config_name: "Config name: the_db_config_name"
        ),
        a_hash_including(
          start: be_a(Time),
          cached: 'Cached',
          transaction: '',
          duration: 2000.0,
          sql: 'SELECT * FROM users WHERE id = 10',
          db_role: 'Role: Replica',
          db_config_name: "Config name: the_db_config_name"
        ),
        a_hash_including(
          start: be_a(Time),
          cached: '',
          transaction: 'In a transaction',
          duration: 3000.0,
          sql: 'UPDATE users SET admin = true WHERE id = 10',
          db_role: 'Role: Primary',
          db_config_name: "Config name: the_db_config_name"
        ),
        a_hash_including(
          start: be_a(Time),
          cached: '',
          transaction: '',
          duration: 4000.0,
          sql: 'SELECT VERSION()',
          db_role: 'Role: Unknown',
          db_config_name: "Config name: the_db_config_name"
        )
      )
    )
  end

  context 'when the GITLAB_MULTIPLE_DATABASE_METRICS env var is disabled' do
    before do
      stub_env('GITLAB_MULTIPLE_DATABASE_METRICS', nil)
    end

    it 'does not include db_config_name field' do
      ActiveSupport::Notifications.publish('sql.active_record', Time.current, Time.current + 1.second, '1', event_1)

      expect(subject.results[:details][0][:db_config_name]).to be_nil
    end
  end
end