mirror of
https://github.com/discourse/discourse.git
synced 2024-12-01 05:33:47 +08:00
3e4621c2cb
This pull request follows on from https://github.com/discourse/discourse/pull/16308. This one does the following:
* Changes `BookmarkQuery` to allow for querying more than just Post and Topic bookmarkables
* Introduces a `Bookmark.register_bookmarkable` method which requires a model, serializer, fields and preload includes for searching. These registered `Bookmarkable` types are then used when validating new bookmarks, and also when determining which serializer to use for the bookmark list. The `Post` and `Topic` bookmarkables are registered by default.
* Adds new specific types for Post and Topic bookmark serializers along with preloading of associations in `UserBookmarkList`
* Changes to the user bookmark list template to allow for more generic bookmarkable types alongside the Post and Topic ones which need to display in a particular way
All of these changes are gated behind the `use_polymorphic_bookmarks` site setting, apart from the .hbs changes where I have updated the original `UserBookmarkSerializer` with some stub methods.
Following this PR will be several plugin PRs (for assign, chat, encrypt) that will register their own bookmarkable types or otherwise alter the bookmark serializers in their own way, also gated behind `use_polymorphic_bookmarks`.
This commit also removes `BookmarkQuery.preloaded_custom_fields` and the functionality surrounding it. It was added in 0cd502a558 but only used by one plugin (discourse-assign) where it has since been removed, and is now used by no plugins. We don't need it anymore.
81 lines
3.7 KiB
Ruby
81 lines
3.7 KiB
Ruby
# frozen_string_literal: true
|
|
#
|
|
# Should only be created via the Bookmark.register_bookmarkable
|
|
# method; this is used to let the BookmarkQuery class query and
|
|
# search additional bookmarks for the user bookmark list, and
|
|
# also to enumerate on the registered Bookmarkable types.
|
|
#
|
|
# Post and Topic bookmarkables are registered by default.
|
|
#
|
|
# Anything other than types registered in this way will throw an error
|
|
# when trying to save the Bookmark record. All things that are bookmarkable
|
|
# must be registered in this way.
|
|
#
|
|
# See Bookmark#reset_bookmarkables for some examples on how registering
|
|
# bookmarkables works.
|
|
class Bookmarkable
|
|
attr_reader :model, :serializer, :list_query, :search_query, :preload_associations
|
|
delegate :table_name, to: :@model
|
|
|
|
def initialize(model:, serializer:, list_query:, search_query:, preload_associations: [])
|
|
@model = model
|
|
@serializer = serializer
|
|
@list_query = list_query
|
|
@search_query = search_query
|
|
@preload_associations = preload_associations
|
|
end
|
|
|
|
##
|
|
# This is where the main query to filter the bookmarks by the provided bookmarkable
|
|
# type should occur. This should join on additional tables that are required later
|
|
# on to preload additional data for serializers, and also is the place where the
|
|
# bookmarks should be filtered based on security checks, which is why the Guardian
|
|
# instance is provided.
|
|
#
|
|
# @param [User] user The user to perform the query for, this scopes the bookmarks returned.
|
|
# @param [Guardian] guardian An instance of Guardian for the user to be used for security filters.
|
|
def perform_list_query(user, guardian)
|
|
list_query.call(user, guardian)
|
|
end
|
|
|
|
##
|
|
# Called from BookmarkQuery when the initial results have been returned by
|
|
# perform_list_query. The search_query should join additional tables required
|
|
# to filter the bookmarks further, as well as defining a string used for
|
|
# where_sql, which can include comparisons with the :q parameter.
|
|
#
|
|
# The block here warrants explanation -- when the search_query is called, we
|
|
# call the provided block with the bookmark relation with additional joins
|
|
# as well as the where_sql string, and then also add the additional OR bookmarks.name
|
|
# filter. This is so every bookmarkable is filtered by its own customized
|
|
# columns _as well as_ the bookmark name, because the bookmark name must always
|
|
# be used in the search.
|
|
#
|
|
# @param [Bookmark::ActiveRecord_Relation] bookmarks The bookmark records returned by perform_list_query
|
|
# @param [String] query The search query from the user surrounded by the %% wildcards
|
|
# @param [String] ts_query The postgres TSQUERY string used for comparisons with full text search columns
|
|
def perform_search_query(bookmarks, query, ts_query)
|
|
search_query.call(bookmarks, query, ts_query) do |bookmarks_joined, where_sql|
|
|
bookmarks_joined.where("#{where_sql} OR bookmarks.name ILIKE :q", q: query)
|
|
end
|
|
end
|
|
|
|
##
|
|
# When displaying the bookmarks in a list for a user there is often additional
|
|
# information drawn from other tables joined to the bookmarkable that must
|
|
# be displayed. We preload these additional associations here on top of the
|
|
# array of bookmarks which has already been filtered, offset by page, ordered,
|
|
# and limited. The preload_associations array should be in the same format as
|
|
# used for .includes() e.g.
|
|
#
|
|
# [{ topic: [:topic_users, :tags] }, :user]
|
|
#
|
|
# @param [Array] bookmarks The array of bookmarks after initial listing and filtering, note this is
|
|
# array _not_ an ActiveRecord::Relation.
|
|
def perform_preload(bookmarks)
|
|
ActiveRecord::Associations::Preloader.new.preload(
|
|
Bookmark.select_type(bookmarks, model.to_s), { bookmarkable: preload_associations }
|
|
)
|
|
end
|
|
end
|