merge_request_diff.rb 7.88 KB
Newer Older
1
class MergeRequestDiff < ActiveRecord::Base
2
  include Sortable
3
  include Importable
James Lopez's avatar
James Lopez committed
4
  include EncodingHelper
5

6
  # Prevent store of diff if commits amount more then 500
7
  COMMITS_SAFE_SIZE = 100
8

9 10 11
  # Valid types of serialized diffs allowed by Gitlab::Git::Diff
  VALID_CLASSES = [Hash, Rugged::Patch, Rugged::Diff::Delta]

12 13 14 15
  belongs_to :merge_request

  state_machine :state, initial: :empty do
    state :collected
16 17 18
    state :overflow
    # Deprecated states: these are no longer used but these values may still occur
    # in the database.
19 20 21 22 23 24 25 26 27
    state :timeout
    state :overflow_commits_safe_size
    state :overflow_diff_files_limit
    state :overflow_diff_lines_limit
  end

  serialize :st_commits
  serialize :st_diffs

28 29
  # All diff information is collected from repository after object is created.
  # It allows you to override variables like head_commit_sha before getting diff.
30
  after_create :save_git_content, unless: :importing?
31

32 33 34 35
  def self.select_without_diff
    select(column_names - ['st_diffs'])
  end

36 37 38 39
  def st_commits
    super || []
  end

40 41 42
  # Collect information about commits and diff from repository
  # and save it to the database as serialized data
  def save_git_content
43
    ensure_commits_sha
44
    save_commits
45
    reload_commits
46
    save_diffs
47 48 49 50
    keep_around_commits
  end

  def ensure_commits_sha
51
    merge_request.fetch_ref
52
    self.start_commit_sha ||= merge_request.target_branch_sha
53
    self.head_commit_sha  ||= merge_request.source_branch_sha
54
    self.base_commit_sha  ||= find_base_sha
55 56 57 58 59 60 61 62 63 64 65
    save
  end

  # 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.
  def head_commit_sha
    if persisted? && super.nil?
      last_commit.try(:sha)
    else
      super
    end
66 67
  end

68 69 70 71 72 73 74
  # 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
  def safe_start_commit_sha
    start_commit_sha || merge_request.target_branch_sha
  end

75
  def size
76
    real_size.presence || raw_diffs.size
77 78
  end

79
  def raw_diffs(options = {})
80
    if options[:ignore_whitespace_change]
81
      @diffs_no_whitespace ||=
82 83 84
        Gitlab::Git::Compare.new(
          repository.raw_repository,
          safe_start_commit_sha,
85
          head_commit_sha).diffs(options)
86
    else
87 88
      @raw_diffs ||= {}
      @raw_diffs[options] ||= load_diffs(st_diffs, options)
89
    end
90 91
  end

92
  def commits
93
    @commits ||= load_commits(st_commits)
94 95
  end

96 97 98 99 100
  def reload_commits
    @commits = nil
    commits
  end

101 102 103 104
  def last_commit
    commits.first
  end

105 106 107 108
  def first_commit
    commits.last
  end

109
  def base_commit
110
    return unless base_commit_sha
111

112
    project.commit(base_commit_sha)
113 114
  end

115
  def start_commit
116
    return unless start_commit_sha
117

118
    project.commit(start_commit_sha)
119 120 121
  end

  def head_commit
122
    return unless head_commit_sha
123

124
    project.commit(head_commit_sha)
125 126
  end

127 128 129
  def commits_sha
    if @commits
      commits.map(&:sha)
130
    else
131
      st_commits.map { |commit| commit[:id] }
132 133 134
    end
  end

135
  def diff_refs
136
    return unless start_commit_sha || base_commit_sha
137 138 139 140 141 142 143 144

    Gitlab::Diff::DiffRefs.new(
      base_sha:  base_commit_sha,
      start_sha: start_commit_sha,
      head_sha:  head_commit_sha
    )
  end

145 146 147 148
  def diff_refs_by_sha?
    base_commit_sha? && head_commit_sha? && start_commit_sha?
  end

149 150 151 152 153 154 155
  def diffs(diff_options = nil)
    Gitlab::Diff::FileCollection::MergeRequestDiff.new(self, diff_options: diff_options)
  end

  def project
    merge_request.target_project
  end
156

157 158
  def compare
    @compare ||=
159 160 161 162 163
      Gitlab::Git::Compare.new(
        repository.raw_repository,
        safe_start_commit_sha,
        head_commit_sha
      )
164 165
  end

166 167 168 169
  def latest?
    self == merge_request.merge_request_diff
  end

