diff_note.rb 3.2 KB
Newer Older
D
Douwe Maan 已提交
1
# A note on merge request or commit diffs
D
Douwe Maan 已提交
2 3 4
class DiffNote < Note
  include NoteOnDiff

D
Douwe Maan 已提交
5 6
  NOTEABLE_TYPES = %w(MergeRequest Commit).freeze

D
Douwe Maan 已提交
7 8 9 10 11 12 13
  serialize :original_position, Gitlab::Diff::Position
  serialize :position, Gitlab::Diff::Position

  validates :original_position, presence: true
  validates :position, presence: true
  validates :diff_line, presence: true
  validates :line_code, presence: true, line_code: true
D
Douwe Maan 已提交
14
  validates :noteable_type, inclusion: { in: NOTEABLE_TYPES }
D
Douwe Maan 已提交
15 16 17
  validate :positions_complete
  validate :verify_supported

18
  before_validation :set_original_position, :update_position, on: :create
19
  before_validation :set_line_code
20
  after_save :keep_around_commits
D
Douwe Maan 已提交
21

22 23 24 25
  def discussion_class(*)
    DiffDiscussion
  end

26 27
  %i(original_position position).each do |meth|
    define_method "#{meth}=" do |new_position|
28 29 30
      if new_position.is_a?(String)
        new_position = JSON.parse(new_position) rescue nil
      end
D
Douwe Maan 已提交
31

32 33 34 35
      if new_position.is_a?(Hash)
        new_position = new_position.with_indifferent_access
        new_position = Gitlab::Diff::Position.new(new_position)
      end
D
Douwe Maan 已提交
36

37 38
      super(new_position)
    end
D
Douwe Maan 已提交
39 40 41 42 43 44 45 46 47 48 49 50 51 52
  end

  def diff_file
    @diff_file ||= self.original_position.diff_file(self.project.repository)
  end

  def diff_line
    @diff_line ||= diff_file.line_for_position(self.original_position) if diff_file
  end

  def for_line?(line)
    diff_file.position(line) == self.original_position
  end

53 54 55 56
  def original_line_code
    self.diff_file.line_code(self.diff_line)
  end

D
Douwe Maan 已提交
57 58 59 60
  def active?(diff_refs = nil)
    return false unless supported?
    return true if for_commit?

61
    diff_refs ||= noteable_diff_refs
D
Douwe Maan 已提交
62 63 64 65

    self.position.diff_refs == diff_refs
  end

66 67 68
  private

  def supported?
C
Connor Shea 已提交
69
    for_commit? || self.noteable.has_complete_diff_refs?
70 71
  end

72 73 74 75 76 77 78 79
  def noteable_diff_refs
    if noteable.respond_to?(:diff_sha_refs)
      noteable.diff_sha_refs
    else
      noteable.diff_refs
    end
  end

80
  def set_original_position
81
    self.original_position = self.position.dup unless self.original_position&.complete?
82 83 84 85 86 87
  end

  def set_line_code
    self.line_code = self.position.line_code(self.project.repository)
  end

88 89 90 91 92 93 94 95 96 97
  def update_position
    return unless supported?
    return if for_commit?

    return if active?

    Notes::DiffPositionUpdateService.new(
      self.project,
      nil,
      old_diff_refs: self.position.diff_refs,
98
      new_diff_refs: noteable_diff_refs,
99 100 101 102
      paths: self.position.paths
    ).execute(self)
  end

D
Douwe Maan 已提交
103 104 105 106 107 108 109 110 111 112 113
  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?

    errors.add(:position, "is invalid")
  end
114 115 116 117 118 119 120 121 122 123 124 125

  def keep_around_commits
    project.repository.keep_around(self.original_position.base_sha)
    project.repository.keep_around(self.original_position.start_sha)
    project.repository.keep_around(self.original_position.head_sha)

    if self.position != self.original_position
      project.repository.keep_around(self.position.base_sha)
      project.repository.keep_around(self.position.start_sha)
      project.repository.keep_around(self.position.head_sha)
    end
  end
D
Douwe Maan 已提交
126
end