1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
/*
Copyright 2022 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 { MBeaconEventContent } from "../@types/beacon";
import { BeaconInfoState, BeaconLocationState, parseBeaconContent, parseBeaconInfoContent } from "../content-helpers";
import { MatrixEvent } from "./event";
import { sortEventsByLatestContentTimestamp } from "../utils";
import { TypedEventEmitter } from "./typed-event-emitter";
export enum BeaconEvent {
New = "Beacon.new",
Update = "Beacon.update",
LivenessChange = "Beacon.LivenessChange",
Destroy = "Beacon.Destroy",
LocationUpdate = "Beacon.LocationUpdate",
}
export type BeaconEventHandlerMap = {
[BeaconEvent.Update]: (event: MatrixEvent, beacon: Beacon) => void;
[BeaconEvent.LivenessChange]: (isLive: boolean, beacon: Beacon) => void;
[BeaconEvent.Destroy]: (beaconIdentifier: string) => void;
[BeaconEvent.LocationUpdate]: (locationState: BeaconLocationState) => void;
[BeaconEvent.Destroy]: (beaconIdentifier: string) => void;
};
export const isTimestampInDuration = (startTimestamp: number, durationMs: number, timestamp: number): boolean =>
timestamp >= startTimestamp && startTimestamp + durationMs >= timestamp;
// beacon info events are uniquely identified by
// `<roomId>_<state_key>`
export type BeaconIdentifier = string;
export const getBeaconInfoIdentifier = (event: MatrixEvent): BeaconIdentifier =>
`${event.getRoomId()}_${event.getStateKey()}`;
// https://github.com/matrix-org/matrix-spec-proposals/pull/3672
export class Beacon extends TypedEventEmitter<Exclude<BeaconEvent, BeaconEvent.New>, BeaconEventHandlerMap> {
public readonly roomId: string;
// beaconInfo is assigned by setBeaconInfo in the constructor
// ! to make tsc believe it is definitely assigned
private _beaconInfo!: BeaconInfoState;
private _isLive?: boolean;
private livenessWatchTimeout?: ReturnType<typeof setTimeout>;
private _latestLocationEvent?: MatrixEvent;
public constructor(private rootEvent: MatrixEvent) {
super();
this.roomId = this.rootEvent.getRoomId()!;
this.setBeaconInfo(this.rootEvent);
}
public get isLive(): boolean {
return !!this._isLive;
}
public get identifier(): BeaconIdentifier {
return getBeaconInfoIdentifier(this.rootEvent);
}
public get beaconInfoId(): string {
return this.rootEvent.getId()!;
}
public get beaconInfoOwner(): string {
return this.rootEvent.getStateKey()!;
}
public get beaconInfoEventType(): string {
return this.rootEvent.getType();
}
public get beaconInfo(): BeaconInfoState {
return this._beaconInfo;
}
public get latestLocationState(): BeaconLocationState | undefined {
return this._latestLocationEvent && parseBeaconContent(this._latestLocationEvent.getContent());
}
public get latestLocationEvent(): MatrixEvent | undefined {
return this._latestLocationEvent;
}
public update(beaconInfoEvent: MatrixEvent): void {
if (getBeaconInfoIdentifier(beaconInfoEvent) !== this.identifier) {
throw new Error("Invalid updating event");
}
// don't update beacon with an older event
if (beaconInfoEvent.getTs() < this.rootEvent.getTs()) {
return;
}
this.rootEvent = beaconInfoEvent;
this.setBeaconInfo(this.rootEvent);
this.emit(BeaconEvent.Update, beaconInfoEvent, this);
this.clearLatestLocation();
}
public destroy(): void {
if (this.livenessWatchTimeout) {
clearTimeout(this.livenessWatchTimeout);
}
this._isLive = false;
this.emit(BeaconEvent.Destroy, this.identifier);
}
/**
* Monitor liveness of a beacon
* Emits BeaconEvent.LivenessChange when beacon expires
*/
public monitorLiveness(): void {
if (this.livenessWatchTimeout) {
clearTimeout(this.livenessWatchTimeout);
}
this.checkLiveness();
if (!this.beaconInfo) return;
if (this.isLive) {
const expiryInMs = this.beaconInfo.timestamp! + this.beaconInfo.timeout - Date.now();
if (expiryInMs > 1) {
this.livenessWatchTimeout = setTimeout(() => {
this.monitorLiveness();
}, expiryInMs);
}
} else if (this.beaconInfo.timestamp! > Date.now()) {
// beacon start timestamp is in the future
// check liveness again then
this.livenessWatchTimeout = setTimeout(() => {
this.monitorLiveness();
}, this.beaconInfo.timestamp! - Date.now());
}
}
/**
* Process Beacon locations
* Emits BeaconEvent.LocationUpdate
*/
public addLocations(beaconLocationEvents: MatrixEvent[]): void {
// discard locations for beacons that are not live
if (!this.isLive) {
return;
}
const validLocationEvents = beaconLocationEvents.filter((event) => {
const content = event.getContent<MBeaconEventContent>();
const parsed = parseBeaconContent(content);
if (!parsed.uri || !parsed.timestamp) return false; // we won't be able to process these
const { timestamp } = parsed;
return (
this._beaconInfo.timestamp &&
// only include positions that were taken inside the beacon's live period
isTimestampInDuration(this._beaconInfo.timestamp, this._beaconInfo.timeout, timestamp) &&
// ignore positions older than our current latest location
(!this.latestLocationState || timestamp > this.latestLocationState.timestamp!)
);
});
const latestLocationEvent = validLocationEvents.sort(sortEventsByLatestContentTimestamp)?.[0];
if (latestLocationEvent) {
this._latestLocationEvent = latestLocationEvent;
this.emit(BeaconEvent.LocationUpdate, this.latestLocationState!);
}
}
private clearLatestLocation = (): void => {
this._latestLocationEvent = undefined;
this.emit(BeaconEvent.LocationUpdate, this.latestLocationState!);
};
private setBeaconInfo(event: MatrixEvent): void {
this._beaconInfo = parseBeaconInfoContent(event.getContent());
this.checkLiveness();
}
private checkLiveness(): void {
const prevLiveness = this.isLive;
// element web sets a beacon's start timestamp to the senders local current time
// when Alice's system clock deviates slightly from Bob's a beacon Alice intended to be live
// may have a start timestamp in the future from Bob's POV
// handle this by adding 6min of leniency to the start timestamp when it is in the future
if (!this.beaconInfo) return;
const startTimestamp =
this.beaconInfo.timestamp! > Date.now()
? this.beaconInfo.timestamp! - 360000 /* 6min */
: this.beaconInfo.timestamp;
this._isLive =
!!this._beaconInfo.live &&
!!startTimestamp &&
isTimestampInDuration(startTimestamp, this._beaconInfo.timeout, Date.now());
if (prevLiveness !== this.isLive) {
this.emit(BeaconEvent.LivenessChange, this.isLive, this);
}
}
}
|
