reemit beacon events (#2245)

* reemit beacon events

Signed-off-by: Kerry Archibald <[email protected]>

* use specific imports

Signed-off-by: Kerry Archibald <[email protected]>

* Update src/models/room-state.ts

Co-authored-by: Travis Ralston <[email protected]>

Co-authored-by: Travis Ralston <[email protected]>

Author: Kerry

spec/unit/room-state.spec.js

@@ -2,6 +2,7 @@ import * as utils from "../test-utils/test-utils";
 import { makeBeaconInfoEvent } from "../test-utils/beacon";
 import { filterEmitCallsByEventType } from "../test-utils/emitter";
 import { RoomState, RoomStateEvent } from "../../src/models/room-state";
+import { BeaconEvent } from "../../src/models/beacon";
 
 describe("RoomState", function() {
     const roomId = "!foo:bar";
@@ -251,13 +252,16 @@ describe("RoomState", function() {
             );
         });
 
-        it('adds new beacon info events to state', () => {
+        it('adds new beacon info events to state and emits', () => {
             const beaconEvent = makeBeaconInfoEvent(userA, roomId);
+            const emitSpy = jest.spyOn(state, 'emit');
 
             state.setStateEvents([beaconEvent]);
 
             expect(state.beacons.size).toEqual(1);
-            expect(state.beacons.get(beaconEvent.getId())).toBeTruthy();
+            const beaconInstance = state.beacons.get(beaconEvent.getId());
+            expect(beaconInstance).toBeTruthy();
+            expect(emitSpy).toHaveBeenCalledWith(BeaconEvent.New, beaconEvent, beaconInstance);
         });
 
         it('updates existing beacon info events in state', () => {

src/models/beacon.ts

@@ -26,7 +26,6 @@ export enum BeaconEvent {
 }
 
 export type BeaconEventHandlerMap = {
-    [BeaconEvent.New]: (event: MatrixEvent, beacon: Beacon) => void;
     [BeaconEvent.Update]: (event: MatrixEvent, beacon: Beacon) => void;
     [BeaconEvent.LivenessChange]: (isLive: boolean, beacon: Beacon) => void;
 };
@@ -42,7 +41,7 @@ export const isBeaconInfoEventType = (type: string) =>
     type.startsWith(M_BEACON_INFO.altName);
 
 // https://github.com/matrix-org/matrix-spec-proposals/pull/3489
-export class Beacon extends TypedEventEmitter<BeaconEvent, BeaconEventHandlerMap> {
+export class Beacon extends TypedEventEmitter<Exclude<BeaconEvent, BeaconEvent.New>, BeaconEventHandlerMap> {
     public readonly roomId: string;
     private _beaconInfo: BeaconInfoState;
     private _isLive: boolean;
@@ -54,7 +53,6 @@ export class Beacon extends TypedEventEmitter<BeaconEvent, BeaconEventHandlerMap
         super();
         this.setBeaconInfo(this.rootEvent);
         this.roomId = this.rootEvent.getRoomId();
-        this.emit(BeaconEvent.New, this.rootEvent, this);
     }
 
     public get isLive(): boolean {

src/models/room-state.ts

@@ -26,7 +26,8 @@ import { MatrixEvent } from "./event";
 import { MatrixClient } from "../client";
 import { GuestAccess, HistoryVisibility, IJoinRuleEventContent, JoinRule } from "../@types/partials";
 import { TypedEventEmitter } from "./typed-event-emitter";
-import { Beacon, BeaconEvent, isBeaconInfoEventType } from "./beacon";
+import { Beacon, BeaconEvent, isBeaconInfoEventType, BeaconEventHandlerMap } from "./beacon";
+import { TypedReEmitter } from "../ReEmitter";
 
 // possible statuses for out-of-band member loading
 enum OobStatus {
@@ -49,9 +50,14 @@ export type RoomStateEventHandlerMap = {
     [RoomStateEvent.NewMember]: (event: MatrixEvent, state: RoomState, member: RoomMember) => void;
     [RoomStateEvent.Update]: (state: RoomState) => void;
     [RoomStateEvent.BeaconLiveness]: (state: RoomState, hasLiveBeacons: boolean) => void;
+    [BeaconEvent.New]: (event: MatrixEvent, beacon: Beacon) => void;
 };
 
-export class RoomState extends TypedEventEmitter<RoomStateEvent, RoomStateEventHandlerMap> {
+type EmittedEvents = RoomStateEvent | BeaconEvent;
+type EventHandlerMap = RoomStateEventHandlerMap & BeaconEventHandlerMap;
+
+export class RoomState extends TypedEventEmitter<EmittedEvents, EventHandlerMap> {
+    public readonly reEmitter = new TypedReEmitter<EmittedEvents, EventHandlerMap>(this);
     private sentinels: Record<string, RoomMember> = {}; // userId: RoomMember
     // stores fuzzy matches to a list of userIDs (applies utils.removeHiddenChars to keys)
     private displayNameToUserIds: Record<string, string[]> = {};
@@ -436,6 +442,14 @@ export class RoomState extends TypedEventEmitter<RoomStateEvent, RoomStateEventH
         }
 
         const beacon = new Beacon(event);
+
+        this.reEmitter.reEmit<BeaconEvent, BeaconEvent>(beacon, [
+            BeaconEvent.New,
+            BeaconEvent.Update,
+            BeaconEvent.LivenessChange,
+        ]);
+
+        this.emit(BeaconEvent.New, event, beacon);
         beacon.on(BeaconEvent.LivenessChange, this.onBeaconLivenessChange.bind(this));
         this.beacons.set(beacon.beaconInfoId, beacon);
     }

src/sync.ts

@@ -55,6 +55,7 @@ import { EventType } from "./@types/event";
 import { IPushRules } from "./@types/PushRules";
 import { RoomStateEvent } from "./models/room-state";
 import { RoomMemberEvent } from "./models/room-member";
+import { BeaconEvent } from "./models/beacon";
 
 const DEBUG = true;
 
@@ -241,7 +242,11 @@ export class SyncApi {
             RoomStateEvent.Members,
             RoomStateEvent.NewMember,
             RoomStateEvent.Update,
+            BeaconEvent.New,
+            BeaconEvent.Update,
+            BeaconEvent.LivenessChange,
         ]);
+
         room.currentState.on(RoomStateEvent.NewMember, function(event, state, member) {
             member.user = client.getUser(member.userId);
             client.reEmitter.reEmit(member, [