gitlab-ce/app/finders/issues_finder.rb

148 lines
4.3 KiB
Ruby

# frozen_string_literal: true
# Finders::Issues class
#
# Used to filter Issues collections by set of params
#
# Arguments:
# current_user - which user use
# params:
# scope: 'created_by_me' or 'assigned_to_me' or 'all'
# state: 'opened' or 'closed' or 'all'
# group_id: integer
# project_id: integer
# milestone_title: string (cannot be simultaneously used with milestone_wildcard_id)
# milestone_wildcard_id: 'none', 'any', 'upcoming', 'started' (cannot be simultaneously used with milestone_title)
# assignee_id: integer
# closed_by_id: integer
# search: string
# in: 'title', 'description', or a string joining them with comma
# label_name: string
# sort: string
# my_reaction_emoji: string
# due_date: date or '0', '', 'overdue', 'week', or 'month'
# due_after: datetime
# due_before: datetime
# created_after: datetime
# created_before: datetime
# updated_after: datetime
# updated_before: datetime
# confidential: boolean
# issue_types: array of strings (one of WorkItems::Type.base_types)
#
class IssuesFinder < IssuableFinder
extend ::Gitlab::Utils::Override
def self.scalar_params
@scalar_params ||= super + [:due_date]
end
def klass
Issue
end
def params_class
self.class.const_get(:Params, false)
end
private
def filter_items(items)
issues = by_service_desk(items) # Call before super because we remove params
issues = super(issues)
issues = by_due_date(issues)
issues = by_due_after_or_before(issues)
issues = by_confidential(issues)
by_issue_types(issues)
end
# Negates all params found in `negatable_params`
def filter_negated_items(items)
issues = super
by_negated_issue_types(issues)
end
override :filter_by_full_text_search
def filter_by_full_text_search(items)
# This project condition is used as a hint to PG about the partitions that need searching
# because the search data is partitioned by project.
# In certain cases, like the recent items search, the query plan is much better without this condition.
return super if params[:skip_full_text_search_project_condition].present?
super.with_projects_matching_search_data
end
def by_confidential(items)
Issues::ConfidentialityFilter.new(
current_user: current_user,
params: original_params,
parent: params.parent,
assignee_filter: assignee_filter
).filter(items)
end
def by_due_after_or_before(items)
items = items.due_after(params[:due_after]) if params[:due_after].present?
items = items.due_before(params[:due_before]) if params[:due_before].present?
items
end
def by_due_date(items)
return items unless params.due_date?
if params.filter_by_no_due_date?
items.without_due_date
elsif params.filter_by_any_due_date?
items.with_due_date
elsif params.filter_by_overdue?
items.due_before(Date.today)
elsif params.filter_by_due_today?
items.due_today
elsif params.filter_by_due_tomorrow?
items.due_tomorrow
elsif params.filter_by_due_this_week?
items.due_between(Date.today.beginning_of_week, Date.today.end_of_week)
elsif params.filter_by_due_this_month?
items.due_between(Date.today.beginning_of_month, Date.today.end_of_month)
elsif params.filter_by_due_next_month_and_previous_two_weeks?
items.due_between(Date.today - 2.weeks, (Date.today + 1.month).end_of_month)
else
items.none
end
end
def by_issue_types(items)
types_filter.filter(items)
end
def types_filter
Issues::IssueTypesFilter.new(
params: original_params,
parent: params.parent
)
end
strong_memoize_attr :types_filter
def by_service_desk(items)
return items unless params[:author_username] == "support-bot"
# Delete param so we don't additionally filter by author username
params.delete(:author_username)
# Also delete from here because we pass original_params to
# Issuables::AuthorFilter in IssuableFinder
original_params.delete(:author_username)
items.service_desk
end
def by_negated_issue_types(items)
issue_type_params = Array(not_params[:issue_types]).map(&:to_s) & WorkItems::Type.base_types.keys
return items if issue_type_params.blank?
items.without_issue_type(issue_type_params)
end
end
IssuesFinder.prepend_mod_with('IssuesFinder')