commit.rb 14.7 KB
Newer Older
Robert Speicher's avatar
Robert Speicher committed
1 2 3 4
# Gitlab::Git::Commit is a wrapper around native Rugged::Commit object
module Gitlab
  module Git
    class Commit
5
      include Gitlab::EncodingHelper
Robert Speicher's avatar
Robert Speicher committed
6

7
      attr_accessor :raw_commit, :head
Robert Speicher's avatar
Robert Speicher committed
8

9
      MIN_SHA_LENGTH = 7
Robert Speicher's avatar
Robert Speicher committed
10 11 12 13 14 15 16 17
      SERIALIZE_KEYS = [
        :id, :message, :parent_ids,
        :authored_date, :author_name, :author_email,
        :committed_date, :committer_name, :committer_email
      ].freeze

      attr_accessor *SERIALIZE_KEYS # rubocop:disable Lint/AmbiguousOperator

18
      delegate :tree, to: :rugged_commit
Douwe Maan's avatar
Douwe Maan committed
19

Robert Speicher's avatar
Robert Speicher committed
20 21 22
      def ==(other)
        return false unless other.is_a?(Gitlab::Git::Commit)

23
        id && id == other.id
Robert Speicher's avatar
Robert Speicher committed
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
      end

      class << self
        # Get commits collection
        #
        # Ex.
        #   Commit.where(
        #     repo: repo,
        #     ref: 'master',
        #     path: 'app/models',
        #     limit: 10,
        #     offset: 5,
        #   )
        #
        def where(options)
          repo = options.delete(:repo)
          raise 'Gitlab::Git::Repository is required' unless repo.respond_to?(:log)

42
          repo.log(options)
Robert Speicher's avatar
Robert Speicher committed
43 44 45 46 47 48 49 50 51
        end

        # Get single commit
        #
        # Ex.
        #   Commit.find(repo, '29eda46b')
        #
        #   Commit.find(repo, 'master')
        #
52
        # Gitaly migration: https://gitlab.com/gitlab-org/gitaly/issues/321
Robert Speicher's avatar
Robert Speicher committed
53
        def find(repo, commit_id = "HEAD")
54
          # Already a commit?
55
          return commit_id if commit_id.is_a?(Gitlab::Git::Commit)
56 57 58

          # A rugged reference?
          commit_id = Gitlab::Git::Ref.dereference_object(commit_id)
59
          return decorate(repo, commit_id) if commit_id.is_a?(Rugged::Commit)
Robert Speicher's avatar
Robert Speicher committed
60

61 62 63 64 65 66 67 68
          # Some weird thing?
          return nil unless commit_id.is_a?(String)

          commit = repo.gitaly_migrate(:find_commit) do |is_enabled|
            if is_enabled
              repo.gitaly_commit_client.find_commit(commit_id)
            else
              obj = repo.rev_parse_target(commit_id)
Robert Speicher's avatar
Robert Speicher committed
69

70 71 72
              obj.is_a?(Rugged::Commit) ? obj : nil
            end
          end
Robert Speicher's avatar
Robert Speicher committed
73

74 75
          decorate(repo, commit) if commit
        rescue Rugged::ReferenceError, Rugged::InvalidError, Rugged::ObjectError,
76
               Gitlab::Git::CommandError, Gitlab::Git::Repository::NoRepository,
77
               Rugged::OdbError, Rugged::TreeError, ArgumentError
Robert Speicher's avatar
Robert Speicher committed
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
          nil
        end

        # Get last commit for HEAD
        #
        # Ex.
        #   Commit.last(repo)
        #
        def last(repo)
          find(repo)
        end

        # Get last commit for specified path and ref
        #
        # Ex.
        #   Commit.last_for_path(repo, '29eda46b', 'app/models')
        #
        #   Commit.last_for_path(repo, 'master', 'Gemfile')
        #
        def last_for_path(repo, ref, path = nil)
          where(
            repo: repo,
            ref: ref,
            path: path,
            limit: 1
          ).first
        end

        # Get commits between two revspecs
        # See also #repository.commits_between
        #
        # Ex.
        #   Commit.between(repo, '29eda46b', 'master')
        #
        def between(repo, base, head)
113
          Gitlab::GitalyClient.migrate(:commits_between) do |is_enabled|
114 115 116
            if is_enabled
              repo.gitaly_commit_client.between(base, head)
            else
117
              repo.rugged_commits_between(base, head).map { |c| decorate(repo, c) }
