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
|
# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Gitlab::Database::Partitioning::ConvertTableToFirstListPartition do
include Gitlab::Database::DynamicModelHelpers
include Database::TableSchemaHelpers
let(:migration_context) { Gitlab::Database::Migration[2.0].new }
let(:connection) { migration_context.connection }
let(:table_name) { '_test_table_to_partition' }
let(:table_identifier) { "#{connection.current_schema}.#{table_name}" }
let(:partitioning_column) { :partition_number }
let(:partitioning_default) { 1 }
let(:referenced_table_name) { '_test_referenced_table' }
let(:other_referenced_table_name) { '_test_other_referenced_table' }
let(:parent_table_name) { "#{table_name}_parent" }
let(:lock_tables) { [] }
let(:model) { define_batchable_model(table_name, connection: connection) }
let(:parent_model) { define_batchable_model(parent_table_name, connection: connection) }
let(:converter) do
described_class.new(
migration_context: migration_context,
table_name: table_name,
partitioning_column: partitioning_column,
parent_table_name: parent_table_name,
zero_partition_value: partitioning_default,
lock_tables: lock_tables
)
end
before do
# Suppress printing migration progress
allow(migration_context).to receive(:puts)
allow(migration_context.connection).to receive(:transaction_open?).and_return(false)
connection.execute(<<~SQL)
create table #{referenced_table_name} (
id bigserial primary key not null
)
SQL
connection.execute(<<~SQL)
create table #{other_referenced_table_name} (
id bigserial primary key not null
)
SQL
connection.execute(<<~SQL)
insert into #{referenced_table_name} default values;
insert into #{other_referenced_table_name} default values;
SQL
connection.execute(<<~SQL)
create table #{table_name} (
id bigserial not null,
#{partitioning_column} bigint not null default #{partitioning_default},
referenced_id bigint not null references #{referenced_table_name} (id) on delete cascade,
other_referenced_id bigint not null references #{other_referenced_table_name} (id) on delete set null,
primary key (id, #{partitioning_column})
)
SQL
connection.execute(<<~SQL)
insert into #{table_name} (referenced_id, other_referenced_id)
select #{referenced_table_name}.id, #{other_referenced_table_name}.id
from #{referenced_table_name}, #{other_referenced_table_name};
SQL
end
describe "#prepare_for_partitioning" do
subject(:prepare) { converter.prepare_for_partitioning }
it 'adds a check constraint' do
expect { prepare }.to change {
Gitlab::Database::PostgresConstraint
.check_constraints
.by_table_identifier(table_identifier)
.count
}.from(0).to(1)
end
end
describe '#revert_prepare_for_partitioning' do
before do
converter.prepare_for_partitioning
end
subject(:revert_prepare) { converter.revert_preparation_for_partitioning }
it 'removes a check constraint' do
expect { revert_prepare }.to change {
Gitlab::Database::PostgresConstraint
.check_constraints
.by_table_identifier("#{connection.current_schema}.#{table_name}")
.count
}.from(1).to(0)
end
end
describe "#convert_to_zero_partition" do
subject(:partition) { converter.partition }
before do
converter.prepare_for_partitioning
end
context 'when the primary key is incorrect' do
before do
connection.execute(<<~SQL)
alter table #{table_name} drop constraint #{table_name}_pkey;
alter table #{table_name} add constraint #{table_name}_pkey PRIMARY KEY (id);
SQL
end
it 'throws a reasonable error message' do
expect { partition }.to raise_error(described_class::UnableToPartition, /#{partitioning_column}/)
end
end
context 'when there is not a supporting check constraint' do
before do
connection.execute(<<~SQL)
alter table #{table_name} drop constraint partitioning_constraint;
SQL
end
it 'throws a reasonable error message' do
expect { partition }.to raise_error(described_class::UnableToPartition, /constraint /)
end
end
it 'migrates the table to a partitioned table' do
fks_before = migration_context.foreign_keys(table_name)
partition
expect(Gitlab::Database::PostgresPartition.for_parent_table(parent_table_name).count).to eq(1)
expect(migration_context.foreign_keys(parent_table_name).map(&:options)).to match_array(fks_before.map(&:options))
connection.execute(<<~SQL)
insert into #{table_name} (referenced_id, other_referenced_id) select #{referenced_table_name}.id, #{other_referenced_table_name}.id from #{referenced_table_name}, #{other_referenced_table_name};
SQL
# Create a second partition
connection.execute(<<~SQL)
create table #{table_name}2 partition of #{parent_table_name} FOR VALUES IN (2)
SQL
parent_model.create!(partitioning_column => 2, :referenced_id => 1, :other_referenced_id => 1)
expect(parent_model.pluck(:id)).to match_array([1, 2, 3])
end
context 'when the existing table is owned by a different user' do
before do
connection.execute(<<~SQL)
CREATE USER other_user SUPERUSER;
ALTER TABLE #{table_name} OWNER TO other_user;
SQL
end
let(:current_user) { model.connection.select_value('select current_user') }
it 'partitions without error' do
expect { partition }.not_to raise_error
end
end
context 'with locking tables' do
let(:lock_tables) { [table_name] }
it 'locks the table' do
recorder = ActiveRecord::QueryRecorder.new { partition }
expect(recorder.log).to include(/LOCK "_test_table_to_partition" IN ACCESS EXCLUSIVE MODE/)
end
end
context 'when an error occurs during the conversion' do
def fail_first_time
# We can't directly use a boolean here, as we need something that will be passed by-reference to the proc
fault_status = { faulted: false }
proc do |m, *args, **kwargs|
next m.call(*args, **kwargs) if fault_status[:faulted]
fault_status[:faulted] = true
raise 'fault!'
end
end
def fail_sql_matching(regex)
proc do
allow(migration_context.connection).to receive(:execute).and_call_original
allow(migration_context.connection).to receive(:execute).with(regex).and_wrap_original(&fail_first_time)
end
end
def fail_adding_fk(from_table, to_table)
proc do
allow(migration_context.connection).to receive(:add_foreign_key).and_call_original
expect(migration_context.connection).to receive(:add_foreign_key).with(from_table, to_table, any_args)
.and_wrap_original(&fail_first_time)
end
end
where(:case_name, :fault) do
[
["creating parent table", lazy { fail_sql_matching(/CREATE/i) }],
["adding the first foreign key", lazy { fail_adding_fk(parent_table_name, referenced_table_name) }],
["adding the second foreign key", lazy { fail_adding_fk(parent_table_name, other_referenced_table_name) }],
["attaching table", lazy { fail_sql_matching(/ATTACH/i) }]
]
end
before do
# Set up the fault that we'd like to inject
fault.call
end
with_them do
it 'recovers from a fault', :aggregate_failures do
expect { converter.partition }.to raise_error(/fault/)
expect(Gitlab::Database::PostgresPartition.for_parent_table(parent_table_name).count).to eq(0)
expect { converter.partition }.not_to raise_error
expect(Gitlab::Database::PostgresPartition.for_parent_table(parent_table_name).count).to eq(1)
end
end
end
end
describe '#revert_conversion_to_zero_partition' do
before do
converter.prepare_for_partitioning
converter.partition
end
subject(:revert_conversion) { converter.revert_partitioning }
it 'detaches the partition' do
expect { revert_conversion }.to change {
Gitlab::Database::PostgresPartition
.for_parent_table(parent_table_name).count
}.from(1).to(0)
end
it 'does not drop the child partition' do
expect { revert_conversion }.not_to change { table_oid(table_name) }
end
it 'removes the parent table' do
expect { revert_conversion }.to change { table_oid(parent_table_name).present? }.from(true).to(false)
end
it 're-adds the check constraint' do
expect { revert_conversion }.to change {
Gitlab::Database::PostgresConstraint
.check_constraints
.by_table_identifier(table_identifier)
.count
}.by(1)
end
it 'moves sequences back to the original table' do
expect { revert_conversion }.to change { converter.send(:sequences_owned_by, table_name).count }.from(0)
.and change { converter.send(:sequences_owned_by, parent_table_name).count }.to(0)
end
end
end
|