Class: Projects::JobsController

Inherits:
ApplicationController show all
Includes:
ContinueParams, SendFileUpload
Defined in:
app/controllers/projects/jobs_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 ContinueParams

#continue_params

Methods included from InternalRedirect

#full_path_for_uri, #host_allowed?, #referer_path, #safe_redirect_path, #safe_redirect_path_for_url, #sanitize_redirect

Methods included from SendFileUpload

#content_type_for, #guess_content_type, #send_upload

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

#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

#cancel ⇒ Object 


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

def cancel
  return respond_422 unless @build.cancelable?

  @build.cancel

  if continue_params[:to]
    redirect_to continue_params[:to]
  else
    redirect_to builds_project_pipeline_path(@project, @build.pipeline.id)
  end
end

#erase ⇒ Object 


107
108
109
110
111
112
113
114
 
# File 'app/controllers/projects/jobs_controller.rb', line 107

def erase
  if @build.erase(erased_by: current_user)
    redirect_to project_job_path(project, @build),
              notice: _("Job has been successfully erased!")
  else
    respond_422
  end
end

#index ⇒ Object 


19
20
21
22
23
24
25
26
27
 
# File 'app/controllers/projects/jobs_controller.rb', line 19

def index
  # We need all builds for tabs counters
  @all_builds = Ci::JobsFinder.new(current_user: current_user, project: @project).execute

  @scope = params[:scope]
  @builds = Ci::JobsFinder.new(current_user: current_user, project: @project, params: params).execute
  @builds = @builds.eager_load_everything
  @builds = @builds.page(params[:page]).per(30).without_count
end

#play ⇒ Object 


75
76
77
78
79
80
 
# File 'app/controllers/projects/jobs_controller.rb', line 75

def play
  return respond_422 unless @build.playable?

  build = @build.play(current_user, play_params[:job_variables_attributes])
  redirect_to build_path(build)
end

#proxy_websocket_authorize ⇒ Object 


148
149
150
 
# File 'app/controllers/projects/jobs_controller.rb', line 148

def proxy_websocket_authorize
  render json: proxy_websocket_service(build_service_specification)
end

#raw ⇒ Object 


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

def raw
  if trace_artifact_file
    workhorse_set_content_type!
    send_upload(trace_artifact_file,
                send_params: raw_send_params,
                redirect_params: raw_redirect_params)
  else
    build.trace.read do |stream|
      if stream.file?
        workhorse_set_content_type!
        send_file stream.path, type: 'text/plain; charset=utf-8', disposition: 'inline'
      else
        # In this case we can't use workhorse_set_content_type! and let
        # Workhorse handle the response because the data is streamed directly
        # to the user but, because we have the trace content, we can calculate
        # the proper content type and disposition here.
        raw_data = stream.raw
        send_data raw_data, type: 'text/plain; charset=utf-8', disposition: raw_trace_content_disposition(raw_data), filename: 'job.log'
      end
    end
  end
end

#retry ⇒ Object 


68
69
70
71
72
73
 
# File 'app/controllers/projects/jobs_controller.rb', line 68

def retry
  return respond_422 unless @build.retryable?

  build = Ci::Build.retry(@build, current_user)
  redirect_to build_path(build)
end

#show ⇒ Object

rubocop: disable CodeReuse/ActiveRecord


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

def show
  @pipeline = @build.pipeline
  @builds = @pipeline.builds
    .order('id DESC')
    .present(current_user: current_user)

  respond_to do |format|
    format.html
    format.json do
      Gitlab::PollingInterval.set_header(response, interval: 10_000)

      render json: BuildSerializer
        .new(project: @project, current_user: @current_user)
        .represent(@build, {}, BuildDetailsEntity)
    end
  end
end

#status ⇒ Object 


101
102
103
104
105
 
# File 'app/controllers/projects/jobs_controller.rb', line 101

def status
  render json: BuildSerializer
    .new(project: @project, current_user: @current_user)
    .represent_status(@build)
end

#terminal ⇒ Object 


139
140
 
# File 'app/controllers/projects/jobs_controller.rb', line 139

def terminal
end

#terminal_websocket_authorize ⇒ Object

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


143
144
145
146
 
# File 'app/controllers/projects/jobs_controller.rb', line 143

def terminal_websocket_authorize
  set_workhorse_internal_api_content_type
  render json: Gitlab::Workhorse.channel_websocket(@build.terminal_specification)
end

#trace ⇒ Object

rubocop: enable CodeReuse/ActiveRecord


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

def trace
  build.trace.read do |stream|
    respond_to do |format|
      format.json do
        build.trace.being_watched!

        build_trace = Ci::BuildTrace.new(
          build: @build,
          stream: stream,
          state: params[:state])

        render json: BuildTraceSerializer
          .new(project: @project, current_user: @current_user)
          .represent(build_trace)
      end
    end
  end
end

#unschedule ⇒ Object 


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

def unschedule
  return respond_422 unless @build.scheduled?

  @build.unschedule!
  redirect_to build_path(@build)
end