gitlab-org--gitlab-foss/app/models/environment.rb

239 lines
6.3 KiB
Ruby
Raw Normal View History

2016-06-10 17:36:54 -04:00
class Environment < ActiveRecord::Base
2016-12-07 20:09:18 -05:00
# Used to generate random suffixes for the slug
LETTERS = 'a'..'z'
2016-12-07 20:09:18 -05:00
NUMBERS = '0'..'9'
SUFFIX_CHARS = LETTERS.to_a + NUMBERS.to_a
2016-12-07 20:09:18 -05:00
belongs_to :project, required: true
2016-06-10 17:36:54 -04:00
has_many :deployments, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
Constrain environment deployments to project IDs When querying the deployments of an environment the query Rails produces will be along the lines of the following: SELECT * FROM deployments WHERE environment_id = X For queries such as this (or queries that use this as their base and add more conditions) there is no meaningful index that can be used as long as deployments.project_id is not part of a WHERE clause. To work around this we change that "has_many :deployments" relation to always add a "WHERE project_id = X" condition. This means that queries filtering deployments can make better use of the existing indexes. For example, when filtering by deployments.iid this will result in the following query: SELECT * FROM deployments WHERE environment_id = X AND project_id = Y AND iid = Z This means PostgreSQL can use the existing index on (project_id, environment_id, iid) instead of having to use a different index (or none at all) and having to scan over a large amount of data. Query plan wise this means that instead of this query and plan: EXPLAIN (BUFFERS, ANALYZE) SELECT deployments.* FROM deployments WHERE deployments.environment_id = 5 AND deployments.iid = 225; Index Scan using index_deployments_on_project_id_and_iid on deployments (cost=0.42..14465.75 rows=1 width=117) (actual time=6.394..38.048 rows=1 loops=1) Index Cond: (iid = 225) Filter: (environment_id = 5) Rows Removed by Filter: 839 Buffers: shared hit=4534 Planning time: 0.076 ms Execution time: 38.073 ms We produce the following query and plan: EXPLAIN (BUFFERS, ANALYZE) SELECT deployments.* FROM deployments WHERE deployments.environment_id = 5 AND deployments.iid = 225 AND deployments.project_id = 1292351; Index Scan using index_deployments_on_project_id_and_iid on deployments (cost=0.42..4.45 rows=1 width=117) (actual time=0.018..0.018 rows=1 loops=1) Index Cond: ((project_id = 1292351) AND (iid = 225)) Filter: (environment_id = 5) Buffers: shared hit=4 Planning time: 0.088 ms Execution time: 0.039 ms On GitLab.com these changes result in a (roughly) 11x improvement in SQL timings for the CI environment status endpoint. Fixes https://gitlab.com/gitlab-org/gitlab-ce/issues/36877
2017-09-13 08:43:03 -04:00
has_one :last_deployment, -> { order('deployments.id DESC') }, class_name: 'Deployment'
2016-06-10 17:36:54 -04:00
2016-07-26 08:19:37 -04:00
before_validation :nullify_external_url
2016-12-07 20:09:18 -05:00
before_validation :generate_slug, if: ->(env) { env.slug.blank? }
before_save :set_environment_type
2016-07-26 08:19:37 -04:00
2016-06-14 07:04:21 -04:00
validates :name,
presence: true,
2016-06-14 12:34:48 -04:00
uniqueness: { scope: :project_id },
length: { maximum: 255 },
2016-06-14 07:04:21 -04:00
format: { with: Gitlab::Regex.environment_name_regex,
message: Gitlab::Regex.environment_name_regex_message }
2016-06-10 17:36:54 -04:00
2016-12-07 20:09:18 -05:00
validates :slug,
presence: true,
uniqueness: { scope: :project_id },
length: { maximum: 24 },
format: { with: Gitlab::Regex.environment_slug_regex,
message: Gitlab::Regex.environment_slug_regex_message }
validates :external_url,
2016-07-26 08:19:37 -04:00
length: { maximum: 255 },
allow_nil: true,
addressable_url: true
2016-11-21 07:47:18 -05:00
delegate :stop_action, :manual_actions, to: :last_deployment, allow_nil: true
2016-10-17 15:06:10 -04:00
scope :available, -> { with_state(:available) }
scope :stopped, -> { with_state(:stopped) }
2017-02-06 19:06:46 -05:00
scope :order_by_last_deployed_at, -> do
max_deployment_id_sql =
2017-06-21 09:48:12 -04:00
Deployment.select(Deployment.arel_table[:id].maximum)
.where(Deployment.arel_table[:environment_id].eq(arel_table[:id]))
.to_sql
2017-02-06 19:06:46 -05:00
order(Gitlab::Database.nulls_first_order("(#{max_deployment_id_sql})", 'ASC'))
end
scope :in_review_folder, -> { where(environment_type: "review") }
2016-10-17 15:06:10 -04:00
state_machine :state, initial: :available do
event :start do
transition stopped: :available
end
event :stop do
transition available: :stopped
end
state :available
state :stopped
after_transition do |environment|
environment.expire_etag_cache
end
end
def predefined_variables
[
{ key: 'CI_ENVIRONMENT_NAME', value: name, public: true },
{ key: 'CI_ENVIRONMENT_SLUG', value: slug, public: true }
]
end
def recently_updated_on_branch?(ref)
ref.to_s == last_deployment.try(:ref)
end
2016-07-26 08:19:37 -04:00
def nullify_external_url
self.external_url = nil if self.external_url.blank?
end
2016-08-02 08:01:22 -04:00
def set_environment_type
names = name.split('/')
self.environment_type = names.many? ? names.first : nil
end
def includes_commit?(commit)
2016-08-03 07:37:39 -04:00
return false unless last_deployment
2016-08-02 08:01:22 -04:00
last_deployment.includes_commit?(commit)
2016-08-02 08:01:22 -04:00
end
def last_deployed_at
last_deployment.try(:created_at)
end
def update_merge_request_metrics?
folder_name == "production"
end
2016-09-30 09:45:27 -04:00
def first_deployment_for(commit)
2016-10-04 10:03:13 -04:00
ref = project.repository.ref_name_for_sha(ref_path, commit.sha)
return nil unless ref
2016-10-19 08:49:09 -04:00
deployment_iid = ref.split('/').last
deployments.find_by(iid: deployment_iid)
2016-10-04 10:03:13 -04:00
end
2016-09-30 09:45:27 -04:00
def ref_path
"refs/#{Repository::REF_ENVIRONMENTS}/#{slug}"
2016-09-30 09:45:27 -04:00
end
2016-10-12 09:21:01 -04:00
def formatted_external_url
return nil unless external_url
2018-01-27 00:35:53 -05:00
external_url.gsub(%r{\A.*?://}, '')
2016-10-12 09:21:01 -04:00
end
2016-10-17 10:13:19 -04:00
2017-02-06 10:50:03 -05:00
def stop_action?
2016-10-17 10:13:19 -04:00
available? && stop_action.present?
end
2016-10-18 06:02:50 -04:00
2017-02-06 10:50:03 -05:00
def stop_with_action!(current_user)
2016-11-10 07:59:26 -05:00
return unless available?
2016-10-18 06:02:50 -04:00
2017-02-06 10:50:03 -05:00
stop!
stop_action&.play(current_user)
2016-10-18 06:02:50 -04:00
end
2016-11-21 07:47:18 -05:00
def actions_for(environment)
return [] unless manual_actions
manual_actions.select do |action|
action.expanded_environment_name == environment
2016-11-10 07:59:26 -05:00
end
2016-10-18 06:02:50 -04:00
end
2016-12-07 20:09:18 -05:00
def has_terminals?
project.deployment_platform.present? && available? && last_deployment.present?
end
def terminals
project.deployment_platform.terminals(self) if has_terminals?
end
def has_metrics?
project.monitoring_service.present? && available? && last_deployment.present?
end
def metrics
project.monitoring_service.environment_metrics(self) if has_metrics?
end
def has_additional_metrics?
project.prometheus_service.present? && available? && last_deployment.present?
end
def additional_metrics
if has_additional_metrics?
project.prometheus_service.additional_environment_metrics(self)
end
end
def slug
super.presence || generate_slug
end
2016-12-07 20:09:18 -05:00
# An environment name is not necessarily suitable for use in URLs, DNS
# or other third-party contexts, so provide a slugified version. A slug has
# the following properties:
# * contains only lowercase letters (a-z), numbers (0-9), and '-'
# * begins with a letter
# * has a maximum length of 24 bytes (OpenShift limitation)
# * cannot end with `-`
def generate_slug
# Lowercase letters and numbers only
slugified = name.to_s.downcase.gsub(/[^a-z0-9]/, '-')
# Must start with a letter
slugified = 'env-' + slugified unless LETTERS.cover?(slugified[0])
# Repeated dashes are invalid (OpenShift limitation)
slugified.gsub!(/\-+/, '-')
2016-12-07 20:09:18 -05:00
# Maximum length: 24 characters (OpenShift limitation)
slugified = slugified[0..23]
# Cannot end with a dash (Kubernetes label limitation)
slugified.chop! if slugified.end_with?('-')
2016-12-07 20:09:18 -05:00
# Add a random suffix, shortening the current string if necessary, if it
# has been slugified. This ensures uniqueness.
if slugified != name
slugified = slugified[0..16]
slugified << '-' unless slugified.end_with?('-')
slugified << random_suffix
end
2016-12-07 20:09:18 -05:00
self.slug = slugified
end
def external_url_for(path, commit_sha)
return unless self.external_url
public_path = project.public_path_for_source_path(path, commit_sha)
return unless public_path
2017-01-29 16:31:13 -05:00
[external_url, public_path].join('/')
end
def expire_etag_cache
Gitlab::EtagCaching::Store.new.tap do |store|
2017-05-30 17:56:26 -04:00
store.touch(etag_cache_key)
end
end
2017-05-30 17:56:26 -04:00
def etag_cache_key
Gitlab::Routing.url_helpers.project_environments_path(
project,
format: :json)
2017-05-30 17:56:26 -04:00
end
def folder_name
self.environment_type || self.name
end
2016-12-07 20:09:18 -05:00
private
# Slugifying a name may remove the uniqueness guarantee afforded by it being
# based on name (which must be unique). To compensate, we add a random
# 6-byte suffix in those circumstances. This is not *guaranteed* uniqueness,
# but the chance of collisions is vanishingly small
def random_suffix
(0..5).map { SUFFIX_CHARS.sample }.join
end
2016-06-10 17:36:54 -04:00
end