Class: MergeRequestDiff
Constant Summary
collapse
- COMMITS_SAFE_SIZE =
Don't display more than 100 commits at once
100
- BATCH_SIZE =
1000
- EXTERNAL_DIFF_CUTOFF =
Applies to closed or merged MRs when determining whether to migrate their diffs to external storage
7.days.freeze
- FILES_COUNT_SENTINEL =
The files_count column is a 2-byte signed integer. Look up the true value from the database if this sentinel is seen
2**15 - 1
Instance Attribute Summary
Attributes included from Importable
#imported, #importing
Class Method Summary
collapse
Instance Method Summary
collapse
#bulk_insert_associations!, bulk_inserts_enabled?, with_bulk_insert
#background_upload, #changed_mounts
#clear_memoization, #strong_memoize, #strong_memoized?
at_most, id_in, id_not_in, iid_in, pluck_primary_key, primary_key_in, safe_ensure_unique, safe_find_or_create_by, safe_find_or_create_by!, underscore, without_order
Class Method Details
.find_by_diff_refs(diff_refs) ⇒ Object
162
163
164
|
# File 'app/models/merge_request_diff.rb', line 162
def self.find_by_diff_refs(diff_refs)
find_by(start_commit_sha: diff_refs.start_sha, head_commit_sha: diff_refs.head_sha, base_commit_sha: diff_refs.base_sha)
end
|
.ids_for_external_storage_migration(limit:) ⇒ Object
110
111
112
113
114
115
116
117
118
119
120
121
|
# File 'app/models/merge_request_diff.rb', line 110
def ids_for_external_storage_migration(limit:)
return [] unless Gitlab.config.external_diffs.enabled
case Gitlab.config.external_diffs.when
when 'always'
ids_for_external_storage_migration_strategy_always(limit: limit)
when 'outdated'
ids_for_external_storage_migration_strategy_outdated(limit: limit)
else
[]
end
end
|
.ids_for_external_storage_migration_strategy_always(limit:) ⇒ Object
123
124
125
|
# File 'app/models/merge_request_diff.rb', line 123
def ids_for_external_storage_migration_strategy_always(limit:)
files_in_database.limit(limit).pluck(:id)
end
|
.ids_for_external_storage_migration_strategy_outdated(limit:) ⇒ Object
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
# File 'app/models/merge_request_diff.rb', line 127
def ids_for_external_storage_migration_strategy_outdated(limit:)
before = EXTERNAL_DIFF_CUTOFF.ago
ids = files_in_database
.old_merged_diffs(before)
.limit(limit)
.pluck(:id)
return ids if ids.size >= limit
ids += files_in_database
.old_closed_diffs(before)
.limit(limit - ids.size)
.pluck(:id)
return ids if ids.size >= limit
ids + files_in_database
.not_latest_diffs
.limit(limit - ids.size)
.pluck(:id)
end
|
Instance Method Details
#base_commit ⇒ Object
264
265
266
267
268
|
# File 'app/models/merge_request_diff.rb', line 264
def base_commit
return unless base_commit_sha
project.commit_by(oid: base_commit_sha)
end
|
#commit_shas(limit: nil) ⇒ Object
282
283
284
|
# File 'app/models/merge_request_diff.rb', line 282
def commit_shas(limit: nil)
merge_request_diff_commits.limit(limit).pluck(:sha)
end
|
#commits(limit: nil) ⇒ Object
246
247
248
249
250
|
# File 'app/models/merge_request_diff.rb', line 246
def commits(limit: nil)
strong_memoize(:"commits_#{limit || 'all'}") do
load_commits(limit: limit)
end
end
|
#compare ⇒ Object
374
375
376
377
378
379
380
381
|
# File 'app/models/merge_request_diff.rb', line 374
def compare
@compare ||=
Gitlab::Git::Compare.new(
repository.raw_repository,
safe_start_commit_sha,
head_commit_sha
)
end
|
#compare_with(sha) ⇒ Object
rubocop: disable CodeReuse/ServiceClass
388
389
390
391
392
393
|
# File 'app/models/merge_request_diff.rb', line 388
def compare_with(sha)
CompareService.new(project, head_commit_sha).execute(project, sha, straight: true)
end
|
#diff_refs ⇒ Object
302
303
304
305
306
307
308
309
310
|
# File 'app/models/merge_request_diff.rb', line 302
def diff_refs
return unless start_commit_sha || base_commit_sha
Gitlab::Diff::DiffRefs.new(
base_sha: base_commit_sha,
start_sha: start_commit_sha,
head_sha: head_commit_sha
)
end
|
#diff_refs=(new_diff_refs) ⇒ Object
296
297
298
299
300
|
# File 'app/models/merge_request_diff.rb', line 296
def diff_refs=(new_diff_refs)
self.base_commit_sha = new_diff_refs&.base_sha
self.start_commit_sha = new_diff_refs&.start_sha
self.head_commit_sha = new_diff_refs&.head_sha
end
|
#diff_refs_by_sha? ⇒ Boolean
335
336
337
|
# File 'app/models/merge_request_diff.rb', line 335
def diff_refs_by_sha?
base_commit_sha? && head_commit_sha? && start_commit_sha?
end
|
#diffs(diff_options = nil) ⇒ Object
349
350
351
352
353
354
355
356
357
358
359
360
|
# File 'app/models/merge_request_diff.rb', line 349
def diffs(diff_options = nil)
fetching_repository_diffs(diff_options) do |comparison|
if comparison
comparison.diffs(diff_options)
else
diffs_collection(diff_options)
end
end
end
|
#diffs_collection(diff_options = nil) ⇒ Object
Should always return the DB persisted diffs collection (e.g. Gitlab::Diff::FileCollection::MergeRequestDiff. It's useful when trying to invalidate old caches through FileCollection::MergeRequestDiff#clear_cache!
#diffs_in_batch(batch_page, batch_size, diff_options:) ⇒ Object
339
340
341
342
343
344
345
346
347
|
# File 'app/models/merge_request_diff.rb', line 339
def diffs_in_batch(batch_page, batch_size, diff_options:)
fetching_repository_diffs(diff_options) do |comparison|
if comparison
comparison.diffs_in_batch(batch_page, batch_size, diff_options: diff_options)
else
diffs_in_batch_collection(batch_page, batch_size, diff_options: diff_options)
end
end
end
|
#ensure_commit_shas ⇒ Object
193
194
195
196
197
|
# File 'app/models/merge_request_diff.rb', line 193
def ensure_commit_shas
self.start_commit_sha ||= merge_request.target_branch_sha
self.head_commit_sha ||= merge_request.source_branch_sha
self.base_commit_sha ||= find_base_sha
end
|
#fallback_diff_refs ⇒ Object
MRs created before 8.4 don't store their true diff refs (start and base), but we need to get a commit SHA for the “View file @ …” link by a file, so we use an approximation of the diff refs if we can't get the actual one.
These will not be the actual diff refs if the target branch was merged into the source branch after the merge request was created, but it is good enough for the specific purpose of linking to a commit.
It is not good enough for highlighting diffs, so we can't simply pass these as `diff_refs.`
322
323
324
325
326
327
328
329
330
331
332
333
|
# File 'app/models/merge_request_diff.rb', line 322
def fallback_diff_refs
real_refs = diff_refs
return real_refs if real_refs
likely_base_commit_sha = (first_commit&.parent || first_commit)&.sha
Gitlab::Diff::DiffRefs.new(
base_sha: likely_base_commit_sha,
start_sha: safe_start_commit_sha,
head_sha: head_commit_sha
)
end
|
#files_count ⇒ Object
209
210
211
212
213
214
215
216
217
218
|
# File 'app/models/merge_request_diff.rb', line 209
def files_count
db_value = read_attribute(:files_count)
case db_value
when nil, FILES_COUNT_SENTINEL
merge_request_diff_files.count
else
db_value
end
end
|
#first_commit ⇒ Object
256
257
258
|
# File 'app/models/merge_request_diff.rb', line 256
def first_commit
commits.last
end
|
#head_commit ⇒ Object
276
277
278
279
280
|
# File 'app/models/merge_request_diff.rb', line 276
def head_commit
return unless head_commit_sha
project.commit_by(oid: head_commit_sha)
end
|
#head_commit_sha ⇒ Object
Override head_commit_sha to keep compatibility with merge request diff created before version 8.4 that does not store head_commit_sha in separate db field.
201
202
203
204
205
206
207
|
# File 'app/models/merge_request_diff.rb', line 201
def head_commit_sha
if persisted? && super.nil?
last_commit_sha
else
super
end
end
|
#includes_any_commits?(shas) ⇒ Boolean
286
287
288
289
290
291
292
293
294
|
# File 'app/models/merge_request_diff.rb', line 286
def includes_any_commits?(shas)
return false if shas.blank?
shas.each_slice(BATCH_SIZE).any? do |batched_shas|
merge_request_diff_commits.where(sha: batched_shas).exists?
end
end
|
#last_commit ⇒ Object
260
261
262
|
# File 'app/models/merge_request_diff.rb', line 260
def last_commit
commits.first
end
|
#last_commit_sha ⇒ Object
252
253
254
|
# File 'app/models/merge_request_diff.rb', line 252
def last_commit_sha
commit_shas(limit: 1).first
end
|
#latest? ⇒ Boolean
383
384
385
|
# File 'app/models/merge_request_diff.rb', line 383
def latest?
self.id == merge_request.latest_merge_request_diff_id
end
|
#lines_count ⇒ Object
231
232
233
234
235
|
# File 'app/models/merge_request_diff.rb', line 231
def lines_count
strong_memoize(:lines_count) do
raw_diffs(limits: false).line_count
end
end
|
#migrate_files_to_database! ⇒ Object
Transactionally migrate the current merge_request_diff_files entries from external storage, back to the database. This is the rollback operation for migrate_files_to_external_storage!
If this diff isn't in external storage, the method is a no-op.
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
|
# File 'app/models/merge_request_diff.rb', line 465
def migrate_files_to_database!
return unless stored_externally?
return if files_count == 0
rows = convert_external_diffs_to_database
transaction do
MergeRequestDiffFile.where(merge_request_diff_id: id).delete_all
Gitlab::Database.bulk_insert('merge_request_diff_files', rows) update!(stored_externally: false)
end
remove_external_diff!
merge_request_diff_files.reset
end
|
#migrate_files_to_external_storage! ⇒ Object
Transactionally migrate the current merge_request_diff_files entries to external storage. If external storage isn't an option for this diff, the method is a no-op.
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
|
# File 'app/models/merge_request_diff.rb', line 440
def migrate_files_to_external_storage!
return if stored_externally? || !use_external_diff? || files_count == 0
rows = build_merge_request_diff_files(merge_request_diff_files)
rows = build_external_merge_request_diff_files(rows)
self.external_diff.store!
transaction do
MergeRequestDiffFile.where(merge_request_diff_id: id).delete_all
Gitlab::Database.bulk_insert('merge_request_diff_files', rows) save!
end
merge_request_diff_files.reset
end
|
#modified_paths(fallback_on_overflow: false) ⇒ Object
rubocop: enable CodeReuse/ServiceClass
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
|
# File 'app/models/merge_request_diff.rb', line 396
def modified_paths(fallback_on_overflow: false)
if fallback_on_overflow && overflow?
strong_memoize(:overflowed_modified_paths) do
project.repository.diff_stats(
base_commit_sha,
head_commit_sha
).paths
end
else
strong_memoize(:modified_paths) do
merge_request_diff_files.pluck(:new_path, :old_path).flatten.uniq
end
end
end
|
#opening_external_diff ⇒ Object
If enabled, yields the external file containing the diff. Otherwise, yields nil. This method is not thread-safe, but it is re-entrant, which allows multiple merge_request_diff_files to load their data efficiently
424
425
426
427
428
429
430
431
432
433
434
435
|
# File 'app/models/merge_request_diff.rb', line 424
def opening_external_diff
return yield(nil) unless stored_externally?
return yield(@external_diff_file) if @external_diff_file
external_diff.open do |file|
@external_diff_file = file
yield(@external_diff_file)
ensure
@external_diff_file = nil
end
end
|
#project ⇒ Object
370
371
372
|
# File 'app/models/merge_request_diff.rb', line 370
def project
merge_request.target_project
end
|
#raw_diffs(options = {}) ⇒ Object
237
238
239
240
241
242
243
244
|
# File 'app/models/merge_request_diff.rb', line 237
def raw_diffs(options = {})
if options[:ignore_whitespace_change]
@diffs_no_whitespace ||= compare.diffs(options)
else
@raw_diffs ||= {}
@raw_diffs[options] ||= load_diffs(options)
end
end
|
#safe_start_commit_sha ⇒ Object
This method will rely on repository branch sha in case start_commit_sha is nil. Its necesarry for old merge request diff created before version 8.4 to work
223
224
225
|
# File 'app/models/merge_request_diff.rb', line 223
def safe_start_commit_sha
start_commit_sha || merge_request.target_branch_sha
end
|
#save_git_content ⇒ Object
Collect information about commits and diff from repository and save it to the database as serialized data
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
# File 'app/models/merge_request_diff.rb', line 172
def save_git_content
ensure_commit_shas
save_commits
save_diffs
save
reset
keep_around_commits unless importing?
end
|
#set_as_latest_diff ⇒ Object
187
188
189
190
191
|
# File 'app/models/merge_request_diff.rb', line 187
def set_as_latest_diff
MergeRequest
.where('id = ? AND COALESCE(latest_merge_request_diff_id, 0) < ?', self.merge_request_id, self.id)
.update_all(latest_merge_request_diff_id: self.id)
end
|
#size ⇒ Object
227
228
229
|
# File 'app/models/merge_request_diff.rb', line 227
def size
real_size.presence || raw_diffs.size
end
|
#start_commit ⇒ Object
270
271
272
273
274
|
# File 'app/models/merge_request_diff.rb', line 270
def start_commit
return unless start_commit_sha
project.commit_by(oid: start_commit_sha)
end
|
#update_external_diff_store ⇒ Object
415
416
417
418
419
|
# File 'app/models/merge_request_diff.rb', line 415
def update_external_diff_store
return unless saved_change_to_external_diff? || saved_change_to_stored_externally?
update_column(:external_diff_store, external_diff.object_store)
end
|
#viewable? ⇒ Boolean
166
167
168
|
# File 'app/models/merge_request_diff.rb', line 166
def viewable?
collected? || without_files? || overflow?
end
|