Skip to content

A platform for community discussion. Free, open, simple.

4.9 KB
Raw Blame
# frozen_string_literal: true

class NestedTopic::ListRoots
  include Service::Base

  params do
    attribute :sort, :string
    attribute :page, :integer

    validates :sort, presence: true
    validates :page, presence: true, numericality: { greater_than_or_equal_to: 0 }
  end

  model :loader, :build_loader
  model :preloader, :build_preloader
  model :serializer, :build_serializer
  step :load_roots
  only_if(:initial_page) { step :promote_pinned_roots }
  step :expand_reply_trees
  step :prepare_posts
  step :serialize_roots
  only_if(:initial_page) { step :enrich_with_topic_metadata }
  only_if(:final_page) { step :attach_suggested_and_related }

  private

  def build_loader(topic_view:, guardian:)
    NestedReplies::TreeLoader.new(topic: topic_view.topic, guardian: guardian)
  end

  def build_preloader(topic_view:, guardian:)
    NestedReplies::PostPreloader.new(
      topic_view: topic_view,
      topic: topic_view.topic,
      current_user: guardian.user,
      guardian: guardian,
    )
  end

  def build_serializer(topic_view:, guardian:)
    NestedReplies::PostTreeSerializer.new(
      topic: topic_view.topic,
      topic_view: topic_view,
      guardian: guardian,
    )
  end

  def initial_page(params:)
    params.page == 0
  end

  def final_page(has_more_roots:)
    !has_more_roots
  end

  def load_roots(params:, loader:, topic_view:)
    pinned_post_ids = topic_view.topic.nested_topic&.pinned_post_ids.presence
    scope = loader.root_posts_scope(params.sort)
    scope = scope.where.not(id: pinned_post_ids) if pinned_post_ids.present?
    roots =
      scope.offset(params.page * NestedReplies::TreeLoader::ROOTS_PER_PAGE).limit(
        NestedReplies::TreeLoader::ROOTS_PER_PAGE,
      )
    context[:roots] = loader.load_posts_for_tree(roots).to_a
    context[:has_more_roots] = context[:roots].size == NestedReplies::TreeLoader::ROOTS_PER_PAGE
  end

  def promote_pinned_roots(loader:, topic_view:, roots:)
    pinned_post_ids = topic_view.topic.nested_topic&.pinned_post_ids.presence
    context[:pinned_post_ids] = pinned_post_ids
    context[:roots] = loader.promote_pinned_roots(roots, pinned_post_ids)
  end

  def expand_reply_trees(loader:, params:, roots:)
    tree_data =
      loader.batch_preload_tree(
        roots,
        params.sort,
        max_depth: NestedReplies::TreeLoader::PRELOAD_DEPTH,
        starting_depth: 0,
      )
    context[:children_map] = tree_data[:children_map]
    context[:all_posts] = tree_data[:all_posts]
  end

  def prepare_posts(params:, loader:, preloader:, all_posts:)
    posts = params.page == 0 ? [loader.op_post] + all_posts : all_posts.dup

    preloader.prepare(posts)
    counts = loader.tree_counts(posts)
    context[:reply_counts] = counts[:reply_counts]
    context[:descendant_counts] = counts[:descendant_counts]
  end

  def serialize_roots(
    params:,
    roots:,
    has_more_roots:,
    children_map:,
    reply_counts:,
    descendant_counts:,
    serializer:
  )
    context[:response] = {
      roots:
        roots.map do |root|
          serializer.serialize_tree(root, children_map, reply_counts, descendant_counts)
        end,
      has_more_roots: has_more_roots,
      page: params.page,
    }
  end

  def enrich_with_topic_metadata(
    params:,
    serializer:,
    loader:,
    topic_view:,
    reply_counts:,
    descendant_counts:,
    response:,
    pinned_post_ids:,
    has_more_roots:
  )
    suppress_suggested_and_related_queries(topic_view) if has_more_roots
    response[:topic] = serializer.serialize_topic
    response[:op_post] = serializer.serialize_post(loader.op_post, reply_counts, descendant_counts)
    response[:sort] = params.sort
    response[:effective_sort] = loader.effective_sort(params.sort)
    response[:message_bus_last_id] = topic_view.message_bus_last_id
    response[:pinned_post_ids] = pinned_post_ids if pinned_post_ids.present?
  end

  def attach_suggested_and_related(serializer:, response:)
    response.merge!(serializer.serialize_suggested_and_related)
  end

  # Match flat view behavior: don't run the suggested/related queries
  # when there are more pages of roots coming. The core suggested/related
  # queries honor these include_* flags. The discourse-ai plugin's
  # `related_topics` serializer attribute gates on `object.next_page.nil?`
  # (plugins/discourse-ai/lib/embeddings/entry_point.rb), and also uses
  # `related_topics` in its `TopicView#categories` override to preload
  # category badges on lazy_load_categories sites — so we set @next_page
  # to a non-nil value here, which both short-circuits the AI serializer
  # gate and lets the categories override continue to run unchanged.
  # TopicView's skip_post_loading: true otherwise leaves next_page nil.
  def suppress_suggested_and_related_queries(topic_view)
    topic_view.include_suggested = false
    topic_view.include_related = false
    topic_view.instance_variable_set(:@next_page, topic_view.page + 1)
  end
end