Class: Projects::IssuesController

Inherits:

Object
ActionController::Base
BaseActionController
ApplicationController
ApplicationController
Projects::IssuesController

show all

Includes:: IssuableActions, IssuableCollections, IssuesCalendar, RecordUserLastActivity, ToggleAwardEmoji, ToggleSubscriptionAction

Defined in:: app/controllers/projects/issues_controller.rb

Constant Summary collapse

ISSUES_EXCEPT_ACTIONS =

%i[index calendar new create bulk_update import_csv export_csv service_desk can_create_branch].freeze

SET_ISSUABLES_INDEX_ONLY_ACTIONS =

%i[index calendar service_desk].freeze

WORK_ITEM_REDIRECT_EXCEPT_ACTIONS =

(ISSUES_EXCEPT_ACTIONS + [
  :discussions,                # it's a JSON action, but not always passed on the tests requests
  :designs,                    # redirected on the show action
  :description_diff,
  :delete_description_version
]).freeze

Instance Attribute Summary collapse

#vulnerability_id ⇒ Object

Returns the value of attribute vulnerability_id.

Instance Method Summary collapse

Methods included from RecordUserLastActivity

#set_member_last_activity, #set_user_last_activity

Methods included from CookiesHelper

#set_secure_cookie

Methods included from IssuesCalendar

#render_issues_calendar

Methods included from SortingPreference

#default_sort_order, #legacy_sort_cookie_name, #set_sort_order

Methods included from SortingHelper

#admin_users_sort_options, #branches_sort_options_hash, #can_sort_by_issue_weight?, #can_sort_by_merged_date?, #due_date_option, #forks_reverse_sort_options_hash, #forks_sort_direction_button, #issuable_reverse_sort_order_hash, #issuable_sort_direction_button, #issuable_sort_option_overrides, #issuable_sort_options, #label_priority_option, #label_sort_options_hash, #merged_option, #milestones_sort_options_hash, #popularity_option, #projects_sort_options_hash, #relative_position_option, #sort_direction_button, #sort_direction_icon, #sort_options_hash, #starrers_sort_options_hash, #title_option, #users_sort_options_hash

Methods included from ButtonHelper

#clipboard_button, #dropdown_item_with_description, #http_clone_button, #http_dropdown_description, #link_button_to, #ssh_clone_button

Methods included from SortingTitlesValuesHelper

#sort_title_closed_date, #sort_title_closed_earlier, #sort_title_closed_recently, #sort_title_contacted_date, #sort_title_created_date, #sort_title_downvotes, #sort_title_due_date, #sort_title_due_date_later, #sort_title_due_date_soon, #sort_title_expire_date, #sort_title_label_priority, #sort_title_largest_group, #sort_title_largest_repo, #sort_title_latest_activity, #sort_title_merged_date, #sort_title_merged_earlier, #sort_title_merged_recently, #sort_title_milestone, #sort_title_milestone_later, #sort_title_milestone_soon, #sort_title_most_stars, #sort_title_name, #sort_title_name_asc, #sort_title_name_desc, #sort_title_oldest_activity, #sort_title_oldest_created, #sort_title_oldest_last_activity, #sort_title_oldest_signin, #sort_title_oldest_starred, #sort_title_oldest_updated, #sort_title_popularity, #sort_title_priority, #sort_title_recently_created, #sort_title_recently_last_activity, #sort_title_recently_signin, #sort_title_recently_starred, #sort_title_recently_updated, #sort_title_relative_position, #sort_title_relevance, #sort_title_size, #sort_title_stars, #sort_title_start_date_later, #sort_title_start_date_soon, #sort_title_title, #sort_title_upvotes, #sort_title_version_asc, #sort_title_version_desc, #sort_value_closed_date, #sort_value_closed_earlier, #sort_value_closed_recently, #sort_value_contacted_date, #sort_value_created_date, #sort_value_downvotes, #sort_value_due_date, #sort_value_due_date_later, #sort_value_due_date_soon, #sort_value_expire_date, #sort_value_label_priority, #sort_value_largest_group, #sort_value_largest_repo, #sort_value_latest_activity, #sort_value_least_popular, #sort_value_merged_date, #sort_value_merged_earlier, #sort_value_merged_recently, #sort_value_milestone, #sort_value_milestone_later, #sort_value_milestone_soon, #sort_value_most_popular, #sort_value_name, #sort_value_name_desc, #sort_value_oldest_activity, #sort_value_oldest_created, #sort_value_oldest_last_activity, #sort_value_oldest_signin, #sort_value_oldest_updated, #sort_value_popularity, #sort_value_priority, #sort_value_recently_created, #sort_value_recently_last_activity, #sort_value_recently_signin, #sort_value_recently_updated, #sort_value_relative_position, #sort_value_relevance, #sort_value_size, #sort_value_stars_desc, #sort_value_start_date_later, #sort_value_start_date_soon, #sort_value_title, #sort_value_title_desc, #sort_value_upvotes, #sort_value_version_asc, #sort_value_version_desc

