Merge pull request #2815 from robintown/keepalive-leave

Let leave requests outlive the window

Author: robintown

spec/unit/webrtc/groupCall.spec.ts

@@ -212,12 +212,32 @@ describe('Group Call', function() {
                         ],
                     }),
                     FAKE_USER_ID_1,
+                    { keepAlive: false },
                 );
             } finally {
                 groupCall.leave();
             }
         });
 
+        it("sends member state event to room on leave", async () => {
+            room.currentState.members[FAKE_USER_ID_1] = {
+                userId: FAKE_USER_ID_1,
+            } as unknown as RoomMember;
+
+            await groupCall.create();
+            await groupCall.enter();
+            mockSendState.mockClear();
+
+            groupCall.leave();
+            expect(mockSendState).toHaveBeenCalledWith(
+                FAKE_ROOM_ID,
+                EventType.GroupCallMemberPrefix,
+                expect.objectContaining({ "m.calls": [] }),
+                FAKE_USER_ID_1,
+                { keepAlive: true }, // Request should outlive the window
+            );
+        });
+
         it("starts with mic unmuted in regular calls", async () => {
             try {
                 await groupCall.create();

src/client.ts

@@ -65,6 +65,7 @@ import {
     FileType,
     UploadResponse,
     HTTPError,
+    IRequestOpts,
 } from "./http-api";
 import {
     Crypto,
@@ -7517,6 +7518,7 @@ export class MatrixClient extends TypedEventEmitter<EmittedEvents, ClientEventHa
      * @param {string} eventType
      * @param {Object} content
      * @param {string} stateKey
+     * @param {IRequestOpts} opts Options for the request function.
      * @return {Promise} Resolves: TODO
      * @return {module:http-api.MatrixError} Rejects: with an error response.
      */
@@ -7525,6 +7527,7 @@ export class MatrixClient extends TypedEventEmitter<EmittedEvents, ClientEventHa
         eventType: string,
         content: any,
         stateKey = "",
+        opts: IRequestOpts = {},
     ): Promise<ISendEventResponse> {
         const pathParams = {
             $roomId: roomId,
@@ -7535,7 +7538,7 @@ export class MatrixClient extends TypedEventEmitter<EmittedEvents, ClientEventHa
         if (stateKey !== undefined) {
             path = utils.encodeUri(path + "/$stateKey", pathParams);
         }
-        return this.http.authedRequest(Method.Put, path, undefined, content);
+        return this.http.authedRequest(Method.Put, path, undefined, content, opts);
     }
 
     /**

src/http-api/fetch.ts

@@ -234,7 +234,7 @@ export class FetchHttpApi<O extends IHttpOpts> {
         method: Method,
         url: URL | string,
         body?: Body,
-        opts: Pick<IRequestOpts, "headers" | "json" | "localTimeoutMs" | "abortSignal"> = {},
+        opts: Pick<IRequestOpts, "headers" | "json" | "localTimeoutMs" | "keepAlive" | "abortSignal"> = {},
     ): Promise<ResponseType<T, O>> {
         const headers = Object.assign({}, opts.headers || {});
         const json = opts.json ?? true;
@@ -252,6 +252,7 @@ export class FetchHttpApi<O extends IHttpOpts> {
         }
 
         const timeout = opts.localTimeoutMs ?? this.opts.localTimeoutMs;
+        const keepAlive = opts.keepAlive ?? false;
         const signals = [
             this.abortController.signal,
         ];
@@ -284,6 +285,7 @@ export class FetchHttpApi<O extends IHttpOpts> {
                 referrerPolicy: "no-referrer",
                 cache: "no-cache",
                 credentials: "omit", // we send credentials via headers
+                keepalive: keepAlive,
             });
         } catch (e) {
             if ((<Error>e).name === "AbortError") {

src/http-api/interface.ts

@@ -38,6 +38,7 @@ export interface IRequestOpts {
     headers?: Record<string, string>;
     abortSignal?: AbortSignal;
     localTimeoutMs?: number;
+    keepAlive?: boolean; // defaults to false
     json?: boolean; // defaults to true
 
     // Set to true to prevent the request function from emitting a Session.logged_out event.

src/webrtc/groupCall.ts

@@ -726,10 +726,13 @@ export class GroupCall extends TypedEventEmitter<
     private async removeMemberStateEvent(): Promise<ISendEventResponse> {
         if (this.resendMemberStateTimer !== null) clearInterval(this.resendMemberStateTimer);
         this.resendMemberStateTimer = null;
-        return await this.updateMemberCallState(undefined);
+        return await this.updateMemberCallState(undefined, true);
     }
 
-    private async updateMemberCallState(memberCallState?: IGroupCallRoomMemberCallState): Promise<ISendEventResponse> {
+    private async updateMemberCallState(
+        memberCallState?: IGroupCallRoomMemberCallState,
+        keepAlive = false,
+    ): Promise<ISendEventResponse> {
         const localUserId = this.client.getUserId()!;
 
         const memberState = this.getMemberStateEvents(localUserId)?.getContent<IGroupCallRoomMemberState>();
@@ -758,7 +761,9 @@ export class GroupCall extends TypedEventEmitter<
             "m.expires_ts": Date.now() + CALL_MEMBER_STATE_TIMEOUT,
         };
 
-        return this.client.sendStateEvent(this.room.roomId, EventType.GroupCallMemberPrefix, content, localUserId);
+        return this.client.sendStateEvent(
+            this.room.roomId, EventType.GroupCallMemberPrefix, content, localUserId, { keepAlive },
+        );
     }
 
     public onMemberStateChanged = async (event: MatrixEvent) => {