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
|
# frozen_string_literal: true
class SwapNotesIdToBigintForSelfManaged < Gitlab::Database::Migration[2.1]
include Gitlab::Database::MigrationHelpers::ConvertToBigint
disable_ddl_transaction!
TABLE_NAME = 'notes'
PK_INDEX_NAME = 'index_notes_on_id_convert_to_bigint'
SECONDARY_INDEXES = [
{
original_name: :index_notes_on_author_id_and_created_at_and_id,
temporary_name: :index_notes_on_author_id_created_at_id_convert_to_bigint,
columns: [:author_id, :created_at, :id_convert_to_bigint],
options: {}
},
{
original_name: :index_notes_on_id_where_confidential,
temporary_name: :index_notes_on_id_convert_to_bigint_where_confidential,
columns: [:id_convert_to_bigint],
options: { where: 'confidential = true' }
},
{
original_name: :index_notes_on_id_where_internal,
temporary_name: :index_notes_on_id_convert_to_bigint_where_internal,
columns: [:id_convert_to_bigint],
options: { where: 'internal = true' }
},
{
original_name: :index_notes_on_project_id_and_id_and_system_false,
temporary_name: :index_notes_on_project_id_id_convert_to_bigint_system_false,
columns: [:project_id, :id_convert_to_bigint],
options: { where: 'NOT system' }
},
{
original_name: :note_mentions_temp_index,
temporary_name: :note_mentions_temp_index_convert_to_bigint,
columns: [:id_convert_to_bigint, :noteable_type],
options: { where: "note ~~ '%@%'::text" }
}
]
REFERENCING_FOREIGN_KEYS = [
[:todos, :fk_91d1f47b13, :note_id, :cascade],
[:incident_management_timeline_events, :fk_d606a2a890, :promoted_from_note_id, :nullify],
[:system_note_metadata, :fk_d83a918cb1, :note_id, :cascade],
[:diff_note_positions, :fk_rails_13c7212859, :note_id, :cascade],
[:epic_user_mentions, :fk_rails_1c65976a49, :note_id, :cascade],
[:suggestions, :fk_rails_33b03a535c, :note_id, :cascade],
[:issue_user_mentions, :fk_rails_3861d9fefa, :note_id, :cascade],
[:note_diff_files, :fk_rails_3d66047aeb, :diff_note_id, :cascade],
[:snippet_user_mentions, :fk_rails_4d3f96b2cb, :note_id, :cascade],
[:design_user_mentions, :fk_rails_8de8c6d632, :note_id, :cascade],
[:vulnerability_user_mentions, :fk_rails_a18600f210, :note_id, :cascade],
[:commit_user_mentions, :fk_rails_a6760813e0, :note_id, :cascade],
[:merge_request_user_mentions, :fk_rails_c440b9ea31, :note_id, :cascade],
[:note_metadata, :fk_rails_d853224d37, :note_id, :cascade],
[:alert_management_alert_user_mentions, :fk_rails_eb2de0cdef, :note_id, :cascade],
[:timelogs, :fk_timelogs_note_id, :note_id, :nullify]
]
class PgForeignKeys < MigrationRecord
self.table_name = :postgres_foreign_keys
end
def up
return if com_or_dev_or_test_but_not_jh?
return if temp_column_removed?(TABLE_NAME, :id)
return if columns_swapped?(TABLE_NAME, :id)
swap
end
def down
return if com_or_dev_or_test_but_not_jh?
return if temp_column_removed?(TABLE_NAME, :id)
return unless columns_swapped?(TABLE_NAME, :id)
swap
end
private
def swap
create_indexes
create_referencing_foreign_keys
replace_referencing_foreign_keys
find_and_drop_faulting_foreign_keys(:system_note_metadata, :fk_d83a918cb1)
with_lock_retries(raise_on_exhaustion: true) do
# Swap the original and new column names
execute "ALTER TABLE #{TABLE_NAME} RENAME COLUMN id TO id_tmp"
execute "ALTER TABLE #{TABLE_NAME} RENAME COLUMN id_convert_to_bigint TO id"
execute "ALTER TABLE #{TABLE_NAME} RENAME COLUMN id_tmp TO id_convert_to_bigint"
# Reset the function so PG drops the plan cache for the incorrect integer type
function_name = Gitlab::Database::UnidirectionalCopyTrigger
.on_table(TABLE_NAME, connection: connection)
.name(:id, :id_convert_to_bigint)
execute "ALTER FUNCTION #{quote_table_name(function_name)} RESET ALL"
# Swap defaults of the two columns, and change ownership of the sequence to the new id
execute "ALTER SEQUENCE notes_id_seq OWNED BY #{TABLE_NAME}.id"
change_column_default TABLE_NAME, :id, -> { "nextval('notes_id_seq'::regclass)" }
change_column_default TABLE_NAME, :id_convert_to_bigint, 0
# Swap the PK constraint from the original column to the new column.
# We deliberately don't CASCADE here because the old FKs should be removed already
execute "ALTER TABLE #{TABLE_NAME} DROP CONSTRAINT notes_pkey"
rename_index TABLE_NAME, PK_INDEX_NAME, 'notes_pkey'
execute "ALTER TABLE #{TABLE_NAME} ADD CONSTRAINT notes_pkey PRIMARY KEY USING INDEX notes_pkey"
rename_secondary_indexes # rubocop:disable Migration/WithLockRetriesDisallowedMethod
end
end
# Copy existing indexes from the original column to the new column
def create_indexes
add_concurrent_index TABLE_NAME, :id_convert_to_bigint, unique: true, name: PK_INDEX_NAME
SECONDARY_INDEXES.each do |index_definition|
options = index_definition[:options]
options[:name] = index_definition[:temporary_name]
add_concurrent_index(TABLE_NAME, index_definition[:columns], options)
end
end
# Remove old column indexes and change new column indexes to have the original names
def rename_secondary_indexes
SECONDARY_INDEXES.each do |index_definition|
remove_index(TABLE_NAME, name: index_definition[:original_name], if_exists: true) # rubocop:disable Migration/RemoveIndex
rename_index(TABLE_NAME, index_definition[:temporary_name], index_definition[:original_name])
end
end
# Copy existing FKs from the original column to the new column
#
# @note Don't attempt to create the FK if one already exists from the table to the new column.
# The check in `add_concurrent_foreign_key` already checks for this, but it looks for the foreign key
# with the new name only (containing the `_tmp` suffix). Since we might partially rename FKs and re-run
# the migration, we also have to check and see if a FK exists on those columns that might not
# match the `_tmp` name.
def create_referencing_foreign_keys
REFERENCING_FOREIGN_KEYS.each do |(from_table, name, column, on_delete)|
next if foreign_key_exists?(from_table, TABLE_NAME, column: column,
primary_key: :id_convert_to_bigint, name: name)
add_concurrent_foreign_key(
from_table,
TABLE_NAME,
column: column,
target_column: :id_convert_to_bigint,
name: "#{name}_tmp",
on_delete: on_delete,
reverse_lock_order: true
)
end
end
# Remove existing FKs from the referencing tables, so we don't have to lock on them when we drop the existing PK
#
# @note Don't attempt to replace the FK unless it exists and points at the original column. This could happen if the
# migration is re-run due to failing midway.
def replace_referencing_foreign_keys
REFERENCING_FOREIGN_KEYS.each do |(from_table, name, column, _)|
next unless foreign_key_exists?(from_table, TABLE_NAME, column: column, primary_key: :id, name: name)
with_lock_retries(raise_on_exhaustion: true) do
temporary_name = "#{name}_tmp"
# Explicitly lock table in order of parent, child to attempt to avoid deadlocks
execute "LOCK TABLE #{TABLE_NAME}, #{from_table} IN ACCESS EXCLUSIVE MODE"
remove_foreign_key(from_table, TABLE_NAME, column: column, primary_key: :id, name: name)
rename_constraint(from_table, temporary_name, name)
end
end
end
# Customers reported that some FKs are blocking the +notes_pkey+ to be dropped. This is happening, because some
# foreign keys listed in +REFERENCING_FOREIGN_KEYS+ have different names in customers instances.
# We need to find and remove this FKs to finish the swapping process.
#
# @info https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/8227
def find_and_drop_faulting_foreign_keys(constrained_table, referenced_fk_name)
foreign_keys = PgForeignKeys.select(:name)
.where(constrained_table_name: constrained_table)
.where(referenced_table_name: TABLE_NAME)
.where.not(name: referenced_fk_name)
with_lock_retries(raise_on_exhaustion: true) do
execute "LOCK TABLE #{TABLE_NAME}, #{constrained_table} IN ACCESS EXCLUSIVE MODE"
foreign_keys.each do |foreign_key|
remove_foreign_key_if_exists(constrained_table, name: foreign_key.name)
end
end
end
end
|
