blob: 3b4cbc79de2609909e265d1518d7db07b1d236c4 (
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::Database::QueryAnalyzer, query_analyzers: false do
let(:analyzer) { double(:query_analyzer) }
let(:user_analyzer) { double(:query_analyzer) }
let(:disabled_analyzer) { double(:disabled_query_analyzer) }
before do
allow(described_class.instance).to receive(:all_analyzers).and_return([analyzer, disabled_analyzer])
allow(analyzer).to receive(:enabled?).and_return(true)
allow(analyzer).to receive(:suppressed?).and_return(false)
allow(analyzer).to receive(:begin!)
allow(analyzer).to receive(:end!)
allow(disabled_analyzer).to receive(:enabled?).and_return(false)
end
context 'the hook is enabled by default in specs' do
it 'does process queries and gets normalized SQL' do
expect(analyzer).to receive(:enabled?).and_return(true)
expect(analyzer).to receive(:analyze) do |parsed|
expect(parsed.sql).to include("SELECT $1 FROM projects")
expect(parsed.pg.tables).to eq(%w[projects])
end
described_class.instance.within do
Project.connection.execute("SELECT 1 FROM projects")
end
end
it 'does prevent recursive execution' do
expect(analyzer).to receive(:enabled?).and_return(true)
expect(analyzer).to receive(:analyze) do
Project.connection.execute("SELECT 1 FROM projects")
end
described_class.instance.within do
Project.connection.execute("SELECT 1 FROM projects")
end
end
end
describe '#within' do
context 'when it is already initialized' do
around do |example|
described_class.instance.within do
example.run
end
end
it 'does not evaluate enabled? again do yield block' do
expect(analyzer).not_to receive(:enabled?)
expect { |b| described_class.instance.within(&b) }.to yield_control
end
it 'raises exception when trying to re-define analyzers' do
expect { |b| described_class.instance.within([user_analyzer], &b) }.to raise_error /Query analyzers are already defined, cannot re-define them/
end
end
context 'when initializer is enabled' do
before do
expect(analyzer).to receive(:enabled?).and_return(true)
end
it 'calls begin! and end!' do
expect(analyzer).to receive(:begin!)
expect(analyzer).to receive(:end!)
expect { |b| described_class.instance.within(&b) }.to yield_control
end
it 'when begin! raises the end! is not called' do
expect(analyzer).to receive(:begin!).and_raise('exception')
expect(analyzer).not_to receive(:end!)
expect(Gitlab::ErrorTracking).to receive(:track_and_raise_for_dev_exception)
expect { |b| described_class.instance.within(&b) }.to yield_control
end
end
context 'when user analyzers are used' do
it 'calls begin! and end!' do
expect(analyzer).not_to receive(:begin!)
allow(user_analyzer).to receive(:enabled?).and_return(true)
allow(user_analyzer).to receive(:suppressed?).and_return(false)
expect(user_analyzer).to receive(:begin!)
expect(user_analyzer).to receive(:end!)
expect { |b| described_class.instance.within([user_analyzer], &b) }.to yield_control
end
end
end
describe '#process_sql' do
it 'does not analyze query if not enabled' do
expect(analyzer).to receive(:enabled?).and_return(false)
expect(analyzer).not_to receive(:analyze)
process_sql("SELECT 1 FROM projects")
end
it 'does analyze query if enabled' do
expect(analyzer).to receive(:enabled?).and_return(true)
expect(analyzer).to receive(:analyze) do |parsed|
expect(parsed.sql).to eq("SELECT $1 FROM projects")
expect(parsed.pg.tables).to eq(%w[projects])
end
process_sql("SELECT 1 FROM projects")
end
it 'does track exception if query cannot be parsed' do
expect(analyzer).to receive(:enabled?).and_return(true)
expect(analyzer).not_to receive(:analyze)
expect(Gitlab::ErrorTracking).to receive(:track_exception)
expect { process_sql("invalid query") }.not_to raise_error
end
it 'does track exception if analyzer raises exception on enabled?' do
expect(analyzer).to receive(:enabled?).and_raise('exception')
expect(analyzer).not_to receive(:analyze)
expect(Gitlab::ErrorTracking).to receive(:track_and_raise_for_dev_exception)
expect { process_sql("SELECT 1 FROM projects") }.not_to raise_error
end
it 'does track exception if analyzer raises exception on analyze' do
expect(analyzer).to receive(:enabled?).and_return(true)
expect(analyzer).to receive(:analyze).and_raise('exception')
expect(Gitlab::ErrorTracking).to receive(:track_and_raise_for_dev_exception)
expect { process_sql("SELECT 1 FROM projects") }.not_to raise_error
end
it 'does call analyze only on enabled initializers' do
expect(analyzer).to receive(:analyze)
expect(disabled_analyzer).not_to receive(:analyze)
expect { process_sql("SELECT 1 FROM projects") }.not_to raise_error
end
it 'does not call analyze on suppressed analyzers' do
expect(analyzer).to receive(:suppressed?).and_return(true)
expect(analyzer).to receive(:requires_tracking?).and_return(false)
expect(analyzer).not_to receive(:analyze)
expect { process_sql("SELECT 1 FROM projects") }.not_to raise_error
end
it 'does call analyze on suppressed analyzers if some queries require tracking' do
expect(analyzer).to receive(:suppressed?).and_return(true)
expect(analyzer).to receive(:requires_tracking?).and_return(true)
expect(analyzer).to receive(:analyze)
expect { process_sql("SELECT 1 FROM projects") }.not_to raise_error
end
def process_sql(sql)
described_class.instance.within do
ApplicationRecord.load_balancer.read_write do |connection|
described_class.instance.process_sql(sql, connection)
end
end
end
end
end
|