118 119
            end
          end
Robert Speicher's avatar
Robert Speicher committed
120 121 122 123
        rescue Rugged::ReferenceError
          []
        end

124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
        # Returns commits collection
        #
        # Ex.
        #   Commit.find_all(
        #     repo,
        #     ref: 'master',
        #     max_count: 10,
        #     skip: 5,
        #     order: :date
        #   )
        #
        #   +options+ is a Hash of optional arguments to git
        #     :ref is the ref from which to begin (SHA1 or name)
        #     :max_count is the maximum number of commits to fetch
        #     :skip is the number of commits to skip
        #     :order is the commits order and allowed value is :none (default), :date,
        #        :topo, or any combination of them (in an array). Commit ordering types
        #        are documented here:
        #        http://www.rubydoc.info/github/libgit2/rugged/Rugged#SORT_NONE-constant)
        #
144
        # Gitaly migration: https://gitlab.com/gitlab-org/gitaly/issues/326
Robert Speicher's avatar
Robert Speicher committed
145
        def find_all(repo, options = {})
146 147 148 149 150 151 152 153 154 155
          Gitlab::GitalyClient.migrate(:find_all_commits) do |is_enabled|
            if is_enabled
              find_all_by_gitaly(repo, options)
            else
              find_all_by_rugged(repo, options)
            end
          end
        end

        def find_all_by_rugged(repo, options = {})
156 157
          actual_options = options.dup

158
          allowed_options = [:ref, :max_count, :skip, :order]
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

          actual_options.keep_if do |key|
            allowed_options.include?(key)
          end

          default_options = { skip: 0 }
          actual_options = default_options.merge(actual_options)

          rugged = repo.rugged
          walker = Rugged::Walker.new(rugged)

          if actual_options[:ref]
            walker.push(rugged.rev_parse_oid(actual_options[:ref]))
          else
            rugged.references.each("refs/heads/*") do |ref|
              walker.push(ref.target_id)
            end
          end

          walker.sorting(rugged_sort_type(actual_options[:order]))

          commits = []
          offset = actual_options[:skip]
          limit = actual_options[:max_count]
          walker.each(offset: offset, limit: limit) do |commit|
184
            commits.push(decorate(repo, commit))
185 186 187 188 189 190 191
          end

          walker.reset

          commits
        rescue Rugged::OdbError
          []
Robert Speicher's avatar
Robert Speicher committed
192 193
        end

194 195 196 197
        def find_all_by_gitaly(repo, options = {})
          Gitlab::GitalyClient::CommitService.new(repo).find_all_commits(options)
        end

198 199
        def decorate(repository, commit, ref = nil)
          Gitlab::Git::Commit.new(repository, commit, ref)
Robert Speicher's avatar
Robert Speicher committed
200 201
        end

202 203 204 205 206 207 208 209 210 211 212 213 214
        # Returns the `Rugged` sorting type constant for one or more given
        # sort types. Valid keys are `:none`, `:topo`, and `:date`, or an array
        # containing more than one of them. `:date` uses a combination of date and
        # topological sorting to closer mimic git's native ordering.
        def rugged_sort_type(sort_type)
          @rugged_sort_types ||= {
            none: Rugged::SORT_NONE,
            topo: Rugged::SORT_TOPO,
            date: Rugged::SORT_DATE | Rugged::SORT_TOPO
          }

          @rugged_sort_types.fetch(sort_type, Rugged::SORT_NONE)
        end
215 216

        def shas_with_signatures(repository, shas)
217 218 219 220 221 222 223 224 225 226 227
          GitalyClient.migrate(:filter_shas_with_signatures) do |is_enabled|
            if is_enabled
              Gitlab::GitalyClient::CommitService.new(repository).filter_shas_with_signatures(shas)
            else
              shas.select do |sha|
                begin
                  Rugged::Commit.extract_signature(repository.rugged, sha)
                rescue Rugged::OdbError
                  false
                end
              end
228 229 230
            end
          end
        end
231 232 233 234 235 236 237 238 239 240 241 242 243

        # Only to be used when the object ids will not necessarily have a
        # relation to each other. The last 10 commits for a branch for example,
        # should go through .where
        def batch_by_oid(repo, oids)
          repo.gitaly_migrate(:list_commits_by_oid) do |is_enabled|
            if is_enabled
              repo.gitaly_commit_client.list_commits_by_oid(oids)
            else
              oids.map { |oid| find(repo, oid) }.compact
            end
          end
        end
