2018-07-25 09:30:33 +00:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2017-03-31 03:06:09 +00:00
|
|
|
# A note on merge request or commit diffs
|
2017-04-06 15:05:57 +00:00
|
|
|
#
|
|
|
|
# A note of this type can be resolvable.
|
2016-06-20 17:20:39 +00:00
|
|
|
class DiffNote < Note
|
|
|
|
include NoteOnDiff
|
2018-10-04 21:45:00 +00:00
|
|
|
include DiffPositionableNote
|
2018-05-16 15:46:18 +00:00
|
|
|
include Gitlab::Utils::StrongMemoize
|
2016-06-20 17:20:39 +00:00
|
|
|
|
2018-10-26 13:23:58 +00:00
|
|
|
def self.noteable_types
|
|
|
|
%w(MergeRequest Commit)
|
|
|
|
end
|
2017-03-17 19:25:52 +00:00
|
|
|
|
2016-06-20 17:20:39 +00:00
|
|
|
validates :original_position, presence: true
|
|
|
|
validates :position, presence: true
|
2017-10-07 04:25:17 +00:00
|
|
|
validates :line_code, presence: true, line_code: true, if: :on_text?
|
2019-06-03 14:41:05 +00:00
|
|
|
# We need to evaluate the `noteable` types when running the validation since
|
|
|
|
# EE might have added a type when the module was prepended
|
|
|
|
validates :noteable_type, inclusion: { in: -> (_note) { noteable_types } }
|
2016-06-20 17:20:39 +00:00
|
|
|
validate :positions_complete
|
|
|
|
validate :verify_supported
|
|
|
|
|
2019-12-04 15:11:23 +00:00
|
|
|
before_validation :set_line_code, if: :on_text?, unless: :importing?
|
|
|
|
after_save :keep_around_commits, unless: :importing?
|
2019-12-18 12:07:48 +00:00
|
|
|
|
|
|
|
NoteDiffFileCreationError = Class.new(StandardError)
|
|
|
|
|
|
|
|
DIFF_LINE_NOT_FOUND_MESSAGE = "Failed to find diff line for: %{file_path}, old_line: %{old_line}, new_line: %{new_line}"
|
|
|
|
DIFF_FILE_NOT_FOUND_MESSAGE = "Failed to find diff file"
|
|
|
|
|
2018-05-16 15:46:18 +00:00
|
|
|
after_commit :create_diff_file, on: :create
|
2016-06-20 17:20:39 +00:00
|
|
|
|
2017-03-10 01:29:11 +00:00
|
|
|
def discussion_class(*)
|
|
|
|
DiffDiscussion
|
|
|
|
end
|
|
|
|
|
2018-05-16 15:46:18 +00:00
|
|
|
def create_diff_file
|
|
|
|
return unless should_create_diff_file?
|
|
|
|
|
|
|
|
diff_file = fetch_diff_file
|
2019-12-18 12:07:48 +00:00
|
|
|
raise NoteDiffFileCreationError, DIFF_FILE_NOT_FOUND_MESSAGE unless diff_file
|
|
|
|
|
2018-05-16 15:46:18 +00:00
|
|
|
diff_line = diff_file.line_for_position(self.original_position)
|
2019-12-18 12:07:48 +00:00
|
|
|
unless diff_line
|
|
|
|
raise NoteDiffFileCreationError, DIFF_LINE_NOT_FOUND_MESSAGE % {
|
|
|
|
file_path: diff_file.file_path,
|
|
|
|
old_line: original_position.old_line,
|
|
|
|
new_line: original_position.new_line
|
|
|
|
}
|
|
|
|
end
|
2018-05-16 15:46:18 +00:00
|
|
|
|
|
|
|
creation_params = diff_file.diff.to_hash
|
|
|
|
.except(:too_large)
|
|
|
|
.merge(diff: diff_file.diff_hunk(diff_line))
|
|
|
|
|
|
|
|
create_note_diff_file(creation_params)
|
|
|
|
end
|
|
|
|
|
2019-02-20 21:20:08 +00:00
|
|
|
# Returns the diff file from `position`
|
|
|
|
def latest_diff_file
|
|
|
|
strong_memoize(:latest_diff_file) do
|
2019-06-03 14:42:49 +00:00
|
|
|
position.diff_file(repository)
|
2019-02-20 21:20:08 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
# Returns the diff file from `original_position`
|
2016-06-20 17:20:39 +00:00
|
|
|
def diff_file
|
2018-05-16 15:46:18 +00:00
|
|
|
strong_memoize(:diff_file) do
|
|
|
|
enqueue_diff_file_creation_job if should_create_diff_file?
|
|
|
|
|
|
|
|
fetch_diff_file
|
|
|
|
end
|
2016-06-20 17:20:39 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def diff_line
|
2017-05-21 20:38:33 +00:00
|
|
|
@diff_line ||= diff_file&.line_for_position(self.original_position)
|
2016-06-20 17:20:39 +00:00
|
|
|
end
|
|
|
|
|
2016-08-19 17:38:40 +00:00
|
|
|
def original_line_code
|
2017-10-07 04:25:17 +00:00
|
|
|
return unless on_text?
|
|
|
|
|
2016-08-19 17:38:40 +00:00
|
|
|
self.diff_file.line_code(self.diff_line)
|
|
|
|
end
|
|
|
|
|
2017-04-30 20:32:09 +00:00
|
|
|
def created_at_diff?(diff_refs)
|
|
|
|
return false unless supported?
|
|
|
|
return true if for_commit?
|
2017-03-31 23:39:14 +00:00
|
|
|
|
2017-04-30 20:32:09 +00:00
|
|
|
self.original_position.diff_refs == diff_refs
|
2017-03-31 23:39:14 +00:00
|
|
|
end
|
|
|
|
|
2019-09-23 18:06:14 +00:00
|
|
|
# Checks if the current `position` line in the diff
|
|
|
|
# exists and is suggestible (not a deletion).
|
|
|
|
#
|
|
|
|
# Avoid using in iterations as it requests Gitaly.
|
2018-12-13 19:17:19 +00:00
|
|
|
def supports_suggestion?
|
2019-02-19 19:29:10 +00:00
|
|
|
return false unless noteable&.supports_suggestion? && on_text?
|
2018-12-13 19:17:19 +00:00
|
|
|
# We don't want to trigger side-effects of `diff_file` call.
|
2019-03-15 17:35:34 +00:00
|
|
|
return false unless file = latest_diff_file
|
|
|
|
return false unless line = file.line_for_position(self.position)
|
2018-12-13 19:17:19 +00:00
|
|
|
|
|
|
|
line&.suggestible?
|
|
|
|
end
|
|
|
|
|
|
|
|
def banzai_render_context(field)
|
2019-06-02 17:23:53 +00:00
|
|
|
super.merge(suggestions_filter_enabled: true)
|
2018-12-13 19:17:19 +00:00
|
|
|
end
|
|
|
|
|
2016-07-07 20:13:55 +00:00
|
|
|
private
|
|
|
|
|
2018-05-16 15:46:18 +00:00
|
|
|
def enqueue_diff_file_creation_job
|
|
|
|
# Avoid enqueuing multiple file creation jobs at once for a note (i.e.
|
|
|
|
# parallel calls to `DiffNote#diff_file`).
|
|
|
|
lease = Gitlab::ExclusiveLease.new("note_diff_file_creation:#{id}", timeout: 1.hour.to_i)
|
|
|
|
return unless lease.try_obtain
|
|
|
|
|
|
|
|
CreateNoteDiffFileWorker.perform_async(id)
|
|
|
|
end
|
|
|
|
|
|
|
|
def should_create_diff_file?
|
2019-11-21 09:06:16 +00:00
|
|
|
on_text? && note_diff_file.nil? && start_of_discussion?
|
2018-05-16 15:46:18 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def fetch_diff_file
|
2019-09-16 15:06:26 +00:00
|
|
|
return note_diff_file.raw_diff_file if note_diff_file
|
|
|
|
|
2019-12-18 12:07:48 +00:00
|
|
|
if created_at_diff?(noteable.diff_refs)
|
|
|
|
# We're able to use the already persisted diffs (Postgres) if we're
|
|
|
|
# presenting a "current version" of the MR discussion diff.
|
|
|
|
# So no need to make an extra Gitaly diff request for it.
|
|
|
|
# As an extra benefit, the returned `diff_file` already
|
|
|
|
# has `highlighted_diff_lines` data set from Redis on
|
|
|
|
# `Diff::FileCollection::MergeRequestDiff`.
|
|
|
|
file = noteable.diffs(original_position.diff_options).diff_files.first
|
|
|
|
# if line is not found in persisted diffs, fallback and retrieve file from repository using gitaly
|
|
|
|
# This is required because of https://gitlab.com/gitlab-org/gitlab/issues/42676
|
|
|
|
file = nil if file&.line_for_position(original_position).nil? && importing?
|
|
|
|
end
|
2018-10-16 16:21:16 +00:00
|
|
|
|
2019-12-18 12:07:48 +00:00
|
|
|
file ||= original_position.diff_file(repository)
|
2019-09-16 15:06:26 +00:00
|
|
|
file&.unfold_diff_lines(position)
|
2018-10-16 16:21:16 +00:00
|
|
|
|
|
|
|
file
|
2018-05-16 15:46:18 +00:00
|
|
|
end
|
|
|
|
|
2016-07-07 20:13:55 +00:00
|
|
|
def supported?
|
2016-08-17 18:29:05 +00:00
|
|
|
for_commit? || self.noteable.has_complete_diff_refs?
|
2016-07-07 20:13:55 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def set_line_code
|
2019-06-03 14:42:49 +00:00
|
|
|
self.line_code = self.position.line_code(repository)
|
2016-07-07 20:13:55 +00:00
|
|
|
end
|
|
|
|
|
2016-06-20 17:20:39 +00:00
|
|
|
def verify_supported
|
|
|
|
return if supported?
|
|
|
|
|
|
|
|
errors.add(:noteable, "doesn't support new-style diff notes")
|
|
|
|
end
|
|
|
|
|
|
|
|
def positions_complete
|
|
|
|
return if self.original_position.complete? && self.position.complete?
|
|
|
|
|
2020-02-17 18:09:00 +00:00
|
|
|
errors.add(:position, "is incomplete")
|
2016-06-20 17:20:39 +00:00
|
|
|
end
|
2016-07-04 16:26:28 +00:00
|
|
|
|
|
|
|
def keep_around_commits
|
2018-08-16 23:55:00 +00:00
|
|
|
shas = [
|
|
|
|
self.original_position.base_sha,
|
|
|
|
self.original_position.start_sha,
|
|
|
|
self.original_position.head_sha
|
|
|
|
]
|
2016-07-04 16:26:28 +00:00
|
|
|
|
|
|
|
if self.position != self.original_position
|
2018-08-16 23:55:00 +00:00
|
|
|
shas << self.position.base_sha
|
|
|
|
shas << self.position.start_sha
|
|
|
|
shas << self.position.head_sha
|
2016-07-04 16:26:28 +00:00
|
|
|
end
|
2018-08-16 23:55:00 +00:00
|
|
|
|
2019-06-03 14:42:49 +00:00
|
|
|
repository.keep_around(*shas)
|
|
|
|
end
|
|
|
|
|
|
|
|
def repository
|
|
|
|
noteable.respond_to?(:repository) ? noteable.repository : project.repository
|
2016-07-04 16:26:28 +00:00
|
|
|
end
|
2016-06-20 17:20:39 +00:00
|
|
|
end
|
2019-09-13 13:26:31 +00:00
|
|
|
|
|
|
|
DiffNote.prepend_if_ee('::EE::DiffNote')
|