Open-source live-chat, email support, omni-channel desk. An alternative to Intercom, Zendesk, Salesforce Service Cloud etc. 🔥💬
Ruby actioncablechat-widgetconversationcustomer-supportdashboarddesigndockerdocker-imageherokuintercomjavascriptlivechatopensourcerailsrubysassvuejswhatsappzendesk
require 'rails_helper'
RSpec.describe 'Super Admin Users API', type: :request do
let(:super_admin) { create(:super_admin) }
describe 'GET /super_admin/users' do
context 'when it is an unauthenticated super admin' do
it 'returns unauthorized' do
get '/super_admin/users'
expect(response).to have_http_status(:redirect)
end
end
context 'when it is an authenticated super admin' do
let!(:user) { create(:user, name: 'Disabled User') }
let!(:params) do
{ user: {
name: '[email protected]',
display_name: '[email protected]',
email: '[email protected]',
password: 'Password1!',
confirmed_at: '2023-03-20 22:32:41',
type: 'SuperAdmin'
} }
end
let!(:params_without_confirmed_at) do
{ user: {
name: '[email protected]',
display_name: '[email protected]',
email: '[email protected]',
password: 'Password1!',
type: 'SuperAdmin'
} }
end
let!(:params_with_blank_confirmed_at) do
{ user: {
name: '[email protected]',
display_name: '[email protected]',
email: '[email protected]',
password: 'Password1!',
confirmed_at: '',
type: 'SuperAdmin'
} }
end
it 'shows the list of users' do
sign_in(super_admin, scope: :super_admin)
get '/super_admin/users'
doc = Nokogiri::HTML(response.body)
header_texts = doc.css('table thead th').map { |header| header.text.squish }
expect(response).to have_http_status(:success)
expect(response.body).to include('New user')
expect(response.body).to include(CGI.escapeHTML(user.name))
expect(header_texts).not_to include('MFA')
end
it 'prefills confirmed_at on new user form' do
sign_in(super_admin, scope: :super_admin)
get '/super_admin/users/new'
expect(response).to have_http_status(:success)
expect(response.body).to include('name="user[confirmed_at]"')
confirmed_at_value = response.body[/name="user\[confirmed_at\]".*?value="([^"]+)"/m, 1]
expect(confirmed_at_value).to be_present
end
it 'creates the new super_admin record' do
sign_in(super_admin, scope: :super_admin)
post '/super_admin/users', params: params
expect(response).to redirect_to("http://www.example.com/super_admin/users/#{User.last.id}")
expect(SuperAdmin.last.email).to eq('[email protected]')
post '/super_admin/users', params: params
expect(response).to redirect_to('http://www.example.com/super_admin/users/new')
end
it 'creates unconfirmed users when confirmed_at is not provided in payload' do
sign_in(super_admin, scope: :super_admin)
post '/super_admin/users', params: params_without_confirmed_at
expect(response).to redirect_to("http://www.example.com/super_admin/users/#{User.last.id}")
expect(User.last).not_to be_confirmed
end
it 'creates unconfirmed users when confirmed_at is explicitly cleared' do
sign_in(super_admin, scope: :super_admin)
post '/super_admin/users', params: params_with_blank_confirmed_at
expect(response).to redirect_to("http://www.example.com/super_admin/users/#{User.last.id}")
expect(User.last).not_to be_confirmed
end
end
end
describe 'DELETE /super_admin/users/:id/avatar' do
let!(:user) { create(:user, :with_avatar) }
context 'when it is an unauthenticated super admin' do
it 'returns unauthorized' do
delete "/super_admin/users/#{user.id}/avatar", params: { attachment_id: user.avatar.id }
expect(response).to have_http_status(:redirect)
expect(user.reload.avatar).to be_attached
end
end
context 'when it is an authenticated super admin' do
it 'destroys the avatar' do
sign_in(super_admin, scope: :super_admin)
delete "/super_admin/users/#{user.id}/avatar", params: { attachment_id: user.avatar.id }
expect(response).to have_http_status(:redirect)
expect(user.reload.avatar).not_to be_attached
end
end
end
describe 'PATCH /super_admin/users/:id' do
let!(:user) { create(:user) }
let(:request_path) { "/super_admin/users/#{user.id}" }
before { sign_in(super_admin, scope: :super_admin) }
it 'skips reconfirmation when confirmed_at is provided' do
ActiveJob::Base.queue_adapter.enqueued_jobs.clear
patch request_path, params: { user: { email: '[email protected]', confirmed_at: Time.current } }
expect(response).to have_http_status(:redirect)
expect(user.reload.email).to eq('[email protected]')
expect(user.reload.unconfirmed_email).to be_nil
mail_jobs = ActiveJob::Base.queue_adapter.enqueued_jobs.select do |job|
job[:job].to_s == 'ActionMailer::MailDeliveryJob'
end
expect(mail_jobs.count).to eq(0)
end
it 'does not skip reconfirmation when confirmed_at is blank' do
ActiveJob::Base.queue_adapter.enqueued_jobs.clear
patch request_path, params: { user: { email: '[email protected]' } }
expect(response).to have_http_status(:redirect)
expect(user.reload.unconfirmed_email).to eq('[email protected]')
mail_jobs = ActiveJob::Base.queue_adapter.enqueued_jobs.select do |job|
job[:job].to_s == 'ActionMailer::MailDeliveryJob'
end
expect(mail_jobs.count).to be >= 1
end
end
describe 'POST /super_admin/users/:id/resend_confirmation' do
def mail_jobs
ActiveJob::Base.queue_adapter.enqueued_jobs.select do |job|
job[:job].to_s == 'ActionMailer::MailDeliveryJob'
end
end
context 'when it is an unauthenticated super admin' do
let!(:user) { create(:user, skip_confirmation: false) }
it 'returns unauthorized and does not enqueue a confirmation email' do
ActiveJob::Base.queue_adapter.enqueued_jobs.clear
post "/super_admin/users/#{user.id}/resend_confirmation"
expect(response).to have_http_status(:redirect)
expect(mail_jobs.count).to eq(0)
end
end
context 'when it is an authenticated super admin' do
before { sign_in(super_admin, scope: :super_admin) }
context 'when the user is not confirmed' do
let!(:user) { create(:user, skip_confirmation: false) }
it 'redirects and enqueues a confirmation email' do
ActiveJob::Base.queue_adapter.enqueued_jobs.clear
post "/super_admin/users/#{user.id}/resend_confirmation"
expect(response).to have_http_status(:redirect)
expect(mail_jobs.count).to be >= 1
end
end
context 'when the user is already confirmed' do
let!(:user) { create(:user) }
it 'redirects and does not enqueue a confirmation email' do
expect(user).to be_confirmed
ActiveJob::Base.queue_adapter.enqueued_jobs.clear
post "/super_admin/users/#{user.id}/resend_confirmation"
expect(response).to have_http_status(:redirect)
expect(mail_jobs.count).to eq(0)
end
end
end
end
describe 'GET /super_admin/users/:id' do
let!(:user) { create(:user, name: 'MFA Enabled User', otp_required_for_login: true) }
it 'shows the MFA status on the user detail page' do
sign_in(super_admin, scope: :super_admin)
get "/super_admin/users/#{user.id}"
doc = Nokogiri::HTML(response.body)
labels = doc.css('dt').map { |label| label.text.squish }
expect(response).to have_http_status(:success)
expect(labels).to include('MFA')
expect(response.body).to include('Enabled')
expect(response.body).to include(CGI.escapeHTML(user.name))
end
it 'renders an impersonation form without minting a token' do
sign_in(super_admin, scope: :super_admin)
expect { get "/super_admin/users/#{user.id}" }
.not_to(change { Redis::Alfred.keys_count("USER_SSO_AUTH_TOKEN::#{user.id}::*") })
form = Nokogiri::HTML(response.body).at_css("form[action='/super_admin/users/#{user.id}/impersonate']")
expect(form).to be_present
expect(form['method']).to eq('post')
expect(form['target']).to eq('_blank')
expect(form['rel']).to eq('noopener')
expect(response.body).not_to include('sso_auth_token=')
end
it 'renders a copy impersonation link form next to the impersonate button' do
sign_in(super_admin, scope: :super_admin)
get "/super_admin/users/#{user.id}"
form = Nokogiri::HTML(response.body).at_css("form[action='/super_admin/users/#{user.id}/impersonation_link']")
expect(form).to be_present
expect(form['method']).to eq('post')
end
end
describe 'POST /super_admin/users/:id/impersonation_link' do
let!(:user) { create(:user) }
it 'mints a token for the signed-in super admin and returns the link' do
sign_in(super_admin, scope: :super_admin)
with_modified_env FRONTEND_URL: 'https://dashboard.example.com' do
expect { post "/super_admin/users/#{user.id}/impersonation_link", as: :json }
.to change { Redis::Alfred.keys_count("USER_SSO_AUTH_TOKEN::#{user.id}::*") }.by(1)
end
link = URI(response.parsed_body['url'])
query = Rack::Utils.parse_query(link.query)
expect(response).to have_http_status(:ok)
expect("#{link.scheme}://#{link.host}#{link.path}").to eq('https://dashboard.example.com/app/login')
expect(user.sso_auth_token_impersonator_id(query.fetch('sso_auth_token'))).to eq(super_admin.id)
end
it 'requires super admin authentication without minting a token' do
expect { post "/super_admin/users/#{user.id}/impersonation_link" }
.not_to(change { Redis::Alfred.keys_count("USER_SSO_AUTH_TOKEN::#{user.id}::*") })
expect(response).to redirect_to(new_super_admin_session_path)
end
end
describe 'POST /super_admin/users/:id/impersonate' do
let!(:user) { create(:user) }
it 'mints a token for the signed-in super admin and redirects to the frontend' do
sign_in(super_admin, scope: :super_admin)
with_modified_env FRONTEND_URL: 'https://dashboard.example.com' do
expect { post "/super_admin/users/#{user.id}/impersonate" }
.to change { Redis::Alfred.keys_count("USER_SSO_AUTH_TOKEN::#{user.id}::*") }.by(1)
end
location = URI(response.location)
query = Rack::Utils.parse_query(location.query)
expect(response).to have_http_status(:see_other)
expect("#{location.scheme}://#{location.host}#{location.path}").to eq('https://dashboard.example.com/app/login')
expect(query).to include('email' => user.email, 'impersonation' => 'true')
expect(user.sso_auth_token_impersonator_id(query.fetch('sso_auth_token'))).to eq(super_admin.id)
end
it 'requires super admin authentication without minting a token' do
expect { post "/super_admin/users/#{user.id}/impersonate" }
.not_to(change { Redis::Alfred.keys_count("USER_SSO_AUTH_TOKEN::#{user.id}::*") })
expect(response).to redirect_to(new_super_admin_session_path)
end
context 'with CSRF protection enabled' do
around do |example|
previous = ActionController::Base.allow_forgery_protection
ActionController::Base.allow_forgery_protection = true
example.run
ensure
ActionController::Base.allow_forgery_protection = previous
end
it 'rejects a POST without a CSRF token' do
sign_in(super_admin, scope: :super_admin)
expect { post "/super_admin/users/#{user.id}/impersonate" }
.not_to(change { Redis::Alfred.keys_count("USER_SSO_AUTH_TOKEN::#{user.id}::*") })
expect(response).to have_http_status(422)
end
end
end
describe 'SES suppression diagnostic' do
let!(:user) { create(:user, email: '[email protected]') }
let(:suppression) { instance_double(Email::SesSuppressionService) }
before do
sign_in(super_admin, scope: :super_admin)
allow(Email::SesSuppressionService).to receive(:new).and_return(suppression)
end
context 'when SES suppression is not configured' do
it 'returns not found for every action' do
%w[check_email_suppression clear_email_suppression send_test_email].each do |action|
post "/super_admin/users/#{user.id}/#{action}"
expect(response).to have_http_status(:not_found)
end
end
it 'hides the diagnostic buttons' do
get "/super_admin/users/#{user.id}"
expect(response.body).not_to include('Check email delivery')
expect(response.body).not_to include('Send test email')
end
it 'keeps resend confirmation as a standalone button for unconfirmed users' do
unconfirmed = create(:user, skip_confirmation: false)
get "/super_admin/users/#{unconfirmed.id}"
doc = Nokogiri::HTML(response.body)
expect(doc.at_css('main header details button:contains("Resend confirmation email")')).to be_nil
expect(doc.at_css('main header button:contains("Resend confirmation email")')).to be_present
end
end
context 'when SES suppression is configured' do
around do |example|
with_modified_env(SES_SUPPRESSION_ROLE_ARN: 'arn:aws:iam::123456789012:role/test') { example.run }
end
it 'shows a disabled unblock with a hint before a check' do
get "/super_admin/users/#{user.id}"
doc = Nokogiri::HTML(response.body)
button = doc.at_css('main header button:contains("Unblock email")')
expect(button['disabled']).to be_present
expect(button.parent.text).to include('Check email delivery first.')
expect(response.body).to include('Check email delivery')
expect(response.body).to include('Send test email')
end
it 'moves resend confirmation into the email menu for unconfirmed users' do
unconfirmed = create(:user, skip_confirmation: false)
get "/super_admin/users/#{unconfirmed.id}"
expect(Nokogiri::HTML(response.body).at_css('main header details button:contains("Resend confirmation email")')).to be_present
end
it 'shows an active clear button after a bounce check' do
get "/super_admin/users/#{user.id}", params: { suppression: 'bounce' }
button = Nokogiri::HTML(response.body).at_css('button:contains("Unblock email")')
expect(button).to be_present
expect(button['disabled']).to be_nil
end
it 'uses the installation brand in the unblock dialog' do
allow(GlobalConfig).to receive(:get_value).and_call_original
allow(GlobalConfig).to receive(:get_value).with('BRAND_NAME').and_return('Acme')
get "/super_admin/users/#{user.id}", params: { suppression: 'bounce' }
expect(Nokogiri::HTML(response.body).at_css('dialog#unblock-email-dialog').text).to include('Acme will send emails')
end
it 'confirms the unblock in an in-app dialog' do
get "/super_admin/users/#{user.id}", params: { suppression: 'bounce' }
dialog = Nokogiri::HTML(response.body).at_css('dialog#unblock-email-dialog')
expect(dialog.text).to include('Unblock [email protected]?')
expect(dialog.text).to include('Chatwoot will send emails to this address again.')
expect(dialog.at_css("form[action='/super_admin/users/#{user.id}/clear_email_suppression']")).to be_present
end
it 'disables resend confirmation while the address is blocked' do
unconfirmed = create(:user, skip_confirmation: false)
get "/super_admin/users/#{unconfirmed.id}", params: { suppression: 'bounce' }
button = Nokogiri::HTML(response.body).at_css('main header button:contains("Resend confirmation email")')
expect(button['disabled']).to be_present
end
it 'refuses to resend confirmation to a blocked address' do
unconfirmed = create(:user, skip_confirmation: false)
allow(suppression).to receive(:lookup).with(unconfirmed.email).and_return(status: :bounce, since: 1.day.ago)
ActiveJob::Base.queue_adapter.enqueued_jobs.clear
post "/super_admin/users/#{unconfirmed.id}/resend_confirmation"
expect(ActiveJob::Base.queue_adapter.enqueued_jobs.count { |job| job[:job].to_s == 'ActionMailer::MailDeliveryJob' }).to eq(0)
expect(flash[:alert]).to include('because the address bounced')
end
it 'resends confirmation when the address is not blocked' do
unconfirmed = create(:user, skip_confirmation: false)
allow(suppression).to receive(:lookup).with(unconfirmed.email).and_return(status: :not_suppressed)
ActiveJob::Base.queue_adapter.enqueued_jobs.clear
post "/super_admin/users/#{unconfirmed.id}/resend_confirmation"
expect(ActiveJob::Base.queue_adapter.enqueued_jobs.count { |job| job[:job].to_s == 'ActionMailer::MailDeliveryJob' }).to be >= 1
end
it 'disables the test email while the address is blocked' do
get "/super_admin/users/#{user.id}", params: { suppression: 'complaint' }
button = Nokogiri::HTML(response.body).at_css('main header button:contains("Send test email")')
expect(button['disabled']).to be_present
expect(button.parent.text).to include('Blocked after a spam complaint. Emails to this address are dropped.')
end
it 'keeps the test email available when the address is not blocked' do
get "/super_admin/users/#{user.id}", params: { suppression: 'not_suppressed' }
button = Nokogiri::HTML(response.body).at_css('main header button:contains("Send test email")')
expect(button['disabled']).to be_nil
end
it 'explains why unblock is disabled when the address is not blocked' do
get "/super_admin/users/#{user.id}", params: { suppression: 'not_suppressed' }
button = Nokogiri::HTML(response.body).at_css('main header button:contains("Unblock email")')
expect(button['disabled']).to be_present
expect(button.parent.text).to include('Emails to this address are not blocked.')
end
it 'shows a disabled clear button after a complaint check' do
get "/super_admin/users/#{user.id}", params: { suppression: 'complaint' }
button = Nokogiri::HTML(response.body).at_css('button:contains("Unblock email")')
expect(button['disabled']).to be_present
expect(button.parent.text).to include('Blocked after a spam complaint. Escalate to engineering.')
end
it 'reports an address that is not suppressed' do
allow(suppression).to receive(:lookup).with(user.email).and_return(status: :not_suppressed)
post "/super_admin/users/#{user.id}/check_email_suppression"
expect(response).to redirect_to("/super_admin/users/#{user.id}?suppression=not_suppressed")
expect(flash[:notice]).to eq('Emails to [email protected] are not blocked.')
end
it 'shows the result as a toast that fades on its own' do
allow(suppression).to receive(:lookup).and_return(status: :not_suppressed)
post "/super_admin/users/#{user.id}/check_email_suppression"
follow_redirect!
toast = Nokogiri::HTML(response.body).at_css('[data-toast]')
expect(toast['role']).to eq('status')
expect(toast.key?('data-toast-sticky')).to be(false)
expect(toast.text).to include('are not blocked')
end
it 'reports a bounce with its date' do
travel_to Time.utc(2026, 9, 6, 10, 0, 0)
since = Time.utc(2026, 9, 1, 10, 0, 0)
allow(suppression).to receive(:lookup).with(user.email).and_return(status: :bounce, since: since)
post "/super_admin/users/#{user.id}/check_email_suppression"
expect(response).to redirect_to("/super_admin/users/#{user.id}?suppression=bounce")
expect(flash[:alert]).to eq('Emails to [email protected] have been blocked since 1 Sep 2026 (5 days ago) because the address bounced. ' \
'Unblock it, then ask the user to try again.')
end
it 'reports a complaint as an error with an escalation note' do
travel_to Time.utc(2026, 9, 6, 10, 0, 0)
since = Time.utc(2026, 9, 1, 10, 0, 0)
allow(suppression).to receive(:lookup).with(user.email).and_return(status: :complaint, since: since)
post "/super_admin/users/#{user.id}/check_email_suppression"
expect(response).to redirect_to("/super_admin/users/#{user.id}?suppression=complaint")
expect(flash[:error]).to eq('Emails to [email protected] have been blocked since 1 Sep 2026 (5 days ago) because of a spam complaint. ' \
'Escalate to engineering.')
end
it 'reports a failed lookup' do
allow(suppression).to receive(:lookup).with(user.email).and_return(status: :unavailable)
post "/super_admin/users/#{user.id}/check_email_suppression"
expect(response).to redirect_to("/super_admin/users/#{user.id}?suppression=unavailable")
expect(flash[:alert]).to eq("Couldn't check delivery for [email protected]. Try again, or escalate to engineering.")
end
it 'clears the suppression and logs who did it' do
allow(suppression).to receive(:lookup).with(user.email).and_return(status: :bounce, since: 1.day.ago)
allow(suppression).to receive(:clear!)
allow(Rails.logger).to receive(:info)
post "/super_admin/users/#{user.id}/clear_email_suppression"
expect(suppression).to have_received(:clear!).with(user.email)
expect(Rails.logger).to have_received(:info).with(a_string_including('ses_suppression_cleared', super_admin.email, user.email))
expect(flash[:notice]).to eq('Unblocked [email protected]. Ask the user to try again, or send a test email to check delivery.')
end
it 'refuses to clear a complaint suppression' do
allow(suppression).to receive(:lookup).with(user.email).and_return(status: :complaint, since: 1.day.ago)
allow(suppression).to receive(:clear!)
post "/super_admin/users/#{user.id}/clear_email_suppression"
expect(suppression).not_to have_received(:clear!)
expect(flash[:error]).to include('because of a spam complaint. Escalate to engineering.')
end
it 'reports an address that is no longer blocked without clearing it' do
allow(suppression).to receive(:lookup).with(user.email).and_return(status: :not_suppressed)
allow(suppression).to receive(:clear!)
post "/super_admin/users/#{user.id}/clear_email_suppression"
expect(suppression).not_to have_received(:clear!)
expect(flash[:notice]).to eq('Emails to [email protected] are not blocked.')
end
it 'does not clear when the lookup fails' do
allow(suppression).to receive(:lookup).with(user.email).and_return(status: :unavailable)
allow(suppression).to receive(:clear!)
post "/super_admin/users/#{user.id}/clear_email_suppression"
expect(suppression).not_to have_received(:clear!)
expect(flash[:alert]).to eq("Couldn't check delivery for [email protected]. Try again, or escalate to engineering.")
end
it 'reports a failed clear' do
allow(suppression).to receive(:lookup).with(user.email).and_return(status: :bounce, since: 1.day.ago)
allow(suppression).to receive(:clear!).and_raise(StandardError, 'boom')
post "/super_admin/users/#{user.id}/clear_email_suppression"
expect(flash[:error]).to eq("Couldn't unblock [email protected] (boom). Escalate to engineering.")
end
it 'does not queue a test email to a blocked address' do
allow(suppression).to receive(:lookup).with(user.email).and_return(status: :complaint, since: 1.day.ago)
expect do
post "/super_admin/users/#{user.id}/send_test_email"
end.not_to have_enqueued_mail(EmailDeliveryTestMailer, :delivery_test)
expect(flash[:error]).to include('because of a spam complaint')
end
it 'still queues the test email when the lookup fails' do
allow(suppression).to receive(:lookup).with(user.email).and_return(status: :unavailable)
expect do
post "/super_admin/users/#{user.id}/send_test_email"
end.to have_enqueued_mail(EmailDeliveryTestMailer, :delivery_test)
end
it 'queues a test email and logs who sent it' do
allow(suppression).to receive(:lookup).with(user.email).and_return(status: :not_suppressed)
allow(Rails.logger).to receive(:info)
expect do
post "/super_admin/users/#{user.id}/send_test_email"
end.to have_enqueued_mail(EmailDeliveryTestMailer, :delivery_test).with(user.email, user.name)
expect(Rails.logger).to have_received(:info).with(a_string_including('ses_test_email_sent', super_admin.email, user.email))
expect(flash[:notice]).to eq('Test email on its way to [email protected]. Ask the user to check their inbox and spam folder.')
end
end
end
end