Methods included from ToggleAwardEmoji

#toggle_award_emoji

Methods included from IssuableActions

#bulk_update, #check_destroy_confirmation!, #destroy, #realtime_changes, #update

Methods included from Spam::Concerns::HasSpamActionResponseFields

#spam_action_response_fields

Methods included from SpammableActions::AkismetMarkAsSpamAction

#mark_as_spam

Methods included from Gitlab::Cache::Helpers

#cache, #render_cached

Methods included from ToggleSubscriptionAction

#toggle_subscription

Methods included from SafeFormatHelper

#safe_format, #tag_pair

Methods included from RoutableActions

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

Methods included from ChecksCollaboration

#can_collaborate_with_project?, #user_access

Methods inherited from ApplicationController

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

#store_json_metadata_headers!

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

#fallback_to_email_otp_permitted?, #obfuscated_email, #passkey_authentication_data, #remember_me_enabled?, #render_email_otp_fallback_for_totp?, #session_expire_modal_data, #sign_in_form_app_data, #unconfirmed_email?, #verification_data, #webauthn_authentication_data

Methods included from VerifiesWithEmailHelper

#permitted_to_skip_email_otp_in_grace_period?, #treat_as_locked?, #trusted_ip_address?

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_raw_snippet_blob_url, #gitlab_raw_snippet_url, #gitlab_snippet_note_path, #gitlab_snippet_notes_path, #gitlab_snippet_path, #gitlab_snippet_url, #gitlab_toggle_award_emoji_snippet_note_path, #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, #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

Methods included from ProjectsHelper

#able_to_see_forks_count?, #able_to_see_issues?, #able_to_see_merge_requests?, #any_projects?, #archiving_available?, #author_content_tag, #autodeploy_flash_notice, #badge_count, #branch_rules_path, #can_admin_associated_clusters?, #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_archive_settings_app_data, #project_can_be_shared?, #project_classes, #project_coverage_chart_data_attributes, #project_incident_management_setting, #project_license_name, #project_pages_domain_choices, #project_permissions_panel_data, #project_unarchive_settings_app_data, #projects_filtered_search_and_sort_app_data, #push_project_breadcrumbs, #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_badge?, #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_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_gon_feature_flags, #add_gon_user_specific, #add_gon_variables, #current_organization, #default_avatar_url, #push_application_setting, #push_force_frontend_feature_flag, #push_frontend_ability, #push_frontend_feature_flag, #push_namespace_setting, #push_to_gon_attributes

Methods included from Organizations::OrganizationHelper

#admin_organizations_index_app_data, #organization_activity_app_data, #organization_groups_and_projects_app_data, #organization_groups_edit_app_data, #organization_groups_new_app_data, #organization_index_app_data, #organization_layout_nav, #organization_new_app_data, #organization_projects_edit_app_data, #organization_settings_general_app_data, #organization_show_app_data, #organization_user_app_data, #ui_for_organizations_enabled?

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_page_entrypoint_paths

Methods inherited from BaseActionController

#append_to_content_security_policy

Methods included from ContentSecurityPolicyPatch

