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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::Database::Partitioning::PartitionManager, feature_category: :database do
include ActiveSupport::Testing::TimeHelpers
include Database::PartitioningHelpers
include ExclusiveLeaseHelpers
using RSpec::Parameterized::TableSyntax
let(:partitioned_table_name) { :_test_gitlab_main_my_model_example_table }
context 'creating partitions (mocked)' do
subject(:sync_partitions) { described_class.new(model).sync_partitions }
let(:model) { double(partitioning_strategy: partitioning_strategy, table_name: table, connection: connection) }
let(:connection) { ActiveRecord::Base.connection }
let(:table) { partitioned_table_name }
let(:partitioning_strategy) do
double(missing_partitions: partitions, extra_partitions: [], after_adding_partitions: nil, analyze_interval: nil)
end
let(:partitions) do
[
instance_double(Gitlab::Database::Partitioning::TimePartition, table: 'bar', partition_name: 'foo', to_sql: "SELECT 1"),
instance_double(Gitlab::Database::Partitioning::TimePartition, table: 'bar', partition_name: 'foo2', to_sql: "SELECT 2")
]
end
context 'when the given table is partitioned' do
before do
create_partitioned_table(connection, table)
allow(connection).to receive(:table_exists?).and_call_original
allow(connection).to receive(:table_exists?).with(table).and_return(true)
allow(connection).to receive(:execute).and_call_original
expect(partitioning_strategy).to receive(:validate_and_fix)
stub_exclusive_lease(described_class::MANAGEMENT_LEASE_KEY % table, timeout: described_class::LEASE_TIMEOUT)
end
it 'creates the partition' do
expect(connection).to receive(:execute).with("LOCK TABLE \"#{table}\" IN ACCESS EXCLUSIVE MODE")
expect(connection).to receive(:execute).with(partitions.first.to_sql)
expect(connection).to receive(:execute).with(partitions.second.to_sql)
sync_partitions
end
context 'with explicitly provided connection' do
let(:connection) { Ci::ApplicationRecord.connection }
it 'uses the explicitly provided connection when any' do
skip_if_multiple_databases_not_setup(:ci)
expect(connection).to receive(:execute).with("LOCK TABLE \"#{table}\" IN ACCESS EXCLUSIVE MODE")
expect(connection).to receive(:execute).with(partitions.first.to_sql)
expect(connection).to receive(:execute).with(partitions.second.to_sql)
described_class.new(model, connection: connection).sync_partitions
end
end
context 'when an ArgumentError occurs during partition management' do
it 'raises error' do
expect(partitioning_strategy).to receive(:missing_partitions).and_raise(ArgumentError)
expect { sync_partitions }.to raise_error(ArgumentError)
end
end
context 'when an error occurs during partition management' do
it 'does not raise an error' do
expect(partitioning_strategy).to receive(:missing_partitions).and_raise('this should never happen (tm)')
expect { sync_partitions }.not_to raise_error
end
end
end
context 'when the table is not partitioned' do
let(:table) { 'this_does_not_need_to_be_real_table' }
it 'does not try creating the partitions' do
expect(connection).not_to receive(:execute).with("LOCK TABLE \"#{table}\" IN ACCESS EXCLUSIVE MODE")
expect(Gitlab::AppLogger).to receive(:warn).with(
{
message: 'Skipping synching partitions',
table_name: table,
connection_name: 'main'
}
)
sync_partitions
end
end
end
context 'creating partitions' do
subject(:sync_partitions) { described_class.new(my_model).sync_partitions }
let(:connection) { ActiveRecord::Base.connection }
let(:my_model) do
Class.new(ApplicationRecord) do
include PartitionedTable
partitioned_by :created_at, strategy: :monthly
end
end
context 'when single database is configured' do
before do
skip_if_database_exists(:ci)
my_model.table_name = partitioned_table_name
create_partitioned_table(connection, partitioned_table_name)
end
it 'creates partitions' do
expect { sync_partitions }.to change { find_partitions(my_model.table_name, schema: Gitlab::Database::DYNAMIC_PARTITIONS_SCHEMA).size }.from(0)
end
end
context 'when multiple databases are configured' do
before do
skip_if_shared_database(:ci)
my_model.table_name = partitioned_table_name
create_partitioned_table(connection, partitioned_table_name)
stub_feature_flags(automatic_lock_writes_on_partition_tables: ff_enabled)
sync_partitions
end
where(:gitlab_schema, :database, :expectation) do
:gitlab_main | :main | false
:gitlab_main | :ci | true
:gitlab_ci | :main | true
:gitlab_ci | :ci | false
end
with_them do
subject(:sync_partitions) { described_class.new(my_model, connection: connection).sync_partitions }
let(:partitioned_table_name) { "_test_gitlab_#{database}_my_model_example_#{gitlab_schema}" }
let(:base_model) { Gitlab::Database.schemas_to_base_models[gitlab_schema].first }
let(:connection) { Gitlab::Database.database_base_models[database.to_s].connection }
let(:my_model) do
Class.new(base_model) do
include PartitionedTable
partitioned_by :created_at, strategy: :monthly
end
end
let(:partitions) do
Gitlab::Database::PostgresPartition.using_connection(connection) { Gitlab::Database::PostgresPartition.for_parent_table(partitioned_table_name).to_a }
end
let(:partitions_locked_for_writes?) do
partitions.map do |partition|
Gitlab::Database::LockWritesManager.new(
table_name: "#{partition.schema}.#{partition.name}",
connection: connection,
database_name: gitlab_schema
).table_locked_for_writes?
end.all?(true)
end
context 'when feature flag is enabled' do
let(:ff_enabled) { true }
it "matches expectation" do
sync_partitions
expect(partitions_locked_for_writes?).to eq(expectation)
end
end
context 'when feature flag is disabled' do
let(:ff_enabled) { false }
it "will not lock created partition" do
sync_partitions
expect(partitions_locked_for_writes?).to eq(false)
end
end
end
end
end
context 'detaching partitions (mocked)' do
subject(:sync_partitions) { manager.sync_partitions }
let(:manager) { described_class.new(model) }
let(:model) { double(partitioning_strategy: partitioning_strategy, table_name: table, connection: connection) }
let(:connection) { ActiveRecord::Base.connection }
let(:table) { :_test_foo }
let(:partitioning_strategy) do
double(extra_partitions: extra_partitions, missing_partitions: [], after_adding_partitions: nil, analyze_interval: nil)
end
before do
create_partitioned_table(connection, table)
allow(connection).to receive(:table_exists?).and_call_original
allow(connection).to receive(:table_exists?).with(table).and_return(true)
expect(partitioning_strategy).to receive(:validate_and_fix)
stub_exclusive_lease(described_class::MANAGEMENT_LEASE_KEY % table, timeout: described_class::LEASE_TIMEOUT)
end
let(:extra_partitions) do
[
instance_double(Gitlab::Database::Partitioning::TimePartition, table: table, partition_name: 'foo1', to_detach_sql: 'SELECT 1'),
instance_double(Gitlab::Database::Partitioning::TimePartition, table: table, partition_name: 'foo2', to_detach_sql: 'SELECT 2')
]
end
it 'detaches each extra partition' do
extra_partitions.each { |p| expect(manager).to receive(:detach_one_partition).with(p) }
sync_partitions
end
it 'logs an error if the partitions are not detachable' do
allow(Gitlab::Database::PostgresForeignKey).to receive(:by_referenced_table_identifier).with("public._test_foo")
.and_return([double(name: "fk_1", constrained_table_identifier: "public.constrainted_table_1")])
expect(Gitlab::AppLogger).to receive(:error).with(
{
message: "Failed to create / detach partition(s)",
connection_name: "main",
exception_class: Gitlab::Database::Partitioning::PartitionManager::UnsafeToDetachPartitionError,
exception_message:
"Cannot detach foo1, it would block while checking foreign key fk_1 on public.constrainted_table_1",
table_name: :_test_foo
}
)
sync_partitions
end
end
describe '#detach_partitions' do
around do |ex|
travel_to(Date.parse('2021-06-23')) do
ex.run
end
end
subject { described_class.new(my_model).sync_partitions }
let(:connection) { ActiveRecord::Base.connection }
let(:my_model) do
Class.new(ApplicationRecord) do
include PartitionedTable
partitioned_by :created_at, strategy: :monthly, retain_for: 1.month
end
end
before do
connection.execute(<<~SQL)
CREATE TABLE #{partitioned_table_name}
(id serial not null, created_at timestamptz not null, primary key (id, created_at))
PARTITION BY RANGE (created_at);
CREATE TABLE #{Gitlab::Database::DYNAMIC_PARTITIONS_SCHEMA}.#{partitioned_table_name}_202104
PARTITION OF #{partitioned_table_name}
FOR VALUES FROM ('2021-04-01') TO ('2021-05-01');
CREATE TABLE #{Gitlab::Database::DYNAMIC_PARTITIONS_SCHEMA}.#{partitioned_table_name}_202105
PARTITION OF #{partitioned_table_name}
FOR VALUES FROM ('2021-05-01') TO ('2021-06-01');
SQL
my_model.table_name = partitioned_table_name
# Also create all future partitions so that the sync is only trying to detach old partitions
my_model.partitioning_strategy.missing_partitions.each do |p|
connection.execute p.to_sql
end
end
def num_tables
connection.select_value(<<~SQL)
SELECT COUNT(*)
FROM pg_class
where relkind IN ('r', 'p')
SQL
end
it 'detaches exactly one partition' do
expect { subject }.to change { find_partitions(my_model.table_name).size }.from(9).to(8)
end
it 'detaches the old partition' do
expect { subject }.to change { has_partition(my_model, 2.months.ago.beginning_of_month) }.from(true).to(false)
end
it 'deletes zero tables' do
expect { subject }.not_to change { num_tables }
end
it 'creates the appropriate PendingPartitionDrop entry' do
subject
pending_drop = Postgresql::DetachedPartition.find_by!(table_name: "#{partitioned_table_name}_202104")
expect(pending_drop.drop_after).to eq(Time.current + described_class::RETAIN_DETACHED_PARTITIONS_FOR)
end
context 'when the model is the target of a foreign key' do
before do
connection.execute(<<~SQL)
create unique index idx_for_fk ON #{partitioned_table_name}(created_at);
create table _test_gitlab_main_referencing_table (
id bigserial primary key not null,
referencing_created_at timestamptz references #{partitioned_table_name}(created_at)
);
SQL
end
it 'does not detach partitions with a referenced foreign key' do
expect { subject }.not_to change { find_partitions(my_model.table_name).size }
end
end
end
describe 'analyze partitioned table' do
let(:analyze) { true }
let(:analyze_table) { partitioned_table_name }
let(:analyze_partition) { "#{partitioned_table_name}_1" }
let(:analyze_regex) { /ANALYZE VERBOSE "#{analyze_table}"/ }
let(:analyze_interval) { 1.week }
let(:connection) { my_model.connection }
let(:create_partition) { true }
let(:my_model) do
interval = analyze_interval
Class.new(ApplicationRecord) do
include PartitionedTable
partitioned_by :partition_id,
strategy: :ci_sliding_list,
next_partition_if: proc { false },
detach_partition_if: proc { false },
analyze_interval: interval
end
end
shared_examples_for 'run only once analyze within interval' do
specify do
control = ActiveRecord::QueryRecorder.new { described_class.new(my_model, connection: connection).sync_partitions(analyze: analyze) }
expect(control.occurrences).to include(analyze_regex)
control = ActiveRecord::QueryRecorder.new { described_class.new(my_model, connection: connection).sync_partitions(analyze: analyze) }
expect(control.occurrences).not_to include(analyze_regex)
travel_to((analyze_interval * 2).since) do
control = ActiveRecord::QueryRecorder.new { described_class.new(my_model, connection: connection).sync_partitions(analyze: analyze) }
expect(control.occurrences).to include(analyze_regex)
end
end
end
shared_examples_for 'not to run the analyze at all' do
specify do
control = ActiveRecord::QueryRecorder.new { described_class.new(my_model, connection: connection).sync_partitions(analyze: analyze) }
expect(control.occurrences).not_to include(analyze_regex)
control = ActiveRecord::QueryRecorder.new { described_class.new(my_model, connection: connection).sync_partitions(analyze: analyze) }
expect(control.occurrences).not_to include(analyze_regex)
travel_to((analyze_interval * 2).since) do
control = ActiveRecord::QueryRecorder.new { described_class.new(my_model, connection: connection).sync_partitions(analyze: analyze) }
expect(control.occurrences).not_to include(analyze_regex)
end
end
end
before do
my_model.table_name = partitioned_table_name
connection.execute(<<~SQL)
CREATE TABLE #{analyze_table}(id serial) PARTITION BY LIST (id);
SQL
connection.execute(<<~SQL) if create_partition
CREATE TABLE IF NOT EXISTS #{analyze_partition} PARTITION OF #{analyze_table} FOR VALUES IN (1);
SQL
allow(connection).to receive(:select_value).and_return(nil, Time.current, Time.current)
end
it_behaves_like 'run only once analyze within interval'
context 'when analyze is false' do
let(:analyze) { false }
it_behaves_like 'not to run the analyze at all'
end
context 'when model does not set analyze_interval' do
let(:my_model) do
Class.new(ApplicationRecord) do
include PartitionedTable
partitioned_by :partition_id,
strategy: :ci_sliding_list,
next_partition_if: proc { false },
detach_partition_if: proc { false }
end
end
it_behaves_like 'not to run the analyze at all'
end
context 'when no partition is created' do
let(:create_partition) { false }
it_behaves_like 'run only once analyze within interval'
end
end
describe 'strategies that support analyze_interval' do
[
::Gitlab::Database::Partitioning::MonthlyStrategy,
::Gitlab::Database::Partitioning::SlidingListStrategy,
::Gitlab::Database::Partitioning::CiSlidingListStrategy
].each do |klass|
specify "#{klass} supports analyze_interval" do
expect(klass).to be_method_defined(:analyze_interval)
end
end
end
context 'creating and then detaching partitions for a table' do
let(:connection) { ActiveRecord::Base.connection }
let(:my_model) do
Class.new(ApplicationRecord) do
include PartitionedTable
partitioned_by :created_at, strategy: :monthly, retain_for: 1.month
end
end
before do
my_model.table_name = partitioned_table_name
connection.execute(<<~SQL)
CREATE TABLE #{partitioned_table_name}
(id serial not null, created_at timestamptz not null, primary key (id, created_at))
PARTITION BY RANGE (created_at);
SQL
end
def num_partitions(model)
find_partitions(model.table_name, schema: Gitlab::Database::DYNAMIC_PARTITIONS_SCHEMA).size
end
it 'creates partitions for the future then drops the oldest one after a month' do
# 1 month for the current month, 1 month for the old month that we're retaining data for, headroom
expected_num_partitions = (Gitlab::Database::Partitioning::MonthlyStrategy::HEADROOM + 2.months) / 1.month
expect { described_class.new(my_model).sync_partitions }.to change { num_partitions(my_model) }.from(0).to(expected_num_partitions)
travel 1.month
expect { described_class.new(my_model).sync_partitions }.to change { has_partition(my_model, 2.months.ago.beginning_of_month) }.from(true).to(false).and(change { num_partitions(my_model) }.by(0))
end
end
def has_partition(model, month)
Gitlab::Database::PostgresPartition.for_parent_table(model.table_name).any? do |partition|
Gitlab::Database::Partitioning::TimePartition.from_sql(
model.table_name,
partition.name,
partition.condition
).from == month
end
end
def create_partitioned_table(connection, table)
connection.execute(<<~SQL)
CREATE TABLE #{table}
(id serial not null, created_at timestamptz not null, primary key (id, created_at))
PARTITION BY RANGE (created_at);
SQL
end
end
|