MSC3773 POC

Author: Germain Souquet

src/filter.ts

@@ -57,6 +57,7 @@ export interface IRoomEventFilter extends IFilterComponent {
     types?: Array<EventType | string>;
     related_by_senders?: Array<RelationType | string>;
     related_by_rel_types?: string[];
+    unread_thread_notifications?: boolean;
 
     // Unstable values
     "io.element.relation_senders"?: Array<RelationType | string>;

src/models/room.ts

@@ -207,6 +207,8 @@ export type RoomEventHandlerMap = {
     [ThreadEvent.New]: (thread: Thread, toStartOfTimeline: boolean) => void;
 } & ThreadHandlerMap & MatrixEventHandlerMap;
 
+type NotificationCount = Partial<Record<NotificationCountType, number>>;
+
 export class Room extends TypedEventEmitter<EmittedEvents, RoomEventHandlerMap> {
     public readonly reEmitter: TypedReEmitter<EmittedEvents, RoomEventHandlerMap>;
     private txnToEvent: Record<string, MatrixEvent> = {}; // Pending in-flight requests { string: MatrixEvent }
@@ -216,7 +218,8 @@ export class Room extends TypedEventEmitter<EmittedEvents, RoomEventHandlerMap>
     // a pre-cached list for this purpose.
     private receipts: Receipts = {}; // { receipt_type: { user_id: IReceipt } }
     private receiptCacheByEventId: ReceiptCache = {}; // { event_id: ICachedReceipt[] }
-    private notificationCounts: Partial<Record<NotificationCountType, number>> = {};
+    private notificationCounts: NotificationCount = {};
+    private threadNotifications: Record<string, NotificationCount> = {};
     private readonly timelineSets: EventTimelineSet[];
     public readonly threadsTimelineSets: EventTimelineSet[] = [];
     // any filtered timeline sets we're maintaining for this room
@@ -1177,14 +1180,30 @@ export class Room extends TypedEventEmitter<EmittedEvents, RoomEventHandlerMap>
         return event;
     }
 
+    /**
+     * Get sum of threads and roon notification counts
+     * @param {String} type The type of notification count to get. default: 'total'
+     * @return {Number} The notification count.
+     */
+    public getTotalUnreadNotificationCount(type = NotificationCountType.Total): number {
+        return (this.getUnreadNotificationCount(type) ?? 0) +
+            this.getTotalThreadsUnreadNotificationCount(type);
+    }
+
+    public getTotalThreadsUnreadNotificationCount(type = NotificationCountType.Total): number {
+        return Object.keys(this.threadNotifications).reduce((total: number, threadId: string) => {
+            return total + (this.getThreadUnreadNotificationCount(threadId, type) ?? 0);
+        }, 0);
+    }
+
     /**
      * Get one of the notification counts for this room
      * @param {String} type The type of notification count to get. default: 'total'
      * @return {Number} The notification count, or undefined if there is no count
      *                  for this type.
      */
     public getUnreadNotificationCount(type = NotificationCountType.Total): number | undefined {
-        return this.notificationCounts[type];
+        return this.notificationCounts[type] ?? 0;
     }
 
     /**
@@ -1196,6 +1215,17 @@ export class Room extends TypedEventEmitter<EmittedEvents, RoomEventHandlerMap>
         this.notificationCounts[type] = count;
     }
 
+    public getThreadUnreadNotificationCount(threadId: string, type = NotificationCountType.Total): number | undefined {
+        return this.threadNotifications[threadId]?.[type];
+    }
+
+    public setThreadUnreadNotificationCount(threadId: string, type: NotificationCountType, count: number): void {
+        const notificationCount = this.threadNotifications[threadId];
+        if (notificationCount) {
+            notificationCount[type] = count;
+        }
+    }
+
     public setSummary(summary: IRoomSummary): void {
         const heroes = summary["m.heroes"];
         const joinedCount = summary["m.joined_member_count"];

src/sync-accumulator.ts

@@ -76,6 +76,9 @@ export interface IJoinedRoom {
     ephemeral: IEphemeral;
     account_data: IAccountData;
     unread_notifications: IUnreadNotificationCounts;
+    unread_thread_notifications?: {
+        [threadId: string]: IUnreadNotificationCounts;
+    };
 }
 
 export interface IStrippedState {
@@ -154,6 +157,9 @@ interface IRoom {
     _summary: Partial<IRoomSummary>;
     _accountData: { [eventType: string]: IMinimalEvent };
     _unreadNotifications: Partial<IUnreadNotificationCounts>;
+    _unreadThreadNotifications?: {
+        [threadId: string]: Partial<IUnreadNotificationCounts>;
+    };
     _readReceipts: {
         [userId: string]: {
             data: IMinimalEvent;
@@ -358,12 +364,13 @@ export class SyncAccumulator {
             // Create truly empty objects so event types of 'hasOwnProperty' and co
             // don't cause this code to break.
             this.joinRooms[roomId] = {
-                _currentState: Object.create(null),
-                _timeline: [],
-                _accountData: Object.create(null),
-                _unreadNotifications: {},
-                _summary: {},
-                _readReceipts: {},
+                "_currentState": Object.create(null),
+                "_timeline": [],
+                "_accountData": Object.create(null),
+                "_unreadNotifications": {},
+                "_unreadThreadNotifications": {},
+                "_summary": {},
+                "_readReceipts": {},
             };
         }
         const currentData = this.joinRooms[roomId];
@@ -379,6 +386,9 @@ export class SyncAccumulator {
         if (data.unread_notifications) {
             currentData._unreadNotifications = data.unread_notifications;
         }
+        if (data.unread_thread_notifications) {
+            currentData._unreadThreadNotifications = data.unread_thread_notifications;
+        }
         if (data.summary) {
             const HEROES_KEY = "m.heroes";
             const INVITED_COUNT_KEY = "m.invited_member_count";
@@ -537,6 +547,7 @@ export class SyncAccumulator {
                     prev_batch: null,
                 },
                 unread_notifications: roomData._unreadNotifications,
+                unread_thread_notifications: roomData._unreadThreadNotifications,
                 summary: roomData._summary as IRoomSummary,
             };
             // Add account data

src/sync.ts

@@ -138,6 +138,8 @@ interface ISyncParams {
     // eslint-disable-next-line camelcase
     set_presence?: SetPresence;
     _cacheBuster?: string | number; // not part of the API itself
+    unread_thread_notifications?: boolean;
+    "org.matrix.msc3773.unread_thread_notifications"?: boolean;
 }
 
 type WrappedRoom<T> = T & {
@@ -996,8 +998,10 @@ export class SyncApi {
         }
 
         const qps: ISyncParams = {
-            filter: filterId,
-            timeout: pollTimeout,
+            "filter": filterId,
+            "timeout": pollTimeout,
+            "unread_thread_notifications": true,
+            "org.matrix.msc3773.unread_thread_notifications": true,
         };
 
         if (this.opts.disablePresence) {
@@ -1299,6 +1303,27 @@ export class SyncApi {
                 }
             }
 
+            const unreadThreadNotifications = joinObj.unread_thread_notifications;
+            if (unreadThreadNotifications) {
+                Object.entries(unreadThreadNotifications).forEach(([threadId, unreadNotification]) => {
+                    room.setThreadUnreadNotificationCount(
+                        threadId,
+                        NotificationCountType.Total,
+                        unreadNotification.notification_count,
+                    );
+
+                    const hasUnreadNotification =
+                        room.getThreadUnreadNotificationCount(threadId, NotificationCountType.Highlight) <= 0;
+                    if (!encrypted || (encrypted && hasUnreadNotification)) {
+                        room.setThreadUnreadNotificationCount(
+                            threadId,
+                            NotificationCountType.Highlight,
+                            unreadNotification.highlight_count,
+                        );
+                    }
+                });
+            }
+
             joinObj.timeline = joinObj.timeline || {} as ITimeline;
 
             if (joinObj.isBrandNewRoom) {