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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::Database::AsyncIndexes::MigrationHelpers, feature_category: :database do
let(:migration) { ActiveRecord::Migration.new.extend(described_class) }
let(:index_model) { Gitlab::Database::AsyncIndexes::PostgresAsyncIndex }
let(:connection) { ApplicationRecord.connection }
let(:table_name) { '_test_async_indexes' }
let(:index_name) { "index_#{table_name}_on_id" }
before do
allow(migration).to receive(:puts)
end
describe '#unprepare_async_index' do
let!(:async_index) { create(:postgres_async_index, name: index_name) }
it 'destroys the record' do
expect do
migration.unprepare_async_index(table_name, 'id')
end.to change { index_model.where(name: index_name).count }.by(-1)
end
context 'when an explicit name is given' do
let(:index_name) { 'my_test_async_index' }
it 'destroys the record' do
expect do
migration.unprepare_async_index(table_name, 'id', name: index_name)
end.to change { index_model.where(name: index_name).count }.by(-1)
end
end
context 'when the async index table does not exist' do
it 'does not raise an error' do
connection.drop_table(:postgres_async_indexes)
expect(index_model).not_to receive(:find_by)
expect { migration.unprepare_async_index(table_name, 'id') }.not_to raise_error
end
end
end
describe '#unprepare_async_index_by_name' do
let(:index_name) { "index_#{table_name}_on_id" }
let!(:async_index) { create(:postgres_async_index, name: index_name) }
it 'destroys the record' do
expect do
migration.unprepare_async_index_by_name(table_name, index_name)
end.to change { index_model.where(name: index_name).count }.by(-1)
end
context 'when the async index table does not exist' do
it 'does not raise an error' do
connection.drop_table(:postgres_async_indexes)
expect(index_model).not_to receive(:find_by)
expect { migration.unprepare_async_index_by_name(table_name, index_name) }.not_to raise_error
end
end
end
describe '#prepare_async_index' do
before do
connection.create_table(table_name)
end
it 'creates the record for the async index' do
expect do
migration.prepare_async_index(table_name, 'id')
end.to change { index_model.where(name: index_name).count }.by(1)
record = index_model.find_by(name: index_name)
expect(record.table_name).to eq(table_name)
expect(record.definition).to match(/CREATE INDEX CONCURRENTLY "#{index_name}"/)
end
context 'when an explicit name is given' do
let(:index_name) { 'my_async_index_name' }
it 'creates the record with the given name' do
expect do
migration.prepare_async_index(table_name, 'id', name: index_name)
end.to change { index_model.where(name: index_name).count }.by(1)
record = index_model.find_by(name: index_name)
expect(record.table_name).to eq(table_name)
expect(record.definition).to match(/CREATE INDEX CONCURRENTLY "#{index_name}"/)
end
end
context 'when the index already exists' do
it 'does not create the record' do
connection.add_index(table_name, 'id', name: index_name)
expect do
migration.prepare_async_index(table_name, 'id')
end.not_to change { index_model.where(name: index_name).count }
end
end
context 'when the record already exists' do
it 'does attempt to create the record' do
create(:postgres_async_index, table_name: table_name, name: index_name)
expect do
migration.prepare_async_index(table_name, 'id')
end.not_to change { index_model.where(name: index_name).count }
end
it 'updates definition if changed' do
index = create(:postgres_async_index, table_name: table_name, name: index_name, definition: '...')
expect do
migration.prepare_async_index(table_name, 'id', name: index_name)
end.to change { index.reload.definition }
end
it 'does not update definition if not changed' do
definition = "CREATE INDEX CONCURRENTLY \"index_#{table_name}_on_id\" ON \"#{table_name}\" (\"id\")"
index = create(:postgres_async_index, table_name: table_name, name: index_name, definition: definition)
expect do
migration.prepare_async_index(table_name, 'id', name: index_name)
end.not_to change { index.reload.updated_at }
end
end
context 'when the async index table does not exist' do
it 'does not raise an error' do
connection.drop_table(:postgres_async_indexes)
expect(index_model).not_to receive(:safe_find_or_create_by!)
expect { migration.prepare_async_index(table_name, 'id') }.not_to raise_error
end
end
end
describe '#prepare_async_index_from_sql' do
let(:index_definition) { "CREATE INDEX CONCURRENTLY #{index_name} ON #{table_name} USING btree(id)" }
subject(:prepare_async_index_from_sql) do
migration.prepare_async_index_from_sql(index_definition)
end
before do
connection.create_table(table_name)
allow(Gitlab::Database::QueryAnalyzers::RestrictAllowedSchemas).to receive(:require_ddl_mode!).and_call_original
end
it 'requires ddl mode' do
prepare_async_index_from_sql
expect(Gitlab::Database::QueryAnalyzers::RestrictAllowedSchemas).to have_received(:require_ddl_mode!)
end
context 'when the given index is invalid' do
let(:index_definition) { "SELECT FROM users" }
it 'raises a RuntimeError' do
expect { prepare_async_index_from_sql }.to raise_error(RuntimeError, 'Index statement not found!')
end
end
context 'when the given index is valid' do
context 'when the index algorithm is not concurrent' do
let(:index_definition) { "CREATE INDEX #{index_name} ON #{table_name} USING btree(id)" }
it 'raises a RuntimeError' do
expect { prepare_async_index_from_sql }.to raise_error(RuntimeError, 'Index must be created concurrently!')
end
end
context 'when the index algorithm is concurrent' do
context 'when the statement tries to create an index for non-existing table' do
let(:index_definition) { "CREATE INDEX CONCURRENTLY #{index_name} ON foo_table USING btree(id)" }
it 'raises a RuntimeError' do
expect { prepare_async_index_from_sql }.to raise_error(RuntimeError, 'Table does not exist!')
end
end
context 'when the statement tries to create an index for an existing table' do
context 'when the async index creation is not available' do
before do
connection.drop_table(:postgres_async_indexes)
end
it 'does not raise an error' do
expect { prepare_async_index_from_sql }.not_to raise_error
end
end
context 'when the async index creation is available' do
context 'when there is already an index with the given name' do
before do
connection.add_index(table_name, 'id', name: index_name)
end
it 'does not create the async index record' do
expect { prepare_async_index_from_sql }.not_to change { index_model.where(name: index_name).count }
end
end
context 'when there is no index with the given name' do
let(:async_index) { index_model.find_by(name: index_name) }
it 'creates the async index record' do
expect { prepare_async_index_from_sql }.to change { index_model.where(name: index_name).count }.by(1)
end
it 'sets the async index attributes correctly' do
prepare_async_index_from_sql
expect(async_index).to have_attributes(table_name: table_name, definition: index_definition)
end
end
context 'when the given SQL has whitespace' do
let(:index_definition) { " #{super()}" }
let(:async_index) { index_model.find_by(name: index_name) }
it 'creates the async index record' do
expect { prepare_async_index_from_sql }.to change { index_model.where(name: index_name).count }.by(1)
end
it 'sets the async index attributes correctly' do
prepare_async_index_from_sql
expect(async_index).to have_attributes(table_name: table_name, definition: index_definition.strip)
end
end
end
end
end
end
end
describe '#prepare_async_index_removal' do
before do
connection.create_table(table_name)
connection.add_index(table_name, 'id', name: index_name)
end
it 'creates the record for the async index removal' do
expect do
migration.prepare_async_index_removal(table_name, 'id', name: index_name)
end.to change { index_model.where(name: index_name).count }.by(1)
record = index_model.find_by(name: index_name)
expect(record.table_name).to eq(table_name)
expect(record.definition).to match(/DROP INDEX CONCURRENTLY "#{index_name}"/)
end
context 'when the index does not exist' do
it 'does not create the record' do
connection.remove_index(table_name, 'id', name: index_name)
expect do
migration.prepare_async_index_removal(table_name, 'id', name: index_name)
end.not_to change { index_model.where(name: index_name).count }
end
end
context 'when the record already exists' do
it 'does attempt to create the record' do
create(:postgres_async_index, table_name: table_name, name: index_name)
expect do
migration.prepare_async_index_removal(table_name, 'id', name: index_name)
end.not_to change { index_model.where(name: index_name).count }
end
end
end
end
|
