Class: Environment

Inherits:
ApplicationRecord show all
Includes:
FastDestroyAll::Helpers, Gitlab::Utils::StrongMemoize, Presentable, ReactiveCaching
Defined in:
app/models/environment.rb

Constant Summary collapse

PRODUCTION_ENVIRONMENT_IDENTIFIERS =
%w[prod production].freeze

Constants included from ReactiveCaching

ReactiveCaching::ExceededReactiveCacheLimit, ReactiveCaching::InvalidateReactiveCache, ReactiveCaching::WORK_TYPE

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Presentable

#present

Methods included from FastDestroyAll::Helpers

#perform_fast_destroy

Methods included from AfterCommitQueue

#run_after_commit, #run_after_commit_or_now

Methods included from Gitlab::Utils::StrongMemoize

#clear_memoization, #strong_memoize, #strong_memoized?

Methods inherited from ApplicationRecord

at_most, id_in, id_not_in, iid_in, pluck_primary_key, primary_key_in, safe_ensure_unique, safe_find_or_create_by, safe_find_or_create_by!, underscore, where_exists, with_fast_statement_timeout, without_order

Class Method Details

.count_by_stateObject


167
168
169
170
171
172
173
# File 'app/models/environment.rb', line 167

def count_by_state
  environments_count_by_state = group(:state).count

  valid_states.each_with_object({}) do |state, count_hash|
    count_hash[state] = environments_count_by_state[state.to_s] || 0
  end
end

.find_or_create_by_name(name) ⇒ Object


131
132
133
# File 'app/models/environment.rb', line 131

def self.find_or_create_by_name(name)
  find_or_create_by(name: name)
end

.for_id_and_slug(id, slug) ⇒ Object


113
114
115
# File 'app/models/environment.rb', line 113

def self.for_id_and_slug(id, slug)
  find_by(id: id, slug: slug)
end

.max_deployment_id_sqlObject


117
118
119
120
121
# File 'app/models/environment.rb', line 117

def self.max_deployment_id_sql
  Deployment.select(Deployment.arel_table[:id].maximum)
  .where(Deployment.arel_table[:environment_id].eq(arel_table[:id]))
  .to_sql
end

.pluck_namesObject


123
124
125
# File 'app/models/environment.rb', line 123

def self.pluck_names
  pluck(:name)
end

.pluck_unique_namesObject


127
128
129
# File 'app/models/environment.rb', line 127

def self.pluck_unique_names
  pluck('DISTINCT(environments.name)')
end

.stop_actionsObject

This method returns stop actions (jobs) for multiple environments within one query. It's useful to avoid N+1 problem.

NOTE: The count of environments should be small~medium (e.g. < 5000)


145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'app/models/environment.rb', line 145

def stop_actions
  cte = cte_for_deployments_with_stop_action
  ci_builds = Ci::Build.arel_table

  inner_join_stop_actions = ci_builds.join(cte.table).on(
    ci_builds[:project_id].eq(cte.table[:project_id])
      .and(ci_builds[:ref].eq(cte.table[:ref]))
      .and(ci_builds[:name].eq(cte.table[:on_stop]))
  ).join_sources

  pipeline_ids = ci_builds.join(cte.table).on(
    ci_builds[:id].eq(cte.table[:deployable_id])
  ).project(:commit_id)

  Ci::Build.joins(inner_join_stop_actions)
           .with(cte.to_arel)
           .where(ci_builds[:commit_id].in(pipeline_ids))
           .where(status: Ci::HasStatus::BLOCKED_STATUS)
           .preload_project_and_pipeline_project
           .preload(:user, :metadata, :deployment)
end

.valid_statesObject


135
136
137
# File 'app/models/environment.rb', line 135

def self.valid_states
  self.state_machine.states.map(&:name)
end

Instance Method Details

#actions_for(environment) ⇒ Object


263
264
265
266
267
268
269
# File 'app/models/environment.rb', line 263

def actions_for(environment)
  return [] unless manual_actions

  manual_actions.select do |action|
    action.expanded_environment_name == environment
  end
end

#additional_metrics(*args) ⇒ Object


317
318
319
320
321
# File 'app/models/environment.rb', line 317

def additional_metrics(*args)
  return unless has_metrics_and_can_query?

  prometheus_adapter.query(:additional_metrics_environment, self, *args.map(&:to_f))
end

#auto_stop_inObject


372
373
374
# File 'app/models/environment.rb', line 372

def auto_stop_in
  auto_stop_at - Time.current if auto_stop_at
end

#auto_stop_in=(value) ⇒ Object


376
377
378
379
380
381
# File 'app/models/environment.rb', line 376

