FIX: Regression in custom homepage modifier used in theme components (#27569)

This commit is contained in:
Penar Musaraj 2024-06-21 11:24:11 -04:00 committed by GitHub
parent 099bffe37a
commit f4108702c8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 91 additions and 65 deletions

View File

@ -492,7 +492,7 @@ class ApplicationController < ActionController::Base
end end
def current_homepage def current_homepage
current_user&.user_option&.homepage || HomepageHelper.resolve(@theme_id, current_user) current_user&.user_option&.homepage || HomepageHelper.resolve(request, current_user)
end end
def serialize_data(obj, serializer, opts = nil) def serialize_data(obj, serializer, opts = nil)

View File

@ -560,7 +560,7 @@ module ApplicationHelper
end end
def current_homepage def current_homepage
current_user&.user_option&.homepage || HomepageHelper.resolve(theme_id, current_user) current_user&.user_option&.homepage || HomepageHelper.resolve(request, current_user)
end end
def build_plugin_html(name) def build_plugin_html(name)

View File

@ -9,11 +9,10 @@ class HomePageConstraint
return @filter == "finish_installation" if SiteSetting.has_login_hint? return @filter == "finish_installation" if SiteSetting.has_login_hint?
current_user = CurrentUser.lookup_from_env(request.env) current_user = CurrentUser.lookup_from_env(request.env)
# ensures we resolve the theme id as early as possible # ensures we resolve the theme id as early as possible
theme_id = ThemeResolver.resolve_theme_id(request, Guardian.new(current_user), current_user) ThemeResolver.resolve_theme_id(request, Guardian.new(current_user), current_user)
homepage = current_user&.user_option&.homepage || HomepageHelper.resolve(theme_id, current_user) homepage = current_user&.user_option&.homepage || HomepageHelper.resolve(request, current_user)
homepage == @filter homepage == @filter
rescue Discourse::InvalidAccess, Discourse::ReadOnly rescue Discourse::InvalidAccess, Discourse::ReadOnly
false false

View File

@ -1,8 +1,8 @@
# frozen_string_literal: true # frozen_string_literal: true
class HomepageHelper class HomepageHelper
def self.resolve(theme_id = nil, current_user = nil) def self.resolve(request = nil, current_user = nil)
return "custom" if ThemeModifierHelper.new(theme_ids: theme_id).custom_homepage return "custom" if ThemeModifierHelper.new(request: request).custom_homepage
current_user ? SiteSetting.homepage : SiteSetting.anonymous_homepage current_user ? SiteSetting.homepage : SiteSetting.anonymous_homepage
end end

View File

@ -53,6 +53,64 @@ describe "Homepage", type: :system do
expect(page).to have_css(".navigation-container .categories.active", text: "Categories") expect(page).to have_css(".navigation-container .categories.active", text: "Categories")
end end
shared_examples "a custom homepage" do
it "shows the custom homepage component" do
visit "/"
expect(page).to have_css(".new-home", text: "Hi friends!")
expect(page).to have_no_css(".list-container")
find("#sidebar-section-content-community li:first-child").click
expect(page).to have_css(".list-container")
find("#site-logo").click
expect(page).to have_no_css(".list-container")
# ensure clicking on logo brings user back to the custom homepage
expect(page).to have_css(".new-home", text: "Hi friends!")
end
it "respects the user's homepage choice" do
visit "/"
expect(page).not_to have_css(".list-container")
expect(page).to have_css(".new-home", text: "Hi friends!")
sign_in user
visit "/u/#{user.username}/preferences/interface"
homepage_picker = PageObjects::Components::SelectKit.new("#home-selector")
homepage_picker.expand
# user overrides theme custom homepage
homepage_picker.select_row_by_name("Top")
page.find(".btn-primary.save-changes").click
# Wait for the save to complete
find(".btn-primary.save-changes:not([disabled])", wait: 5)
find("#site-logo").click
expect(page).to have_css(".navigation-container .top.active", text: "Top")
expect(page).to have_css(".top-lists")
visit "/u/#{user.username}/preferences/interface"
homepage_picker = PageObjects::Components::SelectKit.new("#home-selector")
homepage_picker.expand
# user selects theme custom homepage again
homepage_picker.select_row_by_name("(default)")
page.find(".btn-primary.save-changes").click
# Wait for the save to complete
find(".btn-primary.save-changes:not([disabled])", wait: 5)
find("#site-logo").click
expect(page).not_to have_css(".list-container")
expect(page).to have_css(".new-home", text: "Hi friends!")
end
end
context "when default theme uses a custom_homepage modifier" do context "when default theme uses a custom_homepage modifier" do
before do before do
theme.theme_modifier_set.custom_homepage = true theme.theme_modifier_set.custom_homepage = true
@ -76,64 +134,6 @@ describe "Homepage", type: :system do
expect(page).to have_css(".alert-info") expect(page).to have_css(".alert-info")
end end
shared_examples "a custom homepage" do
it "shows the custom homepage component" do
visit "/"
expect(page).to have_css(".new-home", text: "Hi friends!")
expect(page).to have_no_css(".list-container")
find("#sidebar-section-content-community li:first-child").click
expect(page).to have_css(".list-container")
find("#site-logo").click
expect(page).to have_no_css(".list-container")
# ensure clicking on logo brings user back to the custom homepage
expect(page).to have_css(".new-home", text: "Hi friends!")
end
it "respects the user's homepage choice" do
visit "/"
expect(page).not_to have_css(".list-container")
expect(page).to have_css(".new-home", text: "Hi friends!")
sign_in user
visit "/u/#{user.username}/preferences/interface"
homepage_picker = PageObjects::Components::SelectKit.new("#home-selector")
homepage_picker.expand
# user overrides theme custom homepage
homepage_picker.select_row_by_name("Top")
page.find(".btn-primary.save-changes").click
# Wait for the save to complete
find(".btn-primary.save-changes:not([disabled])", wait: 5)
find("#site-logo").click
expect(page).to have_css(".navigation-container .top.active", text: "Top")
expect(page).to have_css(".top-lists")
visit "/u/#{user.username}/preferences/interface"
homepage_picker = PageObjects::Components::SelectKit.new("#home-selector")
homepage_picker.expand
# user selects theme custom homepage again
homepage_picker.select_row_by_name("(default)")
page.find(".btn-primary.save-changes").click
# Wait for the save to complete
find(".btn-primary.save-changes:not([disabled])", wait: 5)
find("#site-logo").click
expect(page).not_to have_css(".list-container")
expect(page).to have_css(".new-home", text: "Hi friends!")
end
end
context "when the theme adds content to the [custom-homepage] connector" do context "when the theme adds content to the [custom-homepage] connector" do
let!(:basic_html_field) do let!(:basic_html_field) do
Fabricate( Fabricate(
@ -175,4 +175,31 @@ describe "Homepage", type: :system do
include_examples "a custom homepage" include_examples "a custom homepage"
end end
end end
context "when a theme component uses the custom_homepage modifier" do
let!(:component) { Fabricate(:theme, component: true) }
let!(:component_html_field) do
Fabricate(
:theme_field,
theme: component,
type_id: ThemeField.types[:html],
target_id: Theme.targets[:common],
name: "head_tag",
value: <<~HTML,
<script type="text/x-handlebars" data-template-name="/connectors/custom-homepage/new-home">
<div class="new-home">Hi friends!</div>
</script>
HTML
)
end
before do
component.theme_modifier_set.custom_homepage = true
component.theme_modifier_set.save!
theme.add_relative_theme!(:child, component)
theme.set_default!
end
include_examples "a custom homepage"
end
end end