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>
330 lines
12 KiB
Ruby
330 lines
12 KiB
Ruby
require 'rails_helper'
|
|
|
|
RSpec.describe 'Api::V1::Accounts::Portals', type: :request do
|
|
let(:account) { create(:account) }
|
|
let(:agent) { create(:user, account: account, role: :agent) }
|
|
let(:admin) { create(:user, account: account, role: :administrator) }
|
|
let(:agent_1) { create(:user, account: account, role: :agent) }
|
|
let(:agent_2) { create(:user, account: account, role: :agent) }
|
|
let!(:portal) { create(:portal, slug: 'portal-1', name: 'test_portal', account_id: account.id) }
|
|
|
|
describe 'GET /api/v1/accounts/{account.id}/portals' do
|
|
context 'when it is an unauthenticated user' do
|
|
it 'returns unauthorized' do
|
|
get "/api/v1/accounts/#{account.id}/portals"
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an authenticated user' do
|
|
it 'get all portals' do
|
|
portal2 = create(:portal, name: 'test_portal_2', account_id: account.id, slug: 'portal-2')
|
|
expect(portal2.id).not_to be_nil
|
|
get "/api/v1/accounts/#{account.id}/portals",
|
|
headers: admin.create_new_auth_token
|
|
|
|
expect(response).to have_http_status(:success)
|
|
json_response = response.parsed_body
|
|
expect(json_response['payload'].length).to be 2
|
|
expect(json_response['payload'][0]['id']).to be portal.id
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'GET /api/v1/accounts/{account.id}/portals/{portal.slug}' do
|
|
context 'when it is an unauthenticated user' do
|
|
it 'returns unauthorized' do
|
|
get "/api/v1/accounts/#{account.id}/portals"
|
|
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an authenticated user' do
|
|
it 'get one portals' do
|
|
get "/api/v1/accounts/#{account.id}/portals/#{portal.slug}",
|
|
headers: admin.create_new_auth_token
|
|
|
|
expect(response).to have_http_status(:success)
|
|
json_response = response.parsed_body
|
|
expect(json_response['name']).to eq portal.name
|
|
expect(json_response['meta']['all_articles_count']).to eq 0
|
|
end
|
|
|
|
it 'returns portal articles metadata' do
|
|
portal.update(config: { allowed_locales: %w[en es], default_locale: 'en' })
|
|
en_cat = create(:category, locale: :en, portal_id: portal.id, slug: 'en-cat')
|
|
es_cat = create(:category, locale: :es, portal_id: portal.id, slug: 'es-cat')
|
|
create(:article, category_id: en_cat.id, portal_id: portal.id, author_id: agent.id)
|
|
create(:article, category_id: en_cat.id, portal_id: portal.id, author_id: admin.id)
|
|
create(:article, category_id: es_cat.id, portal_id: portal.id, author_id: agent.id)
|
|
|
|
get "/api/v1/accounts/#{account.id}/portals/#{portal.slug}?locale=en",
|
|
headers: admin.create_new_auth_token
|
|
|
|
expect(response).to have_http_status(:success)
|
|
json_response = response.parsed_body
|
|
expect(json_response['name']).to eq portal.name
|
|
expect(json_response['meta']['all_articles_count']).to eq 2
|
|
expect(json_response['meta']['mine_articles_count']).to eq 1
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'POST /api/v1/accounts/{account.id}/portals' do
|
|
context 'when it is an unauthenticated user' do
|
|
it 'returns unauthorized' do
|
|
post "/api/v1/accounts/#{account.id}/portals",
|
|
params: {},
|
|
headers: agent.create_new_auth_token
|
|
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an authenticated user' do
|
|
it 'creates portal' do
|
|
portal_params = {
|
|
portal: {
|
|
name: 'test_portal',
|
|
slug: 'test_kbase',
|
|
custom_domain: 'https://support.chatwoot.dev'
|
|
}
|
|
}
|
|
post "/api/v1/accounts/#{account.id}/portals",
|
|
params: portal_params,
|
|
headers: admin.create_new_auth_token
|
|
|
|
expect(response).to have_http_status(:success)
|
|
json_response = response.parsed_body
|
|
expect(json_response['name']).to eql('test_portal')
|
|
expect(json_response['custom_domain']).to eql('support.chatwoot.dev')
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'PUT /api/v1/accounts/{account.id}/portals/{portal.slug}' do
|
|
context 'when it is an unauthenticated user' do
|
|
it 'returns unauthorized' do
|
|
put "/api/v1/accounts/#{account.id}/portals/#{portal.slug}", params: {}
|
|
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an authenticated user' do
|
|
it 'updates portal' do
|
|
portal_params = {
|
|
portal: {
|
|
name: 'updated_test_portal',
|
|
config: { 'allowed_locales' => %w[en es], 'draft_locales' => ['es'], 'default_locale' => 'en' }
|
|
}
|
|
}
|
|
|
|
expect(portal.name).to eql('test_portal')
|
|
|
|
put "/api/v1/accounts/#{account.id}/portals/#{portal.slug}",
|
|
params: portal_params,
|
|
headers: admin.create_new_auth_token
|
|
|
|
expect(response).to have_http_status(:success)
|
|
json_response = response.parsed_body
|
|
expect(json_response['name']).to eql(portal_params[:portal][:name])
|
|
expect(json_response['config']).to eql(
|
|
{
|
|
'allowed_locales' => [
|
|
{ 'articles_count' => 0, 'categories_count' => 0, 'code' => 'en', 'draft' => false },
|
|
{ 'articles_count' => 0, 'categories_count' => 0, 'code' => 'es', 'draft' => true }
|
|
]
|
|
}
|
|
)
|
|
end
|
|
|
|
it 'preserves drafted locales when draft_locales is omitted' do
|
|
portal.update!(config: { allowed_locales: %w[en es fr], draft_locales: ['es'], default_locale: 'en' })
|
|
|
|
put "/api/v1/accounts/#{account.id}/portals/#{portal.slug}",
|
|
params: {
|
|
portal: {
|
|
config: { allowed_locales: %w[en es fr], default_locale: 'en' }
|
|
}
|
|
},
|
|
headers: admin.create_new_auth_token
|
|
|
|
expect(response).to have_http_status(:success)
|
|
portal.reload
|
|
expect(portal.draft_locale_codes).to eq(['es'])
|
|
expect(response.parsed_body.dig('config', 'allowed_locales')).to include(
|
|
a_hash_including('code' => 'es', 'draft' => true)
|
|
)
|
|
end
|
|
|
|
it 'archive portal' do
|
|
portal_params = {
|
|
portal: {
|
|
archived: true
|
|
}
|
|
}
|
|
|
|
expect(portal.archived).to be_falsy
|
|
|
|
put "/api/v1/accounts/#{account.id}/portals/#{portal.slug}",
|
|
params: portal_params,
|
|
headers: admin.create_new_auth_token
|
|
|
|
expect(response).to have_http_status(:success)
|
|
json_response = response.parsed_body
|
|
expect(json_response['archived']).to eql(portal_params[:portal][:archived])
|
|
|
|
portal.reload
|
|
expect(portal.archived).to be_truthy
|
|
end
|
|
|
|
it 'clears associated web widget when inbox selection is blank' do
|
|
web_widget_inbox = create(:inbox, account: account)
|
|
portal.update!(channel_web_widget: web_widget_inbox.channel)
|
|
|
|
expect(portal.channel_web_widget_id).to eq(web_widget_inbox.channel.id)
|
|
|
|
put "/api/v1/accounts/#{account.id}/portals/#{portal.slug}",
|
|
params: {
|
|
portal: { name: portal.name },
|
|
inbox_id: ''
|
|
},
|
|
headers: admin.create_new_auth_token
|
|
|
|
expect(response).to have_http_status(:success)
|
|
portal.reload
|
|
expect(portal.channel_web_widget_id).to be_nil
|
|
expect(response.parsed_body['inbox']).to be_nil
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'DELETE /api/v1/accounts/{account.id}/portals/{portal.slug}' do
|
|
context 'when it is an unauthenticated user' do
|
|
it 'returns unauthorized' do
|
|
delete "/api/v1/accounts/#{account.id}/portals/#{portal.slug}", params: {}
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an authenticated user' do
|
|
it 'deletes portal' do
|
|
delete "/api/v1/accounts/#{account.id}/portals/#{portal.slug}",
|
|
headers: admin.create_new_auth_token
|
|
expect(response).to have_http_status(:success)
|
|
deleted_portal = Portal.find_by(id: portal.slug)
|
|
expect(deleted_portal).to be_nil
|
|
end
|
|
end
|
|
end
|
|
|
|
# Portal members endpoint removed
|
|
|
|
describe 'DELETE /api/v1/accounts/{account.id}/portals/{portal.slug}/logo' do
|
|
context 'when it is an unauthenticated user' do
|
|
it 'returns unauthorized' do
|
|
delete "/api/v1/accounts/#{account.id}/portals/#{portal.slug}/logo"
|
|
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an authenticated user' do
|
|
before do
|
|
portal.logo.attach(io: Rails.root.join('spec/assets/avatar.png').open, filename: 'avatar.png', content_type: 'image/png')
|
|
end
|
|
|
|
it 'throw error if agent' do
|
|
delete "/api/v1/accounts/#{account.id}/portals/#{portal.slug}/logo",
|
|
headers: agent.create_new_auth_token,
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
|
|
it 'delete portal logo if admin' do
|
|
delete "/api/v1/accounts/#{account.id}/portals/#{portal.slug}/logo",
|
|
headers: admin.create_new_auth_token,
|
|
as: :json
|
|
|
|
expect { portal.logo.attachment.reload }.to raise_error(ActiveRecord::RecordNotFound)
|
|
expect(response).to have_http_status(:success)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'POST /api/v1/accounts/{account.id}/portals/{portal.slug}/send_instructions' do
|
|
let(:portal_with_domain) { create(:portal, slug: 'portal-with-domain', account_id: account.id, custom_domain: 'docs.example.com') }
|
|
|
|
context 'when it is an unauthenticated user' do
|
|
it 'returns unauthorized' do
|
|
post "/api/v1/accounts/#{account.id}/portals/#{portal_with_domain.slug}/send_instructions",
|
|
params: { email: 'dev@example.com' }
|
|
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an authenticated agent' do
|
|
it 'returns unauthorized' do
|
|
post "/api/v1/accounts/#{account.id}/portals/#{portal_with_domain.slug}/send_instructions",
|
|
headers: agent.create_new_auth_token,
|
|
params: { email: 'dev@example.com' },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:unauthorized)
|
|
end
|
|
end
|
|
|
|
context 'when it is an authenticated admin' do
|
|
it 'returns error when email is missing' do
|
|
post "/api/v1/accounts/#{account.id}/portals/#{portal_with_domain.slug}/send_instructions",
|
|
headers: admin.create_new_auth_token,
|
|
params: {},
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:unprocessable_entity)
|
|
expect(response.parsed_body['error']).to eq('Email is required')
|
|
end
|
|
|
|
it 'returns error when email is invalid' do
|
|
post "/api/v1/accounts/#{account.id}/portals/#{portal_with_domain.slug}/send_instructions",
|
|
headers: admin.create_new_auth_token,
|
|
params: { email: 'invalid-email' },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:unprocessable_entity)
|
|
expect(response.parsed_body['error']).to eq('Invalid email format')
|
|
end
|
|
|
|
it 'returns error when custom domain is not configured' do
|
|
post "/api/v1/accounts/#{account.id}/portals/#{portal.slug}/send_instructions",
|
|
headers: admin.create_new_auth_token,
|
|
params: { email: 'dev@example.com' },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:unprocessable_entity)
|
|
expect(response.parsed_body['error']).to eq('Custom domain is not configured')
|
|
end
|
|
|
|
it 'sends instructions successfully' do
|
|
mailer_double = instance_double(ActionMailer::MessageDelivery)
|
|
allow(PortalInstructionsMailer).to receive(:send_cname_instructions).and_return(mailer_double)
|
|
allow(mailer_double).to receive(:deliver_later)
|
|
|
|
post "/api/v1/accounts/#{account.id}/portals/#{portal_with_domain.slug}/send_instructions",
|
|
headers: admin.create_new_auth_token,
|
|
params: { email: 'dev@example.com' },
|
|
as: :json
|
|
|
|
expect(response).to have_http_status(:success)
|
|
expect(response.parsed_body['message']).to eq('Instructions sent successfully')
|
|
expect(PortalInstructionsMailer).to have_received(:send_cname_instructions)
|
|
.with(portal: portal_with_domain, recipient_email: 'dev@example.com')
|
|
end
|
|
end
|
|
end
|
|
end
|