def auto_stop_in=(value)
  return unless value
  return unless parsed_result = ChronicDuration.parse(value)

  self.auto_stop_at = parsed_result.seconds.from_now
end

#calculate_reactive_cacheObject


281
282
283
284
285
# File 'app/models/environment.rb', line 281

def calculate_reactive_cache
  return unless has_terminals? && !project.pending_delete?

  deployment_platform.calculate_reactive_cache_for(self)
end

#cancel_deployment_jobs!Object


241
242
243
244
245
246
247
248
249
250
# File 'app/models/environment.rb', line 241

def cancel_deployment_jobs!
  jobs = active_deployments.with_deployable
  jobs.each do |deployment|
    Gitlab::OptimisticLocking.retry_lock(deployment.deployable) do |deployable|
      deployable.cancel! if deployable&.cancelable?
    end
  rescue => e
    Gitlab::ErrorTracking.track_exception(e, environment_id: id, deployment_id: deployment.id)
  end
end

#clear_prometheus_reactive_cache!(query_name) ⇒ Object


185
186
187
# File 'app/models/environment.rb', line 185

def clear_prometheus_reactive_cache!(query_name)
  cluster_prometheus_adapter&.clear_prometheus_reactive_cache!(query_name, self)
end

#cluster_prometheus_adapterObject


189
190
191
# File 'app/models/environment.rb', line 189

def cluster_prometheus_adapter
  @cluster_prometheus_adapter ||= ::Gitlab::Prometheus::Adapter.new(project, deployment_platform&.cluster).cluster_prometheus_adapter
end

#deployment_namespaceObject


287
288
289
290
291
# File 'app/models/environment.rb', line 287

def deployment_namespace
  strong_memoize(:kubernetes_namespace) do
    deployment_platform.cluster.kubernetes_namespace_for(self) if deployment_platform
  end
end

#deployment_platformObject


360
361
362
363
364
# File 'app/models/environment.rb', line 360

def deployment_platform
  strong_memoize(:deployment_platform) do
    project.deployment_platform(environment: self.name)
  end
end

#elastic_stack_available?Boolean

Returns:

  • (Boolean)

383
384
385
# File 'app/models/environment.rb', line 383

def elastic_stack_available?
  !!deployment_platform&.cluster&.application_elastic_stack_available?
end

#etag_cache_keyObject


346
347
348
349
350
# File 'app/models/environment.rb', line 346

def etag_cache_key
  Gitlab::Routing.url_helpers.project_environments_path(
    project,
    format: :json)
end

#expire_etag_cacheObject


340
341
342
343
344
# File 'app/models/environment.rb', line 340

def expire_etag_cache
  Gitlab::EtagCaching::Store.new.tap do |store|
    store.touch(etag_cache_key)
  end
end

#external_url_for(path, commit_sha) ⇒ Object


331
332
333
334
335
336
337
338
# File 'app/models/environment.rb', line 331

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

  [external_url.delete_suffix('/'), public_path.delete_prefix('/')].join('/')
end

#folder_nameObject


352
353
354
# File 'app/models/environment.rb', line 352

def folder_name
  self.environment_type || self.name
end

#for_name_likeObject

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.


84
85
86
# File 'app/models/environment.rb', line 84

scope :for_name_like, -> (query, limit: 5) do
  where(arel_table[:name].matches("#{sanitize_sql_like query}%")).limit(limit)
end

#formatted_external_urlObject


231
232
233
234
235
# File 'app/models/environment.rb', line 231

