mirror of
https://github.com/discourse/discourse.git
synced 2024-11-29 04:03:57 -06:00
1fc06520bd
* REFACTOR: Improve support for consolidating notifications. Before this commit, we didn't have a single way of consolidating notifications. For notifications like group summaries, we manually removed old ones before creating a new one. On the other hand, we used an after_create callback for likes and group membership requests, which caused unnecessary work, as we need to delete the record we created to replace it with a consolidated one. We now have all the consolidation rules centralized in a single place: the consolidation planner class. Other parts of the app looking to create a consolidable notification can do so by calling Notification#consolidate_or_save!, instead of the default Notification#create! method. Finally, we added two more rules: one for re-using existing group summaries and another for deleting duplicated dashboard problems PMs notifications when the user is tracking the moderator's inbox. Setting the threshold to one forces the planner to apply this rule every time. I plan to add plugin support for adding custom rules in another PR to keep this one relatively small. * DEV: Introduces a plugin API for consolidating notifications. This commit removes the `Notification#filter_by_consolidation_data` scope since plugins could have to define their criteria. The Plan class now receives two blocks, one to query for an already consolidated notification, which we'll try to update, and another to query for existing ones to consolidate. It also receives a consolidation window, which accepts an ActiveSupport::Duration object, and filter notifications created since that value.
58 lines
2.1 KiB
Ruby
58 lines
2.1 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require 'rails_helper'
|
|
|
|
describe Notifications::ConsolidationPlanner do
|
|
describe '#consolidate_or_save!' do
|
|
let(:threshold) { 1 }
|
|
fab!(:user) { Fabricate(:user) }
|
|
let(:like_user) { 'user1' }
|
|
|
|
before { SiteSetting.notification_consolidation_threshold = threshold }
|
|
|
|
it "does nothing it haven't passed the consolidation threshold yet" do
|
|
notification = build_notification(:liked, { display_username: like_user })
|
|
|
|
saved_like = subject.consolidate_or_save!(notification)
|
|
|
|
expect(saved_like.id).to be_present
|
|
expect(saved_like.notification_type).to eq(Notification.types[:liked])
|
|
end
|
|
|
|
it 'consolidates multiple notifications into a new one' do
|
|
first_notification = Fabricate(:notification, user: user, notification_type: Notification.types[:liked], data: { display_username: like_user }.to_json)
|
|
notification = build_notification(:liked, { display_username: like_user })
|
|
|
|
consolidated_like = subject.consolidate_or_save!(notification)
|
|
|
|
expect(consolidated_like.id).not_to eq(first_notification.id)
|
|
expect(consolidated_like.notification_type).to eq(Notification.types[:liked_consolidated])
|
|
data = JSON.parse(consolidated_like.data)
|
|
expect(data['count']).to eq(threshold + 1)
|
|
end
|
|
|
|
it 'updates the notification if we already consolidated it' do
|
|
count = 5
|
|
Fabricate(:notification,
|
|
user: user, notification_type: Notification.types[:liked_consolidated],
|
|
data: { count: count, display_username: like_user }.to_json
|
|
)
|
|
notification = build_notification(:liked, { display_username: like_user })
|
|
|
|
updated = subject.consolidate_or_save!(notification)
|
|
|
|
expect { notification.reload }.to raise_error(ActiveRecord::RecordNotFound)
|
|
data = JSON.parse(updated.data)
|
|
expect(data['count']).to eq(count + 1)
|
|
end
|
|
end
|
|
|
|
def build_notification(type_sym, data)
|
|
Fabricate.build(:notification, user: user, notification_type: Notification.types[type_sym], data: data.to_json)
|
|
end
|
|
|
|
def plan_for(notification)
|
|
subject.plan_for(notification)
|
|
end
|
|
end
|