Class: Projects::EnvironmentsController

Inherits:
ApplicationController show all
Includes:
MetricsDashboard
Defined in:
app/controllers/projects/environments_controller.rb

Constant Summary

Constants included from CookiesHelper

CookiesHelper::COOKIE_TYPE_ENCRYPTED, CookiesHelper::COOKIE_TYPE_PERMANENT

Constants inherited from ApplicationController

ApplicationController::DEFAULT_GITLAB_CACHE_CONTROL

Constants included from Gitlab::Logging::CloudflareHelper

Gitlab::Logging::CloudflareHelper::CLOUDFLARE_CUSTOM_HEADERS

Constants included from Gitlab::NoCacheHeaders

Gitlab::NoCacheHeaders::DEFAULT_GITLAB_NO_CACHE_HEADERS

Instance Method Summary collapse

Methods included from MetricsDashboard

#metrics_dashboard

Methods included from EnvironmentsHelper

#can_destroy_environment?, #custom_metrics_available?, #environment_logs_data, #environments_folder_list_view_data, #environments_list_data, #metrics_data

Methods included from ChecksCollaboration

#can_collaborate_with_project?, #user_access

Methods included from RenderServiceResults

#continue_polling_response, #error_response, #success_response

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

#not_found, #redirect_back_or_default, #render, #route_not_found

Methods included from Gitlab::Utils::StrongMemoize

#clear_memoization, #strong_memoize, #strong_memoized?

Methods included from Gitlab::Logging::CloudflareHelper

#store_cloudflare_headers!, #valid_cloudflare_header?

Methods included from Impersonation

#current_user

Methods included from InitializesCurrentUserMode

#current_user_mode

Methods included from Gitlab::Experimentation::ControllerConcern

#experiment_enabled?, #experiment_tracking_category_and_group, #frontend_experimentation_tracking_data, #record_experiment_user, #set_experimentation_subject_id_cookie, #track_experiment_event

Methods included from SessionsHelper

#limit_session_time, #unconfirmed_email?

Methods included from SessionlessAuthentication

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

Methods included from Gitlab::SearchContext::ControllerConcern

#search_context

Methods included from EnforcesTwoFactorAuthentication

#check_two_factor_requirement, #current_user_requires_two_factor?, #skip_two_factor?, #two_factor_authentication_reason, #two_factor_authentication_required?, #two_factor_grace_period, #two_factor_grace_period_expired?, #two_factor_skippable?, #two_factor_verifier

Methods included from WorkhorseHelper

#send_artifacts_entry, #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, #header_title, #nav, #page_card_attributes, #page_card_meta_tags, #page_description, #page_image, #page_title, #search_context, #sidebar

Methods included from GitlabRoutingHelper

#approve_access_request_group_member_path, #approve_access_request_project_member_path, #artifacts_action_path, #commit_url, #commits_url, #edit_milestone_path, #edit_pipeline_schedule_path, #environment_delete_path, #environment_metrics_path, #environment_path, #expose_fast_artifacts_path, #fast_browse_project_job_artifacts_path, #fast_download_project_job_artifacts_path, #fast_keep_project_job_artifacts_path, #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, #group_member_path, #group_members_url, #issue_path, #issue_url, #leave_group_members_path, #leave_project_members_path, #merge_request_path, #merge_request_url, #pipeline_job_url, #pipeline_path, #pipeline_schedule_path, #pipeline_schedules_path, #pipeline_url, #play_pipeline_schedule_path, #preview_markdown_path, #project_commits_path, #project_member_path, #project_members_url, #project_ref_path, #project_tree_path, #request_access_group_members_path, #request_access_project_members_path, #resend_invite_group_member_path, #resend_invite_project_member_path, #take_ownership_pipeline_schedule_path, #toggle_award_emoji_personal_snippet_path, #toggle_award_emoji_project_project_snippet_path, #toggle_award_emoji_project_project_snippet_url, #toggle_subscription_path, #wiki_page_path, #wiki_path

Methods included from API::Helpers::RelatedResourcesHelpers

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

Methods included from Gitlab::NoCacheHeaders

