## Description Agent notification emails (new conversation, assignment, mention, new message, SLA misses) currently carry no indication of why the recipient received them or how to turn them off. When recipients cannot easily manage these emails, some mark them as spam, which hurts sender reputation and overall deliverability. This adds a short footer line to agent notification emails only: > You're receiving this email because email notifications are enabled for your account. **Manage notification preferences**. The link points the recipient to their dashboard profile notification settings page (`/app/accounts/:account_id/profile/settings`) so they can disable notifications instead of marking the email as spam. This is a navigational link only, not a one-click unsubscribe (a real unsubscribe flow is a separate future change). Scoping: the mailer layout (`app/views/layouts/mailer/base.liquid`) is shared by all mailers via `ApplicationMailer`. To keep the footer on agent notification emails only, `AgentNotifications::ConversationNotificationsMailer` exposes a `notification_settings_url` liquid local (built from the existing `app_account_url` route helper), and the layout renders the footer line only when that local is present. Transactional and other emails do not set it, so they are unaffected. The enterprise SLA notification methods prepend into the same mailer class, so they inherit the footer automatically. Part of https://linear.app/chatwoot/issue/CW-7752 ## Type of change - [x] New feature (non-breaking change which adds functionality) ## How Has This Been Tested? - `bundle exec rspec spec/mailers/agent_notifications/conversation_notifications_mailer_spec.rb spec/mailers/confirmation_instructions_spec.rb` — 26 examples, 0 failures. Asserts the footer link and settings URL are present in an agent notification email and absent from a non-notification (confirmation) email. - `bundle exec rspec spec/enterprise/mailers/enterprise/agent_notifications/conversation_notifications_mailer_spec.rb` — 6 examples, 0 failures (SLA notification emails). ## Checklist: - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my code - [ ] I have commented on my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published in downstream modules
124 lines
5.0 KiB
Ruby
124 lines
5.0 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require 'rails_helper'
|
|
|
|
RSpec.describe 'Devise::Mailer' do
|
|
describe 'notify' do
|
|
let(:account) { create(:account) }
|
|
let!(:confirmable_user) { create(:user, inviter: inviter_val, account: account) }
|
|
let(:inviter_val) { nil }
|
|
let(:mail) { Devise::Mailer.confirmation_instructions(confirmable_user.reload, nil, {}) }
|
|
let(:mail_body) { CGI.unescapeHTML(mail.body.to_s) }
|
|
|
|
before do
|
|
# to verify the token in email
|
|
confirmable_user.update!(confirmed_at: nil)
|
|
confirmable_user.send(:generate_confirmation_token)
|
|
end
|
|
|
|
it 'has the correct header data' do
|
|
expect(mail.reply_to).to contain_exactly('accounts@chatwoot.com')
|
|
expect(mail.to).to contain_exactly(confirmable_user.email)
|
|
expect(mail.subject).to eq('Confirmation Instructions')
|
|
end
|
|
|
|
it 'uses the user\'s name' do
|
|
expect(mail.body.to_s).to include("Hi #{CGI.escapeHTML(confirmable_user.name)},")
|
|
expect(mail_body).to include("Hi #{confirmable_user.name},")
|
|
end
|
|
|
|
context 'when the user name contains HTML' do
|
|
before do
|
|
confirmable_user.update!(name: 'Sony <script>alert(1)</script>')
|
|
end
|
|
|
|
it 'escapes the name in the rendered email body' do
|
|
expect(mail.body.to_s).to include("Hi #{CGI.escapeHTML(confirmable_user.name)},")
|
|
expect(mail.body.to_s).not_to include("Hi #{confirmable_user.name},")
|
|
end
|
|
end
|
|
|
|
it 'shows the default confirmation state' do
|
|
expect(mail_body).to include('Confirm your email to get started')
|
|
expect(mail_body).to include('Welcome to Chatwoot. We just need to verify your email address before you can start using your account.')
|
|
expect(mail_body).to include('Confirm my account')
|
|
expect(mail_body).not_to include('Workspace invitation')
|
|
end
|
|
|
|
it 'sends a confirmation link' do
|
|
expect(mail.body).to include("app/auth/confirmation?confirmation_token=#{confirmable_user.confirmation_token}")
|
|
expect(mail.body).not_to include('app/auth/password/edit')
|
|
end
|
|
|
|
it 'does not render the agent notification preferences footer' do
|
|
expect(mail_body).not_to include('Manage notification preferences')
|
|
end
|
|
|
|
context 'when there is an inviter' do
|
|
let(:inviter_val) { create(:user, :administrator, skip_confirmation: true, account: account) }
|
|
|
|
it 'refers to the inviter and their account' do
|
|
expect(mail_body).to include("You're invited to join #{account.name}")
|
|
expect(mail_body).to include("#{inviter_val.name} invited you to join the #{account.name} workspace on Chatwoot.")
|
|
expect(mail_body).to include('Accept invitation')
|
|
expect(mail_body).not_to include('Confirm your email to get started')
|
|
end
|
|
|
|
it 'sends a password reset link' do
|
|
expect(mail.body).to include('app/auth/password/edit?reset_password_token')
|
|
expect(mail.body).not_to include('app/auth/confirmation')
|
|
end
|
|
end
|
|
|
|
context 'when user updates the email' do
|
|
before do
|
|
confirmable_user.update!(email: 'user@example.com')
|
|
end
|
|
|
|
it 'sends a confirmation link' do
|
|
confirmation_mail = Devise::Mailer.confirmation_instructions(confirmable_user.reload, nil, {})
|
|
confirmation_body = CGI.unescapeHTML(confirmation_mail.body.to_s)
|
|
|
|
expect(confirmation_body).to include('Confirm your new email address')
|
|
expect(confirmation_body).to include('New email')
|
|
expect(confirmation_mail.body).to include('app/auth/confirmation?confirmation_token')
|
|
expect(confirmation_mail.body).not_to include('app/auth/password/edit')
|
|
expect(confirmable_user.unconfirmed_email.blank?).to be false
|
|
end
|
|
end
|
|
|
|
context 'when user is confirmed and updates the email' do
|
|
before do
|
|
confirmable_user.confirm
|
|
confirmable_user.update!(email: 'user@example.com')
|
|
end
|
|
|
|
it 'sends a confirmation link' do
|
|
confirmation_mail = Devise::Mailer.confirmation_instructions(confirmable_user.reload, nil, {})
|
|
confirmation_body = CGI.unescapeHTML(confirmation_mail.body.to_s)
|
|
|
|
expect(confirmation_body).to include('Confirm your new email address')
|
|
expect(confirmation_mail.body).to include('app/auth/confirmation?confirmation_token')
|
|
expect(confirmation_mail.body).not_to include('app/auth/password/edit')
|
|
expect(confirmable_user.unconfirmed_email.blank?).to be false
|
|
end
|
|
end
|
|
|
|
context 'when user already confirmed' do
|
|
before do
|
|
confirmable_user.confirm
|
|
confirmable_user.account_users.last.destroy!
|
|
end
|
|
|
|
it 'send instructions with the link to login' do
|
|
confirmation_mail = Devise::Mailer.confirmation_instructions(confirmable_user.reload, nil, {})
|
|
confirmation_body = CGI.unescapeHTML(confirmation_mail.body.to_s)
|
|
|
|
expect(confirmation_body).to include('Your account is ready')
|
|
expect(confirmation_body).to include('Open my account')
|
|
expect(confirmation_mail.body).to include('/auth/sign_in')
|
|
end
|
|
end
|
|
end
|
|
end
|