Class: Projects::CommitController

Inherits:
ApplicationController show all
Includes:
CreatesCommit, DiffForPath, DiffHelper, RendersNotes, SourcegraphDecorator
Defined in:
app/controllers/projects/commit_controller.rb

Overview

Controller for a specific Commit

Not to be confused with CommitsController, plural.

Constant Summary collapse

BRANCH_SEARCH_LIMIT =
1000

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 DiffHelper

#apply_diff_view_cookie!, #diff_file_blob_raw_path, #diff_file_blob_raw_url, #diff_file_changed_icon, #diff_file_changed_icon_color, #diff_file_html_data, #diff_file_old_blob_raw_path, #diff_file_old_blob_raw_url, #diff_line_content, #diff_match_line, #diff_options, #diff_view, #diffs_expanded?, #editable_diff?, #inline_diff_btn, #mark_inline_diffs, #parallel_diff_btn, #parallel_diff_discussions, #render_overflow_warning?, #submodule_diff_compare_link, #submodule_link

Methods included from DiffForPath

#render_diff_for_path

Methods included from CreatesCommit

#authorize_edit_tree!, #create_commit

Methods included from Gitlab::Utils::StrongMemoize

#clear_memoization, #strong_memoize, #strong_memoized?

Methods included from RendersNotes

#prepare_notes_for_rendering

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

#branchesObject


88
89
90
91
92
93
94
95
96
97
98
# File 'app/controllers/projects/commit_controller.rb', line 88

def branches
  # branch_names_contains/tag_names_contains can take a long time when there are thousands of
  # branches/tags - each `git branch --contains xxx` request can consume a cpu core.
  # so only do the query when there are a manageable number of branches/tags
  @branches_limit_exceeded = @project.repository.branch_count > BRANCH_SEARCH_LIMIT
  @branches = @branches_limit_exceeded ? [] : @project.repository.branch_names_contains(commit.id)

  @tags_limit_exceeded = @project.repository.tag_count > BRANCH_SEARCH_LIMIT
  @tags = @tags_limit_exceeded ? [] : @project.repository.tag_names_contains(commit.id)
  render layout: false
end

#cherry_pickObject


111
112
113
114
115
116
117
118
119
120
# File 'app/controllers/projects/commit_controller.rb', line 111

def cherry_pick
  assign_change_commit_vars

  return render_404 if @start_branch.blank?

  @branch_name = create_new_branch? ? @commit.cherry_pick_branch_name : @start_branch

  create_commit(Commits::CherryPickService, success_notice: "The #{@commit.change_type_title(current_user)} has been successfully cherry-picked into #{@branch_name}.",
                                            success_path: -> { successful_change_path }, failure_path: failed_change_path)
end

#diff_filesObject


44
45
46
# File 'app/controllers/projects/commit_controller.rb', line 44

def diff_files
  render json: { html: view_to_html_string('projects/commit/diff_files', diffs: @diffs, environment: @environment) }
end

#diff_for_pathObject


40
41
42
# File 'app/controllers/projects/commit_controller.rb', line 40

def diff_for_path
  render_diff_for_path(@commit.diffs(diff_options))
end

#merge_requestsObject

rubocop: enable CodeReuse/ActiveRecord


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'app/controllers/projects/commit_controller.rb', line 72

def merge_requests
  @merge_requests = MergeRequestsFinder.new(
    current_user,
    project_id: @project.id,
    commit_sha: @commit.sha
  ).execute.map do |mr|
    { iid: mr.iid, path: merge_request_path(mr), title: mr.title }
  end

  respond_to do |format|
    format.json do
      render json: @merge_requests.to_json
    end
  end
end

#pipelinesObject

rubocop: disable CodeReuse/ActiveRecord


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

def pipelines
  @pipelines = @commit.pipelines.order(id: :desc)
  @pipelines = @pipelines.where(ref: params[:ref]).page(params[:page]).per(30) if params[:ref]

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

      render json: {
        pipelines: PipelineSerializer
          .new(project: @project, current_user: @current_user)
          .with_pagination(request, response)
          .represent(@pipelines),
        count: {
          all: @pipelines.count
        }
      }
    end
  end
end

#revertObject


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

def revert
  assign_change_commit_vars

  return render_404 if @start_branch.blank?

  @branch_name = create_new_branch? ? @commit.revert_branch_name : @start_branch

  create_commit(Commits::RevertService, success_notice: "The #{@commit.change_type_title(current_user)} has been successfully reverted.",
                                        success_path: -> { successful_change_path }, failure_path: failed_change_path)
end

#showObject


24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# File 'app/controllers/projects/commit_controller.rb', line 24

def show
  apply_diff_view_cookie!

  respond_to do |format|
    format.html do
      render
    end
    format.diff do
      send_git_diff(@project.repository, @commit.diff_refs)
    end
    format.patch do
      send_git_patch(@project.repository, @commit.diff_refs)
    end
  end
end