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

285 lines
7.7 KiB
Ruby
Raw Normal View History

# frozen_string_literal: true
class Environment < ApplicationRecord
include Gitlab::Utils::StrongMemoize
include ReactiveCaching
2016-12-07 20:09:18 -05:00
# Used to generate random suffixes for the slug
2019-05-05 06:19:14 -04:00
LETTERS = ('a'..'z').freeze
NUMBERS = ('0'..'9').freeze
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
2018-11-07 00:29:16 -05:00
has_many :deployments, -> { success }, 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
2018-11-07 00:29:16 -05:00
has_one :last_deployment, -> { success.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
after_save :clear_reactive_cache!
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") }
scope :for_name, -> (name) { where(name: name) }
##
# Search environments which have names like the given query.
# Do not set a large limit unless you've confirmed that it works on gitlab.com scale.
scope :for_name_like, -> (query, limit: 5) do
where('name LIKE ?', "#{sanitize_sql_like(query)}%").limit(limit)
end
scope :for_project, -> (project) { where(project_id: project) }
2018-11-07 00:29:16 -05:00
scope :with_deployment, -> (sha) { where('EXISTS (?)', Deployment.select(1).where('deployments.environment_id = environments.id').where(sha: sha)) }
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 self.pluck_names
pluck(:name)
end
def predefined_variables
Gitlab::Ci::Variables::Collection.new
.append(key: 'CI_ENVIRONMENT_NAME', value: name)
.append(key: 'CI_ENVIRONMENT_SLUG', value: slug)
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
2018-11-07 00:36:42 -05:00
last_deployment.try(:created_at)
end
def update_merge_request_metrics?
folder_name == "production"
end
2016-09-30 09:45:27 -04:00
2018-11-07 00:29:16 -05:00
def first_deployment_for(commit_sha)
ref = project.repository.ref_name_for_sha(ref_path, commit_sha)
return unless ref
2018-11-07 00:29:16 -05:00
deployment_iid = ref.split('/').last
deployments.find_by(iid: deployment_iid)
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 unless external_url
2016-10-12 09:21:01 -04:00
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
def stop_action_available?
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?
available? && deployment_platform.present? && last_deployment.present?
end
def terminals
with_reactive_cache do |data|
deployment_platform.terminals(self, data)
end
end
def calculate_reactive_cache
return unless has_terminals? && !project.pending_delete?
deployment_platform.calculate_reactive_cache_for(self)
end
def deployment_namespace
strong_memoize(:kubernetes_namespace) do
deployment_platform&.kubernetes_namespace_for(project)
end
end
def has_metrics?
available? && prometheus_adapter&.can_query?
end
def metrics
Squashed commit of the following: commit 22e1cb8f4b98f71d21026f69aa3e68d79946d6ae Merge: 766a42a9639 e966c6aea25 Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Fri Feb 23 21:30:46 2018 +0100 Merge remote-tracking branch 'upstream/master' into 38783-add-cluster-metrics.yml # Conflicts: # app/controllers/projects/prometheus/metrics_controller.rb # app/controllers/projects/prometheus_controller.rb # app/models/project_services/prometheus_service.rb # lib/gitlab/prometheus/queries/query_additional_metrics.rb # spec/controllers/projects/prometheus/metrics_controller_spec.rb # spec/models/project_services/prometheus_service_spec.rb commit 766a42a96393f502d439c1f0beb0b6cfb2c228d4 Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Fri Feb 23 17:58:45 2018 +0100 Move prometheus adapter to app/models/concerns commit ca84eed49811cf3064a2e5ea611af1c947c590d7 Merge: 66702099586 cb504cedc2a Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Fri Feb 23 15:36:03 2018 +0100 Merge remote-tracking branch 'upstream/backport_custom_metrics_ce_components' into 38783-add-cluster-metrics.yml + fix failing tests # Conflicts: # app/controllers/projects/prometheus_controller.rb # app/models/project_services/prometheus_service.rb # lib/gitlab/prometheus/queries/query_additional_metrics.rb # spec/models/project_services/prometheus_service_spec.rb commit cb504cedc2a6e353ffb56833334681e3da09fc14 Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Fri Feb 23 14:46:15 2018 +0100 Fix prometheus_service found by find_or_initialize_service commit 928b84c72c2c4c46e1785b9a943c1822a137de16 Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Thu Feb 22 23:15:11 2018 +0100 additional metrics and backported tests commit 41291383b4b6976af94eaf9e1a7b2e2a172310e7 Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Thu Feb 22 21:57:45 2018 +0100 Introduce Metrics controller and retire prometheus controller commit 6e7492e4c7ffa9d8621f09198071bc14be875976 Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Thu Feb 22 21:46:37 2018 +0100 Backport PrometheusClient::Error and all->common_metrics rename commit 66702099586c864a7f78970a0ee0dd9f3c2beeef Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Thu Feb 22 20:23:03 2018 +0100 fix failing tests commit ce921ea723cde61b2441ba98c9aca97606c719c8 Author: Mike Greiling <mike@pixelcog.com> Date: Wed Feb 21 23:47:30 2018 -0600 add labels to cluster metrics commit 993830c6892e4fbf53d3f72da00002d642c7e9b2 Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Thu Feb 22 01:20:49 2018 +0100 Fix formatting probelms and few small tests commit 66ee65d8e3f747c90d986bc3056178422156bc8e Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Thu Feb 22 01:08:03 2018 +0100 stop using in deployment tests environment.id commit 62c91978d15f0369988521363dae24bd7510d68d Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Thu Feb 22 01:06:33 2018 +0100 fix prometheus_controller and adapter tests commit 977b1d34c1d03c7233582e8328f85caf634895ed Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Thu Feb 22 00:19:39 2018 +0100 finish up active? -> can_query? rename commit e614f7daee58a9758d83ba3efe1649c8b80bc1e2 Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Wed Feb 21 23:51:33 2018 +0100 deployment prometheus adapter tests fix commit ebd726c114a6026fef0adf3eba6ee1972530148a Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Wed Feb 21 21:40:40 2018 +0100 Move environment dependant tests to environment commit 6d31311cd3729c29233283dded70e03a4a9a3c97 Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Wed Feb 21 20:40:24 2018 +0100 update monitoring service and move adding dpeloyment_time to deployment model commit 60b6bf391ab36846dce122bc6b0c5196a186267c Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Wed Feb 21 20:15:46 2018 +0100 adjust deployment spec and prometheus specs commit 6681662cf1c028aff2ff94aa0501732cb7119ba1 Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Tue Feb 20 22:30:20 2018 +0100 Revert changes to reactive caching commit e282f86c45a056889f57d3f7fd23a81c88efff6a Merge: 5751c73df59 6844a2df873 Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Tue Feb 20 22:08:17 2018 +0100 Merge remote-tracking branch 'upstream/master' into 38783-add-cluster-metrics.yml commit 5751c73df59d0a03840a1b4b71b0637670f971a6 Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Tue Feb 20 22:07:43 2018 +0100 rename active? to can_query? and cleanup environment prometheus router commit 3f3c6e1d33dcd9315979daf26a95f2aab83a7de9 Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Tue Feb 20 21:51:43 2018 +0100 Fix tests, and only use prometheus service if its active commit 6345838bac584c213b665d334252ccab202cb271 Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Tue Feb 20 16:24:27 2018 +0100 Fix typo commit 7a585d32afe8da050b5615b1d036a550e06479f5 Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Tue Feb 20 15:29:40 2018 +0100 Cluster id is not required commit e6af62afb11fa380f6aff1c31a81bcc9bab3b1eb Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Tue Feb 20 15:15:46 2018 +0100 Result transformation support commit f3b1bd7c67894f44efe33591ddb70093bd620c03 Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Tue Feb 20 15:07:07 2018 +0100 Fix rubocop warning and exten cluster query timeframe commit be77947cea64261a4d3dead33c3c57f413a9880c Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Tue Feb 20 14:42:47 2018 +0100 Fix additional metrics test commit eb3922e16221abe16f59fae1c38122f227643343 Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Tue Feb 20 14:34:44 2018 +0100 rename prometheus adapter methods commit 045476cd08b21593818b274ae8a44d19b705523f Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Tue Feb 20 13:19:36 2018 +0100 Make prometheus adapter a module commit f2daf050d8c689f72c4c61207930bc53c331f12e Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Tue Feb 20 12:00:44 2018 +0100 refactoring wip commit 52e4ef5587794e811dc10a0f2dca522342a865da Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Sun Feb 18 20:25:55 2018 +0100 cleanup prometheus adapter concept commit 3887365faab9dfcd9c00bcfc501d09ac62431a03 Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Sun Feb 18 19:22:11 2018 +0100 Refactor out deployment id, Rename PrometheusQuerier to PrometheusAdapter commit aa2fc2df57bd72c9a5e94f66d1f1e23990be6c3f Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Fri Feb 16 23:59:54 2018 +0100 Refactor prometheus client commit e43c1ca9d9874d6cf1569f40fa1aca158d9d5d91 Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Thu Feb 15 20:24:45 2018 +0100 Use initial version of cluster_metrics.yml commit 867821ce0b2609ebf8994220aa8e3a94d66a01e0 Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Thu Feb 15 05:24:14 2018 +0100 Fix querying cluster metrics commit 1601e002a064cbb10ffe110a19433c5662858f1d Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Thu Feb 15 04:49:03 2018 +0100 Queues for unicersal querier commit 5db198fdc925c0223be24939b76da1d544dd569c Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Thu Feb 15 03:35:17 2018 +0100 refactor reactive caching and prometheus querying commit b0fc00e8c9d21e961ef44b0129103e2a62928b52 Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Thu Feb 15 00:12:03 2018 +0100 Add generic query additional metrics commit ffe76e6a9ba196bccff22c4880e0384959ad5e48 Author: Pawel Chojnacki <pawel@chojnacki.ws> Date: Tue Feb 13 15:40:15 2018 +0100 Cluster Metric yml initial + Remove cluster query + remove cluster_metrics.yml + Prometheus adapter tests
2018-02-23 15:33:33 -05:00
prometheus_adapter.query(:environment, self) if has_metrics?
end
def additional_metrics(*args)
return unless has_metrics?
prometheus_adapter.query(:additional_metrics_environment, self, *args.map(&:to_f))
end
# rubocop: disable CodeReuse/ServiceClass
2018-03-05 13:34:59 -05:00
def prometheus_adapter
@prometheus_adapter ||= Prometheus::AdapterService.new(project, deployment_platform).prometheus_adapter
end
# rubocop: enable CodeReuse/ServiceClass
2018-03-05 13:34:59 -05:00
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]/, '-')
2016-12-07 20:09:18 -05:00
# 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
def name_without_type
@name_without_type ||= name.delete_prefix("#{environment_type}/")
end
def deployment_platform
strong_memoize(:deployment_platform) do
project.deployment_platform(environment: self.name)
end
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