A platform for community discussion. Free, open, simple.
# frozen_string_literal: true
RSpec.describe NestedTopic::ListRoots do
describe described_class::Contract, type: :model do
subject { described_class.new(sort: "top", page: 0) }
it { is_expected.to validate_presence_of(:sort) }
it { is_expected.to validate_presence_of(:page) }
it { is_expected.not_to allow_value(-1).for(:page) }
end
describe ".call" do
subject(:result) { described_class.call(params:, **dependencies) }
fab!(:user) { Fabricate(:user, refresh_auto_groups: true) }
fab!(:topic) { Fabricate(:topic, user: user) }
fab!(:op) { Fabricate(:post, topic: topic, user: user, post_number: 1) }
let(:topic_view) do
TopicView.new(topic.id, user, skip_custom_fields: true, skip_post_loading: true)
end
let(:dependencies) { { guardian: user.guardian, topic_view: topic_view } }
let(:params) { { sort: "top", page: 0 } }
before { SiteSetting.nested_replies_enabled = true }
context "when contract is invalid" do
let(:params) { { sort: nil, page: nil } }
it { is_expected.to fail_a_contract }
end
context "when page 0 with no posts" do
it { is_expected.to run_successfully }
it "returns an empty roots list with topic metadata" do
response = result[:response]
expect(response[:roots]).to be_empty
expect(response[:page]).to eq(0)
expect(response).to have_key(:topic)
expect(response).to have_key(:op_post)
expect(response).to have_key(:sort)
expect(response).to have_key(:message_bus_last_id)
end
end
context "when page 0 with root posts" do
fab!(:root_post) { Fabricate(:post, topic: topic, user: user, reply_to_post_number: 1) }
it { is_expected.to run_successfully }
it "includes root posts and topic metadata in the response" do
response = result[:response]
expect(response[:roots]).to be_present
expect(response[:roots].first[:id]).to eq(root_post.id)
expect(response[:topic]).to be_present
expect(response[:op_post]).to be_present
expect(response[:sort]).to eq("top")
expect(response[:message_bus_last_id]).to be_an(Integer)
end
end
context "when nesting is capped" do
before do
SiteSetting.nested_replies_cap_nesting_depth = true
SiteSetting.nested_replies_max_depth = 3
end
it "returns deeper branches as one sorted collection at the depth boundary" do
root = Fabricate(:post, topic: topic, user: user, reply_to_post_number: 1)
second_level =
Fabricate(:post, topic: topic, user: user, reply_to_post_number: root.post_number)
boundary_parent =
Fabricate(:post, topic: topic, user: user, reply_to_post_number: second_level.post_number)
left =
Fabricate(
:post,
topic: topic,
user: user,
reply_to_post_number: boundary_parent.post_number,
)
right =
Fabricate(
:post,
topic: topic,
user: user,
reply_to_post_number: boundary_parent.post_number,
)
right_children =
2.times.map do
Fabricate(:post, topic: topic, user: user, reply_to_post_number: right.post_number)
end
left_children =
2.times.map do
Fabricate(:post, topic: topic, user: user, reply_to_post_number: left.post_number)
end
response =
stub_const(NestedReplies::TreeLoader, :PRELOAD_CHILDREN_PER_PARENT, 10) do
described_class.call(params: { sort: "old", page: 0 }, **dependencies)[:response]
end
boundary_json = response[:roots].first.dig(:children, 0, :children, 0)
expected_posts = [left, right, *right_children, *left_children]
expect(boundary_json[:children].map { |post_json| post_json[:id] }).to eq(
expected_posts.map(&:id),
)
expect(boundary_json[:children].map { |post_json| post_json[:children] }.uniq).to eq([[]])
end
it "keeps roots without replies when the boundary is the root level" do
SiteSetting.nested_replies_max_depth = 1
lonely = Fabricate(:post, topic: topic, user: user, reply_to_post_number: 1)
chatty = Fabricate(:post, topic: topic, user: user, reply_to_post_number: 1)
Fabricate(:post, topic: topic, user: user, reply_to_post_number: chatty.post_number)
response = described_class.call(params: { sort: "old", page: 0 }, **dependencies)[:response]
expect(response[:roots].map { |root_json| root_json[:id] }).to eq([lonely.id, chatty.id])
end
end
context "when staff views root posts with official notices" do
fab!(:admin) { Fabricate(:admin, refresh_auto_groups: true) }
fab!(:root_post) { Fabricate(:post, topic: topic, user: user, reply_to_post_number: 1) }
let(:topic_view) do
TopicView.new(topic.id, admin, skip_custom_fields: true, skip_post_loading: true)
end
let(:dependencies) { { guardian: admin.guardian, topic_view: topic_view } }
before do
root_post.custom_fields[Post::NOTICE] = {
type: Post.notices[:custom],
raw: "Official reply notice",
cooked: "<p>Official reply notice</p>",
created_by_user_id: admin.id,
}
root_post.save_custom_fields
end
it "serializes the official notice creator for nested posts" do
root_json = result[:response][:roots].first
expect(root_json[:notice]).to eq(
{
cooked: "<p>Official reply notice</p>",
created_by_user_id: admin.id,
raw: "Official reply notice",
type: Post.notices[:custom],
}.with_indifferent_access,
)
expect(root_json[:notice_created_by_user]).to eq(
{
id: admin.id,
username: admin.username,
name: admin.name,
avatar_template: admin.avatar_template,
},
)
end
end
context "when page is greater than 0" do
let(:params) { { sort: "top", page: 1 } }
it { is_expected.to run_successfully }
it "does not include topic metadata in the response" do
response = result[:response]
expect(response).to have_key(:roots)
expect(response).not_to have_key(:topic)
expect(response).not_to have_key(:op_post)
expect(response).not_to have_key(:sort)
end
end
context "when there are pinned roots on page 0" do
fab!(:root_post) { Fabricate(:post, topic: topic, user: user, reply_to_post_number: 1) }
fab!(:pinned_post) { Fabricate(:post, topic: topic, user: user, reply_to_post_number: 1) }
before { Fabricate(:nested_topic, topic: topic).update!(pinned_post_ids: [pinned_post.id]) }
it { is_expected.to run_successfully }
it "promotes the pinned post to the front of the roots list" do
response = result[:response]
root_ids = response[:roots].map { |r| r[:id] }
expect(root_ids.first).to eq(pinned_post.id)
end
it "includes pinned_post_ids in the response" do
response = result[:response]
expect(response[:pinned_post_ids]).to include(pinned_post.id)
end
end
context "when there are pinned roots on page 1" do
let(:params) { { sort: "top", page: 1 } }
fab!(:root_post) { Fabricate(:post, topic: topic, user: user, reply_to_post_number: 1) }
before { Fabricate(:nested_topic, topic: topic).update!(pinned_post_ids: [root_post.id]) }
it { is_expected.to run_successfully }
it "does not promote pinned posts" do
response = result[:response]
expect(response).not_to have_key(:pinned_post_ids)
end
it "excludes pinned posts from paginated results" do
response = result[:response]
root_ids = response[:roots].map { |r| r[:id] }
expect(root_ids).not_to include(root_post.id)
end
end
end
end