Skip to content

A platform for community discussion. Free, open, simple.

FIX: Upcoming change notification data JSON limit (#40626)

Martin Brennan89c3787d7413
diff --git a/app/services/upcoming_changes/action/notification_data_merger.rb b/app/services/upcoming_changes/action/notification_data_merger.rb
index 65756717d24..3df57bb5307 100644
--- a/app/services/upcoming_changes/action/notification_data_merger.rb
+++ b/app/services/upcoming_changes/action/notification_data_merger.rb
@@ -9,6 +9,8 @@
# UpcomingChanges::NotifyPromotion, and only unread notifications are considered
# for merging.
class UpcomingChanges::Action::NotificationDataMerger < Service::ActionBase
+ MAX_STORED_NAMES = 5
+
option :existing_notification_data
option :new_change_name
@@ -30,8 +32,8 @@ class UpcomingChanges::Action::NotificationDataMerger < Service::ActionBase
end
{
- upcoming_change_names: merged_names,
- upcoming_change_humanized_names: merged_humanized,
+ upcoming_change_names: merged_names.first(MAX_STORED_NAMES),
+ upcoming_change_humanized_names: merged_humanized.first(MAX_STORED_NAMES),
count: merged_names.size,
}
end
diff --git a/app/services/upcoming_changes/notify_promotion.rb b/app/services/upcoming_changes/notify_promotion.rb
index 0af0ce94d36..66d2bc8e858 100644
--- a/app/services/upcoming_changes/notify_promotion.rb
+++ b/app/services/upcoming_changes/notify_promotion.rb
@@ -32,11 +32,14 @@ class UpcomingChanges::NotifyPromotion
policy :should_notify_admins
try do
- step :log_promotion
- model :existing_notifications, optional: true
- model :bulk_notification_new_records
- step :notify_admins
- step :create_event
+ transaction do
+ step :log_promotion
+ model :existing_notifications, optional: true
+ model :bulk_notification_new_records
+ step :notify_admins
+ step :create_event
+ end
+
step :trigger_discourse_event
end
diff --git a/spec/services/upcoming_changes/action/notification_data_merger_spec.rb b/spec/services/upcoming_changes/action/notification_data_merger_spec.rb
new file mode 100644
index 00000000000..94143de0db0
--- /dev/null
+++ b/spec/services/upcoming_changes/action/notification_data_merger_spec.rb
@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+RSpec.describe UpcomingChanges::Action::NotificationDataMerger do
+ describe ".call" do
+ subject(:result) do
+ described_class.call(
+ existing_notification_data: existing_notification_data,
+ new_change_name: new_change_name,
+ )
+ end
+
+ let(:new_change_name) { :enable_upload_debug_mode }
+
+ context "when there is no existing notification data" do
+ let(:existing_notification_data) { nil }
+
+ it "returns the new change name in arrays" do
+ expect(result[:upcoming_change_names]).to eq(["enable_upload_debug_mode"])
+ expect(result[:upcoming_change_humanized_names]).to eq(["Enable upload debug mode"])
+ expect(result[:count]).to eq(1)
+ end
+ end
+
+ context "when there is existing notification data in the new format" do
+ let(:existing_notification_data) do
+ {
+ upcoming_change_names: ["other_change"],
+ upcoming_change_humanized_names: ["Other change"],
+ count: 1,
+ }.to_json
+ end
+
+ it "merges the new change with existing changes" do
+ expect(result[:upcoming_change_names]).to contain_exactly(
+ "other_change",
+ "enable_upload_debug_mode",
+ )
+ expect(result[:upcoming_change_humanized_names]).to contain_exactly(
+ "Other change",
+ "Enable upload debug mode",
+ )
+ expect(result[:count]).to eq(2)
+ end
+ end
+
+ context "when there is existing notification data in the old format" do
+ let(:existing_notification_data) do
+ {
+ upcoming_change_name: "other_change",
+ upcoming_change_humanized_name: "Other change",
+ }.to_json
+ end
+
+ it "merges old format into the new array format" do
+ expect(result[:upcoming_change_names]).to contain_exactly(
+ "other_change",
+ "enable_upload_debug_mode",
+ )
+ expect(result[:upcoming_change_humanized_names]).to contain_exactly(
+ "Other change",
+ "Enable upload debug mode",
+ )
+ expect(result[:count]).to eq(2)
+ end
+ end
+
+ context "when the new change already exists in the notification data" do
+ let(:existing_notification_data) do
+ {
+ upcoming_change_names: ["enable_upload_debug_mode"],
+ upcoming_change_humanized_names: ["Enable upload debug mode"],
+ count: 1,
+ }.to_json
+ end
+
+ it "deduplicates the change names" do
+ expect(result[:upcoming_change_names]).to eq(["enable_upload_debug_mode"])
+ expect(result[:upcoming_change_humanized_names]).to eq(["Enable upload debug mode"])
+ expect(result[:count]).to eq(1)
+ end
+ end
+
+ context "when there are more than MAX_STORED_NAMES changes" do
+ let(:existing_notification_data) do
+ {
+ upcoming_change_names: %w[change_1 change_2 change_3 change_4 change_5 change_6],
+ upcoming_change_humanized_names: [
+ "Change 1",
+ "Change 2",
+ "Change 3",
+ "Change 4",
+ "Change 5",
+ "Change 6",
+ ],
+ count: 6,
+ }.to_json
+ end
+
+ it "truncates the names arrays to MAX_STORED_NAMES" do
+ expect(result[:upcoming_change_names].size).to eq(
+ UpcomingChanges::Action::NotificationDataMerger::MAX_STORED_NAMES,
+ )
+ expect(result[:upcoming_change_humanized_names].size).to eq(
+ UpcomingChanges::Action::NotificationDataMerger::MAX_STORED_NAMES,
+ )
+ end
+
+ it "preserves the accurate total count" do
+ expect(result[:count]).to eq(7)
+ end
+
+ it "keeps the first MAX_STORED_NAMES names in order" do
+ expect(result[:upcoming_change_names]).to eq(
+ %w[change_1 change_2 change_3 change_4 change_5],
+ )
+ expect(result[:upcoming_change_humanized_names]).to eq(
+ ["Change 1", "Change 2", "Change 3", "Change 4", "Change 5"],
+ )
+ end
+ end
+
+ context "when exactly at MAX_STORED_NAMES" do
+ let(:existing_notification_data) do
+ {
+ upcoming_change_names: %w[change_1 change_2 change_3 change_4],
+ upcoming_change_humanized_names: ["Change 1", "Change 2", "Change 3", "Change 4"],
+ count: 4,
+ }.to_json
+ end
+
+ it "does not truncate when adding one more reaches exactly MAX_STORED_NAMES" do
+ expect(result[:upcoming_change_names].size).to eq(5)
+ expect(result[:count]).to eq(5)
+ end
+ end
+ end
+end
diff --git a/spec/services/upcoming_changes/notify_promotion_spec.rb b/spec/services/upcoming_changes/notify_promotion_spec.rb
index a8b07a56887..cd48a34497f 100644
--- a/spec/services/upcoming_changes/notify_promotion_spec.rb
+++ b/spec/services/upcoming_changes/notify_promotion_spec.rb
@@ -255,6 +255,34 @@ RSpec.describe UpcomingChanges::NotifyPromotion do
end
end
+ context "when the notification creation fails" do
+ before do
+ Notification::Action::BulkCreate.stubs(:call).raises(ActiveRecord::StatementInvalid.new)
+ end
+
+ it "rolls back the staff action log" do
+ expect { result }.not_to change {
+ UserHistory.where(
+ action: UserHistory.actions[:upcoming_change_toggled],
+ subject: "enable_upload_debug_mode",
+ ).count
+ }
+ end
+
+ it "rolls back the upcoming change event" do
+ expect { result }.not_to change {
+ UpcomingChangeEvent.where(
+ event_type: :admins_notified_automatic_promotion,
+ upcoming_change_name: :enable_upload_debug_mode,
+ ).count
+ }
+ end
+
+ it "fails the service" do
+ expect(result).to fail_with_exception
+ end
+ end
+
context "when there is an existing notification with the old data format" do
before do
Fabricate(