47380306c2
Previously we were creating a notification state whenever we needed one, which was leading to hundreds of listeners even on a small account. To ease the burden, and reduce the load of having to wake so many listeners, we now record a single listener for each tag ID and room combination. This commit also introduces a number of utilities to make future notification work a bit of an easier transition, such as the `isX` and `hasX` getters on the new NotificationState abstract class. Similarly, "snapshots" have been added to reduce code duplication between different kinds of states checking for updates. The ListNotificationState is now heavily tied into the store which offers it to help reuse the cache of room notification states. Fixes https://github.com/vector-im/riot-web/issues/14370
106 lines
3.7 KiB
TypeScript
106 lines
3.7 KiB
TypeScript
/*
|
|
Copyright 2020 The Matrix.org Foundation C.I.C.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
import { NotificationColor } from "./NotificationColor";
|
|
import { TagID } from "../room-list/models";
|
|
import { Room } from "matrix-js-sdk/src/models/room";
|
|
import { arrayDiff } from "../../utils/arrays";
|
|
import { RoomNotificationState } from "./RoomNotificationState";
|
|
import { NOTIFICATION_STATE_UPDATE, NotificationState } from "./NotificationState";
|
|
|
|
export type FetchRoomFn = (room: Room) => RoomNotificationState;
|
|
|
|
export class ListNotificationState extends NotificationState {
|
|
private rooms: Room[] = [];
|
|
private states: { [roomId: string]: RoomNotificationState } = {};
|
|
|
|
constructor(private byTileCount = false, private tagId: TagID, private getRoomFn: FetchRoomFn) {
|
|
super();
|
|
}
|
|
|
|
public get symbol(): string {
|
|
return null; // This notification state doesn't support symbols
|
|
}
|
|
|
|
public setRooms(rooms: Room[]) {
|
|
// If we're only concerned about the tile count, don't bother setting up listeners.
|
|
if (this.byTileCount) {
|
|
this.rooms = rooms;
|
|
this.calculateTotalState();
|
|
return;
|
|
}
|
|
|
|
const oldRooms = this.rooms;
|
|
const diff = arrayDiff(oldRooms, rooms);
|
|
this.rooms = rooms;
|
|
for (const oldRoom of diff.removed) {
|
|
const state = this.states[oldRoom.roomId];
|
|
if (!state) continue; // We likely just didn't have a badge (race condition)
|
|
delete this.states[oldRoom.roomId];
|
|
state.off(NOTIFICATION_STATE_UPDATE, this.onRoomNotificationStateUpdate);
|
|
}
|
|
for (const newRoom of diff.added) {
|
|
const state = this.getRoomFn(newRoom);
|
|
state.on(NOTIFICATION_STATE_UPDATE, this.onRoomNotificationStateUpdate);
|
|
if (this.states[newRoom.roomId]) {
|
|
// "Should never happen" disclaimer.
|
|
console.warn("Overwriting notification state for room:", newRoom.roomId);
|
|
this.states[newRoom.roomId].destroy();
|
|
}
|
|
this.states[newRoom.roomId] = state;
|
|
}
|
|
|
|
this.calculateTotalState();
|
|
}
|
|
|
|
public getForRoom(room: Room) {
|
|
const state = this.states[room.roomId];
|
|
if (!state) throw new Error("Unknown room for notification state");
|
|
return state;
|
|
}
|
|
|
|
public destroy() {
|
|
super.destroy();
|
|
for (const state of Object.values(this.states)) {
|
|
state.off(NOTIFICATION_STATE_UPDATE, this.onRoomNotificationStateUpdate);
|
|
}
|
|
this.states = {};
|
|
}
|
|
|
|
private onRoomNotificationStateUpdate = () => {
|
|
this.calculateTotalState();
|
|
};
|
|
|
|
private calculateTotalState() {
|
|
const snapshot = this.snapshot();
|
|
|
|
if (this.byTileCount) {
|
|
this._color = NotificationColor.Red;
|
|
this._count = this.rooms.length;
|
|
} else {
|
|
this._count = 0;
|
|
this._color = NotificationColor.None;
|
|
for (const state of Object.values(this.states)) {
|
|
this._count += state.count;
|
|
this._color = Math.max(this.color, state.color);
|
|
}
|
|
}
|
|
|
|
// finally, publish an update if needed
|
|
this.emitIfUpdated(snapshot);
|
|
}
|
|
}
|
|
|