Extract requestMediaPermissions (#9568)

test/components/views/messages/CallEvent-test.tsx

@@ -44,7 +44,6 @@ const CallEvent = wrapInMatrixClientContext(UnwrappedCallEvent);
 
 describe("CallEvent", () => {
     useMockedCalls();
-    Object.defineProperty(navigator, "mediaDevices", { value: { enumerateDevices: () => [] } });
     jest.spyOn(HTMLMediaElement.prototype, "play").mockImplementation(async () => {});
 
     let client: Mocked<MatrixClient>;

test/components/views/rooms/RoomTile-test.tsx

@@ -43,9 +43,6 @@ describe("RoomTile", () => {
     jest.spyOn(PlatformPeg, "get")
         .mockReturnValue({ overrideBrowserShortcuts: () => false } as unknown as BasePlatform);
     useMockedCalls();
-    Object.defineProperty(navigator, "mediaDevices", {
-        value: { enumerateDevices: async () => [] },
-    });
 
     let client: Mocked<MatrixClient>;
 

test/components/views/voip/CallView-test.tsx

@@ -44,12 +44,6 @@ const CallView = wrapInMatrixClientContext(_CallView);
 
 describe("CallLobby", () => {
     useMockedCalls();
-    Object.defineProperty(navigator, "mediaDevices", {
-        value: {
-            enumerateDevices: jest.fn(),
-            getUserMedia: () => null,
-        },
-    });
     jest.spyOn(HTMLMediaElement.prototype, "play").mockImplementation(async () => {});
 
     let client: Mocked<MatrixClient>;

test/components/views/voip/PipView-test.tsx

@@ -55,7 +55,6 @@ import { mkVoiceBroadcastInfoStateEvent } from "../../../voice-broadcast/utils/t
 
 describe("PipView", () => {
     useMockedCalls();
-    Object.defineProperty(navigator, "mediaDevices", { value: { enumerateDevices: () => [] } });
     jest.spyOn(HTMLMediaElement.prototype, "play").mockImplementation(async () => {});
 
     let sdkContext: TestSdkContext;

test/setup/setupManualMocks.ts

@@ -86,3 +86,11 @@ fetchMock.catch("");
 fetchMock.get("/image-file-stub", "image file stub");
 // @ts-ignore
 window.fetch = fetchMock.sandbox();
+
+// set up mediaDevices mock
+Object.defineProperty(navigator, "mediaDevices", {
+    value: {
+        enumerateDevices: jest.fn().mockResolvedValue([]),
+        getUserMedia: jest.fn(),
+    },
+});

test/stores/room-list/algorithms/Algorithm-test.ts

@@ -89,10 +89,6 @@ describe("Algorithm", () => {
             stop: () => {},
         } as unknown as ClientWidgetApi);
 
-        Object.defineProperty(navigator, "mediaDevices", {
-            value: { enumerateDevices: async () => [] },
-        });
-
         // End of setup
 
         expect(algorithm.getOrderedRooms()[DefaultTagID.Untagged]).toEqual([room, roomWithCall]);

test/toasts/IncomingCallToast-test.tsx

@@ -42,7 +42,6 @@ import { getIncomingCallToastKey, IncomingCallToast } from "../../src/toasts/Inc
 
 describe("IncomingCallEvent", () => {
     useMockedCalls();
-    Object.defineProperty(navigator, "mediaDevices", { value: { enumerateDevices: () => [] } });
     jest.spyOn(HTMLMediaElement.prototype, "play").mockImplementation(async () => { });
 
     let client: Mocked<MatrixClient>;

test/utils/media/requestMediaPermissions-test.tsx

@@ -0,0 +1,124 @@
+/*
+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 { mocked } from "jest-mock";
+import { logger } from "matrix-js-sdk/src/logger";
+import { screen } from "@testing-library/react";
+
+import { requestMediaPermissions } from "../../../src/utils/media/requestMediaPermissions";
+import { flushPromises } from "../../test-utils";
+
+describe("requestMediaPermissions", () => {
+    let error: Error;
+    const audioVideoStream = {} as MediaStream;
+    const audioStream = {} as MediaStream;
+
+    const itShouldLogTheErrorAndShowTheNoMediaPermissionsModal = () => {
+        it("should log the error and show the »No media permissions« modal", () => {
+            expect(logger.log).toHaveBeenCalledWith(
+                "Failed to list userMedia devices",
+                error,
+            );
+            screen.getByText("No media permissions");
+        });
+    };
+
+    beforeEach(() => {
+        error = new Error();
+        jest.spyOn(logger, "log");
+    });
+
+    describe("when an audio and video device is available", () => {
+        beforeEach(() => {
+            mocked(navigator.mediaDevices.getUserMedia).mockImplementation(
+                async ({ audio, video }): Promise<MediaStream> => {
+                    if (audio && video) return audioVideoStream;
+                    return audioStream;
+                },
+            );
+        });
+
+        it("should return the audio/video stream", async () => {
+            expect(await requestMediaPermissions()).toBe(audioVideoStream);
+        });
+    });
+
+    describe("when calling with video = false and an audio device is available", () => {
+        beforeEach(() => {
+            mocked(navigator.mediaDevices.getUserMedia).mockImplementation(
+                async ({ audio, video }): Promise<MediaStream> => {
+                    if (audio && !video) return audioStream;
+                    return audioVideoStream;
+                },
+            );
+        });
+
+        it("should return the audio stream", async () => {
+            expect(await requestMediaPermissions(false)).toBe(audioStream);
+        });
+    });
+
+    describe("when only an audio stream is available", () => {
+        beforeEach(() => {
+            error.name = "NotFoundError";
+            mocked(navigator.mediaDevices.getUserMedia).mockImplementation(
+                async ({ audio, video }): Promise<MediaStream> => {
+                    if (audio && video) throw error;
+                    if (audio) return audioStream;
+                    return audioVideoStream;
+                },
+            );
+        });
+
+        it("should return the audio stream", async () => {
+            expect(await requestMediaPermissions()).toBe(audioStream);
+        });
+    });
+
+    describe("when no device is available", () => {
+        beforeEach(async () => {
+            error.name = "NotFoundError";
+            mocked(navigator.mediaDevices.getUserMedia).mockImplementation(
+                async (): Promise<MediaStream> => {
+                    throw error;
+                },
+            );
+            await requestMediaPermissions();
+            // required for the modal to settle
+            await flushPromises();
+            await flushPromises();
+        });
+
+        itShouldLogTheErrorAndShowTheNoMediaPermissionsModal();
+    });
+
+    describe("when an Error is raised", () => {
+        beforeEach(async () => {
+            mocked(navigator.mediaDevices.getUserMedia).mockImplementation(
+                async ({ audio, video }): Promise<MediaStream> => {
+                    if (audio && video) throw error;
+                    return audioVideoStream;
+                },
+            );
+            await requestMediaPermissions();
+            // required for the modal to settle
+            await flushPromises();
+            await flushPromises();
+        });
+
+        itShouldLogTheErrorAndShowTheNoMediaPermissionsModal();
+    });
+});