6f3c490107
This refactors the AutocompleteController according to the guidelines and boundaries discussed in https://gitlab.com/gitlab-org/gitlab-ce/issues/49653. Specifically, ActiveRecord logic is moved to different finders, which are then used in the controller. View logic in turn is moved to presenters, instead of directly using ActiveRecord's "to_json" method. The finder MoveToProjectFinder is also adjusted according to the abstraction guidelines and boundaries, resulting in a much more simple finder. By using finders (and other abstractions) more actively, we can push a lot of logic out of the controller. We also remove the need for various "before_action" hooks, though this could be achieved without using finders as well. The various finders related to AutcompleteController have also been moved into a namespace. This removes the need for calling everything "AutocompleteSmurfFinder", instead you can use "Autocomplete::SmurfFinder".
85 lines
2.3 KiB
Ruby
85 lines
2.3 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module Autocomplete
|
|
class UsersFinder
|
|
# The number of users to display in the results is hardcoded to 20, and
|
|
# pagination is not supported. This ensures that performance remains
|
|
# consistent and removes the need for implementing keyset pagination to
|
|
# ensure good performance.
|
|
LIMIT = 20
|
|
|
|
attr_reader :current_user, :project, :group, :search, :skip_users,
|
|
:author_id, :todo_filter, :todo_state_filter,
|
|
:filter_by_current_user
|
|
|
|
def initialize(params:, current_user:, project:, group:)
|
|
@current_user = current_user
|
|
@project = project
|
|
@group = group
|
|
@search = params[:search]
|
|
@skip_users = params[:skip_users]
|
|
@author_id = params[:author_id]
|
|
@todo_filter = params[:todo_filter]
|
|
@todo_state_filter = params[:todo_state_filter]
|
|
@filter_by_current_user = params[:current_user]
|
|
end
|
|
|
|
def execute
|
|
items = limited_users
|
|
|
|
if search.blank?
|
|
# Include current user if available to filter by "Me"
|
|
items.unshift(current_user) if prepend_current_user?
|
|
|
|
if prepend_author? && (author = User.find_by_id(author_id))
|
|
items.unshift(author)
|
|
end
|
|
end
|
|
|
|
items.uniq
|
|
end
|
|
|
|
private
|
|
|
|
# Returns the users based on the input parameters, as an Array.
|
|
#
|
|
# This method is separate so it is easier to extend in EE.
|
|
def limited_users
|
|
# When changing the order of these method calls, make sure that
|
|
# reorder_by_name() is called _before_ optionally_search(), otherwise
|
|
# reorder_by_name will break the ORDER BY applied in optionally_search().
|
|
find_users
|
|
.active
|
|
.reorder_by_name
|
|
.optionally_search(search)
|
|
.where_not_in(skip_users)
|
|
.limit_to_todo_authors(
|
|
user: current_user,
|
|
with_todos: todo_filter,
|
|
todo_state: todo_state_filter
|
|
)
|
|
.limit(LIMIT)
|
|
.to_a
|
|
end
|
|
|
|
def prepend_current_user?
|
|
filter_by_current_user.present? && current_user
|
|
end
|
|
|
|
def prepend_author?
|
|
author_id.present? && current_user
|
|
end
|
|
|
|
def find_users
|
|
if project
|
|
project.authorized_users.union_with_user(author_id)
|
|
elsif group
|
|
group.users_with_parents
|
|
elsif current_user
|
|
User.all
|
|
else
|
|
User.none
|
|
end
|
|
end
|
|
end
|
|
end
|