debian-mirror-gitlab/app/services/git/base_hooks_service.rb

180 lines
5 KiB
Ruby
Raw Normal View History

2019-07-31 22:56:46 +05:30
# frozen_string_literal: true
module Git
class BaseHooksService < ::BaseService
include Gitlab::Utils::StrongMemoize
2019-12-21 20:55:43 +05:30
include ChangeParams
2019-07-31 22:56:46 +05:30
# The N most recent commits to process in a single push payload.
PROCESS_COMMIT_LIMIT = 100
def execute
create_events
create_pipelines
execute_project_hooks
# Not a hook, but it needs access to the list of changed commits
enqueue_invalidate_cache
2019-10-12 21:52:04 +05:30
success
2019-07-31 22:56:46 +05:30
end
private
def hook_name
raise NotImplementedError, "Please implement #{self.class}##{__method__}"
end
2021-11-11 11:23:49 +05:30
# This should return PROCESS_COMMIT_LIMIT commits, ordered with newest last
2019-07-31 22:56:46 +05:30
def limited_commits
2021-11-11 11:23:49 +05:30
raise NotImplementedError, "Please implement #{self.class}##{__method__}"
2019-07-31 22:56:46 +05:30
end
def commits_count
2021-11-11 11:23:49 +05:30
raise NotImplementedError, "Please implement #{self.class}##{__method__}"
2019-07-31 22:56:46 +05:30
end
def event_message
nil
end
def invalidated_file_types
[]
end
2019-10-12 21:52:04 +05:30
# Push events in the activity feed only show information for the
# last commit.
2019-07-31 22:56:46 +05:30
def create_events
2019-12-21 20:55:43 +05:30
return unless params.fetch(:create_push_event, true)
2019-10-12 21:52:04 +05:30
EventCreateService.new.push(project, current_user, event_push_data)
2019-07-31 22:56:46 +05:30
end
def create_pipelines
return unless params.fetch(:create_pipelines, true)
Ci::CreatePipelineService
2019-10-12 21:52:04 +05:30
.new(project, current_user, pipeline_params)
2019-12-04 20:38:33 +05:30
.execute!(:push, pipeline_options)
rescue Ci::CreatePipelineService::CreateError => ex
log_pipeline_errors(ex)
2019-07-31 22:56:46 +05:30
end
def execute_project_hooks
2019-12-21 20:55:43 +05:30
return unless params.fetch(:execute_project_hooks, true)
2019-10-12 21:52:04 +05:30
# Creating push_data invokes one CommitDelta RPC per commit. Only
# build this data if we actually need it.
project.execute_hooks(push_data, hook_name) if project.has_active_hooks?(hook_name)
2021-09-30 23:02:18 +05:30
project.execute_integrations(push_data, hook_name) if project.has_active_integrations?(hook_name)
2019-07-31 22:56:46 +05:30
end
def enqueue_invalidate_cache
2019-10-12 21:52:04 +05:30
file_types = invalidated_file_types
return unless file_types.present?
ProjectCacheWorker.perform_async(project.id, file_types, [], false)
2019-07-31 22:56:46 +05:30
end
2019-10-12 21:52:04 +05:30
def pipeline_params
2020-03-13 15:44:24 +05:30
strong_memoize(:pipeline_params) do
{
before: oldrev,
after: newrev,
ref: ref,
variables_attributes: generate_vars_from_push_options || [],
push_options: params[:push_options] || {},
checkout_sha: Gitlab::DataBuilder::Push.checkout_sha(
project.repository, newrev, ref)
}
end
2019-10-12 21:52:04 +05:30
end
2020-01-01 13:55:28 +05:30
def ci_variables_from_push_options
strong_memoize(:ci_variables_from_push_options) do
params[:push_options]&.deep_symbolize_keys&.dig(:ci, :variable)
end
end
def generate_vars_from_push_options
return [] unless ci_variables_from_push_options
ci_variables_from_push_options.map do |var_definition, _count|
key, value = var_definition.to_s.split("=", 2)
# Accept only valid format. We ignore the following formats
# 1. "=123". In this case, `key` will be an empty string
# 2. "FOO". In this case, `value` will be nil.
# However, the format "FOO=" will result in key beign `FOO` and value
# being an empty string. This is acceptable.
next if key.blank? || value.nil?
{ "key" => key, "variable_type" => "env_var", "secret_value" => value }
end.compact
end
2019-10-12 21:52:04 +05:30
def push_data_params(commits:, with_changed_files: true)
{
2019-12-21 20:55:43 +05:30
oldrev: oldrev,
newrev: newrev,
ref: ref,
2019-10-12 21:52:04 +05:30
project: project,
user: current_user,
commits: commits,
2019-07-31 22:56:46 +05:30
message: event_message,
commits_count: commits_count,
2019-10-12 21:52:04 +05:30
with_changed_files: with_changed_files
}
end
def event_push_data
2021-10-27 15:23:28 +05:30
# We only need the newest commit for the event push, and we don't
2019-10-12 21:52:04 +05:30
# need the full deltas either.
@event_push_data ||= Gitlab::DataBuilder::Push.build(
2021-10-27 15:23:28 +05:30
**push_data_params(commits: limited_commits.last, with_changed_files: false)
2021-02-22 17:27:13 +05:30
)
2019-10-12 21:52:04 +05:30
end
def push_data
2021-02-22 17:27:13 +05:30
@push_data ||= Gitlab::DataBuilder::Push.build(**push_data_params(commits: limited_commits))
2019-07-31 22:56:46 +05:30
# Dependent code may modify the push data, so return a duplicate each time
@push_data.dup
end
# to be overridden in EE
def pipeline_options
{}
end
2019-09-04 21:01:54 +05:30
2019-12-04 20:38:33 +05:30
def log_pipeline_errors(exception)
data = {
class: self.class.name,
correlation_id: Labkit::Correlation::CorrelationId.current_id.to_s,
project_id: project.id,
project_path: project.full_path,
message: "Error creating pipeline",
errors: exception.to_s,
2020-03-13 15:44:24 +05:30
pipeline_params: sanitized_pipeline_params
2019-12-04 20:38:33 +05:30
}
logger.warn(data)
end
2020-03-13 15:44:24 +05:30
def sanitized_pipeline_params
pipeline_params.except(:push_options)
end
2019-12-04 20:38:33 +05:30
def logger
2020-03-13 15:44:24 +05:30
if Gitlab::Runtime.sidekiq?
2019-12-04 20:38:33 +05:30
Sidekiq.logger
else
# This service runs in Sidekiq, so this shouldn't ever be
# called, but this is included just in case.
Gitlab::ProjectServiceLogger
end
end
2019-07-31 22:56:46 +05:30
end
end