discourse/spec/requests/admin/config/customize_controller_spec.rb
Yuriy Kurant db10d595e7
FEATURE: enhance screenshot support for themes with dark/light modes (#36422)
Enable theme cards to show dark and light mode screenshots.

### Context
Prior to this change, a single screenshot was displayed only.

### Changes
* introduce separate fields: `screenshot_light_url` and
`screenshot_dark_url`
* displays both screenshots (horizontally scrollable)
* limits display of screenshots to the files named `light` and `dark`
only

### Result


https://github.com/user-attachments/assets/4d845f32-9120-49b8-8f05-ba7790ce1629

---------

Co-authored-by: Yuriy Kurant <yuriy@discourse.org>
2025-12-10 11:23:21 +10:00

261 lines
8.9 KiB
Ruby

# frozen_string_literal: true
RSpec.describe Admin::Config::CustomizeController do
fab!(:admin)
before { sign_in(admin) }
describe "#themes" do
fab!(:theme1) { Fabricate(:theme, name: "Theme 1", component: false) }
fab!(:theme2) { Fabricate(:theme, name: "Theme 2", component: false) }
fab!(:component) { Fabricate(:theme, name: "Component", component: true) }
it "returns only non-component themes" do
get "/admin/config/customize/themes.json"
expect(response.status).to eq(200)
themes = response.parsed_body["themes"]
theme_ids = themes.map { |t| t["id"] }
expect(theme_ids).to include(theme1.id)
expect(theme_ids).to include(theme2.id)
expect(theme_ids).not_to include(component.id)
end
it "includes color scheme in response" do
color_scheme = Fabricate(:color_scheme)
theme1.update!(color_scheme_id: color_scheme.id)
get "/admin/config/customize/themes.json"
expect(response.status).to eq(200)
theme_response = response.parsed_body["themes"].find { |t| t["id"] == theme1.id }
expect(theme_response["color_scheme"]["id"]).to eq(color_scheme.id)
end
it "includes screenshot_light_url in response" do
upload = UploadCreator.new(file_from_fixtures("logo.png"), "logo.png").create_for(-1)
theme1.set_field(
target: :common,
name: "screenshot_light",
upload_id: upload.id,
type: :theme_screenshot_upload_var,
)
theme1.save!
get "/admin/config/customize/themes.json"
expect(response.status).to eq(200)
theme_response = response.parsed_body["themes"].find { |t| t["id"] == theme1.id }
expect(theme_response["screenshot_light_url"]).to eq(upload.url)
end
end
describe "#components" do
fab!(:parent_theme_1, :theme)
fab!(:parent_theme_2, :theme)
fab!(:used_component) do
Fabricate(
:theme,
name: "AweSome comp",
component: true,
parent_themes: [parent_theme_1, parent_theme_2],
)
end
fab!(:unused_component) { Fabricate(:theme, name: "some comp", component: true) }
fab!(:remote_component) do
Fabricate(
:theme,
component: true,
remote_theme: RemoteTheme.create!(remote_url: "https://github.com/discourse/discourse-tc"),
)
end
fab!(:remote_component_with_update) do
Fabricate(
:theme,
component: true,
remote_theme:
RemoteTheme.create!(
remote_url: "https://github.com/discourse/discourse",
commits_behind: 1,
),
)
end
context "when filtering by `used`" do
it "returns components that have a parent theme" do
get "/admin/config/customize/components.json", params: { status: "used" }
expect(response.status).to eq(200)
expect(response.parsed_body["components"].map { |c| c["id"] }).to contain_exactly(
used_component.id,
)
end
end
context "when filtering by `unused`" do
it "returns components that have no parent theme" do
get "/admin/config/customize/components.json", params: { status: "unused" }
expect(response.status).to eq(200)
expect(response.parsed_body["components"].map { |c| c["id"] }).to contain_exactly(
unused_component.id,
remote_component.id,
remote_component_with_update.id,
)
end
end
context "when filtering by `updates_available`" do
it "returns components that are behind their remote" do
get "/admin/config/customize/components.json", params: { status: "updates_available" }
expect(response.status).to eq(200)
expect(response.parsed_body["components"].map { |c| c["id"] }).to contain_exactly(
remote_component_with_update.id,
)
end
end
context "when filtering by `all`" do
it "returns all components" do
get "/admin/config/customize/components.json", params: { status: "all" }
expect(response.status).to eq(200)
expect(response.parsed_body["components"].map { |c| c["id"] }).to contain_exactly(
used_component.id,
unused_component.id,
remote_component.id,
remote_component_with_update.id,
)
end
end
context "when there's no filter param" do
it "is equivalent to filtering by `all`" do
get "/admin/config/customize/components.json"
expect(response.status).to eq(200)
expect(response.parsed_body["components"].map { |c| c["id"] }).to contain_exactly(
used_component.id,
unused_component.id,
remote_component.id,
remote_component_with_update.id,
)
end
end
it "can filter components by a search term" do
get "/admin/config/customize/components.json", params: { name: "SomE" }
expect(response.status).to eq(200)
expect(response.parsed_body["components"].map { |c| c["id"] }).to contain_exactly(
used_component.id,
unused_component.id,
)
end
it "paginates the components list" do
stub_const(Admin::Config::CustomizeController, "PAGE_SIZE", 2) do
components = []
get "/admin/config/customize/components.json"
expect(response.status).to eq(200)
expect(response.parsed_body["components"].size).to eq(2)
components.concat(response.parsed_body["components"])
expect(response.parsed_body["has_more"]).to eq(true)
get "/admin/config/customize/components.json", params: { page: 1 }
expect(response.status).to eq(200)
expect(response.parsed_body["components"].size).to eq(2)
components.concat(response.parsed_body["components"])
expect(response.parsed_body["has_more"]).to eq(false)
get "/admin/config/customize/components.json", params: { page: 2 }
expect(response.status).to eq(200)
expect(response.parsed_body["components"].size).to eq(0)
expect(response.parsed_body["has_more"]).to eq(false)
expect(components.map { |c| c["id"] }).to contain_exactly(
used_component.id,
unused_component.id,
remote_component.id,
remote_component_with_update.id,
)
end
end
end
describe "#theme_site_settings" do
fab!(:theme_1, :theme)
fab!(:theme_2, :theme)
fab!(:theme_3, :theme)
fab!(:theme_1_theme_site_setting) do
Fabricate(
:theme_site_setting_with_service,
theme: theme_1,
name: "search_experience",
value: "search_field",
)
end
fab!(:theme_2_theme_site_setting) do
Fabricate(
:theme_site_setting_with_service,
theme: theme_2,
name: "enable_welcome_banner",
value: false,
)
end
it "gets all theme site settings and the themes which have overridden values for these settings" do
get "/admin/config/customize/theme-site-settings.json"
expect(response.status).to eq(200)
json = response.parsed_body
expect(json["themeable_site_settings"]).to include(
"search_experience",
"enable_welcome_banner",
)
search_setting =
json["themes_with_site_setting_overrides"]["search_experience"].deep_symbolize_keys
expect(search_setting[:setting]).to eq("search_experience")
expect(search_setting[:default]).to eq("search_icon")
expect(search_setting[:description]).to eq(I18n.t("site_settings.search_experience"))
expect(search_setting[:type]).to eq("enum")
expect(search_setting[:themes].find { |t| t[:theme_id] == theme_1.id }).to include(
theme_name: theme_1.name,
theme_id: theme_1.id,
value: "search_field",
)
welcome_banner_setting =
json["themes_with_site_setting_overrides"]["enable_welcome_banner"].deep_symbolize_keys
expect(welcome_banner_setting[:setting]).to eq("enable_welcome_banner")
expect(welcome_banner_setting[:default]).to eq(true)
expect(welcome_banner_setting[:description]).to eq(
I18n.t("site_settings.enable_welcome_banner"),
)
expect(welcome_banner_setting[:type]).to eq("bool")
expect(welcome_banner_setting[:themes].find { |t| t[:theme_id] == theme_2.id }).to include(
theme_name: theme_2.name,
theme_id: theme_2.id,
value: false,
)
end
it "does not count theme site settings with same value as site setting default as overridden" do
theme_2_theme_site_setting.update!(
value: SiteSetting.type_supervisor.to_db_value(:enable_welcome_banner, true).first,
)
get "/admin/config/customize/theme-site-settings.json"
expect(response.status).to eq(200)
json = response.parsed_body
welcome_banner_setting =
json["themes_with_site_setting_overrides"]["enable_welcome_banner"].deep_symbolize_keys
expect(welcome_banner_setting[:themes].find { |t| t[:theme_id] == theme_2.id }).to be_nil
end
end
end