170 171 172 173 174
  def compare_with(sha, straight = true)
    # When compare merge request versions we want diff A..B instead of A...B
    # so we handle cases when user squash and rebase commits in one of versions.
    # For this reason we set straight to true by default.
    CompareService.new.execute(project, head_commit_sha, project, sha, straight)
175 176
  end

177 178
  private

179 180 181 182 183 184 185 186 187
  # Old GitLab implementations may have generated diffs as ["--broken-diff"].
  # Avoid an error 500 by ignoring bad elements. See:
  # https://gitlab.com/gitlab-org/gitlab-ce/issues/20776
  def valid_raw_diff?(raw)
    return false unless raw.respond_to?(:each)

    raw.any? { |element| VALID_CLASSES.include?(element.class) }
  end

188 189 190 191 192 193 194 195
  def dump_commits(commits)
    commits.map(&:to_hash)
  end

  def load_commits(array)
    array.map { |hash| Commit.new(Gitlab::Git::Commit.new(hash), merge_request.source_project) }
  end

196
  # Load all commits related to current merge request diff from repo
197
  # and save it as array of hashes in st_commits db field
198
  def save_commits
199 200
    new_attributes = {}

201
    commits = compare.commits
202

203 204 205
    if commits.present?
      commits = Commit.decorate(commits, merge_request.source_project).reverse
      new_attributes[:st_commits] = dump_commits(commits)
206 207
    end

208
    update_columns_serialized(new_attributes)
209 210
  end

211 212 213 214 215 216 217
  def dump_diffs(diffs)
    if diffs.respond_to?(:map)
      diffs.map(&:to_hash)
    end
  end

  def load_diffs(raw, options)
218
    if valid_raw_diff?(raw)
219
      if paths = options[:paths]
220
        raw = raw.select do |diff|
221
          paths.include?(diff[:old_path]) || paths.include?(diff[:new_path])
222 223 224
        end
      end

225 226 227 228 229 230
      Gitlab::Git::DiffCollection.new(raw, options)
    else
      Gitlab::Git::DiffCollection.new([])
    end
  end

231
  # Load diffs between branches related to current merge request diff from repo
232
  # and save it as array of hashes in st_diffs db field
233
  def save_diffs
234
    new_attributes = {}
235 236 237
    new_diffs = []

    if commits.size.zero?
238
      new_attributes[:state] = :empty
239
    else
240
      diff_collection = compare.diffs(Commit.max_diff_options)
241

242 243 244
      if diff_collection.overflow?
        # Set our state to 'overflow' to make the #empty? and #collected?
        # methods (generated by StateMachine) return false.
245
        new_attributes[:state] = :overflow
246 247
      end

248
      new_attributes[:real_size] = diff_collection.real_size
249

250 251
      if diff_collection.any?
        new_diffs = dump_diffs(diff_collection)
252
        new_attributes[:state] = :collected
253
      end
254
    end
255

256 257
    new_attributes[:st_diffs] = new_diffs
    update_columns_serialized(new_attributes)
258 259 260
  end

  def repository
261
    project.repository
262
  end
263

264 265
  def find_base_sha
    return unless head_commit_sha && start_commit_sha
266

267
    project.merge_base_commit(head_commit_sha, start_commit_sha).try(:sha)
268 269
  end

James Lopez's avatar
James Lopez committed
270 271 272 273 274 275 276 277
  def utf8_st_diffs
    st_diffs.map do |diff|
      diff.each do |k, v|
        diff[k] = encode_utf8(v) if v.respond_to?(:encoding)
      end
    end
  end

278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
  #
  # #save or #update_attributes providing changes on serialized attributes do a lot of
  # serialization and deserialization calls resulting in bad performance.
  # Using #update_columns solves the problem with just one YAML.dump per serialized attribute that we provide.
  # As a tradeoff we need to reload the current instance to properly manage time objects on those serialized
  # attributes. So to keep the same behaviour as the attribute assignment we reload the instance.
  # The difference is in the usage of
  # #write_attribute= (#update_attributes) and #raw_write_attribute= (#update_columns)
  #
  # Ex:
  #
  #   new_attributes[:st_commits].first.slice(:committed_date)
  #   => {:committed_date=>2014-02-27 11:01:38 +0200}
  #   YAML.load(YAML.dump(new_attributes[:st_commits].first.slice(:committed_date)))
  #   => {:committed_date=>2014-02-27 10:01:38 +0100}
  #
  def update_columns_serialized(new_attributes)
    return unless new_attributes.any?

    update_columns(new_attributes.merge(updated_at: current_time_from_proper_timezone))
    reload
  end
300

301
  def keep_around_commits
302 303 304
    repository.keep_around(start_commit_sha)
    repository.keep_around(head_commit_sha)
    repository.keep_around(base_commit_sha)
305
  end
306
end