Update member count on room summary update (#11488)
* Update member count on room summary update * Fix performance regression for large rooms * Update useRoomMemberCount JSDoc * Improve throttle updates definition * remove useCallback
This commit is contained in:
parent
77a468f8e8
commit
f948a8f798
2 changed files with 28 additions and 34 deletions
|
@ -67,7 +67,7 @@ export const useRoomCallStatus = (
|
||||||
|
|
||||||
const hasGroupCall = useCall(room.roomId) !== null;
|
const hasGroupCall = useCall(room.roomId) !== null;
|
||||||
|
|
||||||
const memberCount = useRoomMemberCount(room, { includeFunctional: false });
|
const memberCount = useRoomMemberCount(room);
|
||||||
|
|
||||||
const [mayEditWidgets, mayCreateElementCalls] = useTypedEventEmitterState(
|
const [mayEditWidgets, mayCreateElementCalls] = useTypedEventEmitterState(
|
||||||
room,
|
room,
|
||||||
|
|
|
@ -14,12 +14,11 @@ See the License for the specific language governing permissions and
|
||||||
limitations under the License.
|
limitations under the License.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
import { useState } from "react";
|
import { useMemo, useState } from "react";
|
||||||
import { Room, RoomEvent, RoomMember, RoomStateEvent } from "matrix-js-sdk/src/matrix";
|
import { Room, RoomEvent, RoomMember, RoomStateEvent } from "matrix-js-sdk/src/matrix";
|
||||||
import { throttle } from "lodash";
|
import { throttle } from "lodash";
|
||||||
|
|
||||||
import { useTypedEventEmitter } from "./useEventEmitter";
|
import { useTypedEventEmitter } from "./useEventEmitter";
|
||||||
import { getJoinedNonFunctionalMembers } from "../utils/room/getJoinedNonFunctionalMembers";
|
|
||||||
|
|
||||||
// Hook to simplify watching Matrix Room joined members
|
// Hook to simplify watching Matrix Room joined members
|
||||||
export const useRoomMembers = (room: Room, throttleWait = 250): RoomMember[] => {
|
export const useRoomMembers = (room: Room, throttleWait = 250): RoomMember[] => {
|
||||||
|
@ -43,43 +42,38 @@ type RoomMemberCountOpts = {
|
||||||
* Wait time between room member count update
|
* Wait time between room member count update
|
||||||
*/
|
*/
|
||||||
throttleWait?: number;
|
throttleWait?: number;
|
||||||
/**
|
|
||||||
* Whether to include functional members (bots, etc...) in the room count
|
|
||||||
* @default true
|
|
||||||
*/
|
|
||||||
includeFunctional: boolean;
|
|
||||||
};
|
};
|
||||||
|
|
||||||
// Hook to simplify watching Matrix Room joined member count
|
/**
|
||||||
export const useRoomMemberCount = (
|
* Returns a count of members in a given room
|
||||||
room: Room,
|
* @param room the room to track.
|
||||||
opts: RoomMemberCountOpts = { throttleWait: 250, includeFunctional: true },
|
* @param opts The options.
|
||||||
): number => {
|
* @returns the room member count.
|
||||||
|
*/
|
||||||
|
export const useRoomMemberCount = (room: Room, opts: RoomMemberCountOpts = { throttleWait: 250 }): number => {
|
||||||
const [count, setCount] = useState<number>(room.getJoinedMemberCount());
|
const [count, setCount] = useState<number>(room.getJoinedMemberCount());
|
||||||
|
|
||||||
const { throttleWait, includeFunctional } = opts;
|
const { throttleWait } = opts;
|
||||||
|
|
||||||
useTypedEventEmitter(
|
const throttledUpdate = useMemo(
|
||||||
room.currentState,
|
() =>
|
||||||
RoomStateEvent.Members,
|
|
||||||
throttle(
|
throttle(
|
||||||
() => {
|
() => {
|
||||||
// At the time where `RoomStateEvent.Members` is emitted the
|
setCount(room.getJoinedMemberCount());
|
||||||
// summary API has not had a chance to update the `summaryJoinedMemberCount`
|
|
||||||
// value, therefore handling the logic locally here.
|
|
||||||
//
|
|
||||||
// Tracked as part of https://github.com/vector-im/element-web/issues/26033
|
|
||||||
const membersCount = includeFunctional
|
|
||||||
? room.getMembers().reduce((count, m) => {
|
|
||||||
return m.membership === "join" ? count + 1 : count;
|
|
||||||
}, 0)
|
|
||||||
: getJoinedNonFunctionalMembers(room).length;
|
|
||||||
setCount(membersCount);
|
|
||||||
},
|
},
|
||||||
throttleWait,
|
throttleWait,
|
||||||
{ leading: true, trailing: true },
|
{ leading: true, trailing: true },
|
||||||
),
|
),
|
||||||
|
[room, throttleWait],
|
||||||
);
|
);
|
||||||
|
|
||||||
|
useTypedEventEmitter(room.currentState, RoomStateEvent.Members, throttledUpdate);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* `room.getJoinedMemberCount()` caches the member count behind the room summary
|
||||||
|
* So we need to re-compute the member count when the summary gets updated
|
||||||
|
*/
|
||||||
|
useTypedEventEmitter(room, RoomEvent.Summary, throttledUpdate);
|
||||||
return count;
|
return count;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue