Class: Projects::EnvironmentsController

Inherits:
ApplicationController show all
Includes:
KasCookie, ProductAnalyticsTracking
Defined in:
app/controllers/projects/environments_controller.rb

Constant Summary collapse

MIN_SEARCH_LENGTH = 
3
ACTIVE_STATES = 
%i[available stopping].freeze
SCOPES_TO_STATES = 
{ "active" => ACTIVE_STATES, "stopped" => %i[stopped] }.freeze

Constants included from CookiesHelper

CookiesHelper::COOKIE_TYPE_ENCRYPTED, CookiesHelper::COOKIE_TYPE_PERMANENT

Constants included from Gitlab::HttpRouter::RuleContext

Gitlab::HttpRouter::RuleContext::ALLOWED_ROUTER_RULE_ACTIONS, Gitlab::HttpRouter::RuleContext::ALLOWED_ROUTER_RULE_TYPES, Gitlab::HttpRouter::RuleContext::ROUTER_RULE_ACTIONS_WITHOUT_TYPE

Constants included from StrongPaginationParams

StrongPaginationParams::PAGINATION_PARAMS

Constants included from Gitlab::Logging::CloudflareHelper

Gitlab::Logging::CloudflareHelper::CLOUDFLARE_CUSTOM_HEADERS

Constants included from Gitlab::EndpointAttributes

Gitlab::EndpointAttributes::DEFAULT_URGENCY

Constants included from Impersonation

Impersonation::SESSION_KEYS_TO_DELETE

Constants included from PreferredLanguageSwitcherHelper

PreferredLanguageSwitcherHelper::SWITCHER_MINIMUM_TRANSLATION_LEVEL

Constants included from Routing::PseudonymizationHelper

Routing::PseudonymizationHelper::PSEUDONOMIZED_GROUP, Routing::PseudonymizationHelper::PSEUDONOMIZED_ID, Routing::PseudonymizationHelper::PSEUDONOMIZED_NAMESPACE, Routing::PseudonymizationHelper::PSEUDONOMIZED_PROJECT

Constants included from ProjectsHelper

ProjectsHelper::BANNED

Constants included from Gitlab::NoCacheHeaders

Gitlab::NoCacheHeaders::DEFAULT_GITLAB_NO_CACHE_HEADERS

Instance Method Summary collapse

Methods included from KasCookie

#set_kas_cookie

Methods included from Gitlab::Tracking::Helpers

#dnt_enabled?, #trackable_html_request?

Methods included from ChecksCollaboration

#can_collaborate_with_project?, #user_access

Methods included from RoutableActions

#ensure_canonical_path, #find_routable!, #not_found_actions, #perform_not_found_actions, #routable_authorized?

Methods included from CookiesHelper

#set_secure_cookie

Methods inherited from ApplicationController

endpoint_id_for_action, #feature_category, #handle_unverified_request, #not_found, #redirect_back_or_default, #render, #route_not_found, #urgency

Methods included from Gitlab::HttpRouter::RuleMetrics

#increment_http_router_metrics

Methods included from StrongPaginationParams

#pagination_params

Methods included from RequestPayloadLogger

#append_info_to_payload

Methods included from Gitlab::Logging::CloudflareHelper

#store_cloudflare_headers!, #valid_cloudflare_header?

Methods included from CheckRateLimit

#check_rate_limit!

Methods included from FlocOptOut

#floc_enabled?, #set_floc_opt_out_header

Methods included from Impersonation

#current_user

Methods included from InitializesCurrentUserMode

#current_user_mode

Methods included from SessionsHelper

#obfuscated_email, #remember_me_enabled?, #unconfirmed_email?, #unconfirmed_verification_email?, #verification_data, #verification_email

Methods included from SessionlessAuthentication

#authenticate_sessionless_user!, #request_authenticator, #sessionless_bypass_admin_mode!, #sessionless_sign_in, #sessionless_user?

Methods included from PreferredLanguageSwitcherHelper

#ordered_selectable_locales

Methods included from Gitlab::SearchContext::ControllerConcern

#search_context

Methods included from EnforcesTwoFactorAuthentication

#check_two_factor_requirement, #current_user_requires_two_factor?, #execute_action_for_2fa_reason, #mfa_help_page_url, #skip_two_factor?, #two_factor_authentication_required?, #two_factor_grace_period, #two_factor_grace_period_expired?, #two_factor_skippable?, #two_factor_verifier

Methods included from WorkhorseHelper

