debian-mirror-gitlab/app/services/projects/update_pages_service.rb

197 lines
5.4 KiB
Ruby
Raw Normal View History

2018-11-18 11:00:15 +05:30
# frozen_string_literal: true
2017-08-17 22:00:37 +05:30
module Projects
class UpdatePagesService < BaseService
2018-10-15 14:42:47 +05:30
InvalidStateError = Class.new(StandardError)
2017-08-17 22:00:37 +05:30
BLOCK_SIZE = 32.kilobytes
2019-12-04 20:38:33 +05:30
PUBLIC_DIR = 'public'
2019-02-02 18:00:53 +05:30
2021-01-29 00:20:46 +05:30
# old deployment can be cached by pages daemon
# so we need to give pages daemon some time update cache
# 10 minutes is enough, but 30 feels safer
OLD_DEPLOYMENTS_DESTRUCTION_DELAY = 30.minutes.freeze
2017-08-17 22:00:37 +05:30
attr_reader :build
def initialize(project, build)
2021-04-29 21:17:54 +05:30
@project = project
@build = build
2017-08-17 22:00:37 +05:30
end
def execute
2018-03-17 18:26:18 +05:30
register_attempt
2017-08-17 22:00:37 +05:30
# Create status notifying the deployment of pages
2021-09-30 23:02:18 +05:30
@status = build_commit_status
::Ci::Pipelines::AddJobService.new(@build.pipeline).execute!(@status) do |job|
job.enqueue!
job.run!
end
2017-08-17 22:00:37 +05:30
2021-10-27 15:23:28 +05:30
validate_state!
validate_max_size!
validate_max_entries!
2017-08-17 22:00:37 +05:30
2021-03-08 18:12:59 +05:30
build.artifacts_file.use_file do |artifacts_path|
create_pages_deployment(artifacts_path, build)
2017-08-17 22:00:37 +05:30
success
end
2018-10-15 14:42:47 +05:30
rescue InvalidStateError => e
2017-08-17 22:00:37 +05:30
error(e.message)
2021-06-08 01:23:25 +05:30
rescue StandardError => e
2018-10-15 14:42:47 +05:30
error(e.message)
2018-05-01 15:08:00 +05:30
raise e
2017-08-17 22:00:37 +05:30
end
private
def success
@status.success
2020-11-24 15:15:51 +05:30
@project.mark_pages_as_deployed(artifacts_archive: build.job_artifacts_archive)
2017-08-17 22:00:37 +05:30
super
end
2018-10-15 14:42:47 +05:30
def error(message)
2018-05-01 15:08:00 +05:30
register_failure
2017-08-17 22:00:37 +05:30
log_error("Projects::UpdatePagesService: #{message}")
@status.allow_failure = !latest?
@status.description = message
2018-03-17 18:26:18 +05:30
@status.drop(:script_failure)
2017-08-17 22:00:37 +05:30
super
end
2021-09-30 23:02:18 +05:30
def build_commit_status
2017-08-17 22:00:37 +05:30
GenericCommitStatus.new(
user: build.user,
stage: 'deploy',
name: 'pages:deploy'
)
end
2021-01-29 00:20:46 +05:30
def create_pages_deployment(artifacts_path, build)
sha256 = build.job_artifacts_archive.file_sha256
2021-01-03 14:25:43 +05:30
2021-01-29 00:20:46 +05:30
deployment = nil
2021-01-03 14:25:43 +05:30
File.open(artifacts_path) do |file|
2021-01-29 00:20:46 +05:30
deployment = project.pages_deployments.create!(file: file,
file_count: entries_count,
2021-10-27 15:23:28 +05:30
file_sha256: sha256,
ci_build_id: build.id
)
2021-03-08 18:12:59 +05:30
2021-10-27 15:23:28 +05:30
validate_outdated_sha!
2021-03-08 18:12:59 +05:30
2021-01-29 00:20:46 +05:30
project.update_pages_deployment!(deployment)
2021-01-03 14:25:43 +05:30
end
2021-01-29 00:20:46 +05:30
DestroyPagesDeploymentsWorker.perform_in(
OLD_DEPLOYMENTS_DESTRUCTION_DELAY,
project.id,
deployment.id
)
2021-01-03 14:25:43 +05:30
end
2017-08-17 22:00:37 +05:30
def ref
build.ref
end
def artifacts
build.artifacts_file.path
end
def latest_sha
project.commit(build.ref).try(:sha).to_s
2018-05-01 15:08:00 +05:30
ensure
# Close any file descriptors that were opened and free libgit2 buffers
project.cleanup
2017-08-17 22:00:37 +05:30
end
def sha
build.sha
end
2017-09-10 17:25:29 +05:30
def register_attempt
pages_deployments_total_counter.increment
end
def register_failure
pages_deployments_failed_total_counter.increment
end
def pages_deployments_total_counter
@pages_deployments_total_counter ||= Gitlab::Metrics.counter(:pages_deployments_total, "Counter of GitLab Pages deployments triggered")
end
def pages_deployments_failed_total_counter
@pages_deployments_failed_total_counter ||= Gitlab::Metrics.counter(:pages_deployments_failed_total, "Counter of GitLab Pages deployments which failed")
end
2019-02-02 18:00:53 +05:30
2021-10-27 15:23:28 +05:30
def validate_state!
raise InvalidStateError, 'missing pages artifacts' unless build.artifacts?
raise InvalidStateError, 'missing artifacts metadata' unless build.artifacts_metadata?
validate_outdated_sha!
end
def validate_outdated_sha!
return if latest?
2021-11-18 22:05:49 +05:30
# use pipeline_id in case the build is retried
last_deployed_pipeline_id = project.pages_metadatum&.pages_deployment&.ci_build&.pipeline_id
2021-10-27 15:23:28 +05:30
2021-11-18 22:05:49 +05:30
return unless last_deployed_pipeline_id
return if last_deployed_pipeline_id <= build.pipeline_id
2021-10-27 15:23:28 +05:30
raise InvalidStateError, 'build SHA is outdated for this ref'
end
def latest?
# check if sha for the ref is still the most recent one
# this helps in case when multiple deployments happens
sha == latest_sha
end
def validate_max_size!
if total_size > max_size
raise InvalidStateError, "artifacts for pages are too large: #{total_size}"
end
end
# Calculate page size after extract
def total_size
@total_size ||= build.artifacts_metadata_entry(PUBLIC_DIR + '/', recursive: true).total_size
end
def max_size_from_settings
Gitlab::CurrentSettings.max_pages_size.megabytes
end
def max_size
max_pages_size = max_size_from_settings
return ::Gitlab::Pages::MAX_SIZE if max_pages_size == 0
max_pages_size
end
def validate_max_entries!
if pages_file_entries_limit > 0 && entries_count > pages_file_entries_limit
raise InvalidStateError, "pages site contains #{entries_count} file entries, while limit is set to #{pages_file_entries_limit}"
end
end
def entries_count
# we're using the full archive and pages daemon needs to read it
# so we want the total count from entries, not only "public/" directory
# because it better approximates work we need to do before we can serve the site
@entries_count = build.artifacts_metadata_entry("", recursive: true).entries.count
end
def pages_file_entries_limit
project.actual_limits.pages_file_entries
end
2017-08-17 22:00:37 +05:30
end
end
2020-03-13 15:44:24 +05:30
2021-06-08 01:23:25 +05:30
Projects::UpdatePagesService.prepend_mod_with('Projects::UpdatePagesService')