#content_security_policy_with_context

Methods included from CurrentOrganization

#set_current_organization

Dynamic Method Handling

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

Instance Attribute Details

#vulnerability_id ⇒ `Object`

Returns the value of attribute vulnerability_id.



87
88
89

# File 'app/controllers/projects/issues_controller.rb', line 87

def vulnerability_id
  @vulnerability_id
end

Instance Method Details

#calendar ⇒ `Object`



104
105
106

# File 'app/controllers/projects/issues_controller.rb', line 104

def calendar
  render_issues_calendar(@issuables)
end

#can_create_branch ⇒ `Object`

# File 'app/controllers/projects/issues_controller.rb', line 246

def can_create_branch
  can_create = current_user &&
    can?(current_user, :push_code, @project) &&
    issue.can_be_worked_on?

  respond_to do |format|
    format.json do
      render json: { can_create_branch: can_create, suggested_branch_name: issue.suggested_branch_name }
    end
  end
end

#create ⇒ `Object`

# File 'app/controllers/projects/issues_controller.rb', line 166

def create
  create_params = issue_params.merge(
    add_related_issue: add_related_issue,
    merge_request_to_resolve_discussions_of: params[:merge_request_to_resolve_discussions_of],
    observability_links: params[:observability_links],
    discussion_to_resolve: params[:discussion_to_resolve]
  )

  service = ::Issues::CreateService.new(container: project, current_user: current_user, params: create_params)
  result = service.execute

  # Only irrecoverable errors such as unauthorized user won't contain an issue in the response
  render_by_create_result_error(result) && return if result.error? && result[:issue].blank?

  @issue = result[:issue]

  if result.success?
    create_vulnerability_issue_feedback(@issue)

    if service.discussions_to_resolve.count(&:resolved?) > 0
      flash[:notice] = if service.discussion_to_resolve_id
                         _("Resolved 1 discussion.")
                       else
                         _("Resolved all discussions.")
                       end
    end

    redirect_to project_issue_path(@project, @issue)
  else
    # NOTE: this CAPTCHA support method is indirectly included via IssuableActions
    with_captcha_check_html_format(spammable: spammable) { render :new }
  end
end

#create_merge_request ⇒ `Object`

# File 'app/controllers/projects/issues_controller.rb', line 258

def create_merge_request
  Labkit::UserExperienceSli.start(:create_merge_request)

  create_params = params.slice(:branch_name, :ref).merge(issue_iid: issue.iid)
  create_params[:target_project_id] = params[:target_project_id]
  result = ::MergeRequests::CreateFromIssueService.new(project: project, current_user: current_user, mr_params: create_params).execute

  if result[:status] == :success
    render json: MergeRequestCreateSerializer.new.represent(result[:merge_request])
  else
    render json: result[:message], status: :unprocessable_entity
  end
end

#discussions ⇒ `Object`

# File 'app/controllers/projects/issues_controller.rb', line 297

def discussions
  Gitlab::QueryLimiting.disable!('https://gitlab.com/gitlab-org/gitlab/-/issues/425834')

  super
end

#edit ⇒ `Object`

# File 'app/controllers/projects/issues_controller.rb', line 155

def edit
  # Check if user can edit the issue
  if can?(current_user, :update_issue, issue)
    # Redirect to issues detail page with edit mode enabled
    redirect_to project_issue_path(project, issue, edit: 'true')
  else
    # Redirect to issues detail page without edit mode
    redirect_to project_issue_path(project, issue)
  end
end

#export_csv ⇒ `Object`

# File 'app/controllers/projects/issues_controller.rb', line 272

def export_csv
  IssuableExportCsvWorker.perform_async(:issue, current_user.id, project.id, finder_options.to_h) # rubocop:disable CodeReuse/Worker

  index_path = project_issues_path(project)
  message = safe_format(_('Your CSV export has started. It will be emailed to %{email} when complete.'),
    email: current_user.notification_email_or_default)
  redirect_to(index_path, notice: message)
end

#import_csv ⇒ `Object`

# File 'app/controllers/projects/issues_controller.rb', line 281