#attachment_content_disposition, #content_disposition_for_blob, #inline_content_disposition, #send_artifacts_entry, #send_dependency, #send_git_archive, #send_git_blob, #send_git_diff, #send_git_patch, #set_workhorse_internal_api_content_type, #workhorse_set_content_type!

Methods included from SafeParamsHelper

#safe_params

Methods included from PageLayoutHelper

#blank_container, #container_class, #favicon, #fluid_layout, #full_content_class, #header_title, #nav, #page_canonical_link, #page_card_attributes, #page_card_meta_tags, #page_description, #page_image, #page_itemtype, #page_title, #search_context, #sidebar, #user_status_properties

Methods included from Routing::PackagesHelper

#package_path

Methods included from Routing::PseudonymizationHelper

#masked_page_url, #masked_query_params, #masked_referrer_url, #referrer_params

Methods included from Routing::GraphqlHelper

#graphql_etag_pipeline_path, #graphql_etag_pipeline_sha_path, #graphql_etag_project_on_demand_scan_counts_path

Methods included from Routing::WikiHelper

#group_wiki_page_url, #project_wiki_page_url, #wiki_page_path, #wiki_path

Methods included from Routing::SnippetsHelper

#gitlab_dashboard_snippets_path, #gitlab_raw_snippet_blob_path, #gitlab_raw_snippet_blob_url, #gitlab_raw_snippet_path, #gitlab_raw_snippet_url, #gitlab_snippet_note_path, #gitlab_snippet_note_url, #gitlab_snippet_notes_path, #gitlab_snippet_notes_url, #gitlab_snippet_path, #gitlab_snippet_url, #gitlab_toggle_award_emoji_snippet_note_path, #gitlab_toggle_award_emoji_snippet_note_url, #gitlab_toggle_award_emoji_snippet_path, #gitlab_toggle_award_emoji_snippet_url, #preview_markdown_path, #toggle_award_emoji_personal_snippet_path, #toggle_award_emoji_project_project_snippet_path, #toggle_award_emoji_project_project_snippet_url

Methods included from Routing::PipelineSchedulesHelper

#edit_pipeline_schedule_path, #pipeline_schedule_path, #pipeline_schedules_path, #play_pipeline_schedule_path, #take_ownership_pipeline_schedule_path

Methods included from Routing::ArtifactsHelper

#artifacts_action_path, #expose_fast_artifacts_path, #fast_browse_project_job_artifacts_path, #fast_download_project_job_artifacts_path, #fast_keep_project_job_artifacts_path

Methods included from Routing::MembersHelper

#source_members_url

Methods included from Routing::Groups::MembersHelper

#approve_access_request_group_member_path, #group_member_path, #group_members_url, #leave_group_members_path, #request_access_group_members_path, #resend_invite_group_member_path

Methods included from Routing::Projects::MembersHelper

#approve_access_request_project_member_path, #leave_project_members_path, #project_member_path, #project_members_url, #request_access_project_members_path, #resend_invite_project_member_path

Methods included from Routing::ProjectsHelper

#commit_url, #commits_url, #edit_milestone_path, #environment_delete_path, #environment_path, #issue_path, #issue_url, #merge_request_path, #merge_request_url, #pipeline_job_url, #pipeline_path, #pipeline_url, #project_commits_path, #project_ref_path, #project_tree_path, #release_url, #toggle_subscription_path, #work_item_url

Methods included from API::Helpers::RelatedResourcesHelpers

#expose_path, #expose_url, #issues_available?, #mrs_available?, #project_feature_string_access_level

Methods included from ApplicationSettingsHelper

#all_protocols_enabled?, #allowed_protocols_present?, #anti_spam_service_enabled?, #deprecated_attributes, #enabled_protocol, #enabled_protocol_button, #expanded_by_default?, #external_authorization_allow_token_help_text, #external_authorization_client_certificate_help_text, #external_authorization_client_key_help_text, #external_authorization_client_pass_help_text, #external_authorization_client_url_help_text, #external_authorization_description, #external_authorization_service_attributes, #external_authorization_timeout_help_text, #external_authorization_url_help_text, #http_enabled?, #import_sources_checkboxes, #instance_clusters_enabled?, #integration_expanded?, #key_restriction_options_for_select, #kroki_available_formats, #oauth_providers_checkboxes, #pending_user_count, #registration_features_can_be_prompted?, #repository_storages_options_json, #restricted_level_checkboxes, #runner_token_expiration_interval_attributes, #sidekiq_job_limiter_mode_help_text, #sidekiq_job_limiter_modes_for_select, #signup_enabled?, #signup_form_data, #ssh_enabled?, #storage_weights, #user_oauth_applications?, #valid_runner_registrars, #visible_attributes

