docbrown/app/controllers/search_controller.rb
rhymes 83852038e4
[Search 2.0] Reading list (#13052)
* Step one in populating the reading list with PG

This first attempt tries to recycle the `Search::ArticleSerializer` which is only
used in input in ES, but we're using it in output in PG.
For this reason it's currently 15.55x times slower

* Serialize only what is requested by the frontend

`Search::ArticleSerializer` which is only used in ES in the indexing step aims
to add as much info as possible for broader purposes, in this case
(with serialization in output) we should aim to save only what's requested from
the frontend.

* Optimize selection of articles columns

* Select only needed columns for users

* Compute total of reading list items

* Attach the basic filtering based on PG on the search controller

* Restructure in methods

* Add tags support

* Use LIKE on articles.cached_tag_list

* Fix tags as nil

* Fix default pagination

* Add optional FTS for reading list

* Reworded the tags comment explaining why

* Add index to reactions.status

* Fix total counter in Preact readingList component

* Fix total count in reading list backend search

* Add GIN index to articles.cached_tag_list

* Add service tests

* Add search request specs

* Added missing early return

* Update spec/requests/search_spec.rb

Co-authored-by: Julianna Tetreault <32834804+juliannatetreault@users.noreply.github.com>

* Extract MAX_PER_PAGE constant and add comments

Co-authored-by: Julianna Tetreault <32834804+juliannatetreault@users.noreply.github.com>
2021-03-24 15:40:00 +01:00

195 lines
4.9 KiB
Ruby

class SearchController < ApplicationController
before_action :authenticate_user!, only: %i[tags chat_channels 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,
:user_id,
{
tag_names: [],
published_at: [:gte]
},
].freeze
def tags
result = if FeatureFlag.enabled?(:search_2_tags)
Search::Postgres::Tag.search_documents(params[:name])
else
Search::Tag.search_documents("name:#{params[:name]}* AND supported:true")
end
render json: { result: result }
rescue Search::Errors::Transport::BadRequest
render json: { result: [] }
end
def chat_channels
search_user_id = if chat_channel_params[:user_id].present?
[current_user.id, SiteConfig.mascot_user_id, chat_channel_params[:user_id]].reject(&:blank?)
else
[current_user.id]
end
ccm_docs = Search::ChatChannelMembership.search_documents(
params: chat_channel_params.merge(user_id: search_user_id).to_h,
)
render json: { result: ccm_docs }
end
def listings
cl_docs = Search::Listing.search_documents(
params: listing_params.to_h,
)
render json: { result: cl_docs }
end
def users
render json: { result: user_search }
end
def usernames
result = if FeatureFlag.enabled?(:search_2_usernames)
Search::Postgres::Username.search_documents(params[:username])
else
Search::User.search_usernames(params[:username])
end
render json: { result: result }
rescue Search::Errors::Transport::BadRequest
render json: { result: [] }
end
def feed_content
feed_docs = if params[:class_name].blank?
# If we are in the main feed and not filtering by type return
# all articles, podcast episodes, and users
feed_content_search.concat(user_search)
elsif params[:class_name] == "User"
# No need to check for articles or podcast episodes if we know we only want users
user_search
else
# if params[:class_name] == PodcastEpisode, Article, or Comment then skip user lookup
feed_content_search
end
render json: {
result: feed_docs,
display_jobs_banner: SiteConfig.display_jobs_banner,
jobs_url: SiteConfig.jobs_url
}
end
def reactions
if FeatureFlag.enabled?(:search_2_reading_list)
# [@rhymes] we're recyling the existing params as we want to change the frontend as
# little as possible, we might simplify in the future
result = Search::Postgres::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] }
else
result = Search::ReadingList.search_documents(
params: reaction_params.to_h, user: current_user,
)
render json: { result: result["reactions"], total: result["total"] }
end
end
private
def feed_content_search
Search::FeedContent.search_documents(params: feed_params.to_h)
end
def user_search
Search::User.search_documents(params: user_params.to_h)
end
def chat_channel_params
accessible = %i[
per_page
page
channel_text
channel_type
channel_status
status
user_id
]
params.permit(accessible)
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.delete_if { |_k, v| v.blank? }
end
end