A platform for community discussion. Free, open, simple.
UX: Always email suspended users and clarify expiry timezones (#44812)
Alan Guo Xiang Tanf3067bbc7d35
diff --git a/app/mailers/user_notifications.rb b/app/mailers/user_notifications.rbindex 1fd74aadbb1..e762c3ad09c 100644--- a/app/mailers/user_notifications.rb+++ b/app/mailers/user_notifications.rb@@ -216,22 +216,33 @@ class UserNotifications < ActionMailer::Basereturn unless user_history = opts[:user_history]+ locale = user_locale(user)+if user.suspended_forever?build_email(user.email,template: "user_notifications.account_suspended_forever",- locale: user_locale(user),+ locale:,reason: user_history.details,recipient_user: user,)else- suspended_till = user.suspended_till.in_time_zone(user.user_option.timezone.presence || "UTC")+ timezone =+ ActiveSupport::TimeZone[user.user_option.timezone.presence || "UTC"] ||+ ActiveSupport::TimeZone["UTC"]+ suspended_till = user.suspended_till.in_time_zone(timezone)build_email(user.email,template: "user_notifications.account_suspended",- locale: user_locale(user),+ locale:,reason: user_history.details,- suspended_till: I18n.l(suspended_till, format: :long),+ suspended_till:+ I18n.t(+ "user_notifications.account_suspended.date_with_timezone",+ locale:,+ date: I18n.l(suspended_till, format: :long, locale:),+ offset: suspended_till.formatted_offset,+ ),recipient_user: user,)enddiff --git a/app/services/user_suspender.rb b/app/services/user_suspender.rbindex ea7160104b5..cfbcbeeb8e6 100644--- a/app/services/user_suspender.rb+++ b/app/services/user_suspender.rb@@ -82,14 +82,12 @@ class UserSuspendersuspended_till: @user.suspended_till.iso8601(TIMESTAMP_PRECISION),)- if @message.present?- Jobs.enqueue(- Jobs::CriticalUserEmail,- type: "account_suspended",- user_id: @user.id,- user_history_id: @user_history.id,- )- end+ Jobs.enqueue(+ Jobs::CriticalUserEmail,+ type: "account_suspended",+ user_id: @user.id,+ user_history_id: @user_history.id,+ )DiscourseEvent.trigger(:user_suspended,diff --git a/config/locales/server.en.yml b/config/locales/server.en.ymlindex 12164336fcf..240dcc98da5 100644--- a/config/locales/server.en.yml+++ b/config/locales/server.en.yml@@ -5086,6 +5086,7 @@ en:%{respond_instructions}account_suspended:+ date_with_timezone: "%{date} (UTC%{offset})"title: "Account Suspended"subject_template: "[%{email_prefix}] Your account has been suspended"subject_template_improved: "Your account has been suspended"diff --git a/spec/mailers/user_notifications_spec.rb b/spec/mailers/user_notifications_spec.rbindex dfa73f3f0f6..5434b5544ef 100644--- a/spec/mailers/user_notifications_spec.rb+++ b/spec/mailers/user_notifications_spec.rb@@ -2549,7 +2549,50 @@ RSpec.describe UserNotifications domail = UserNotifications.account_suspended(user, { user_history: user_history })- expect(mail.body).to include("May 25, 2020, 4:00pm")+ expect(mail.body).to include("May 25, 2020, 4:00pm (UTC+04:00)")+ end++ it "uses the offset at the suspension end date across daylight saving changes" do+ user.user_option.timezone = "America/New_York"++ {+ "2027-01-15T17:00:00Z" => "UTC-05:00",+ "2027-07-15T17:00:00Z" => "UTC-04:00",+ }.each do |deadline, offset|+ user.suspended_till = Time.iso8601(deadline)+ email = UserNotifications.account_suspended(user, user_history:)+ expect(email.body.decoded).to include(offset)+ end+ end++ it "falls back to UTC for an unrecognized timezone" do+ user.user_option.timezone = "Not/A_Timezone"+ user.suspended_till = Time.iso8601("2027-01-15T17:00:00Z")++ email = UserNotifications.account_suspended(user, user_history:)++ expect(email.body.decoded).to include("UTC+00:00")+ end++ it "uses the recipient locale and customized date format" do+ SiteSetting.allow_user_locale = true+ user.locale = "fr"+ user.user_option.timezone = "Asia/Kolkata"+ user.suspended_till = Time.iso8601("2027-01-15T12:00:00Z")+ TranslationOverride.upsert!(:fr, "time.formats.long", "%d/%m/%Y à %H:%M")++ email = UserNotifications.account_suspended(user, user_history:)++ expect(email.body.decoded).to include("15/01/2027 à 17:30 (UTC+05:30)")+ end++ it "keeps permanent suspensions free of an expiry date" do+ user.suspended_till = 1000.years.from_now++ email = UserNotifications.account_suspended(user, user_history:)++ expect(email.body.decoded).to include("You have been suspended from the forum.")+ expect(email.body.decoded).not_to include("UTC")endcontext "when user doesn't have timezone set" do@@ -2565,11 +2608,11 @@ RSpec.describe UserNotifications domail = UserNotifications.account_suspended(user, { user_history: user_history })- expect(mail.body).to include(date)+ expect(mail.body).to include("#{date} (UTC+00:00)")endend- context "when user timezone is invalid" do+ context "when user timezone is blank" dobefore { user.user_option.timezone = "" }it "doesn't raise error" do@@ -2582,7 +2625,7 @@ RSpec.describe UserNotifications domail = UserNotifications.account_suspended(user, { user_history: user_history })- expect(mail.body).to include(date)+ expect(mail.body).to include("#{date} (UTC+00:00)")endendenddiff --git a/spec/requests/admin/users_controller_spec.rb b/spec/requests/admin/users_controller_spec.rbindex 6163da70c09..100e510febf 100644--- a/spec/requests/admin/users_controller_spec.rb+++ b/spec/requests/admin/users_controller_spec.rb@@ -547,7 +547,7 @@ RSpec.describe Admin::UsersController dosuspend_until: 5.hours.from_now,reason: "because I said so",}- end.not_to change { Jobs::CriticalUserEmail.jobs.size }+ end.to change { Jobs::CriticalUserEmail.jobs.size }.by(1)expect(response.status).to eq(200)diff --git a/spec/services/user_suspender_spec.rb b/spec/services/user_suspender_spec.rbindex d944e47c087..48bad488f9a 100644--- a/spec/services/user_suspender_spec.rb+++ b/spec/services/user_suspender_spec.rb@@ -126,8 +126,30 @@ RSpec.describe UserSuspender do)end- it "doesn't enqueue a critical user email job" do- expect do suspend_user end.not_to change { Jobs::CriticalUserEmail.jobs.size }.from(0)+ it "delivers a suspension email containing the reason without an optional message" do+ user.user_option.update!(timezone: "Asia/Singapore")++ expect { suspend_user }.to change { Jobs::CriticalUserEmail.jobs.size }.by(1)+ job = Jobs::CriticalUserEmail.jobs.sole.fetch("args").first+ Jobs::CriticalUserEmail.new.execute(job.with_indifferent_access)++ email = ActionMailer::Base.deliveries.sole+ expect(email.to).to eq([user.email])+ expect(email.subject).to include("Your account has been suspended")+ expect(email.text_part.body.decoded).to include("because", "UTC+08:00")+ end++ it "queues one notification when the optional message is whitespace" do+ suspender =+ UserSuspender.new(+ user,+ suspended_till: 5.hours.from_now,+ reason: "because",+ by_user: admin,+ message: " ",+ )++ expect { suspender.suspend }.to change { Jobs::CriticalUserEmail.jobs.size }.by(1)endendend