Robert Speicher's avatar
Robert Speicher committed
244 245
      end

246
      def initialize(repository, raw_commit, head = nil)
Robert Speicher's avatar
Robert Speicher committed
247 248
        raise "Nil as raw commit passed" unless raw_commit

249 250
        case raw_commit
        when Hash
Robert Speicher's avatar
Robert Speicher committed
251
          init_from_hash(raw_commit)
252
        when Rugged::Commit
Robert Speicher's avatar
Robert Speicher committed
253
          init_from_rugged(raw_commit)
254
        when Gitaly::GitCommit
255
          init_from_gitaly(raw_commit)
Robert Speicher's avatar
Robert Speicher committed
256 257 258 259
        else
          raise "Invalid raw commit type: #{raw_commit.class}"
        end

260
        @repository = repository
Robert Speicher's avatar
Robert Speicher committed
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
        @head = head
      end

      def sha
        id
      end

      def short_id(length = 10)
        id.to_s[0..length]
      end

      def safe_message
        @safe_message ||= message
      end

      def created_at
        committed_date
      end

      # Was this commit committed by a different person than the original author?
      def different_committer?
        author_name != committer_name || author_email != committer_email
      end

      def parent_id
        parent_ids.first
      end

      # Shows the diff between the commit's parent and the commit.
      #
      # Cuts out the header and stats from #to_patch and returns only the diff.
292 293
      #
      # Gitaly migration: https://gitlab.com/gitlab-org/gitaly/issues/324
294
      def to_diff
295 296 297 298 299 300 301
        Gitlab::GitalyClient.migrate(:commit_patch) do |is_enabled|
          if is_enabled
            @repository.gitaly_commit_client.patch(id)
          else
            rugged_diff_from_parent.patch
          end
        end
Robert Speicher's avatar
Robert Speicher committed
302 303 304 305
      end

      # Returns a diff object for the changes from this commit's first parent.
      # If there is no parent, then the diff is between this commit and an
306
      # empty repo. See Repository#diff for keys allowed in the +options+
Robert Speicher's avatar
Robert Speicher committed
307 308
      # hash.
      def diff_from_parent(options = {})
309 310 311 312 313 314 315 316 317 318 319 320 321 322
        Gitlab::GitalyClient.migrate(:commit_raw_diffs) do |is_enabled|
          if is_enabled
            @repository.gitaly_commit_client.diff_from_parent(self, options)
          else
            rugged_diff_from_parent(options)
          end
        end
      end

      def rugged_diff_from_parent(options = {})
        options ||= {}
        break_rewrites = options[:break_rewrites]
        actual_options = Gitlab::Git::Diff.filter_diff_options(options)

323 324 325 326 327
        diff = if rugged_commit.parents.empty?
                 rugged_commit.diff(actual_options.merge(reverse: true))
               else
                 rugged_commit.parents[0].diff(rugged_commit, actual_options)
               end
328 329 330

        diff.find_similar!(break_rewrites: break_rewrites)
        diff
Robert Speicher's avatar
Robert Speicher committed
331 332
      end

333
      def deltas
334 335 336 337 338 339 340 341 342 343 344
        @deltas ||= begin
          deltas = Gitlab::GitalyClient.migrate(:commit_deltas) do |is_enabled|
            if is_enabled
              @repository.gitaly_commit_client.commit_deltas(self)
            else
              rugged_diff_from_parent.each_delta
            end
          end

          deltas.map { |delta| Gitlab::Git::Diff.new(delta) }
        end
345 346
      end

Robert Speicher's avatar
Robert Speicher committed
347 348 349 350 351 352 353 354 355 356 357 358
      def has_zero_stats?
        stats.total.zero?
      rescue
        true
      end

      def no_commit_message
        "--no commit message"
      end

      def to_hash
        serialize_keys.map.with_object({}) do |key, hash|
359
          hash[key] = send(key) # rubocop:disable GitlabSecurity/PublicSend
Robert Speicher's avatar
Robert Speicher committed
360 361 362 363 364 365 366 367
        end
      end

      def date
        committed_date
      end

      def diffs(options = {})
368
        Gitlab::Git::DiffCollection.new(diff_from_parent(options), options)
Robert Speicher's avatar
Robert Speicher committed
369 370 371
      end

      def parents
372
        parent_ids.map { |oid| self.class.find(@repository, oid) }.compact
