matrix-js-sdk/spec/unit/webrtc/stats/groupCallStats.spec.ts

/*
Copyright 2023 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 { GroupCallStats } from "../../../../src/webrtc/stats/groupCallStats";
import { type CallStatsReportSummary } from "../../../../src/webrtc/stats/callStatsReportSummary";

const GROUP_CALL_ID = "GROUP_ID";
const LOCAL_USER_ID = "LOCAL_USER_ID";
const TIME_INTERVAL = 10000;

describe("GroupCallStats", () => {
    let stats: GroupCallStats;
    beforeEach(() => {
        stats = new GroupCallStats(GROUP_CALL_ID, LOCAL_USER_ID, TIME_INTERVAL);
    });

    describe("should on adding a stats collector", () => {
        it("creating a new one if not existing.", async () => {
            expect(stats.addStatsReportGatherer("CALL_ID", "USER_ID", mockRTCPeerConnection())).toBeTruthy();
        });

        it("creating only one when trying add the same collector multiple times.", async () => {
            expect(stats.addStatsReportGatherer("CALL_ID", "USER_ID", mockRTCPeerConnection())).toBeTruthy();
            expect(stats.addStatsReportGatherer("CALL_ID", "USER_ID", mockRTCPeerConnection())).toBeFalsy();
            // The User ID is not relevant! Because for stats the call is needed and the user id is for monitoring
            expect(stats.addStatsReportGatherer("CALL_ID", "SOME_OTHER_USER_ID", mockRTCPeerConnection())).toBeFalsy();
        });
    });

    describe("should on removing a stats collector", () => {
        it("returning `true` if the collector exists", async () => {
            expect(stats.addStatsReportGatherer("CALL_ID", "USER_ID", mockRTCPeerConnection())).toBeTruthy();
            expect(stats.removeStatsReportGatherer("CALL_ID")).toBeTruthy();
        });
        it("returning false if the collector not exists", async () => {
            expect(stats.removeStatsReportGatherer("CALL_ID_NOT_EXIST")).toBeFalsy();
        });
    });

    describe("should on get stats collector", () => {
        it("returning `undefined` if collector not existing", async () => {
            expect(stats.getStatsReportGatherer("CALL_ID")).toBeUndefined();
        });

        it("returning Collector if collector existing", async () => {
            expect(stats.addStatsReportGatherer("CALL_ID", "USER_ID", mockRTCPeerConnection())).toBeTruthy();
            expect(stats.getStatsReportGatherer("CALL_ID")).toBeDefined();
        });
    });

    describe("should on start", () => {
        beforeEach(() => {
            vi.useFakeTimers();
        });
        afterEach(() => {
            vi.useRealTimers();
        });

        it("starting processing stats as well without stats collectors", async () => {
            // @ts-ignore
            stats.processStats = vi.fn();
            stats.start();
            vi.advanceTimersByTime(TIME_INTERVAL);
            // @ts-ignore
            expect(stats.processStats).toHaveBeenCalled();
        });

        it("not starting processing stats if interval 0", async () => {
            const statsDisabled = new GroupCallStats(GROUP_CALL_ID, LOCAL_USER_ID, 0);
            // @ts-ignore
            statsDisabled.processStats = vi.fn();
            statsDisabled.start();
            vi.advanceTimersByTime(TIME_INTERVAL);
            // @ts-ignore
            expect(statsDisabled.processStats).not.toHaveBeenCalled();
        });

        it("starting processing and calling the collectors", async () => {
            stats.addStatsReportGatherer("CALL_ID", "USER_ID", mockRTCPeerConnection());
            const collector = stats.getStatsReportGatherer("CALL_ID");
            stats.reports.emitSummaryStatsReport = vi.fn();
            const summaryStats = {
                isFirstCollection: true,
                receivedMedia: 0,
                receivedAudioMedia: 0,
                receivedVideoMedia: 0,
                audioTrackSummary: {
                    count: 0,
                    muted: 0,
                    maxJitter: 0,
                    maxPacketLoss: 0,
                    concealedAudio: 0,
                    totalAudio: 0,
                },
                videoTrackSummary: {
                    count: 0,
                    muted: 0,
                    maxJitter: 0,
                    maxPacketLoss: 0,
                    concealedAudio: 0,
                    totalAudio: 0,
                },
            } as CallStatsReportSummary;
            let processStatsSpy;
            if (collector) {
                processStatsSpy = vi.spyOn(collector, "processStats").mockResolvedValue(summaryStats);
                stats.start();
                vi.advanceTimersByTime(TIME_INTERVAL);
            } else {
                throw new Error("Test failed, because no Collector found!");
            }
            expect(processStatsSpy).toHaveBeenCalledWith(GROUP_CALL_ID, LOCAL_USER_ID);
        });

        it("doing nothing if process already running", async () => {
            // @ts-ignore
            vi.spyOn(globalThis, "setInterval").mockReturnValue(22);
            stats.start();
            expect(setInterval).toHaveBeenCalledTimes(1);
            stats.start();
            stats.start();
            stats.start();
            stats.start();
            expect(setInterval).toHaveBeenCalledTimes(1);
        });
    });

    describe("should on stop", () => {
        beforeEach(() => {
            vi.useFakeTimers();
        });
        afterEach(() => {
            vi.useRealTimers();
        });
        it("finish stats process if was started", async () => {
            // @ts-ignore
            vi.spyOn(globalThis, "setInterval").mockReturnValue(22);
            vi.spyOn(globalThis, "clearInterval");
            stats.start();
            expect(setInterval).toHaveBeenCalledTimes(1);
            stats.stop();
            expect(clearInterval).toHaveBeenCalledWith(22);
        });

        it("do nothing if stats process was not started", async () => {
            vi.spyOn(globalThis, "clearInterval");
            stats.stop();
            expect(clearInterval).not.toHaveBeenCalled();
        });
    });
});

const mockRTCPeerConnection = (): RTCPeerConnection => {
    const pc = {} as RTCPeerConnection;
    pc.addEventListener = vi.fn();
    pc.getStats = vi.fn().mockResolvedValue(null);
    return pc;
};