Class: PrivateMessageTopicTrackingState
- Inherits:
-
Object
- Object
- PrivateMessageTopicTrackingState
- Includes:
- TopicTrackingStatePublishable
- Defined in:
- app/models/private_message_topic_tracking_state.rb
Overview
This class is used to mirror unread and new status for private messages between server and client.
On the server side, this class has two main responsibilities. The first is to query the database for the initial state of a user’s unread and new private messages. The second is to publish message_bus messages to notify the client of various topic events.
On the client side, we have a ‘PrivateMessageTopicTrackingState` class as well which will load the initial state into memory and subscribes to the relevant message_bus messages. When a message is received, it modifies the in-memory state based on the message type. The filtering for new and unread topics is done on the client side based on the in-memory state in order to derive the count of new and unread topics efficiently.
Constant Summary collapse
- CHANNEL_PREFIX =
"/private-message-topic-tracking-state"
- NEW_MESSAGE_TYPE =
"new_topic"
- UNREAD_MESSAGE_TYPE =
"unread"
- READ_MESSAGE_TYPE =
"read"
- GROUP_ARCHIVE_MESSAGE_TYPE =
"group_archive"
Class Method Summary collapse
- .group_channel(group_id) ⇒ Object
- .new_and_unread_sql(user) ⇒ Object
- .publish_group_archived(topic:, group_id:, acting_user_id: nil) ⇒ Object
- .publish_new(topic) ⇒ Object
- .publish_read(topic_id, last_read_post_number, user, notification_level = nil) ⇒ Object
- .publish_unread(post) ⇒ Object
- .report(user) ⇒ Object
- .report_raw_sql(user, skip_unread: false, skip_new: false) ⇒ Object
- .user_channel(user_id) ⇒ Object
Class Method Details
.group_channel(group_id) ⇒ Object
213 214 215 |
# File 'app/models/private_message_topic_tracking_state.rb', line 213 def self.group_channel(group_id) "#{CHANNEL_PREFIX}/group/#{group_id}" end |
.new_and_unread_sql(user) ⇒ Object
38 39 40 41 42 |
# File 'app/models/private_message_topic_tracking_state.rb', line 38 def self.new_and_unread_sql(user) sql = report_raw_sql(user, skip_unread: true) sql << "\nUNION ALL\n\n" sql << report_raw_sql(user, skip_new: true) end |
.publish_group_archived(topic:, group_id:, acting_user_id: nil) ⇒ Object
183 184 185 186 187 188 189 190 191 192 193 194 195 196 |
# File 'app/models/private_message_topic_tracking_state.rb', line 183 def self.publish_group_archived(topic:, group_id:, acting_user_id: nil) return unless topic. = { message_type: GROUP_ARCHIVE_MESSAGE_TYPE, topic_id: topic.id, payload: { group_ids: [group_id], acting_user_id: acting_user_id, }, }.as_json MessageBus.publish(self.group_channel(group_id), , group_ids: [group_id]) end |
.publish_new(topic) ⇒ Object
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 |
# File 'app/models/private_message_topic_tracking_state.rb', line 153 def self.publish_new(topic) return unless topic. = { message_type: NEW_MESSAGE_TYPE, topic_id: topic.id, payload: { last_read_post_number: nil, highest_post_number: 1, group_ids: topic.allowed_groups.pluck(:id), created_by_user_id: topic.user_id, }, }.as_json topic .allowed_users .pluck(:id) .each do |user_id| next if user_id == topic.user_id # skip topic creator MessageBus.publish(self.user_channel(user_id), , user_ids: [user_id]) end topic .allowed_groups .pluck(:id) .each do |group_id| MessageBus.publish(self.group_channel(group_id), , group_ids: [group_id]) end end |
.publish_read(topic_id, last_read_post_number, user, notification_level = nil) ⇒ Object
198 199 200 201 202 203 204 205 206 207 |
# File 'app/models/private_message_topic_tracking_state.rb', line 198 def self.publish_read(topic_id, last_read_post_number, user, notification_level = nil) self.( message_type: READ_MESSAGE_TYPE, channel_name: self.user_channel(user.id), topic_id: topic_id, user: user, last_read_post_number: last_read_post_number, notification_level: notification_level, ) end |
.publish_unread(post) ⇒ Object
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
# File 'app/models/private_message_topic_tracking_state.rb', line 98 def self.publish_unread(post) topic = post.topic return unless topic. scope = TopicUser.tracking(post.topic_id).includes(user: %i[user_stat user_option]) allowed_group_ids = topic.allowed_groups.pluck(:id) group_ids = if post.post_type == Post.types[:whisper] [Group::AUTO_GROUPS[:staff]] else allowed_group_ids end if group_ids.present? scope = scope.joins("INNER JOIN group_users gu ON gu.user_id = topic_users.user_id").where( "gu.group_id IN (?)", group_ids, ) end # Note: At some point we may want to make the same performance optimisation # here as we did with the other topic tracking state, where we only send # one 'unread' update to all users, not a more accurate unread update to # each individual user with their own read state. # # cf. f6c852bf8e7f4dea519425ba87a114f22f52a8f4 scope .select(%i[user_id last_read_post_number notification_level]) .each do |tu| next if tu.user_id == post.user_id # skip post creator if tu.last_read_post_number.nil? && topic.created_at < tu.user.user_option.treat_as_new_topic_start_date next end = { topic_id: post.topic_id, message_type: UNREAD_MESSAGE_TYPE, payload: { last_read_post_number: tu.last_read_post_number, highest_post_number: post.post_number, notification_level: tu.notification_level, group_ids: allowed_group_ids, created_by_user_id: post.user_id, }, } MessageBus.publish(self.user_channel(tu.user_id), .as_json, user_ids: [tu.user_id]) end end |
.report(user) ⇒ Object
26 27 28 29 30 31 32 33 34 35 36 |
# File 'app/models/private_message_topic_tracking_state.rb', line 26 def self.report(user) sql = new_and_unread_sql(user) DB.query( sql + "\n\n LIMIT :max_topics", { max_topics: TopicTrackingState::MAX_TOPICS, min_new_topic_date: Time.at(SiteSetting.min_new_topics_time).to_datetime, }, ) end |
.report_raw_sql(user, skip_unread: false, skip_new: false) ⇒ Object
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 |
# File 'app/models/private_message_topic_tracking_state.rb', line 44 def self.report_raw_sql(user, skip_unread: false, skip_new: false) unread = if skip_unread "1=0" else first_unread_pm_at = DB.query_single(<<~SQL, user_id: user.id).first SELECT LEAST( MIN(user_stats.first_unread_pm_at), MIN(group_users.first_unread_pm_at) ) FROM group_users JOIN groups ON groups.id = group_users.group_id JOIN user_stats ON user_stats.user_id = :user_id WHERE group_users.user_id = :user_id; SQL <<~SQL #{TopicTrackingState.unread_filter_sql(whisperer: user.whisperer?)} #{first_unread_pm_at ? "AND topics.updated_at > '#{first_unread_pm_at}'" : ""} SQL end new = if skip_new "1=0" else TopicTrackingState.new_filter_sql end sql = +<<~SQL SELECT DISTINCT topics.id AS topic_id, u.id AS user_id, last_read_post_number, tu.notification_level, #{TopicTrackingState.highest_post_number_column_select(user.whisperer?)}, ARRAY(SELECT group_id FROM topic_allowed_groups WHERE topic_allowed_groups.topic_id = topics.id) AS group_ids FROM topics JOIN users u on u.id = #{user.id.to_i} JOIN user_stats AS us ON us.user_id = u.id JOIN user_options AS uo ON uo.user_id = u.id LEFT JOIN group_users gu ON gu.user_id = u.id LEFT JOIN topic_allowed_groups tag ON tag.topic_id = topics.id AND tag.group_id = gu.group_id LEFT JOIN topic_users tu ON tu.topic_id = topics.id AND tu.user_id = u.id LEFT JOIN topic_allowed_users tau ON tau.topic_id = topics.id AND tau.user_id = u.id #{skip_new ? "" : "LEFT JOIN dismissed_topic_users ON dismissed_topic_users.topic_id = topics.id AND dismissed_topic_users.user_id = #{user.id.to_i}"} WHERE (tau.topic_id IS NOT NULL OR tag.topic_id IS NOT NULL) AND topics.archetype = 'private_message' AND ((#{unread}) OR (#{new})) AND topics.deleted_at IS NULL SQL end |
.user_channel(user_id) ⇒ Object
209 210 211 |
# File 'app/models/private_message_topic_tracking_state.rb', line 209 def self.user_channel(user_id) "#{CHANNEL_PREFIX}/user/#{user_id}" end |