This adds a draft status for Help Center locales so teams can prepare localized content in the dashboard without exposing those locales in the public portal switcher until they are ready to publish. Fixes: https://github.com/chatwoot/chatwoot/issues/10412 Closes: https://github.com/chatwoot/chatwoot/issues/10412 ## Why Teams need a way to work on locale-specific Help Center content ahead of launch. The public portal should only show ready locales, while the admin dashboard should continue to expose every allowed locale for ongoing article and category work. ## What this change does - Adds `draft_locales` to portal config as a subset of `allowed_locales` - Hides drafted locales from the public portal language switchers while keeping direct locale URLs working - Keeps drafted locales fully visible in the admin dashboard for article and category management - Adds locale actions to move an existing locale to draft, publish a drafted locale, and keep the default locale protected from drafting - Adds a status dropdown when creating a locale so new locales can be created as `Published` or `Draft` - Returns each admin locale with a `draft` flag so the locale UI can reflect the public visibility state ## Validation - Seed a portal with multiple locales, draft one locale, and confirm the public portal switcher hides it while `/hc/:slug/:locale` still loads directly - In the admin dashboard, confirm drafted locales still appear in the locale list and remain selectable for articles and categories - Create a new locale with `Draft` status and confirm it stays out of the public switcher until published - Move an existing locale back and forth between `Published` and `Draft` and confirm the public switcher updates accordingly ## Demo https://github.com/user-attachments/assets/ba22dc26-c2e7-463a-b1f5-adf1fda1f9be --------- Co-authored-by: Muhsin Keloth <muhsinkeramam@gmail.com>
138 lines
4.6 KiB
Ruby
138 lines
4.6 KiB
Ruby
require 'rails_helper'
|
|
|
|
RSpec.describe Public::Api::V1::PortalsController, type: :request do
|
|
let!(:account) { create(:account) }
|
|
let!(:agent) { create(:user, account: account, role: :agent) }
|
|
let!(:portal) { create(:portal, slug: 'test-portal', account_id: account.id, custom_domain: 'www.example.com') }
|
|
|
|
before do
|
|
create(:portal, slug: 'test-portal-1', account_id: account.id)
|
|
create(:portal, slug: 'test-portal-2', account_id: account.id)
|
|
create_list(:article, 3, account: account, author: agent, portal: portal, status: :published)
|
|
create_list(:article, 2, account: account, author: agent, portal: portal, status: :draft)
|
|
end
|
|
|
|
describe 'GET /public/api/v1/portals/{portal_slug}' do
|
|
it 'Show portal and categories belonging to the portal' do
|
|
get "/hc/#{portal.slug}/en"
|
|
|
|
expect(response).to have_http_status(:success)
|
|
end
|
|
|
|
it 'Throws unauthorised error for unknown domain' do
|
|
portal.update(custom_domain: 'www.something.com')
|
|
|
|
get "/hc/#{portal.slug}/en"
|
|
|
|
expect(response).to have_http_status(:unauthorized)
|
|
json_response = response.parsed_body
|
|
|
|
expect(json_response['error']).to eql "Domain: www.example.com is not registered with us. \
|
|
Please send us an email at support@chatwoot.com with the custom domain name and account API key"
|
|
end
|
|
|
|
context 'when portal has a logo' do
|
|
it 'includes the logo as favicon' do
|
|
# Attach a test image to the portal
|
|
file = Rails.root.join('spec/assets/sample.png').open
|
|
portal.logo.attach(io: file, filename: 'sample.png', content_type: 'image/png')
|
|
file.close
|
|
|
|
get "/hc/#{portal.slug}/en"
|
|
|
|
expect(response).to have_http_status(:success)
|
|
expect(response.body).to include('<link rel="icon" href=')
|
|
end
|
|
end
|
|
|
|
context 'when portal has no logo' do
|
|
it 'does not include a favicon link' do
|
|
# Ensure logo is not attached
|
|
portal.logo.purge if portal.logo.attached?
|
|
|
|
get "/hc/#{portal.slug}/en"
|
|
|
|
expect(response).to have_http_status(:success)
|
|
expect(response.body).not_to include('<link rel="icon" href=')
|
|
end
|
|
end
|
|
|
|
it 'hides drafted locales from the public locale switcher' do
|
|
portal.update!(config: { allowed_locales: %w[en es], draft_locales: ['es'], default_locale: 'en' })
|
|
|
|
get "/hc/#{portal.slug}/en"
|
|
|
|
expect(response).to have_http_status(:success)
|
|
expect(response.body).not_to include('value="es"')
|
|
expect(response.body).not_to include('locale-switcher')
|
|
end
|
|
|
|
it 'allows direct access to drafted locale pages' do
|
|
portal.update!(config: { allowed_locales: %w[en es], draft_locales: ['es'], default_locale: 'en' })
|
|
|
|
get "/hc/#{portal.slug}/es"
|
|
|
|
expect(response).to have_http_status(:success)
|
|
end
|
|
|
|
it 'shows the active drafted locale in the switcher state on direct locale access' do
|
|
portal.update!(config: { allowed_locales: %w[en es fr], draft_locales: ['es'], default_locale: 'en' })
|
|
|
|
get "/hc/#{portal.slug}/es"
|
|
|
|
expect(response).to have_http_status(:success)
|
|
|
|
document = Nokogiri::HTML(response.body)
|
|
switchers = document.css('select.locale-switcher')
|
|
|
|
expect(switchers).not_to be_empty
|
|
|
|
switchers.each do |switcher|
|
|
options = switcher.css('option')
|
|
|
|
expect(options.map { |option| option['value'] }).to include('en', 'es', 'fr')
|
|
expect(
|
|
options.any? do |option|
|
|
option['value'] == 'es' && option['selected'].present? && option['disabled'].present?
|
|
end
|
|
).to be(true)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'GET /public/api/v1/portals/{portal_slug}/sitemap' do
|
|
context 'when custom_domain is present' do
|
|
it 'returns a valid urlset sitemap with the correct namespace' do
|
|
get "/hc/#{portal.slug}/sitemap.xml"
|
|
|
|
expect(response).to have_http_status(:success)
|
|
|
|
doc = Nokogiri::XML(response.body)
|
|
expect(doc.errors).to be_empty
|
|
|
|
expect(doc.root.name).to eq('urlset')
|
|
expect(doc.root.namespace&.href).to eq('http://www.sitemaps.org/schemas/sitemap/0.9')
|
|
end
|
|
|
|
it 'contains valid article URLs for the portal' do
|
|
get "/hc/#{portal.slug}/sitemap.xml"
|
|
|
|
expect(response).to have_http_status(:success)
|
|
|
|
doc = Nokogiri::XML(response.body)
|
|
doc.remove_namespaces!
|
|
|
|
# ensure we are NOT returning a sitemapindex
|
|
expect(doc.xpath('//sitemapindex')).to be_empty
|
|
|
|
links = doc.xpath('//url/loc').map(&:text)
|
|
expect(links.length).to eq(3)
|
|
|
|
expect(links).to all(
|
|
match(%r{\Ahttps://www\.example\.com/hc/#{Regexp.escape(portal.slug)}/articles/\d+})
|
|
)
|
|
end
|
|
end
|
|
end
|
|
end
|