#no_cache_headers

Methods included from Gitlab::GonHelper

#add_gon_variables, #default_avatar_url, #push_frontend_feature_flag

Methods included from WebpackHelper

#webpack_bundle_tag, #webpack_controller_bundle_tags, #webpack_entrypoint_paths, #webpack_public_host, #webpack_public_path

Methods included from StartupCssHelper

#use_startup_css?

Dynamic Method Handling

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

Instance Method Details

#additional_metricsObject


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

def additional_metrics
  respond_to do |format|
    format.json do
      additional_metrics = environment.additional_metrics(*metrics_params) || {}

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

#cancel_auto_stopObject


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 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

#createObject


83
84
85
86
87
88
89
90
91
# File 'app/controllers/projects/environments_controller.rb', line 83

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

  if @environment.persisted?
    redirect_to project_environment_path(project, @environment)
  else
    render :new
  end
end

#editObject


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

def edit
end

#folderObject

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


51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'app/controllers/projects/environments_controller.rb', line 51

def folder
  folder_environments = project.environments.where(environment_type: params[:id])
  @environments = folder_environments.with_state(params[:scope] || :available)
    .order(:name)
  @folder = params[:id]

  respond_to do |format|
    format.html
    format.json do
      render json: {
        environments: serialize_environments(request, response),
        available_count: folder_environments.available.count,
        stopped_count: folder_environments.stopped.count
      }
    end
  end
end

#indexObject


28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# File 'app/controllers/projects/environments_controller.rb', line 28

def index
  @environments = project.environments
    .with_state(params[:scope] || :available)
  @project = ProjectPresenter.new(project, current_user: current_user)

  respond_to do |format|
    format.html
    format.json do
      Gitlab::PollingInterval.set_header(response, interval: 3_000)
      environments_count_by_state = project.environments.count_by_state

      render json: {
        environments: serialize_environments(request, response, params[:nested]),
        review_app: serialize_review_app,
        available_count: environments_count_by_state[:available],
        stopped_count: environments_count_by_state[:stopped]
      }
    end
  end
end

#metricsObject


165
166
167
168
169
170
171
172
173
174
175
176
177
178
# File 'app/controllers/projects/environments_controller.rb', line 165

def metrics
  respond_to do |format|
    format.html do
      redirect_to project_metrics_dashboard_path(project, environment: environment )
    end
    format.json do
      # Currently, this acts as a hint to load the metrics details into the cache
      # if they aren't there already
      @metrics = environment.metrics || {}

      render json: @metrics, status: @metrics.any? ? :ok : :no_content
    end
  end
end

#metrics_redirectObject


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

def metrics_redirect
  redirect_to project_metrics_dashboard_path(project)
end

#newObject

rubocop: enable CodeReuse/ActiveRecord


76
77
78
# File 'app/controllers/projects/environments_controller.rb', line 76

def new
  @environment = project.environments.new
end

#searchObject


190
191
192
193
194
195
196
197
198
# File 'app/controllers/projects/environments_controller.rb', line 190

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

#showObject

rubocop: disable CodeReuse/ActiveRecord


71
72
73
# File 'app/controllers/projects/environments_controller.rb', line 71

def show
  @deployments = environment.deployments.order(id: :desc).page(params[:page])
end

#stopObject


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'app/controllers/projects/environments_controller.rb', line 101

def stop
  return render_404 unless @environment.available?

  stop_action = @environment.stop_with_action!(current_user)

  action_or_env_url =
    if stop_action
      polymorphic_url([project, stop_action])
    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

#terminalObject


140
141
142
143
144
145
# File 'app/controllers/projects/environments_controller.rb', line 140

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_authorizeObject

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


148
149
150
151
152
153
154
155
156
157
158
159
# File 'app/controllers/projects/environments_controller.rb', line 148

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

#updateObject


93
94
95
96
97
98
99
# File 'app/controllers/projects/environments_controller.rb', line 93

def update
  if @environment.update(environment_params)
    redirect_to project_environment_path(project, @environment)
  else
    render :edit
  end
end