Robert Speicher's avatar
Robert Speicher committed
373 374 375
      end

      def stats
376
        Gitlab::Git::CommitStats.new(@repository, self)
Robert Speicher's avatar
Robert Speicher committed
377 378 379 380
      end

      def to_patch(options = {})
        begin
381
          rugged_commit.to_mbox(options)
Robert Speicher's avatar
Robert Speicher committed
382
        rescue Rugged::InvalidError => ex
Alexis Reigel's avatar
Alexis Reigel committed
383
          if ex.message =~ /commit \w+ is a merge commit/i
Robert Speicher's avatar
Robert Speicher committed
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
            'Patch format is not currently supported for merge commits.'
          end
        end
      end

      # Get a collection of Rugged::Reference objects for this commit.
      #
      # Ex.
      #   commit.ref(repo)
      #
      def refs(repo)
        repo.refs_hash[id]
      end

      # Get ref names collection
      #
      # Ex.
      #   commit.ref_names(repo)
      #
      def ref_names(repo)
        refs(repo).map do |ref|
          ref.name.sub(%r{^refs/(heads|remotes|tags)/}, "")
        end
      end

      def message
        encode! @message
      end

      def author_name
        encode! @author_name
      end

      def author_email
        encode! @author_email
      end

      def committer_name
        encode! @committer_name
      end

      def committer_email
        encode! @committer_email
      end

429 430 431 432 433 434 435 436
      def rugged_commit
        @rugged_commit ||= if raw_commit.is_a?(Rugged::Commit)
                             raw_commit
                           else
                             @repository.rev_parse_target(id)
                           end
      end

437 438 439 440
      def merge_commit?
        parent_ids.size > 1
      end

441 442 443 444 445 446 447 448 449 450 451 452 453 454
      def to_gitaly_commit
        return raw_commit if raw_commit.is_a?(Gitaly::GitCommit)

        message_split = raw_commit.message.split("\n", 2)
        Gitaly::GitCommit.new(
          id: raw_commit.oid,
          subject: message_split[0] ? message_split[0].chomp.b : "",
          body: raw_commit.message.b,
          parent_ids: raw_commit.parent_ids,
          author: gitaly_commit_author_from_rugged(raw_commit.author),
          committer: gitaly_commit_author_from_rugged(raw_commit.committer)
        )
      end

Robert Speicher's avatar
Robert Speicher committed
455 456 457 458 459 460
      private

      def init_from_hash(hash)
        raw_commit = hash.symbolize_keys

        serialize_keys.each do |key|
461
          send("#{key}=", raw_commit[key]) # rubocop:disable GitlabSecurity/PublicSend
Robert Speicher's avatar
Robert Speicher committed
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
        end
      end

      def init_from_rugged(commit)
        author = commit.author
        committer = commit.committer

        @raw_commit = commit
        @id = commit.oid
        @message = commit.message
        @authored_date = author[:time]
        @committed_date = committer[:time]
        @author_name = author[:name]
        @author_email = author[:email]
        @committer_name = committer[:name]
        @committer_email = committer[:email]
        @parent_ids = commit.parents.map(&:oid)
      end

481 482 483 484 485 486
      def init_from_gitaly(commit)
        @raw_commit = commit
        @id = commit.id
        # TODO: Once gitaly "takes over" Rugged consider separating the
        # subject from the message to make it clearer when there's one
        # available but not the other.
487
        @message = (commit.body.presence || commit.subject).dup
488
        @authored_date = Time.at(commit.author.date.seconds).utc
489 490
        @author_name = commit.author.name.dup
        @author_email = commit.author.email.dup
491
        @committed_date = Time.at(commit.committer.date.seconds).utc
492 493 494 495 496
        @committer_name = commit.committer.name.dup
        @committer_email = commit.committer.email.dup
        @parent_ids = commit.parent_ids
      end

Robert Speicher's avatar
Robert Speicher committed
497 498 499
      def serialize_keys
        SERIALIZE_KEYS
      end
500 501 502 503 504 505 506 507

      def gitaly_commit_author_from_rugged(author_or_committer)
        Gitaly::CommitAuthor.new(
          name: author_or_committer[:name].b,
          email: author_or_committer[:email].b,
          date: Google::Protobuf::Timestamp.new(seconds: author_or_committer[:time].to_i)
        )
      end
Robert Speicher's avatar
Robert Speicher committed
508 509 510
    end
  end
end