git_push_service.rb 4.8 KB
Newer Older
1
class GitPushService
2
  attr_accessor :project, :user, :push_data, :push_commits
3 4 5 6 7 8

  # This method will be called after each git update
  # and only if the provided user and project is present in GitLab.
  #
  # All callbacks for post receive action should be placed here.
  #
9 10 11 12 13 14 15
  # Next, this method:
  #  1. Creates the push event
  #  2. Ensures that the project satellite exists
  #  3. Updates merge requests
  #  4. Recognizes cross-references from commit messages
  #  5. Executes the project's web hooks
  #  6. Executes the project's services
16 17 18 19 20
  #
  def execute(project, user, oldrev, newrev, ref)
    @project, @user = project, user

    project.ensure_satellite_exists
21
    project.repository.expire_cache
22
    project.update_repository_size
23

24
    if push_to_branch?(ref)
D
Dmitriy Zaporozhets 已提交
25
      if push_remove_branch?(ref, newrev)
26
        @push_commits = []
D
Dmitriy Zaporozhets 已提交
27 28 29 30 31
      elsif push_to_new_branch?(ref, oldrev)
        # Re-find the pushed commits.
        if is_default_branch?(ref)
          # Initial push to the default branch. Take the full history of that branch as "newly pushed".
          @push_commits = project.repository.commits(newrev)
32 33
          # Default branch is protected by default
          project.protected_branches.create({ name: project.default_branch })
D
Dmitriy Zaporozhets 已提交
34 35 36 37 38 39 40
        else
          # Use the pushed commits that aren't reachable by the default branch
          # as a heuristic. This may include more commits than are actually pushed, but
          # that shouldn't matter because we check for existing cross-references later.
          @push_commits = project.repository.commits_between(project.default_branch, newrev)
        end
        process_commit_messages(ref)
41 42 43 44 45
      elsif push_to_existing_branch?(ref, oldrev)
        # Collect data for this git push
        @push_commits = project.repository.commits_between(oldrev, newrev)
        project.update_merge_requests(oldrev, newrev, ref, @user)
        process_commit_messages(ref)
46 47
      end

D
Dmitriy Zaporozhets 已提交
48 49 50 51
      @push_data = post_receive_data(oldrev, newrev, ref)
      create_push_event(@push_data)
      project.execute_hooks(@push_data.dup, :push_hooks)
      project.execute_services(@push_data.dup)
52
    end
53 54 55 56
  end

  protected

D
Dmitriy Zaporozhets 已提交
57
  def create_push_event(push_data)
58
    Event.create!(
59 60 61 62 63 64 65
      project: project,
      action: Event::PUSHED,
      data: push_data,
      author_id: push_data[:user_id]
    )
  end

66 67
  # Extract any GFM references from the pushed commit messages. If the configured issue-closing regex is matched,
  # close the referenced Issue. Create cross-reference Notes corresponding to any other referenced Mentionables.
68
  def process_commit_messages(ref)
69 70 71 72 73 74 75 76
    is_default_branch = is_default_branch?(ref)

    @push_commits.each do |commit|
      # Close issues if these commits were pushed to the project's default branch and the commit message matches the
      # closing regex. Exclude any mentioned Issues from cross-referencing even if the commits are being pushed to
      # a different branch.
      issues_to_close = commit.closes_issues(project)

77 78 79 80 81 82 83
      # Load commit author only if needed.
      # For push with 1k commits it prevents 900+ requests in database
      author = nil

      if issues_to_close.present? && is_default_branch
        author ||= commit_user(commit)

84 85 86
        issues_to_close.each do |issue|
          Issues::CloseService.new(project, author, {}).execute(issue, commit)
        end
87 88 89 90 91 92 93
      end

      # Create cross-reference notes for any other references. Omit any issues that were referenced in an
      # issue-closing phrase, or have already been mentioned from this commit (probably from this commit
      # being pushed to a different branch).
      refs = commit.references(project) - issues_to_close
      refs.reject! { |r| commit.has_mentioned?(r) }
94 95 96 97 98 99 100

      if refs.present?
        author ||= commit_user(commit)

        refs.each do |r|
          Note.create_cross_reference_note(r, commit, author, project)
        end
101 102 103 104
      end
    end
  end

105
  def post_receive_data(oldrev, newrev, ref)
106 107
    Gitlab::PushDataBuilder.
      build(project, user, oldrev, newrev, ref, push_commits)
108 109
  end

110
  def push_to_existing_branch?(ref, oldrev)
111 112 113
    ref_parts = ref.split('/')

    # Return if this is not a push to a branch (e.g. new commits)
114
    ref_parts[1].include?('heads') && oldrev != Gitlab::Git::BLANK_SHA
115 116
  end

117
  def push_to_new_branch?(ref, oldrev)
118 119
    ref_parts = ref.split('/')

120
    ref_parts[1].include?('heads') && oldrev == Gitlab::Git::BLANK_SHA
121 122
  end

123
  def push_remove_branch?(ref, newrev)
D
Dmitriy Zaporozhets 已提交
124 125
    ref_parts = ref.split('/')

126
    ref_parts[1].include?('heads') && newrev == Gitlab::Git::BLANK_SHA
D
Dmitriy Zaporozhets 已提交
127 128
  end

129
  def push_to_branch?(ref)
130
    ref.include?('refs/heads')
131 132
  end

133
  def is_default_branch?(ref)
134 135 136
    ref == "refs/heads/#{project.default_branch}"
  end

137
  def commit_user(commit)
138
    User.find_for_commit(commit.author_email, commit.author_name) || user
139 140
  end
end