Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Expire call member state events after 1 hour #2446

Merged
merged 4 commits into from
Jun 16, 2022
Merged

Expire call member state events after 1 hour #2446

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d7d4c61
Expire call member state events after 1 hour
robintown Jun 8, 2022
792e712
Fix lints
robintown Jun 8, 2022
5b1c3d3
Merge branch 'robertlong/group-call' into expire-member-state
robintown Jun 16, 2022
1dd2a93
Avoid a possible race
robintown Jun 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 72 additions & 46 deletions src/webrtc/groupCall.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import { ISendEventResponse } from "../@types/requests";
import { MatrixEvent } from "../models/event";
import { EventType } from "../@types/event";
import { CallEventHandlerEvent } from "./callEventHandler";
import { RoomStateEvent } from "../matrix";
import { GroupCallEventHandlerEvent } from "./groupCallEventHandler";

export enum GroupCallIntent {
Expand Down Expand Up @@ -109,6 +108,7 @@ export interface IGroupCallRoomMemberCallState {

export interface IGroupCallRoomMemberState {
"m.calls": IGroupCallRoomMemberCallState[];
"m.expires_ts": number;
}

export enum GroupCallState {
Expand All @@ -127,6 +127,16 @@ interface ICallHandlers {
onCallReplaced: (newCall: MatrixCall) => void;
}

const CALL_MEMBER_STATE_TIMEOUT = 1000 * 60 * 60; // 1 hour

const callMemberStateIsExpired = (event: MatrixEvent): boolean => {
const now = Date.now();
const content = event?.getContent<IGroupCallRoomMemberState>() ?? {};
const expiresAt = typeof content["m.expires_ts"] === "number" ? content["m.expires_ts"] : -Infinity;
// The event is expired if the expiration date has passed, or if it's unreasonably far in the future
return expiresAt <= now || expiresAt > now + CALL_MEMBER_STATE_TIMEOUT * 5 / 4;
};

function getCallUserId(call: MatrixCall): string | null {
return call.getOpponentMember()?.userId || call.invitee || null;
}
Expand Down Expand Up @@ -155,6 +165,8 @@ export class GroupCall extends TypedEventEmitter<GroupCallEvent, GroupCallEventH
private retryCallCounts: Map<string, number> = new Map();
private reEmitter: ReEmitter;
private transmitTimer: ReturnType<typeof setTimeout> | null = null;
private memberStateExpirationTimers: Map<string, ReturnType<typeof setTimeout>> = new Map();
private resendMemberStateTimer: ReturnType<typeof setTimeout> | null = null;

constructor(
private client: MatrixClient,
Expand All @@ -170,10 +182,7 @@ export class GroupCall extends TypedEventEmitter<GroupCallEvent, GroupCallEventH
this.reEmitter = new ReEmitter(this);
this.groupCallId = groupCallId || genCallID();

const roomState = this.room.currentState;
const memberStateEvents = roomState.getStateEvents(EventType.GroupCallMemberPrefix);

for (const stateEvent of memberStateEvents) {
for (const stateEvent of this.getMemberStateEvents()) {
this.onMemberStateChanged(stateEvent);
}
}
Expand Down Expand Up @@ -306,10 +315,7 @@ export class GroupCall extends TypedEventEmitter<GroupCallEvent, GroupCallEventH

// Set up participants for the members currently in the room.
// Other members will be picked up by the RoomState.members event.
const roomState = this.room.currentState;
const memberStateEvents = roomState.getStateEvents(EventType.GroupCallMemberPrefix);

for (const stateEvent of memberStateEvents) {
for (const stateEvent of this.getMemberStateEvents()) {
this.onMemberStateChanged(stateEvent);
}

Expand Down Expand Up @@ -378,11 +384,6 @@ export class GroupCall extends TypedEventEmitter<GroupCallEvent, GroupCallEventH
}

this.participants = [];
this.client.removeListener(
RoomStateEvent.Members,
this.onMemberStateChanged,
);

this.client.groupCallEventHandler.groupCalls.delete(this.room.roomId);

if (emitStateEvent) {
Expand Down Expand Up @@ -628,14 +629,24 @@ export class GroupCall extends TypedEventEmitter<GroupCallEvent, GroupCallEventH
* Room Member State
*/

private sendMemberStateEvent(): Promise<ISendEventResponse> {
const deviceId = this.client.getDeviceId();
private getMemberStateEvents(): MatrixEvent[];
private getMemberStateEvents(userId: string): MatrixEvent | null;
private getMemberStateEvents(userId?: string): MatrixEvent[] | MatrixEvent | null {
if (userId != null) {
robintown marked this conversation as resolved.
Show resolved Hide resolved
const event = this.room.currentState.getStateEvents(EventType.GroupCallMemberPrefix, userId);
return callMemberStateIsExpired(event) ? null : event;
} else {
return this.room.currentState.getStateEvents(EventType.GroupCallMemberPrefix)
.filter(event => !callMemberStateIsExpired(event));
}
}

return this.updateMemberCallState({
private async sendMemberStateEvent(): Promise<ISendEventResponse> {
const send = () => this.updateMemberCallState({
"m.call_id": this.groupCallId,
"m.devices": [
{
"device_id": deviceId,
"device_id": this.client.getDeviceId(),
"session_id": this.client.getSessionId(),
"feeds": this.getLocalFeeds().map((feed) => ({
purpose: feed.purpose,
Expand All @@ -645,23 +656,35 @@ export class GroupCall extends TypedEventEmitter<GroupCallEvent, GroupCallEventH
],
// TODO "m.foci"
});

const res = await send();

// Resend the state event every so often so it doesn't become stale
this.resendMemberStateTimer = setInterval(async () => {
logger.log("Resending call member state");
await send();
}, CALL_MEMBER_STATE_TIMEOUT * 3 / 4);

return res;
}

private removeMemberStateEvent(): Promise<ISendEventResponse> {
return this.updateMemberCallState(undefined);
private async removeMemberStateEvent(): Promise<ISendEventResponse> {
const res = await this.updateMemberCallState(undefined);
clearInterval(this.resendMemberStateTimer);
this.resendMemberStateTimer = null;
return res;
robintown marked this conversation as resolved.
Show resolved Hide resolved
}

private async updateMemberCallState(memberCallState?: IGroupCallRoomMemberCallState): Promise<ISendEventResponse> {
const localUserId = this.client.getUserId();

const currentStateEvent = this.room.currentState.getStateEvents(EventType.GroupCallMemberPrefix, localUserId);
const memberStateEvent = currentStateEvent?.getContent<IGroupCallRoomMemberState>();
const memberState = this.getMemberStateEvents(localUserId)?.getContent<IGroupCallRoomMemberState>();

let calls: IGroupCallRoomMemberCallState[] = [];

// Sanitize existing member state event
if (memberStateEvent && Array.isArray(memberStateEvent["m.calls"])) {
calls = memberStateEvent["m.calls"].filter((call) => !!call);
if (memberState && Array.isArray(memberState["m.calls"])) {
calls = memberState["m.calls"].filter((call) => !!call);
}

const existingCallIndex = calls.findIndex((call) => call && call["m.call_id"] === this.groupCallId);
Expand All @@ -678,54 +701,60 @@ export class GroupCall extends TypedEventEmitter<GroupCallEvent, GroupCallEventH

const content = {
"m.calls": calls,
"m.expires_ts": Date.now() + CALL_MEMBER_STATE_TIMEOUT,
};

return this.client.sendStateEvent(this.room.roomId, EventType.GroupCallMemberPrefix, content, localUserId);
}

public onMemberStateChanged = async (event: MatrixEvent) => {
// The member events may be received for another room, which we will ignore.
if (event.getRoomId() !== this.room.roomId) {
return;
}
if (event.getRoomId() !== this.room.roomId) return;

const member = this.room.getMember(event.getStateKey());
if (!member) return;

if (!member) {
return;
}

let callsState = event.getContent<IGroupCallRoomMemberState>()["m.calls"];
const ignore = () => {
this.removeParticipant(member);
clearTimeout(this.memberStateExpirationTimers.get(member.userId));
this.memberStateExpirationTimers.delete(member.userId);
};
SimonBrandner marked this conversation as resolved.
Show resolved Hide resolved

if (Array.isArray(callsState)) {
callsState = callsState.filter((call) => !!call);
}
const content = event.getContent<IGroupCallRoomMemberState>();
const callsState = !callMemberStateIsExpired(event) && Array.isArray(content["m.calls"])
? content["m.calls"].filter((call) => call)
: []; // Ignore expired device data

if (!Array.isArray(callsState) || callsState.length === 0) {
logger.warn(`Ignoring member state from ${member.userId} member not in any calls.`);
this.removeParticipant(member);
if (callsState.length === 0) {
logger.log(`Ignoring member state from ${member.userId} member not in any calls.`);
ignore();
return;
}

// Currently we only support a single call per room. So grab the first call.
const callState = callsState[0];

const callId = callState["m.call_id"];

if (!callId) {
logger.warn(`Room member ${member.userId} does not have a valid m.call_id set. Ignoring.`);
this.removeParticipant(member);
ignore();
return;
}

if (callId !== this.groupCallId) {
logger.warn(`Call id ${callId} does not match group call id ${this.groupCallId}, ignoring.`);
this.removeParticipant(member);
ignore();
return;
}

this.addParticipant(member);

clearTimeout(this.memberStateExpirationTimers.get(member.userId));
this.memberStateExpirationTimers.set(member.userId, setTimeout(() => {
logger.warn(`Call member state for ${member.userId} has expired`);
this.removeParticipant(member);
}, content["m.expires_ts"] - Date.now()));

// Don't process your own member.
const localUserId = this.client.getUserId();

Expand Down Expand Up @@ -813,7 +842,7 @@ export class GroupCall extends TypedEventEmitter<GroupCallEvent, GroupCallEventH
};

public getDeviceForMember(userId: string): IGroupCallRoomMemberDevice {
const memberStateEvent = this.room.currentState.getStateEvents(EventType.GroupCallMemberPrefix, userId);
const memberStateEvent = this.getMemberStateEvents(userId);

if (!memberStateEvent) {
return undefined;
Expand All @@ -838,10 +867,7 @@ export class GroupCall extends TypedEventEmitter<GroupCallEvent, GroupCallEventH
}

private onRetryCallLoop = () => {
const roomState = this.room.currentState;
const memberStateEvents = roomState.getStateEvents(EventType.GroupCallMemberPrefix);

for (const event of memberStateEvents) {
for (const event of this.getMemberStateEvents()) {
const memberId = event.getStateKey();
const existingCall = this.calls.find((call) => getCallUserId(call) === memberId);
const retryCallCount = this.retryCallCounts.get(memberId) || 0;
Expand Down