Class: PostReceiveService

Inherits:
Object
  • Object
show all
Defined in:
app/services/post_receive_service.rb

Overview

PostReceiveService class

Used for scheduling related jobs after a push action has been performed

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(user, repository, project, params) ⇒ PostReceiveService

Returns a new instance of PostReceiveService.



9
10
11
12
13
14
# File 'app/services/post_receive_service.rb', line 9

def initialize(user, repository, project, params)
  @user = user
  @repository = repository
  @project = project
  @params = params
end

Instance Attribute Details

#paramsObject (readonly)

Returns the value of attribute params.



7
8
9
# File 'app/services/post_receive_service.rb', line 7

def params
  @params
end

#projectObject (readonly)

Returns the value of attribute project.



7
8
9
# File 'app/services/post_receive_service.rb', line 7

def project
  @project
end

#repositoryObject (readonly)

Returns the value of attribute repository.



7
8
9
# File 'app/services/post_receive_service.rb', line 7

def repository
  @repository
end

#userObject (readonly)

Returns the value of attribute user.



7
8
9
# File 'app/services/post_receive_service.rb', line 7

def user
  @user
end

Instance Method Details

#executeObject



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# File 'app/services/post_receive_service.rb', line 16

def execute
  response = Gitlab::InternalPostReceive::Response.new

  push_options = Gitlab::PushOptions.new(params[:push_options])
  mr_options = push_options.get(:merge_request)

  response.reference_counter_decreased = Gitlab::ReferenceCounter.new(params[:gl_repository]).decrease

  # The PostReceive worker will normally invalidate the cache. However, it
  # runs asynchronously. If push options require us to create a new merge
  # request synchronously, we can't rely on that, so invalidate the cache here
  repository&.expire_branches_cache if mr_options&.fetch(:create, false)

  PostReceive.perform_async(params[:gl_repository], params[:identifier],
                            params[:changes], push_options.as_json)

  if mr_options.present?
    message = process_mr_push_options(mr_options, params[:changes])
    response.add_alert_message(message)
  end

  response.add_alert_message(broadcast_message)
  response.add_merge_request_urls(merge_request_urls)

  # Neither User nor Repository are guaranteed to be returned; an orphaned write deploy
  # key could be used
  if user && repository
    redirect_message = Gitlab::Checks::ContainerMoved.fetch_message(user, repository)
    project_created_message = Gitlab::Checks::ProjectCreated.fetch_message(user, repository)

    response.add_basic_message(redirect_message)
    response.add_basic_message(project_created_message)

    record_onboarding_progress
  end

  response
end

#merge_request_urlsObject



77
78
79
80
81
# File 'app/services/post_receive_service.rb', line 77

def merge_request_urls
  return [] unless repository&.repo_type&.project?

  ::MergeRequests::GetUrlsService.new(project: project).execute(params[:changes])
end

#process_mr_push_options(push_options, changes) ⇒ Object



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# File 'app/services/post_receive_service.rb', line 55

def process_mr_push_options(push_options, changes)
  Gitlab::QueryLimiting.disable!('https://gitlab.com/gitlab-org/gitlab/-/issues/28494')
  return unless repository

  unless repository.repo_type.project?
    return push_options_warning('Push options are only supported for projects')
  end

  service = ::MergeRequests::PushOptionsHandlerService.new(
    project: project, current_user: user, changes: changes, push_options: push_options
  ).execute

  if service.errors.present?
    push_options_warning(service.errors.join("\n\n"))
  end
end

#push_options_warning(warning) ⇒ Object



72
73
74
75
# File 'app/services/post_receive_service.rb', line 72

def push_options_warning(warning)
  options = Array.wrap(params[:push_options]).map { |p| "'#{p}'" }.join(' ')
  "WARNINGS:\nError encountered with push options #{options}: #{warning}"
end