Methods included from ProjectsHelper

#able_to_see_forks_count?, #able_to_see_issues?, #able_to_see_merge_requests?, #any_projects?, #author_content_tag, #autodeploy_flash_notice, #badge_count, #branch_rules_path, #can_admin_associated_clusters?, #can_admin_project_member?, #can_change_visibility_level?, #can_disable_emails?, #can_push_code?, #can_set_diff_preview_in_email?, #can_view_branch_rules?, #clusters_deprecation_alert_message, #dashboard_projects_app_data, #delete_confirm_phrase, #directory?, #error_tracking_setting_project_json, #explore_projects_tab?, #external_classification_label_help_message, #fork_button_data_attributes, #hidden_issue_icon, #home_panel_data_attributes, #http_clone_url_to_repo, #import_from_bitbucket_message, #inactive_project_deletion_date, #issue_css_classes, #issue_manual_ordering_class, #last_pipeline_from_status_cache, #last_push_event, #link_to_autodeploy_doc, #link_to_data_loss_doc, #link_to_member, #link_to_member_avatar, #link_to_namespace_change_doc, #link_to_project, #load_catalog_resources, #load_pipeline_status, #localized_project_human_access, #membership_locked?, #no_password_message, #notification_data_attributes, #project_can_be_shared?, #project_classes, #project_coverage_chart_data_attributes, #project_incident_management_setting, #project_license_name, #project_permissions_panel_data, #project_title, #projects_filtered_search_and_sort_app_data, #push_to_create_project_command, #remote_mirror_setting_enabled?, #remove_fork_project_confirm_json, #remove_fork_project_description_message, #remove_fork_project_warning_message, #remove_project_message, #show_archived_project_banner?, #show_auto_devops_implicitly_enabled_banner?, #show_clusters_alert?, #show_count?, #show_dashboard_projects_welcome_page?, #show_inactive_project_deletion_banner?, #show_invalid_gpg_key_message?, #show_lfs_misconfiguration_banner?, #show_mobile_devops_project_promo?, #show_no_password_message?, #show_no_ssh_key_message?, #show_projects?, #show_terraform_banner?, #show_xcode_link?, #ssh_clone_url_to_repo, #star_count_data_attributes, #transfer_project_confirm_button, #transfer_project_message, #visibility_level_content, #visible_fork_source, #vue_fork_divergence_data, #xcode_uri_to_repo

Methods included from Gitlab::Allowable

#can?, #can_all?, #can_any?

Methods included from CompareHelper

#create_mr_button?, #create_mr_path, #project_compare_selector_data, #target_projects

Methods included from Gitlab::NoCacheHeaders

#no_cache_headers

Methods included from Gitlab::GonHelper

#add_browsersdk_tracking, #add_gon_variables, #current_organization, #default_avatar_url, #push_force_frontend_feature_flag, #push_frontend_ability, #push_frontend_feature_flag, #push_namespace_setting, #push_to_gon_attributes

Methods included from WebpackHelper

#prefetch_link_tag, #webpack_bundle_tag, #webpack_controller_bundle_tags, #webpack_entrypoint_paths, #webpack_preload_asset_tag, #webpack_public_host, #webpack_public_path

Methods included from ViteHelper

#universal_path_to_stylesheet, #universal_stylesheet_link_tag, #vite_enabled?, #vite_hmr_http_url, #vite_hmr_websocket_url, #vite_page_entrypoint_paths

Methods included from ContentSecurityPolicyPatch

#content_security_policy_with_context

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Projects::ApplicationController

Instance Method Details

#cancel_auto_stop ⇒ Object 



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'app/controllers/projects/environments_controller.rb', line 140

def cancel_auto_stop
  result = Environments::ResetAutoStopService.new(project, current_user)
                                             .execute(environment)

  if result[:status] == :success
    respond_to do |format|
      message = _('Auto stop successfully canceled.')

      format.html { redirect_back_or_default(default: { action: 'show' }, options: { notice: message }) }
      format.json { render json: { message: message }, status: :ok }
    end
  else
    respond_to do |format|
      message = result[:message]

      format.html { redirect_back_or_default(default: { action: 'show' }, options: { alert: message }) }
      format.json { render json: { message: message }, status: :unprocessable_entity }
    end
  end
end

#create ⇒ Object 



101
102
103
104
105
106
107
108
109
 
# File 'app/controllers/projects/environments_controller.rb', line 101

