fix automatic DM avatar with functional members

spec/unit/room-state.spec.ts

@@ -21,7 +21,12 @@ import { makeBeaconEvent, makeBeaconInfoEvent } from "../test-utils/beacon";
 import { filterEmitCallsByEventType } from "../test-utils/emitter";
 import { RoomState, RoomStateEvent } from "../../src/models/room-state";
 import { Beacon, BeaconEvent, getBeaconInfoIdentifier } from "../../src/models/beacon";
-import { EventType, RelationType, UNSTABLE_MSC2716_MARKER } from "../../src/@types/event";
+import {
+    EventType,
+    RelationType,
+    UNSTABLE_ELEMENT_FUNCTIONAL_USERS,
+    UNSTABLE_MSC2716_MARKER,
+} from "../../src/@types/event";
 import { MatrixEvent, MatrixEventEvent } from "../../src/models/event";
 import { M_BEACON } from "../../src/@types/beacon";
 import { MatrixClient } from "../../src/client";
@@ -704,6 +709,59 @@ describe("RoomState", function () {
         });
     });
 
+    describe("getJoinedFunctionalMemberCount", function () {
+        beforeEach(() => {
+            state = new RoomState(roomId);
+        });
+
+        it("should update after adding joined functional member", function () {
+            state.setStateEvents([
+                utils.mkMembership({ event: true, mship: "join", user: userA, room: roomId }),
+                utils.mkEvent({
+                    event: true,
+                    type: UNSTABLE_ELEMENT_FUNCTIONAL_USERS.unstable!,
+                    skey: "",
+                    sender: userB,
+                    room: roomId,
+                    content: { service_members: [userA] },
+                }),
+            ]);
+            expect(state.getJoinedMemberCount()).toEqual(1);
+            expect(state.getJoinedFunctionalMemberCount()).toEqual(1);
+            state.setStateEvents([
+                utils.mkMembership({ event: true, mship: "join", user: userC, room: roomId }),
+                utils.mkEvent({
+                    event: true,
+                    type: UNSTABLE_ELEMENT_FUNCTIONAL_USERS.unstable!,
+                    skey: "",
+                    sender: userB,
+                    room: roomId,
+                    content: { service_members: [userA, userC] },
+                }),
+            ]);
+            expect(state.getJoinedMemberCount()).toEqual(2);
+            expect(state.getJoinedFunctionalMemberCount()).toEqual(2);
+        });
+
+        it("should not update after adding joined non-functional member", function () {
+            state.setStateEvents([utils.mkMembership({ event: true, mship: "join", user: userA, room: roomId })]);
+            expect(state.getJoinedMemberCount()).toEqual(1);
+            expect(state.getJoinedFunctionalMemberCount()).toEqual(0);
+            state.setStateEvents([
+                utils.mkEvent({
+                    event: true,
+                    type: UNSTABLE_ELEMENT_FUNCTIONAL_USERS.unstable!,
+                    skey: "",
+                    sender: userB,
+                    room: roomId,
+                    content: { service_members: [userA] },
+                }),
+            ]);
+            expect(state.getJoinedMemberCount()).toEqual(1);
+            expect(state.getJoinedFunctionalMemberCount()).toEqual(1);
+        });
+    });
+
     describe("getInvitedMemberCount", function () {
         beforeEach(() => {
             state = new RoomState(roomId);
@@ -717,6 +775,58 @@ describe("RoomState", function () {
         });
     });
 
+    describe("getInvitedFunctionalMemberCount", function () {
+        beforeEach(() => {
+            state = new RoomState(roomId);
+        });
+        it("should update after adding invited functional member", function () {
+            state.setStateEvents([
+                utils.mkMembership({ event: true, mship: "invite", user: userA, room: roomId }),
+                utils.mkEvent({
+                    event: true,
+                    type: UNSTABLE_ELEMENT_FUNCTIONAL_USERS.unstable!,
+                    skey: "",
+                    sender: userB,
+                    room: roomId,
+                    content: { service_members: [userA] },
+                }),
+            ]);
+            expect(state.getInvitedMemberCount()).toEqual(1);
+            expect(state.getInvitedFunctionalMemberCount()).toEqual(1);
+            state.setStateEvents([
+                utils.mkMembership({ event: true, mship: "invite", user: userC, room: roomId }),
+                utils.mkEvent({
+                    event: true,
+                    type: UNSTABLE_ELEMENT_FUNCTIONAL_USERS.unstable!,
+                    skey: "",
+                    sender: userB,
+                    room: roomId,
+                    content: { service_members: [userA, userC] },
+                }),
+            ]);
+            expect(state.getInvitedMemberCount()).toEqual(2);
+            expect(state.getInvitedFunctionalMemberCount()).toEqual(2);
+        });
+
+        it("should not update after adding invited non-functional member", function () {
+            state.setStateEvents([utils.mkMembership({ event: true, mship: "invite", user: userA, room: roomId })]);
+            expect(state.getInvitedMemberCount()).toEqual(1);
+            expect(state.getInvitedFunctionalMemberCount()).toEqual(0);
+            state.setStateEvents([
+                utils.mkEvent({
+                    event: true,
+                    type: UNSTABLE_ELEMENT_FUNCTIONAL_USERS.unstable!,
+                    skey: "",
+                    sender: userB,
+                    room: roomId,
+                    content: { service_members: [userA] },
+                }),
+            ]);
+            expect(state.getInvitedMemberCount()).toEqual(1);
+            expect(state.getInvitedFunctionalMemberCount()).toEqual(1);
+        });
+    });
+
     describe("setJoinedMemberCount", function () {
         beforeEach(() => {
             state = new RoomState(roomId);

src/models/room-state.ts

@@ -25,6 +25,7 @@ import { TypedEventEmitter } from "./typed-event-emitter";
 import { Beacon, BeaconEvent, BeaconEventHandlerMap, getBeaconInfoIdentifier, BeaconIdentifier } from "./beacon";
 import { TypedReEmitter } from "../ReEmitter";
 import { M_BEACON, M_BEACON_INFO } from "../@types/beacon";
+import { UNSTABLE_ELEMENT_FUNCTIONAL_USERS } from "../@types/event";
 
 export interface IMarkerFoundOptions {
     /** Whether the timeline was empty before the marker event arrived in the
@@ -220,6 +221,16 @@ export class RoomState extends TypedEventEmitter<EmittedEvents, EventHandlerMap>
         this.summaryJoinedMemberCount = count;
     }
 
+    /**
+     * Returns the number of joined functional members in this room
+     * @returns The number of functional members in this room whose membership is 'join'
+     */
+    public getJoinedFunctionalMemberCount(): number {
+        return this.getFunctionalMembers().reduce((count, m) => {
+            return this.getMembers().find((member) => member.userId === m)?.membership === "join" ? count + 1 : count;
+        }, 0);
+    }
+
     /**
      * Returns the number of invited members in this room
      * @returns The number of members in this room whose membership is 'invite'
@@ -236,6 +247,16 @@ export class RoomState extends TypedEventEmitter<EmittedEvents, EventHandlerMap>
         return this.invitedMemberCount;
     }
 
+    /**
+     * Returns the number of invited functional members in this room
+     * @returns The number of functional members in this room whose membership is 'invite'
+     */
+    public getInvitedFunctionalMemberCount(): number {
+        return this.getFunctionalMembers().reduce((count, m) => {
+            return this.getMembers().find((member) => member.userId === m)?.membership === "invite" ? count + 1 : count;
+        }, 0);
+    }
+
     /**
      * Set the amount of invited members in this room
      * @param count - the amount of invited members
@@ -252,6 +273,20 @@ export class RoomState extends TypedEventEmitter<EmittedEvents, EventHandlerMap>
         return Object.values(this.members);
     }
 
+    /**
+     * Get all functional members in this room.
+     * @returns A list of MXID Strings.
+     */
+    public getFunctionalMembers(): String[] {
+        const [functionalUsersStateEvent] = this.getStateEvents(UNSTABLE_ELEMENT_FUNCTIONAL_USERS.name);
+
+        if (Array.isArray(functionalUsersStateEvent?.getContent().service_members)) {
+            return functionalUsersStateEvent.getContent().service_members;
+        }
+
+        return [];
+    }
+
     /**
      * Get all RoomMembers in this room, excluding the user IDs provided.
      * @param excludedIds - The user IDs to exclude.

src/models/room.ts

@@ -915,7 +915,7 @@ export class Room extends ReadReceipt<RoomEmittedEvents, RoomEventHandlerMap> {
     }
 
     public getAvatarFallbackMember(): RoomMember | undefined {
-        const memberCount = this.getInvitedAndJoinedMemberCount();
+        const memberCount = this.getInvitedAndJoinedMemberCount() - this.getInvitedAndJoinedFunctionalMemberCount();
         if (memberCount > 2) {
             return;
         }
@@ -1699,6 +1699,25 @@ export class Room extends ReadReceipt<RoomEmittedEvents, RoomEventHandlerMap> {
         return this.currentState.getInvitedMemberCount();
     }
 
+    /**
+     * Returns the number of joined non-functional members in this room
+     * This method caches the result.
+     * This is a wrapper around the method of the same name in roomState, returning
+     * its result for the room's current state.
+     * @returns The number of non-functional members in this room whose membership is 'join'
+     */
+    public getJoinedFunctionalMemberCount(): number {
+        return this.currentState.getJoinedFunctionalMemberCount();
+    }
+
+    /**
+     * Returns the number of non-functional invited members in this room
+     * @returns The number of non-functional members in this room whose membership is 'invite'
+     */
+    public getInvitedFunctionalMemberCount(): number {
+        return this.currentState.getInvitedFunctionalMemberCount();
+    }
+
     /**
      * Returns the number of invited + joined members in this room
      * @returns The number of members in this room whose membership is 'invite' or 'join'
@@ -1707,6 +1726,14 @@ export class Room extends ReadReceipt<RoomEmittedEvents, RoomEventHandlerMap> {
         return this.getInvitedMemberCount() + this.getJoinedMemberCount();
     }
 
+    /**
+     * Returns the number of invited + joined non-functional members in this room
+     * @returns The number of non-functional members in this room whose membership is 'invite' or 'join'
+     */
+    public getInvitedAndJoinedFunctionalMemberCount(): number {
+        return this.getInvitedFunctionalMemberCount() + this.getJoinedFunctionalMemberCount();
+    }
+
     /**
      * Get a list of members with given membership state.
      * @param membership - The membership state.