docbrown/app/controllers/search_controller.rb
Daniel Uber 060e426389
validate sort direction (#17439)
* Prefer compact_blank! to delete_if blank

Rubocop suggested this. Why would I argue.

* When sort_direction is anything other than asc or desc, remove it

There is initializer code in the search/query classes that handles nil
sort_direction by adding a default value, so deleting the sort
direction is reasonable here.

* Set a default sort direction for articles of :desc

* Only sort if sort_direction and sort_by are present

* Add test case for article search with invalid parameter
2022-04-27 08:59:13 -05:00

211 lines
5.7 KiB
Ruby

class SearchController < ApplicationController
before_action :authenticate_user!, only: %i[tags reactions usernames]
before_action :format_integer_params
before_action :sanitize_params, only: %i[listings reactions feed_content]
LISTINGS_PARAMS = [
:category,
:listing_search,
:page,
:per_page,
:tag_boolean_mode,
{
tags: []
},
].freeze
REACTION_PARAMS = [
:page,
:per_page,
:category,
:search_fields,
:tag_boolean_mode,
{
tag_names: [],
status: []
},
].freeze
USER_PARAMS = %i[
search_fields
page
per_page
].freeze
FEED_PARAMS = [
:approved,
:class_name,
:id,
:organization_id,
:page,
:per_page,
:search_fields,
:sort_by,
:sort_direction,
:tag,
:user_id,
{
tag_names: [],
published_at: [:gte]
},
].freeze
VALID_SORT_DIRECTIONS = %i[asc desc].freeze
def tags
result = Search::Tag.search_documents(term: params[:name])
render json: { result: result }
end
def listings
result = Search::Listing.search_documents(
category: listing_params[:category],
page: listing_params[:page],
per_page: listing_params[:per_page],
term: listing_params[:listing_search],
)
render json: { result: result }
end
def usernames
result = Search::Username.search_documents(params[:username])
render json: { result: result }
end
def feed_content
class_name = feed_params[:class_name].to_s.inquiry
is_homepage_search = (
class_name.Article? &&
feed_params[:search_fields].blank? &&
feed_params[:sort_by].present?
)
result =
if class_name.blank?
search_postgres_article
elsif is_homepage_search
# NOTE: published_at is sent from the frontend in the following ES-friendly format:
# => {"published_at"=>{"gte"=>"2021-04-06T14:53:23Z"}}
published_at_gte = feed_params.dig(:published_at, :gte)
published_at_gte = Time.zone.parse(published_at_gte) if published_at_gte
published_at = published_at_gte ? published_at_gte.. : nil
# Despite the name "Homepage", this is used by the following index pages:
# => homepage (default, top week/month/year/infinity, latest)
# => profile page
# => organization page
# => tag index page
Homepage::FetchArticles.call(
approved: feed_params[:approved],
published_at: published_at,
user_id: feed_params[:user_id],
organization_id: feed_params[:organization_id],
tags: feed_params[:tag_names],
sort_by: params[:sort_by],
sort_direction: params[:sort_direction],
page: params[:page],
per_page: params[:per_page],
)
elsif class_name.Comment?
Search::Comment.search_documents(
page: feed_params[:page],
per_page: feed_params[:per_page],
sort_by: feed_params[:sort_by],
sort_direction: feed_params[:sort_direction],
term: feed_params[:search_fields],
)
elsif class_name.PodcastEpisode?
Search::PodcastEpisode.search_documents(
page: feed_params[:page],
per_page: feed_params[:per_page],
sort_by: feed_params[:sort_by],
sort_direction: feed_params[:sort_direction],
term: feed_params[:search_fields],
)
elsif class_name.User?
Search::User.search_documents(
term: feed_params[:search_fields],
page: feed_params[:page],
per_page: feed_params[:per_page],
sort_by: feed_params[:sort_by] == "published_at" ? :created_at : nil,
sort_direction: feed_params[:sort_direction],
)
elsif class_name.Article?
search_postgres_article
elsif class_name.Tag?
Search::Tag.search_documents(
term: feed_params[:search_fields],
page: feed_params[:page],
per_page: feed_params[:per_page],
)
end
render json: { result: result }
end
def reactions
# [@rhymes] we're recycling the existing params as we want to change the frontend as
# little as possible, we might simplify in the future
result = Search::ReadingList.search_documents(
current_user,
page: reaction_params[:page],
per_page: reaction_params[:per_page],
statuses: reaction_params[:status],
tags: reaction_params[:tag_names],
term: reaction_params[:search_fields],
)
render json: { result: result[:items], total: result[:total] }
end
private
def search_postgres_article
Search::Article.search_documents(
term: feed_params[:search_fields],
user_id: feed_params[:user_id],
sort_by: feed_params[:sort_by],
sort_direction: feed_params[:sort_direction],
page: feed_params[:page],
per_page: feed_params[:per_page],
)
end
def listing_params
params.permit(LISTINGS_PARAMS)
end
def user_params
params.permit(USER_PARAMS)
end
def feed_params
params.permit(FEED_PARAMS)
end
def reaction_params
params.permit(REACTION_PARAMS)
end
def format_integer_params
params[:page] = params[:page].to_i if params[:page].present?
params[:per_page] = params[:per_page].to_i if params[:per_page].present?
end
# Some Elasticsearches/QueryBuilders treat values such as empty Strings and
# nil differently. This is a helper method to remove any params that are
# blank before passing it to Elasticsearch.
def sanitize_params
params.compact_blank!
remove_invalid_sort_directions
end
def remove_invalid_sort_directions
return unless params.key?(:sort_direction)
direction = params[:sort_direction].downcase.to_sym
params.delete(:sort_direction) unless direction.in?(VALID_SORT_DIRECTIONS)
end
end