def formatted_external_url
  return unless external_url

  external_url.gsub(%r{\A.*?://}, '')
end

#has_metrics?Boolean

Returns:

  • (Boolean)

293
294
295
# File 'app/models/environment.rb', line 293

def has_metrics?
  available? && (prometheus_adapter&.configured? || has_sample_metrics?)
end

#has_opened_alert?Boolean

Returns:

  • (Boolean)

301
302
303
# File 'app/models/environment.rb', line 301

def has_opened_alert?
  latest_opened_most_severe_alert.present?
end

#has_running_deployments?Boolean

Returns:

  • (Boolean)

305
306
307
# File 'app/models/environment.rb', line 305

def has_running_deployments?
  all_deployments.running.exists?
end

#has_sample_metrics?Boolean

Returns:

  • (Boolean)

297
298
299
# File 'app/models/environment.rb', line 297

def has_sample_metrics?
  !!ENV['USE_SAMPLE_METRICS']
end

#has_terminals?Boolean

Returns:

  • (Boolean)

271
272
273
# File 'app/models/environment.rb', line 271

def has_terminals?
  available? && deployment_platform.present? && last_deployment.present?
end

#includes_commit?(commit) ⇒ Boolean

Returns:

  • (Boolean)

213
214
215
216
217
# File 'app/models/environment.rb', line 213

def includes_commit?(commit)
  return false unless last_deployment

  last_deployment.includes_commit?(commit)
end

#ingressesObject


395
396
397
398
399
# File 'app/models/environment.rb', line 395

def ingresses
  return unless rollout_status_available?

  deployment_platform.ingresses(deployment_namespace)
end

#knative_services_finderObject


366
367
368
369
370
# File 'app/models/environment.rb', line 366

def knative_services_finder
  if last_deployment&.cluster
    Clusters::KnativeServicesFinder.new(last_deployment.cluster, self)
  end
end

#last_deployed_atObject


219
220
221
# File 'app/models/environment.rb', line 219

def last_deployed_at
  last_deployment.try(:created_at)
end

#metricsObject


309
310
311
# File 'app/models/environment.rb', line 309

def metrics
  prometheus_adapter.query(:environment, self) if has_metrics_and_can_query?
end

#name_without_typeObject


356
357
358
# File 'app/models/environment.rb', line 356

def name_without_type
  @name_without_type ||= name.delete_prefix("#{environment_type}/")
end

#nullify_external_urlObject


203
204
205
# File 'app/models/environment.rb', line 203

def nullify_external_url
  self.external_url = nil if self.external_url.blank?
end

#patch_ingress(ingress, data) ⇒ Object


401
402
403
404
405
# File 'app/models/environment.rb', line 401

def patch_ingress(ingress, data)
  return unless rollout_status_available?

  deployment_platform.patch_ingress(deployment_namespace, ingress, data)
end

#predefined_variablesObject


193
194
195
196
197
# File 'app/models/environment.rb', line 193

def predefined_variables
  Gitlab::Ci::Variables::Collection.new
    .append(key: 'CI_ENVIRONMENT_NAME', value: name)
    .append(key: 'CI_ENVIRONMENT_SLUG', value: slug)
end

#prometheus_adapterObject


323
324
325
# File 'app/models/environment.rb', line 323

def prometheus_adapter
  @prometheus_adapter ||= Gitlab::Prometheus::Adapter.new(project, deployment_platform&.cluster).prometheus_adapter
end

#prometheus_statusObject


313
314
315
# File 'app/models/environment.rb', line 313

def prometheus_status
  deployment_platform&.cluster&.application_prometheus&.status_name
end

#recently_updated_on_branch?(ref) ⇒ Boolean

Returns:

  • (Boolean)

199
200
201
# File 'app/models/environment.rb', line 199

def recently_updated_on_branch?(ref)
  ref.to_s == last_deployment.try(:ref)
end

#ref_pathObject


227
228
229
# File 'app/models/environment.rb', line 227

def ref_path
  "refs/#{Repository::REF_ENVIRONMENTS}/#{slug}"
end

#reset_auto_stopObject


259
260
261
# File 'app/models/environment.rb', line 259

def reset_auto_stop
  update_column(:auto_stop_at, nil)
end

#rollout_statusObject


387
388
389
390
391
392
393
# File 'app/models/environment.rb', line 387

def rollout_status
  return unless rollout_status_available?

  result = rollout_status_with_reactive_cache

  result || ::Gitlab::Kubernetes::RolloutStatus.loading
end

#set_environment_typeObject


207
208
209
210
211
# File 'app/models/environment.rb', line 207

def set_environment_type
  names = name.split('/')

  self.environment_type = names.many? ? names.first : nil
end

#slugObject


327
328
329
# File 'app/models/environment.rb', line 327

def slug
  super.presence || generate_slug
end

#stop_action_available?Boolean

Returns:

  • (Boolean)

237
238
239
# File 'app/models/environment.rb', line 237

def stop_action_available?
  available? && stop_action.present?
end

#stop_with_action!(current_user) ⇒ Object


252
253
254
255
256
257
# File 'app/models/environment.rb', line 252

def stop_with_action!(current_user)
  return unless available?

  stop!
  stop_action&.play(current_user)
end

#terminalsObject


275
276
277
278
279
# File 'app/models/environment.rb', line 275

def terminals
  with_reactive_cache do |data|
    deployment_platform.terminals(self, data)
  end
end

#update_merge_request_metrics?Boolean

Returns:

  • (Boolean)

223
224
225
# File 'app/models/environment.rb', line 223

def update_merge_request_metrics?
  PRODUCTION_ENVIRONMENT_IDENTIFIERS.include?(folder_name.downcase)
end