Display rooms & threads as unread (bold) if threads have unread messa…

…ges. (matrix-org#9763)

Co-authored-by: Germain <[email protected]>
Co-authored-by: Germain <[email protected]>
Fixes element-hq/element-web#23907

src/Unread.ts

@@ -15,6 +15,7 @@ limitations under the License.
 */
 
 import { Room } from "matrix-js-sdk/src/models/room";
+import { Thread } from "matrix-js-sdk/src/models/thread";
 import { MatrixEvent } from "matrix-js-sdk/src/models/event";
 import { EventType } from "matrix-js-sdk/src/@types/event";
 import { M_BEACON } from "matrix-js-sdk/src/@types/beacon";
@@ -59,35 +60,39 @@ export function doesRoomHaveUnreadMessages(room: Room): boolean {
  return false;
  }
 
+ for (const timeline of [room, ...room.getThreads()]) {
+ // If the current timeline has unread messages, we're done.
+ if (doesRoomOrThreadHaveUnreadMessages(timeline)) {
+ return true;
+ }
+ }
+ // If we got here then no timelines were found with unread messages.
+ return false;
+}
+
+export function doesRoomOrThreadHaveUnreadMessages(roomOrThread: Room | Thread): boolean {
+ // If there are no messages yet in the timeline then it isn't fully initialised
+ // and cannot be unread.
+ if (!roomOrThread || roomOrThread.timeline.length === 0) {
+ return false;
+ }
+
  const myUserId = MatrixClientPeg.get().getUserId();
 
+ // as we don't send RRs for our own messages, make sure we special case that
+ // if *we* sent the last message into the room, we consider it not unread!
+ // Should fix: https:/vector-im/element-web/issues/3263
+ // https:/vector-im/element-web/issues/2427
+ // ...and possibly some of the others at
+ // https:/vector-im/element-web/issues/3363
+ if (roomOrThread.timeline.at(-1)?.getSender() === myUserId) {
+ return false;
+ }
+
  // get the most recent read receipt sent by our account.
  // N.B. this is NOT a read marker (RM, aka "read up to marker"),
  // despite the name of the method :((
- const readUpToId = room.getEventReadUpTo(myUserId!);
-
- if (!SettingsStore.getValue("feature_threadstable")) {
- // as we don't send RRs for our own messages, make sure we special case that
- // if *we* sent the last message into the room, we consider it not unread!
- // Should fix: https:/vector-im/element-web/issues/3263
- // https:/vector-im/element-web/issues/2427
- // ...and possibly some of the others at
- // https:/vector-im/element-web/issues/3363
- if (room.timeline.length && room.timeline[room.timeline.length - 1].getSender() === myUserId) {
- return false;
- }
- }
-
- // if the read receipt relates to an event is that part of a thread
- // we consider that there are no unread messages
- // This might be a false negative, but probably the best we can do until
- // the read receipts have evolved to cater for threads
- if (readUpToId) {
- const event = room.findEventById(readUpToId);
- if (event?.getThread()) {
- return false;
- }
- }
+ const readUpToId = roomOrThread.getEventReadUpTo(myUserId!);
 
  // this just looks at whatever history we have, which if we've only just started
  // up probably won't be very much, so if the last couple of events are ones that
@@ -96,8 +101,8 @@ export function doesRoomHaveUnreadMessages(room: Room): boolean {
  // but currently we just guess.
 
  // Loop through messages, starting with the most recent...
- for (let i = room.timeline.length - 1; i >= 0; --i) {
- const ev = room.timeline[i];
+ for (let i = roomOrThread.timeline.length - 1; i >= 0; --i) {
+ const ev = roomOrThread.timeline[i];
 
  if (ev.getId() == readUpToId) {
  // If we've read up to this event, there's nothing more recent

src/components/views/right_panel/RoomHeaderButtons.tsx

@@ -21,6 +21,7 @@ limitations under the License.
 import React from "react";
 import classNames from "classnames";
 import { NotificationCountType, Room, RoomEvent } from "matrix-js-sdk/src/models/room";
+import { ThreadEvent } from "matrix-js-sdk/src/models/thread";
 import { Feature, ServerSupport } from "matrix-js-sdk/src/feature";
 
 import { _t } from "../../../languageHandler";
@@ -44,6 +45,7 @@ import { NotificationStateEvents } from "../../../stores/notifications/Notificat
 import PosthogTrackers from "../../../PosthogTrackers";
 import { ButtonEvent } from "../elements/AccessibleButton";
 import { MatrixClientPeg } from "../../../MatrixClientPeg";
+import { doesRoomOrThreadHaveUnreadMessages } from "../../../Unread";
 
 const ROOM_INFO_PHASES = [
  RightPanelPhases.RoomSummary,
@@ -154,7 +156,17 @@ export default class RoomHeaderButtons extends HeaderButtons<IProps> {
  if (!this.supportsThreadNotifications) {
  this.threadNotificationState?.on(NotificationStateEvents.Update, this.onNotificationUpdate);
  } else {
+ // Notification badge may change if the notification counts from the
+ // server change, if a new thread is created or updated, or if a
+ // receipt is sent in the thread.
  this.props.room?.on(RoomEvent.UnreadNotifications, this.onNotificationUpdate);
+ this.props.room?.on(RoomEvent.Receipt, this.onNotificationUpdate);
+ this.props.room?.on(RoomEvent.Timeline, this.onNotificationUpdate);
+ this.props.room?.on(RoomEvent.Redaction, this.onNotificationUpdate);
+ this.props.room?.on(RoomEvent.LocalEchoUpdated, this.onNotificationUpdate);
+ this.props.room?.on(RoomEvent.MyMembership, this.onNotificationUpdate);
+ this.props.room?.on(ThreadEvent.New, this.onNotificationUpdate);
+ this.props.room?.on(ThreadEvent.Update, this.onNotificationUpdate);
  }
  this.onNotificationUpdate();
  RoomNotificationStateStore.instance.on(UPDATE_STATUS_INDICATOR, this.onUpdateStatus);
@@ -166,6 +178,13 @@ export default class RoomHeaderButtons extends HeaderButtons<IProps> {
  this.threadNotificationState?.off(NotificationStateEvents.Update, this.onNotificationUpdate);
  } else {
  this.props.room?.off(RoomEvent.UnreadNotifications, this.onNotificationUpdate);
+ this.props.room?.off(RoomEvent.Receipt, this.onNotificationUpdate);
+ this.props.room?.off(RoomEvent.Timeline, this.onNotificationUpdate);
+ this.props.room?.off(RoomEvent.Redaction, this.onNotificationUpdate);
+ this.props.room?.off(RoomEvent.LocalEchoUpdated, this.onNotificationUpdate);
+ this.props.room?.off(RoomEvent.MyMembership, this.onNotificationUpdate);
+ this.props.room?.off(ThreadEvent.New, this.onNotificationUpdate);
+ this.props.room?.off(ThreadEvent.Update, this.onNotificationUpdate);
  }
  RoomNotificationStateStore.instance.off(UPDATE_STATUS_INDICATOR, this.onUpdateStatus);
  }
@@ -191,9 +210,17 @@ export default class RoomHeaderButtons extends HeaderButtons<IProps> {
  return NotificationColor.Red;
  case NotificationCountType.Total:
  return NotificationColor.Grey;
- default:
- return NotificationColor.None;
  }
+ // We don't have any notified messages, but we might have unread messages. Let's
+ // find out.
+ for (const thread of this.props.room!.getThreads()) {
+ // If the current thread has unread messages, we're done.
+ if (doesRoomOrThreadHaveUnreadMessages(thread)) {
+ return NotificationColor.Bold;
+ }
+ }
+ // Otherwise, no notification color.
+ return NotificationColor.None;
  }
 
  private onUpdateStatus = (notificationState: SummarizedNotificationState): void => {

src/hooks/useUnreadNotifications.ts

@@ -15,12 +15,13 @@ limitations under the License.
 */
 
 import { NotificationCount, NotificationCountType, Room, RoomEvent } from "matrix-js-sdk/src/models/room";
+import { Thread } from "matrix-js-sdk/src/models/thread";
 import { useCallback, useEffect, useState } from "react";
 
 import { getUnsentMessages } from "../components/structures/RoomStatusBar";
 import { getRoomNotifsState, getUnreadNotificationCount, RoomNotifState } from "../RoomNotifs";
 import { NotificationColor } from "../stores/notifications/NotificationColor";
-import { doesRoomHaveUnreadMessages } from "../Unread";
+import { doesRoomOrThreadHaveUnreadMessages } from "../Unread";
 import { EffectiveMembership, getEffectiveMembership } from "../utils/membership";
 import { useEventEmitter } from "./useEventEmitter";
 
@@ -75,12 +76,14 @@ export const useUnreadNotifications = (
  setColor(NotificationColor.Red);
  } else if (greyNotifs > 0) {
  setColor(NotificationColor.Grey);
- } else if (!threadId) {
- // TODO: No support for `Bold` on threads at the moment
-
+ } else {
  // We don't have any notified messages, but we might have unread messages. Let's
  // find out.
- const hasUnread = doesRoomHaveUnreadMessages(room);
+ let roomOrThread: Room | Thread = room;
+ if (threadId) {
+ roomOrThread = room.getThread(threadId)!;
+ }
+ const hasUnread = doesRoomOrThreadHaveUnreadMessages(roomOrThread);
  setColor(hasUnread ? NotificationColor.Bold : NotificationColor.None);
  }
  }