FEATURE: Publish read state on group messages. (Originally introduced in #7989) (#8025)

* Revert "Revert "FEATURE: Publish read state on group messages. (#7989) [Undo revert] (#8024)""

This reverts commit 36425eb9f0.

* Fix: Show who read only if the attribute is enabled

* PERF: Precalculate the last post  readed by a group member

* Use book-reader icon instear of far-eye

* FIX: update topic groups correctly

* DEV: Tidy up read indicator update on write
This commit is contained in:
Roman Rizzi 2019-08-27 09:09:00 -03:00 committed by GitHub
parent f2331ef07f
commit 7c741fa0d6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
42 changed files with 688 additions and 21 deletions

View File

@ -40,7 +40,8 @@ export default MountWidget.extend({
"gaps",
"selectedQuery",
"selectedPostsCount",
"searchService"
"searchService",
"showReadIndicator"
);
},
@ -291,6 +292,12 @@ export default MountWidget.extend({
onRefresh: "refreshLikes"
});
}
if (args.refreshReaders) {
this.dirtyKeys.keyDirty(`post-menu-${args.id}`, {
onRefresh: "refreshReaders"
});
}
} else if (args.force) {
this.dirtyKeys.forceAll();
}

View File

@ -35,6 +35,47 @@ export const ListItemDefaults = {
attributeBindings: ["data-topic-id"],
"data-topic-id": Ember.computed.alias("topic.id"),
didInsertElement() {
this._super(...arguments);
if (this.includeReadIndicator) {
this.messageBus.subscribe(this.readIndicatorChannel, data => {
const nodeClassList = document.querySelector(
`.indicator-topic-${data.topic_id}`
).classList;
if (data.show_indicator) {
nodeClassList.remove("unread");
} else {
nodeClassList.add("unread");
}
});
}
},
willDestroyElement() {
this._super(...arguments);
if (this.includeReadIndicator) {
this.messageBus.unsubscribe(this.readIndicatorChannel);
}
},
@computed("topic.id")
readIndicatorChannel(topicId) {
return `/private-messages/read-indicator/${topicId}`;
},
@computed("topic.read_by_group_member")
unreadClass(readByGroupMember) {
return readByGroupMember ? "" : "unread";
},
@computed("topic.read_by_group_member")
includeReadIndicator(readByGroupMember) {
return typeof readByGroupMember !== "undefined";
},
@computed
newDotText() {
return this.currentUser && this.currentUser.trust_level > 0

View File

@ -1348,6 +1348,17 @@ export default Ember.Controller.extend(bufferedProperty("model"), {
})
.then(() => refresh({ id: data.id, refreshLikes: true }));
break;
case "read":
postStream
.triggerChangedPost(data.id, data.updated_at, {
preserveCooked: true
})
.then(() =>
refresh({
id: data.id,
refreshReaders: topic.show_read_indicator
})
);
case "revised":
case "rebaked": {
postStream

View File

@ -71,7 +71,8 @@ export function transformBasicPost(post) {
expandablePost: false,
replyCount: post.reply_count,
locked: post.locked,
userCustomFields: post.user_custom_fields
userCustomFields: post.user_custom_fields,
readCount: post.readers_count
};
_additionalAttributes.forEach(a => (postAtts[a] = post[a]));

View File

@ -178,7 +178,8 @@ const Group = RestModel.extend({
allow_membership_requests: this.allow_membership_requests,
full_name: this.full_name,
default_notification_level: this.default_notification_level,
membership_request_template: this.membership_request_template
membership_request_template: this.membership_request_template,
publish_read_state: this.publish_read_state
};
if (!this.id) {

View File

@ -52,6 +52,16 @@
class="groups-form-messageable-level"}}
</div>
<div class="control-group">
<label>
{{input type="checkbox"
checked=model.publish_read_state
class="groups-form-publish-read-state"}}
{{i18n 'admin.groups.manage.interaction.publish_read_state'}}
</label>
</div>
{{#if showEmailSettings}}
<div class="control-group">
<label class="control-label">{{i18n 'admin.groups.manage.interaction.email'}}</label>

View File

@ -23,6 +23,11 @@
{{~#if showTopicPostBadges}}
{{~raw "topic-post-badges" unread=topic.unread newPosts=topic.displayNewPosts unseen=topic.unseen url=topic.lastUnreadUrl newDotText=newDotText}}
{{~/if}}
{{~#if includeReadIndicator}}
<span class='read-indicator indicator-topic-{{topic.id}} {{unreadClass}}'>
{{~d-icon "book-reader"}}
</span>
{{~/if}}
</span>
<div class="link-bottom-line">
{{#unless hideCategory}}

View File

@ -177,6 +177,7 @@
selectedPostsCount=selectedPostsCount
selectedQuery=selectedQuery
gaps=model.postStream.gaps
showReadIndicator=model.show_read_indicator
showFlags=(action "showPostFlags")
editPost=(action "editPost")
showHistory=(route-action "showHistory")

View File

@ -52,6 +52,36 @@ export function buildButton(name, widget) {
}
}
registerButton("read-count", attrs => {
if (attrs.showReadIndicator) {
const count = attrs.readCount;
if (count > 0) {
return {
action: "toggleWhoRead",
title: "post.controls.read_indicator",
className: "button-count read-indicator",
contents: count,
iconRight: true,
addContainer: false
};
}
}
});
registerButton("read", attrs => {
const disabled = attrs.readCount === 0;
if (attrs.showReadIndicator) {
return {
action: "toggleWhoRead",
title: "post.controls.read_indicator",
icon: "book-reader",
before: "read-count",
addContainer: false,
disabled
};
}
});
function likeCount(attrs) {
const count = attrs.likeCount;
@ -341,7 +371,12 @@ export default createWidget("post-menu", {
},
defaultState() {
return { collapsed: true, likedUsers: [], adminVisible: false };
return {
collapsed: true,
likedUsers: [],
readers: [],
adminVisible: false
};
},
buildKey: attrs => `post-menu-${attrs.id}`,
@ -508,6 +543,19 @@ export default createWidget("post-menu", {
);
}
if (state.readers.length) {
const remaining = state.totalReaders - state.readers.length;
contents.push(
this.attach("small-user-list", {
users: state.readers,
addSelf: false,
listClassName: "who-read",
description: "post.actions.people.read",
count: remaining
})
);
}
return contents;
},
@ -525,9 +573,15 @@ export default createWidget("post-menu", {
showMoreActions() {
this.state.collapsed = false;
if (!this.state.likedUsers.length) {
return this.getWhoLiked();
}
const likesPromise = !this.state.likedUsers.length
? this.getWhoLiked()
: Ember.RSVP.resolve();
return likesPromise.then(() => {
if (!this.state.readers.length && this.attrs.showReadIndicator) {
return this.getWhoRead();
}
});
},
like() {
@ -562,6 +616,12 @@ export default createWidget("post-menu", {
}
},
refreshReaders() {
if (this.state.readers.length) {
return this.getWhoRead();
}
},
getWhoLiked() {
const { attrs, state } = this;
@ -576,6 +636,15 @@ export default createWidget("post-menu", {
});
},
getWhoRead() {
const { attrs, state } = this;
return this.store.find("post-reader", { id: attrs.id }).then(users => {
state.readers = users.map(avatarAtts);
state.totalReaders = users.totalRows;
});
},
toggleWhoLiked() {
const state = this.state;
if (state.likedUsers.length) {
@ -583,5 +652,14 @@ export default createWidget("post-menu", {
} else {
return this.getWhoLiked();
}
},
toggleWhoRead() {
const state = this.state;
if (this.state.readers.length) {
state.readers = [];
} else {
return this.getWhoRead();
}
}
});

View File

@ -136,6 +136,7 @@ export default createWidget("post-stream", {
this.attach("post-small-action", transformed, { model: post })
);
} else {
transformed.showReadIndicator = attrs.showReadIndicator;
result.push(this.attach("post", transformed, { model: post }));
}

View File

@ -133,6 +133,12 @@
.raw-topic-link > * {
pointer-events: none;
}
.read-indicator {
&.unread {
display: none;
}
}
}
.link-bottom-line {

View File

@ -641,7 +641,8 @@ blockquote > *:last-child {
font-size: $font-down-1;
}
.who-liked {
.who-liked,
.who-read {
transition: height 0.5s;
a {
margin: 0 0.25em 0.5em 0;

View File

@ -66,6 +66,7 @@ nav.post-controls {
margin-left: 0;
margin-right: 0;
&.my-likes,
&.read-indicator,
&.regular-likes {
// Like count on posts
.d-icon {
@ -838,7 +839,8 @@ a.attachment:before {
}
}
.who-liked {
.who-liked,
.who-read {
margin-top: 20px;
margin-bottom: 0;
width: 100%;

View File

@ -38,6 +38,7 @@ span.badge-posts {
flex: 0 1 auto;
button {
&.like,
&.read-indicator,
&.create-flag {
flex: 1 1 auto;
}

View File

@ -153,7 +153,8 @@ class Admin::GroupsController < Admin::AdminController
:default_notification_level,
:membership_request_template,
:owner_usernames,
:usernames
:usernames,
:publish_read_state
]
custom_fields = Group.editable_group_custom_fields
permitted << { custom_fields: custom_fields } unless custom_fields.blank?

View File

@ -552,7 +552,8 @@ class GroupsController < ApplicationController
:name,
:grant_trust_level,
:automatic_membership_email_domains,
:automatic_membership_retroactive
:automatic_membership_retroactive,
:publish_read_state
])
custom_fields = Group.editable_group_custom_fields

View File

@ -0,0 +1,26 @@
# frozen_string_literal: true
class PostReadersController < ApplicationController
requires_login
def index
post = Post.includes(topic: %i[allowed_groups]).find(params[:id])
read_state = post.topic.allowed_groups.any? { |g| g.publish_read_state? && g.users.include?(current_user) }
raise Discourse::InvalidAccess unless read_state
readers = User
.joins(:topic_users)
.where('topic_users.topic_id = ? AND COALESCE(topic_users.last_read_post_number, 1) >= ?', post.topic_id, post.post_number)
.where.not(id: [current_user.id, post.user_id])
readers = readers.map do |r|
{
id: r.id, avatar_template: r.avatar_template,
username: r.username,
username_lower: r.username_lower
}
end
render_json_dump(post_readers: readers)
end
end

View File

@ -897,6 +897,7 @@ end
# visibility_level :integer default(0), not null
# public_exit :boolean default(FALSE), not null
# public_admission :boolean default(FALSE), not null
# publish_read_state :boolean default(FALSE), not null
# membership_request_template :text
# messageable_level :integer default(0)
# mentionable_level :integer default(0)

View File

@ -176,6 +176,7 @@ SQL
topic_time = max_time_per_post if topic_time > max_time_per_post
TopicUser.update_last_read(current_user, topic_id, highest_seen, new_posts_read, topic_time, opts)
TopicGroup.update_last_read(current_user, topic_id, highest_seen)
if total_changed > 0
current_user.reload

71
app/models/topic_group.rb Normal file
View File

@ -0,0 +1,71 @@
# frozen_string_literal: true
class TopicGroup < ActiveRecord::Base
belongs_to :group
belongs_to :topic
def self.update_last_read(user, topic_id, post_number)
updated_groups = update_read_count(user, topic_id, post_number)
create_topic_group(user, topic_id, post_number, updated_groups.map(&:group_id))
TopicTrackingState.publish_read_indicator_on_read(topic_id, post_number, user.id)
end
def self.new_message_update(user, topic_id, post_number)
updated_groups = update_read_count(user, topic_id, post_number)
create_topic_group(user, topic_id, post_number, updated_groups.map(&:group_id))
TopicTrackingState.publish_read_indicator_on_write(topic_id, post_number, user.id)
end
def self.update_read_count(user, topic_id, post_number)
update_query = <<~SQL
UPDATE topic_groups tg
SET
last_read_post_number = GREATEST(:post_number, tg.last_read_post_number),
updated_at = :now
FROM topic_allowed_groups tag
INNER JOIN group_users gu ON gu.group_id = tag.group_id
WHERE gu.user_id = :user_id
AND tag.topic_id = :topic_id
AND tg.topic_id = :topic_id
RETURNING
tg.group_id
SQL
updated_groups = DB.query(
update_query,
user_id: user.id, topic_id: topic_id, post_number: post_number, now: DateTime.now
)
end
def self.create_topic_group(user, topic_id, post_number, updated_group_ids)
query = <<~SQL
INSERT INTO topic_groups (topic_id, group_id, last_read_post_number, created_at, updated_at)
SELECT tag.topic_id, tag.group_id, :post_number, :now, :now
FROM topic_allowed_groups tag
INNER JOIN group_users gu ON gu.group_id = tag.group_id
WHERE gu.user_id = :user_id
AND tag.topic_id = :topic_id
SQL
query += 'AND NOT(tag.group_id IN (:already_updated_groups))' unless updated_group_ids.length.zero?
DB.exec(
query,
user_id: user.id, topic_id: topic_id, post_number: post_number, now: DateTime.now, already_updated_groups: updated_group_ids
)
end
end
# == Schema Information
#
# Table name: topic_groups
#
# id :integer not null, primary key
# group_id :integer not null
# topic_id :integer not null
# last_read_post_number :integer default(0), not null
#
# Indexes
#
# index_topic_allowed_groups_on_group_id_and_topic_id (group_id,topic_id) UNIQUE
#

View File

@ -41,7 +41,8 @@ class TopicList
:current_user,
:tags,
:shared_drafts,
:category
:category,
:publish_read_state
)
def initialize(filter, current_user, topics, opts = nil)
@ -57,6 +58,8 @@ class TopicList
if @opts[:tags]
@tags = Tag.where(id: @opts[:tags]).all
end
@publish_read_state = !!@opts[:publish_read_state]
end
def top_tags

View File

@ -128,14 +128,14 @@ class TopicTrackingState
end
def self.publish_read(topic_id, last_read_post_number, user_id, notification_level = nil)
highest_post_number = Topic.where(id: topic_id).pluck(:highest_post_number).first
topic = Topic.select(:highest_post_number, :archetype, :id).find_by(id: topic_id)
message = {
topic_id: topic_id,
message_type: "read",
payload: {
last_read_post_number: last_read_post_number,
highest_post_number: highest_post_number,
highest_post_number: topic.highest_post_number,
topic_id: topic_id,
notification_level: notification_level
}
@ -341,4 +341,56 @@ SQL
)
end
end
def self.publish_read_indicator_on_write(topic_id, last_read_post_number, user_id)
topic = Topic.includes(:allowed_groups).select(:highest_post_number, :archetype, :id).find_by(id: topic_id)
if topic.private_message?
groups = read_allowed_groups_of(topic)
update_topic_list_read_indicator(topic, groups, topic.highest_post_number, user_id, false)
end
end
def self.publish_read_indicator_on_read(topic_id, last_read_post_number, user_id)
topic = Topic.includes(:allowed_groups).select(:highest_post_number, :archetype, :id).find_by(id: topic_id)
if topic.private_message?
groups = read_allowed_groups_of(topic)
post = Post.find_by(topic_id: topic.id, post_number: last_read_post_number)
trigger_post_read_count_update(post, groups)
update_topic_list_read_indicator(topic, groups, last_read_post_number, user_id, true)
end
end
def self.read_allowed_groups_of(topic)
topic.allowed_groups
.joins(:group_users)
.where(publish_read_state: true)
.select('ARRAY_AGG(group_users.user_id) AS members', :name, :id)
.group('groups.id')
end
def self.update_topic_list_read_indicator(topic, groups, last_read_post_number, user_id, read_event)
return unless last_read_post_number == topic.highest_post_number
message = { topic_id: topic.id, show_indicator: read_event }.as_json
groups_to_update = []
groups.each do |group|
member = group.members.include?(user_id)
member_writing = (!read_event && member)
non_member_reading = (read_event && !member)
next if non_member_reading || member_writing
groups_to_update << group
end
return if groups_to_update.empty?
MessageBus.publish("/private-messages/read-indicator/#{topic.id}", message, user_ids: groups_to_update.flat_map(&:members))
end
def self.trigger_post_read_count_update(post, groups)
return if groups.empty?
post.publish_change_to_clients!(:read)
end
end

View File

@ -31,7 +31,8 @@ class BasicGroupSerializer < ApplicationSerializer
:is_group_user,
:is_group_owner,
:members_visibility_level,
:can_see_members
:can_see_members,
:publish_read_state
def include_display_name?
object.automatic

View File

@ -25,7 +25,8 @@ class ListableTopicSerializer < BasicTopicSerializer
:notification_level,
:bookmarked,
:liked,
:unicode_title
:unicode_title,
:read_by_group_member
has_one :last_poster, serializer: BasicUserSerializer, embed: :objects
@ -121,6 +122,18 @@ class ListableTopicSerializer < BasicTopicSerializer
PinnedCheck.unpinned?(object, object.user_data)
end
def read_by_group_member
# object#last_read_post_number is an attribute selected from a joined table.
# See TopicQuery#append_read_state for more information.
return false unless object.respond_to?(:last_read_post_number)
object.last_read_post_number >= object.highest_post_number
end
def include_read_by_group_member?
!!object.topic_list&.publish_read_state
end
protected
def unread_helper

View File

@ -26,6 +26,7 @@ class PostSerializer < BasicPostSerializer
:quote_count,
:incoming_link_count,
:reads,
:readers_count,
:score,
:yours,
:topic_id,
@ -458,6 +459,13 @@ class PostSerializer < BasicPostSerializer
can_review_topic?
end
def readers_count
read_count = object.reads - 1 # Exclude logged user
read_count -= 1 unless yours
read_count < 0 ? 0 : read_count
end
private
def can_review_topic?

View File

@ -71,7 +71,8 @@ class TopicViewSerializer < ApplicationSerializer
:participant_count,
:destination_category_id,
:pm_with_non_human_user,
:queued_posts_count
:queued_posts_count,
:show_read_indicator
)
has_one :details, serializer: TopicViewDetailsSerializer, root: false, embed: :objects
@ -248,4 +249,8 @@ class TopicViewSerializer < ApplicationSerializer
def include_queued_posts_count?
scope.is_staff? && object.queued_posts_enabled
end
def show_read_indicator
object.show_read_indicator?
end
end

View File

@ -32,4 +32,7 @@ class WebHookPostSerializer < PostSerializer
object.topic ? object.topic.posts_count : 0
end
def include_readers_count?
false
end
end

View File

@ -28,6 +28,10 @@ class WebHookTopicViewSerializer < TopicViewSerializer
end
end
def include_show_read_indicator?
false
end
def created_by
BasicUserSerializer.new(object.topic.user, scope: scope, root: false)
end

View File

@ -2421,6 +2421,7 @@ en:
reply: "begin composing a reply to this post"
like: "like this post"
has_liked: "you've liked this post"
read_indicator: "members who read this post"
undo_like: "undo like"
edit: "edit this post"
edit_action: "Edit"
@ -2478,6 +2479,7 @@ en:
notify_user: "sent a message"
bookmark: "bookmarked this"
like: "liked this"
read: "read this"
like_capped:
one: "and {{count}} other liked this"
other: "and {{count}} others liked this"
@ -3217,6 +3219,7 @@ en:
members_visibility_levels:
title: "Who can see this group members?"
description: "Admins can see members of all groups."
publish_read_state: "On group messages publish group read state"
membership:
automatic: Automatic

View File

@ -605,6 +605,7 @@ Discourse::Application.routes.draw do
get "excerpt" => "excerpt#show"
resources :post_action_users
resources :post_readers, only: %i[index]
resources :post_actions do
collection do
get "users"

View File

@ -191,9 +191,10 @@ basic:
post_menu:
client: true
type: list
default: "like|share|flag|edit|bookmark|delete|admin|reply"
default: "read|like|share|flag|edit|bookmark|delete|admin|reply"
allow_any: false
choices:
- read
- like
- edit
- flag

View File

@ -0,0 +1,7 @@
# frozen_string_literal: true
class GroupsPublishReadState < ActiveRecord::Migration[5.2]
def change
add_column :groups, :publish_read_state, :boolean, null: false, default: false
end
end

View File

@ -0,0 +1,14 @@
# frozen_string_literal: true
class CreateTopicGroupTable < ActiveRecord::Migration[5.2]
def change
create_table :topic_groups do |t|
t.integer :group_id, null: false
t.integer :topic_id, null: false
t.integer :last_read_post_number, null: false, default: 0
t.timestamps null: false
end
add_index :topic_groups, %i[group_id topic_id], unique: true
end
end

View File

@ -22,6 +22,7 @@ class PostJobsEnqueuer
if @topic.private_message?
TopicTrackingState.publish_private_message(@topic, post: @post)
TopicGroup.new_message_update(@topic.last_poster, @topic.id, @post.post_number)
end
end

View File

@ -28,6 +28,7 @@ module SvgSprite
"bell-slash",
"bold",
"book",
"book-reader",
"bookmark",
"briefcase",
"calendar-alt",

View File

@ -344,11 +344,13 @@ class TopicQuery
def list_private_messages_group(user)
list = private_messages_for(user, :group)
group_id = Group.where('name ilike ?', @options[:group_name]).pluck(:id).first
group = Group.where('name ilike ?', @options[:group_name]).select(:id, :publish_read_state).first
publish_read_state = !!group&.publish_read_state
list = list.joins("LEFT JOIN group_archived_messages gm ON gm.topic_id = topics.id AND
gm.group_id = #{group_id.to_i}")
gm.group_id = #{group&.id&.to_i}")
list = list.where("gm.id IS NULL")
create_list(:private_messages, {}, list)
list = append_read_state(list, group) if publish_read_state
create_list(:private_messages, { publish_read_state: publish_read_state }, list)
end
def list_private_messages_group_archive(user)
@ -1057,4 +1059,16 @@ class TopicQuery
def sanitize_sql_array(input)
ActiveRecord::Base.public_send(:sanitize_sql_array, input.join(','))
end
def append_read_state(list, group)
group_id = group&.id
return list if group_id.nil?
selected_values = list.select_values.empty? ? ['topics.*'] : list.select_values
selected_values << "COALESCE(tg.last_read_post_number, 0) AS last_read_post_number"
list
.joins("LEFT OUTER JOIN topic_groups tg ON topics.id = tg.topic_id AND tg.group_id = #{group_id}")
.select(*selected_values)
end
end

View File

@ -109,6 +109,14 @@ class TopicView
@personal_message = @topic.private_message?
end
def show_read_indicator?
return false unless @user || topic.private_message?
topic.allowed_groups.any? do |group|
group.publish_read_state? && group.users.include?(@user)
end
end
def canonical_path
path = relative_url.dup
path <<

View File

@ -1020,6 +1020,24 @@ describe TopicQuery do
expect(topics).to eq([])
end
context "Calculating minimum unread count for a topic" do
before { group.update!(publish_read_state: true) }
let(:listed_message) do
TopicQuery.new(nil, group_name: group.name)
.list_private_messages_group(creator)
.topics.first
end
it 'returns the last read post number' do
topic_group = TopicGroup.create!(
topic: group_message, group: group, last_read_post_number: 10
)
expect(listed_message.last_read_post_number).to eq(topic_group.last_read_post_number)
end
end
end
context "shared drafts" do

View File

@ -0,0 +1,85 @@
# frozen_string_literal: true
require 'rails_helper'
describe TopicGroup do
describe '#update_last_read' do
fab!(:group) { Fabricate(:group) }
fab!(:user) { Fabricate(:user) }
before do
@topic = Fabricate(:private_message_topic, allowed_groups: [group])
group.add(user)
end
it 'does nothing if the user is not a member of an allowed group' do
another_user = Fabricate(:user)
described_class.update_last_read(another_user, @topic.id, @topic.highest_post_number)
created_topic_group = described_class.where(topic: @topic, group: group).exists?
expect(created_topic_group).to eq(false)
end
it 'creates a new record if the user is a member of an allowed group' do
described_class.update_last_read(user, @topic.id, @topic.highest_post_number)
created_topic_group = described_class.find_by(topic: @topic, group: group)
expect(created_topic_group.last_read_post_number).to eq @topic.highest_post_number
end
it 'does nothing if the topic does not have allowed groups' do
@topic.update!(allowed_groups: [])
described_class.update_last_read(user, @topic.id, @topic.highest_post_number)
created_topic_group = described_class.where(topic: @topic, group: group).exists?
expect(created_topic_group).to eq(false)
end
it 'updates an existing record with a higher post number' do
described_class.create!(topic: @topic, group: group, last_read_post_number: @topic.highest_post_number - 1)
described_class.update_last_read(user, @topic.id, @topic.highest_post_number)
created_topic_group = described_class.find_by(topic: @topic, group: group)
expect(created_topic_group.last_read_post_number).to eq @topic.highest_post_number
end
it 'does nothing if the user read post number is lower than the current one' do
highest_read_number = @topic.highest_post_number + 1
described_class.create!(topic: @topic, group: group, last_read_post_number: highest_read_number)
described_class.update_last_read(user, @topic.id, @topic.highest_post_number)
created_topic_group = described_class.find_by(topic: @topic, group: group)
expect(created_topic_group.last_read_post_number).to eq highest_read_number
end
it 'creates a new record if the list of allowed groups has changed' do
another_allowed_group = Fabricate(:group)
another_allowed_group.add(user)
@topic.allowed_groups << another_allowed_group
described_class.create!(topic: @topic, group: group, last_read_post_number: @topic.highest_post_number)
described_class.update_last_read(user, @topic.id, @topic.highest_post_number)
created_topic_group = described_class.find_by(topic: @topic, group: another_allowed_group)
expect(created_topic_group.last_read_post_number).to eq @topic.highest_post_number
end
it 'Only updates the record that shares the same topic_id' do
new_post_number = 100
topic2 = Fabricate(:private_message_topic, allowed_groups: [group], topic_allowed_users: [])
described_class.create!(topic: @topic, group: group, last_read_post_number: @topic.highest_post_number)
described_class.create!(topic: topic2, group: group, last_read_post_number: topic2.highest_post_number)
described_class.update_last_read(user, @topic.id, new_post_number)
created_topic_group = described_class.find_by(topic: @topic, group: group)
created_topic_group2 = described_class.find_by(topic: topic2, group: group)
expect(created_topic_group.last_read_post_number).to eq new_post_number
expect(created_topic_group2.last_read_post_number).to eq topic2.highest_post_number
end
end
end

View File

@ -254,6 +254,70 @@ describe TopicTrackingState do
end
end
describe '#publish_read_private_message' do
fab!(:group) { Fabricate(:group) }
let(:read_topic_key) { "/private-messages/read-indicator/#{@group_message.id}" }
let(:read_post_key) { "/topic/#{@group_message.id}" }
let(:latest_post_number) { 3 }
before do
group.add(user)
@group_message = Fabricate(:private_message_topic,
allowed_groups: [group],
topic_allowed_users: [Fabricate.build(:topic_allowed_user, user: user)],
highest_post_number: latest_post_number
)
@post = Fabricate(:post, topic: @group_message, post_number: latest_post_number)
end
it 'does not trigger a read count update if no allowed groups have the option enabled' do
messages = MessageBus.track_publish(read_post_key) do
TopicTrackingState.publish_read_indicator_on_read(@group_message.id, latest_post_number, user.id)
end
expect(messages).to be_empty
end
context 'when the read indicator is enabled' do
before { group.update!(publish_read_state: true) }
it 'does publish the read indicator' do
message = MessageBus.track_publish(read_topic_key) do
TopicTrackingState.publish_read_indicator_on_read(@group_message.id, latest_post_number, user.id)
end.first
expect(message.data['topic_id']).to eq @group_message.id
end
it 'does not publish the read indicator if the message is not the last one' do
not_last_post_number = latest_post_number - 1
Fabricate(:post, topic: @group_message, post_number: not_last_post_number)
messages = MessageBus.track_publish(read_topic_key) do
TopicTrackingState.publish_read_indicator_on_read(@group_message.id, not_last_post_number, user.id)
end
expect(messages).to be_empty
end
it 'does not publish the read indicator if the user is not a group member' do
allowed_user = Fabricate(:topic_allowed_user, topic: @group_message)
messages = MessageBus.track_publish(read_topic_key) do
TopicTrackingState.publish_read_indicator_on_read(@group_message.id, latest_post_number, allowed_user.user_id)
end
expect(messages).to be_empty
end
it 'publish a read count update to every client' do
message = MessageBus.track_publish(read_post_key) do
TopicTrackingState.publish_read_indicator_on_read(@group_message.id, latest_post_number, user.id)
end.first
expect(message.data[:type]).to eq :read
end
end
end
it "correctly handles muted categories" do
user = Fabricate(:user)

View File

@ -0,0 +1,90 @@
# frozen_string_literal: true
require 'rails_helper'
describe PostReadersController do
describe '#index' do
fab!(:admin) { Fabricate(:admin) }
fab!(:reader) { Fabricate(:user) }
before { sign_in(admin) }
before do
@group = Fabricate(:group)
@group_message = Fabricate(:private_message_topic, allowed_groups: [@group])
@post = Fabricate(:post, topic: @group_message, post_number: 3)
end
context 'When the user has access to readers data' do
before do
@group.update!(publish_read_state: true)
@group.add(admin)
@group.add(reader)
end
it 'returns an empty list when nobody has read the topic' do
get '/post_readers.json', params: { id: @post.id }
readers = JSON.parse(response.body)['post_readers']
expect(readers).to be_empty
end
it 'returns an user who read until that post' do
TopicUser.create!(user: reader, topic: @group_message, last_read_post_number: 3)
get '/post_readers.json', params: { id: @post.id }
reader_data = JSON.parse(response.body)['post_readers'].first
assert_reader_is_correctly_serialized(reader_data, reader, @post)
end
it 'returns an user who read pass that post' do
TopicUser.create!(user: reader, topic: @group_message, last_read_post_number: 4)
get '/post_readers.json', params: { id: @post.id }
reader_data = JSON.parse(response.body)['post_readers'].first
assert_reader_is_correctly_serialized(reader_data, reader, @post)
end
it 'return an empty list when nodobody read unti that post' do
TopicUser.create!(user: reader, topic: @group_message, last_read_post_number: 1)
get '/post_readers.json', params: { id: @post.id }
readers = JSON.parse(response.body)['post_readers']
expect(readers).to be_empty
end
it "doesn't include current_user in the readers list" do
TopicUser.create!(user: admin, topic: @group_message, last_read_post_number: 3)
get '/post_readers.json', params: { id: @post.id }
reader = JSON.parse(response.body)['post_readers'].detect { |r| r['username'] == admin.username }
expect(reader).to be_nil
end
end
def assert_reader_is_correctly_serialized(reader_data, reader, post)
expect(reader_data['avatar_template']).to eq reader.avatar_template
expect(reader_data['username']).to eq reader.username
expect(reader_data['username_lower']).to eq reader.username_lower
end
it 'returns forbidden if no group has publish_read_state enabled' do
get '/post_readers.json', params: { id: @post.id }
expect(response).to be_forbidden
end
it 'returns forbidden if current_user is not a member of a group with publish_read_state enabled' do
@group.update!(publish_read_state: true)
get '/post_readers.json', params: { id: @post.id }
expect(response).to be_forbidden
end
end
end

View File

@ -3744,4 +3744,8 @@
<title id="yin-yang-title">Yin Yang</title>
<path d="M248 8C111.03 8 0 119.03 0 256s111.03 248 248 248 248-111.03 248-248S384.97 8 248 8zm0 376c-17.67 0-32-14.33-32-32s14.33-32 32-32 32 14.33 32 32-14.33 32-32 32zm0-128c-53.02 0-96 42.98-96 96s42.98 96 96 96c-106.04 0-192-85.96-192-192S141.96 64 248 64c53.02 0 96 42.98 96 96s-42.98 96-96 96zm0-128c-17.67 0-32 14.33-32 32s14.33 32 32 32 32-14.33 32-32-14.33-32-32-32z"></path>
</symbol>
<symbol id="book-reader" viewBox="0 0 512 512">
<title id="book-reader-title">Book Reader</title>
<path d="M352 96c0-53.02-42.98-96-96-96s-96 42.98-96 96 42.98 96 96 96 96-42.98 96-96zM233.59 241.1c-59.33-36.32-155.43-46.3-203.79-49.05C13.55 191.13 0 203.51 0 219.14v222.8c0 14.33 11.59 26.28 26.49 27.05 43.66 2.29 131.99 10.68 193.04 41.43 9.37 4.72 20.48-1.71 20.48-11.87V252.56c-.01-4.67-2.32-8.95-6.42-11.46zm248.61-49.05c-48.35 2.74-144.46 12.73-203.78 49.05-4.1 2.51-6.41 6.96-6.41 11.63v245.79c0 10.19 11.14 16.63 20.54 11.9 61.04-30.72 149.32-39.11 192.97-41.4 14.9-.78 26.49-12.73 26.49-27.06V219.14c-.01-15.63-13.56-28.01-29.81-27.09z"></path>
</symbol>
</svg>

Before

Width:  |  Height:  |  Size: 642 KiB

After

Width:  |  Height:  |  Size: 642 KiB