Skip to content
This repository has been archived by the owner on Sep 11, 2024. It is now read-only.

Commit

Permalink
Update member count on room summary update (#11488)
Browse files Browse the repository at this point in the history
* Update member count on room summary update

* Fix performance regression for large rooms

* Update useRoomMemberCount JSDoc

* Improve throttle updates definition

* remove useCallback
  • Loading branch information
Germain committed Aug 31, 2023
1 parent 77a468f commit f948a8f
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 34 deletions.
2 changes: 1 addition & 1 deletion src/hooks/room/useRoomCallStatus.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ export const useRoomCallStatus = (

const hasGroupCall = useCall(room.roomId) !== null;

const memberCount = useRoomMemberCount(room, { includeFunctional: false });
const memberCount = useRoomMemberCount(room);

const [mayEditWidgets, mayCreateElementCalls] = useTypedEventEmitterState(
room,
Expand Down
60 changes: 27 additions & 33 deletions src/hooks/useRoomMembers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,11 @@ See the License for the specific language governing permissions and
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 { throttle } from "lodash";

import { useTypedEventEmitter } from "./useEventEmitter";
import { getJoinedNonFunctionalMembers } from "../utils/room/getJoinedNonFunctionalMembers";

// Hook to simplify watching Matrix Room joined members
export const useRoomMembers = (room: Room, throttleWait = 250): RoomMember[] => {
Expand All @@ -43,43 +42,38 @@ type RoomMemberCountOpts = {
* Wait time between room member count update
*/
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 = (
room: Room,
opts: RoomMemberCountOpts = { throttleWait: 250, includeFunctional: true },
): number => {
/**
* Returns a count of members in a given room
* @param room the room to track.
* @param opts The options.
* @returns the room member count.
*/
export const useRoomMemberCount = (room: Room, opts: RoomMemberCountOpts = { throttleWait: 250 }): number => {
const [count, setCount] = useState<number>(room.getJoinedMemberCount());

const { throttleWait, includeFunctional } = opts;
const { throttleWait } = opts;

useTypedEventEmitter(
room.currentState,
RoomStateEvent.Members,
throttle(
() => {
// At the time where `RoomStateEvent.Members` is emitted the
// 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,
{ leading: true, trailing: true },
),
const throttledUpdate = useMemo(
() =>
throttle(
() => {
setCount(room.getJoinedMemberCount());
},
throttleWait,
{ 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;
};

Expand Down

0 comments on commit f948a8f

Please sign in to comment.