A platform for community discussion. Free, open, simple.
FIX: Include timezone offsets in silence emails (#44883)
Alan Guo Xiang Tand50426d12dda
diff --git a/app/mailers/user_notifications.rb b/app/mailers/user_notifications.rbindex e762c3ad09c..c6066f6df43 100644--- a/app/mailers/user_notifications.rb+++ b/app/mailers/user_notifications.rb@@ -173,22 +173,33 @@ class UserNotifications < ActionMailer::Basereturn unless user_history = opts[:user_history]+ locale = user_locale(user)+if user.silenced_forever?build_email(user.email,template: "user_notifications.account_silenced_forever",- locale: user_locale(user),+ locale:,reason: user_history.details,recipient_user: user,)else- silenced_till = user.silenced_till.in_time_zone(user.user_option.timezone.presence || "UTC")+ timezone =+ ActiveSupport::TimeZone[user.user_option.timezone.presence || "UTC"] ||+ ActiveSupport::TimeZone["UTC"]+ silenced_till = user.silenced_till.in_time_zone(timezone)build_email(user.email,template: "user_notifications.account_silenced",- locale: user_locale(user),+ locale:,reason: user_history.details,- silenced_till: I18n.l(silenced_till, format: :long),+ silenced_till:+ I18n.t(+ "user_notifications.account_silenced.date_with_timezone",+ locale:,+ date: I18n.l(silenced_till, format: :long, locale:),+ offset: silenced_till.formatted_offset,+ ),recipient_user: user,)enddiff --git a/config/locales/server.en.yml b/config/locales/server.en.ymlindex 02ed7c48441..424d4c76400 100644--- a/config/locales/server.en.yml+++ b/config/locales/server.en.yml@@ -5142,6 +5142,7 @@ en:For additional guidance, refer to our [community guidelines](%{base_url}/guidelines).account_silenced:+ date_with_timezone: "%{date} (UTC%{offset})"title: "Account Silenced"subject_template: "[%{email_prefix}] Your account has been silenced"subject_template_improved: "Your account has been silenced"diff --git a/spec/mailers/user_notifications_spec.rb b/spec/mailers/user_notifications_spec.rbindex b2caa6c616a..375eb071b2d 100644--- a/spec/mailers/user_notifications_spec.rb+++ b/spec/mailers/user_notifications_spec.rb@@ -2433,7 +2433,55 @@ RSpec.describe UserNotifications domail = UserNotifications.account_silenced(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 silence 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.silenced_till = Time.iso8601(deadline)+ email = UserNotifications.account_silenced(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.silenced_till = Time.iso8601("2027-01-15T17:00:00Z")++ email = UserNotifications.account_silenced(user, user_history:)++ expect(email.body.decoded).to include("UTC+00:00")+ end++ it "uses the recipient locale and customized date format and wrapper" do+ SiteSetting.allow_user_locale = true+ user.locale = "fr"+ user.user_option.timezone = "Asia/Kolkata"+ user.silenced_till = Time.iso8601("2027-01-15T12:00:00Z")+ TranslationOverride.upsert!(:fr, "time.formats.long", "%d/%m/%Y à %H:%M")+ TranslationOverride.upsert!(+ :fr,+ "user_notifications.account_silenced.date_with_timezone",+ "%{date} (heure UTC%{offset})",+ )++ email = UserNotifications.account_silenced(user, user_history:)++ expect(email.body.decoded).to include("15/01/2027 à 17:30 (heure UTC+05:30)")+ end++ it "keeps permanent silences free of an expiry date" do+ user.silenced_till = 1000.years.from_now++ email = UserNotifications.account_silenced(user, user_history:)++ expect(email.body.decoded).not_to include("UTC", "until")endcontext "when user doesn't have timezone set" do@@ -2449,11 +2497,11 @@ RSpec.describe UserNotifications domail = UserNotifications.account_silenced(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@@ -2466,7 +2514,7 @@ RSpec.describe UserNotifications domail = UserNotifications.account_silenced(user, { user_history: user_history })- expect(mail.body).to include(date)+ expect(mail.body).to include("#{date} (UTC+00:00)")endendend