discourse/plugins/chat/assets/javascripts/discourse/services/chat-tracking-state-manager.js
Martin Brennan b6c5a2da08
FEATURE: Initial chat thread unread indicators (#21694)
This commit adds the thread index and individual thread
in the index list unread indicators, and wires up the message
bus events to mark the threads as read/unread when:

1. People send a new message in the thread
2. The user marks a thread as read

There are several hacky parts and TODOs to cover before
this is more functional:

1. We need to flesh out the thread scrolling and message
   visibility behaviour. Currently if you scroll to the end
   of the thread it will just mark the whole thread read
   unconditionally.
2. We need to send down the thread current user membership
   along with the last read message ID to the client and
   update that with read state.
3. We need to handle the sidebar unread dot for when threads
   are unread in the channel and clear it based on when the
   channel was last viewed.
4. We need to show some indicator of thread unreads on the
   thread indicators on original messages.
5. UI improvements to make the experience nicer and more
   like the actual design rather than just placeholders.

But, the basic premise around incrementing/decrementing the
thread overview count and showing which thread is unread
in the list is working as intended.
2023-05-25 09:56:19 +02:00

110 lines
3.6 KiB
JavaScript

import Service, { inject as service } from "@ember/service";
import discourseDebounce from "discourse-common/lib/debounce";
import { cancel } from "@ember/runloop";
import ChatTrackingState from "discourse/plugins/chat/discourse/models/chat-tracking-state";
import { getOwner } from "discourse-common/lib/get-owner";
/**
* This service is used to provide a global interface to tracking individual
* channels and threads. In many places in the app, we need to know the global
* unread count for channels, threads, etc.
*
* The individual tracking state of each channel and thread is stored in
* a ChatTrackingState class instance and changed via the getters/setters
* provided there.
*
* This service is also used to preload bulk tracking state for channels
* and threads, which is used when the user first loads the app, and in
* certain cases where we need to set the state for many items at once.
*/
export default class ChatTrackingStateManager extends Service {
@service chatChannelsManager;
@service appEvents;
// NOTE: In future, we may want to preload some thread tracking state
// as well, but for now we do that on demand when the user opens a channel,
// to avoid having to load all the threads across all channels into memory at once.
setupWithPreloadedState({ channel_tracking = {} }) {
this.chatChannelsManager.channels.forEach((channel) => {
if (channel_tracking[channel.id.toString()]) {
this.#setState(channel, channel_tracking[channel.id.toString()]);
}
});
}
setupChannelThreadState(channel, threadTracking) {
channel.threadsManager.threads.forEach((thread) => {
// TODO (martin) Since we didn't backfill data for thread membership,
// there are cases where we are getting threads the user "participated"
// in but don't have tracking state for them. We need a migration to
// backfill this data.
if (threadTracking[thread.id.toString()]) {
this.#setState(thread, threadTracking[thread.id.toString()]);
}
});
}
get publicChannelUnreadCount() {
return this.#publicChannels().reduce((unreadCount, channel) => {
return unreadCount + channel.tracking.unreadCount;
}, 0);
}
get allChannelUrgentCount() {
let publicChannelMentionCount = this.#publicChannels().reduce(
(mentionCount, channel) => {
return mentionCount + channel.tracking.mentionCount;
},
0
);
let dmChannelUnreadCount = this.#directMessageChannels().reduce(
(unreadCount, channel) => {
return unreadCount + channel.tracking.unreadCount;
},
0
);
return publicChannelMentionCount + dmChannelUnreadCount;
}
willDestroy() {
super.willDestroy(...arguments);
cancel(this._onTriggerNotificationDebounceHandler);
}
/**
* Some reactivity in the app such as the document title
* updates are only done via appEvents -- rather than
* sprinkle this appEvent call everywhere we just define
* it here so it can be changed as required.
*/
triggerNotificationsChanged() {
this._onTriggerNotificationDebounceHandler = discourseDebounce(
this,
this.#triggerNotificationsChanged,
100
);
}
#triggerNotificationsChanged() {
this.appEvents.trigger("notifications:changed");
}
#setState(model, state) {
if (!model.tracking) {
model.tracking = new ChatTrackingState(getOwner(this));
}
model.tracking.unreadCount = state.unread_count;
model.tracking.mentionCount = state.mention_count;
}
#publicChannels() {
return this.chatChannelsManager.publicMessageChannels;
}
#directMessageChannels() {
return this.chatChannelsManager.directMessageChannels;
}
}