Clark Fischer
431afaafc6
* Add tests for unread notification facilities Add some tests to guarantee some consistency in `useUnreadNotifications` and `RoomNotificationState`. Signed-off-by: Clark Fischer <clark.fischer@gmail.com> * Add RoomNotifs#determineUnreadState Intended as a singular replacement for the divergent implementations before. Signed-off-by: Clark Fischer <clark.fischer@gmail.com> * Unify room unread state determination Have both the class-based facility and the hook use the new unified logic in `RoomNotifs#determineUnreadState`. Addresses https://github.com/vector-im/element-web/issues/24229 Signed-off-by: Clark Fischer <clark.fischer@gmail.com> --------- Signed-off-by: Clark Fischer <clark.fischer@gmail.com> Co-authored-by: Michael Telatynski <7t3chguy@gmail.com>
69 lines
2.4 KiB
TypeScript
69 lines
2.4 KiB
TypeScript
/*
|
|
Copyright 2022 - 2023 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 { RoomEvent } from "matrix-js-sdk/src/models/room";
|
|
import { useCallback, useEffect, useState } from "react";
|
|
|
|
import type { NotificationCount, Room } from "matrix-js-sdk/src/models/room";
|
|
import { determineUnreadState } from "../RoomNotifs";
|
|
import type { NotificationColor } from "../stores/notifications/NotificationColor";
|
|
import { useEventEmitter } from "./useEventEmitter";
|
|
|
|
export const useUnreadNotifications = (
|
|
room: Room,
|
|
threadId?: string,
|
|
): {
|
|
symbol: string | null;
|
|
count: number;
|
|
color: NotificationColor;
|
|
} => {
|
|
const [symbol, setSymbol] = useState<string | null>(null);
|
|
const [count, setCount] = useState<number>(0);
|
|
const [color, setColor] = useState<NotificationColor>(0);
|
|
|
|
useEventEmitter(
|
|
room,
|
|
RoomEvent.UnreadNotifications,
|
|
(unreadNotifications: NotificationCount, evtThreadId?: string) => {
|
|
// Discarding all events not related to the thread if one has been setup
|
|
if (threadId && threadId !== evtThreadId) return;
|
|
updateNotificationState();
|
|
},
|
|
);
|
|
useEventEmitter(room, RoomEvent.Receipt, () => updateNotificationState());
|
|
useEventEmitter(room, RoomEvent.Timeline, () => updateNotificationState());
|
|
useEventEmitter(room, RoomEvent.Redaction, () => updateNotificationState());
|
|
useEventEmitter(room, RoomEvent.LocalEchoUpdated, () => updateNotificationState());
|
|
useEventEmitter(room, RoomEvent.MyMembership, () => updateNotificationState());
|
|
|
|
const updateNotificationState = useCallback(() => {
|
|
const { symbol, count, color } = determineUnreadState(room, threadId);
|
|
setSymbol(symbol);
|
|
setCount(count);
|
|
setColor(color);
|
|
}, [room, threadId]);
|
|
|
|
useEffect(() => {
|
|
updateNotificationState();
|
|
}, [updateNotificationState]);
|
|
|
|
return {
|
|
symbol,
|
|
count,
|
|
color,
|
|
};
|
|
};
|