def create
  @environment = project.environments.create(environment_params)

  if @environment.persisted?
    render json: { environment: @environment, path: project_environment_path(project, @environment) }
  else
    render json: { message: @environment.errors.full_messages }, status: :bad_request
  end
end

#edit ⇒ Object 



95
 
# File 'app/controllers/projects/environments_controller.rb', line 95

def edit; end

#folder ⇒ Object

Returns all environments for a given folder rubocop: disable CodeReuse/ActiveRecord



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'app/controllers/projects/environments_controller.rb', line 66

def folder
  @folder = params[:id]

  respond_to do |format|
    format.html
    format.json do
      states = SCOPES_TO_STATES.fetch(params[:scope], ACTIVE_STATES)
      folder_environments = search_environments(type: params[:id])

      @environments = folder_environments.with_state(states)
        .order(:name)

      render json: {
        environments: serialize_environments(request, response),
        available_count: folder_environments.available.count,
        active_count: folder_environments.active.count,
        stopped_count: folder_environments.stopped.count
      }
    end
  end
end

#index ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'app/controllers/projects/environments_controller.rb', line 40

def index
  @project = ProjectPresenter.new(project, current_user: current_user)

  respond_to do |format|
    format.html
    format.json do
      states = SCOPES_TO_STATES.fetch(params[:scope], ACTIVE_STATES)
      @environments = search_environments.with_state(states)

      environments_count_by_state = search_environments.count_by_state

      Gitlab::PollingInterval.set_header(response, interval: 3_000)
      render json: {
        environments: serialize_environments(request, response, params[:nested]),
        review_app: serialize_review_app,
        can_stop_stale_environments: can?(current_user, :stop_environment, @project),
        available_count: environments_count_by_state[:available],
        active_count: environments_count_by_state[:available] + environments_count_by_state[:stopping],
        stopped_count: environments_count_by_state[:stopped]
      }
    end
  end
end

#k8s ⇒ Object 



97
98
99
 
# File 'app/controllers/projects/environments_controller.rb', line 97

def k8s
  render action: :show
end

#new ⇒ Object 



91
92
93
 
# File 'app/controllers/projects/environments_controller.rb', line 91

def new
  @environment = project.environments.new
end

#search ⇒ Object 



182
183
184
185
186
187
188
189
190
 
# File 'app/controllers/projects/environments_controller.rb', line 182

def search
  respond_to do |format|
    format.json do
      environment_names = search_environment_names

      render json: environment_names, status: environment_names.any? ? :ok : :no_content
    end
  end
end

#show ⇒ Object

rubocop: enable CodeReuse/ActiveRecord



89
 
# File 'app/controllers/projects/environments_controller.rb', line 89

def show; end

#stop ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'app/controllers/projects/environments_controller.rb', line 119

def stop
  return render_404 unless @environment.available?

  service_response = Environments::StopService.new(project, current_user).execute(@environment)
  return render_403 unless service_response.success?

  job = service_response[:actions].first if service_response[:actions]&.count == 1

  action_or_env_url =
    if job
      project_job_url(project, job)
    else
      project_environment_url(project, @environment)
    end

  respond_to do |format|
    format.html { redirect_to action_or_env_url }
    format.json { render json: { redirect_url: action_or_env_url } }
  end
end

#terminal ⇒ Object 



161
162
163
164
165
166
 
# File 'app/controllers/projects/environments_controller.rb', line 161

def terminal
  # Currently, this acts as a hint to load the terminal details into the cache
  # if they aren't there already. In the future, users will need these details
  # to choose between terminals to connect to.
  @terminals = environment.terminals
end

#terminal_websocket_authorize ⇒ Object

GET …/terminal.ws : implemented in gitlab-workhorse



169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'app/controllers/projects/environments_controller.rb', line 169

def terminal_websocket_authorize
  # Just return the first terminal for now. If the list is in the process of
  # being looked up, this may result in a 404 response, so the frontend
  # should retry those errors
  terminal = environment.terminals.try(:first)
  if terminal
    set_workhorse_internal_api_content_type
    render json: Gitlab::Workhorse.channel_websocket(terminal)
  else
    render html: 'Not found', status: :not_found
  end
end

#update ⇒ Object 



111
112
113
114
115
116
117
 
# File 'app/controllers/projects/environments_controller.rb', line 111

def update
  if @environment.update(environment_params)
    render json: { environment: @environment, path: project_environment_path(project, @environment) }
  else
    render json: { message: @environment.errors.full_messages }, status: :bad_request
  end
end