def import_csv
  result = Issues::PrepareImportCsvService.new(project, current_user, file: params[:file]).execute

  if result.success?
    flash[:notice] = result.message
  else
    flash[:alert] = result.message
  end

  redirect_to project_issues_path(project)
end

#index ⇒ `Object`

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

def index
  return if redirect_if_epic_params

  if index_html_request?
    set_sort_order
  else
    @issues = @issuables
  end

  respond_to do |format|
    format.html
    format.atom { render layout: 'xml' }
  end
end

#move ⇒ `Object`

# File 'app/controllers/projects/issues_controller.rb', line 200

def move
  params.require(:move_to_project_id)

  if params[:move_to_project_id].to_i > 0
    new_project = Project.find(params[:move_to_project_id])
    return render_404 unless issue.can_move?(current_user, new_project)

    @issue = ::WorkItems::DataSync::MoveService.new(
      work_item: issue, current_user: current_user, target_namespace: new_project.project_namespace
    ).execute[:work_item]
  end

  respond_to do |format|
    format.json do
      render_issue_json
    end
  end

rescue ActiveRecord::StaleObjectError
  render_conflict_response
end

#new ⇒ `Object`

# File 'app/controllers/projects/issues_controller.rb', line 108

def new
  params[:issue] ||= ActionController::Parameters.new(
    assignee_ids: ""
  )
  build_params = issue_params.merge(
    merge_request_to_resolve_discussions_of: params[:merge_request_to_resolve_discussions_of],
    discussion_to_resolve: params[:discussion_to_resolve],
    observability_links: { metrics: params[:observability_metric_details], logs: params[:observability_log_details], tracing: params[:observability_trace_details] },
    confidential: !!Gitlab::Utils.to_boolean(issue_params[:confidential])
  )
  service = ::Issues::BuildService.new(container: project, current_user: current_user, params: build_params)

  @issue = @noteable = service.execute

  @add_related_issue = add_related_issue

  @merge_request_to_resolve_discussions_of = service.merge_request_to_resolve_discussions_of

  if params[:discussion_to_resolve]
    Gitlab::UsageDataCounters::MergeRequestActivityUniqueCounter.track_resolve_thread_in_issue_action(user: current_user)
    @discussion_to_resolve = service.discussions_to_resolve.first
  end

  respond_with(@issue)
end

#related_branches ⇒ `Object`

# File 'app/controllers/projects/issues_controller.rb', line 232

def related_branches
  @related_branches = ::Issues::RelatedBranchesService
    .new(container: project, current_user: current_user)
    .execute(issue)

  respond_to do |format|
    format.json do
      render json: {
        html: view_to_html_string('projects/issues/_related_branches')
      }
    end
  end
end

#reorder ⇒ `Object`

# File 'app/controllers/projects/issues_controller.rb', line 222

def reorder
  service = ::Issues::ReorderService.new(container: project, current_user: current_user, params: reorder_params)

  if service.execute(issue)
    head :ok
  else
    head :unprocessable_entity
  end
end

#service_desk ⇒ `Object`



293
294
295

# File 'app/controllers/projects/issues_controller.rb', line 293

def service_desk
  @issues = @issuables
end

#show ⇒ `Object` Also known as: designs

# File 'app/controllers/projects/issues_controller.rb', line 134

def show
  return super if issue.require_legacy_views? || !html_request?

  if project&.work_items_consolidated_list_enabled?(current_user)
    if params[:vueroute].present? && request.path.include?('/designs/')
      # Only redirect to designs path if both vueroute param exists and path contains /designs/
      # Needed since designs are aliased to show in this controller
      redirect_to designs_project_work_item_path(project, issue.iid, vueroute: params[:vueroute], params: request.query_parameters)
    else
      redirect_to project_work_item_path(project, issue.iid, params: request.query_parameters)
    end
  else
    @right_sidebar = false
    @work_item = issue.becomes(::WorkItem) # rubocop:disable Cop/AvoidBecomes -- We need the instance to be a work item

    render 'projects/work_items/show'
  end
end