Add audible notifcation on broadcast error (#10654)

* Add audible notifcation on broadcast error * Add error audio file * Add error ogg * Catch play broadcast error * Await play error sound * Add promise error handling * Add comment about audio elements
matrix-org · May 11, 2023 · 0a6fe83 · 0a6fe83
1 parent 9aade5a
commit 0a6fe83
Show file tree

Hide file tree

Showing 4 changed files with 65 additions and 0 deletions.
diff --git a/res/media/error.mp3 b/res/media/error.mp3
diff --git a/res/media/error.ogg b/res/media/error.ogg
diff --git a/src/voice-broadcast/models/VoiceBroadcastRecording.ts b/src/voice-broadcast/models/VoiceBroadcastRecording.ts
@@ -46,6 +46,7 @@ import { ActionPayload } from "../../dispatcher/payloads";
 import { VoiceBroadcastChunkEvents } from "../utils/VoiceBroadcastChunkEvents";
 import { RelationsHelper, RelationsHelperEvent } from "../../events/RelationsHelper";
 import { createReconnectedListener } from "../../utils/connection";
+import { localNotificationsAreSilenced } from "../../utils/notifications";
 
 export enum VoiceBroadcastRecordingEvent {
     StateChanged = "liveness_changed",
@@ -333,10 +334,29 @@ export class VoiceBroadcastRecording
      * It sets the connection error state and stops the recorder.
      */
     private async onConnectionError(): Promise<void> {
+        this.playConnectionErrorAudioNotification().catch(() => {
+            // Error logged in playConnectionErrorAudioNotification().
+        });
         await this.stopRecorder(false);
         this.setState("connection_error");
     }
 
+    private async playConnectionErrorAudioNotification(): Promise<void> {
+        if (localNotificationsAreSilenced(this.client)) {
+            return;
+        }
+
+        // Audio files are added to the document in Element Web.
+        // See <audio> elements in https://github.com/vector-im/element-web/blob/develop/src/vector/index.html
+        const audioElement = document.querySelector<HTMLAudioElement>("audio#errorAudio");
+
+        try {
+            await audioElement?.play();
+        } catch (e) {
+            logger.warn("error playing 'errorAudio'", e);
+        }
+    }
+
     private async uploadFile(chunk: ChunkRecordedPayload): ReturnType<typeof uploadFile> {
         return uploadFile(
             this.client,

diff --git a/test/voice-broadcast/models/VoiceBroadcastRecording-test.ts b/test/voice-broadcast/models/VoiceBroadcastRecording-test.ts
@@ -19,6 +19,7 @@ import {
     ClientEvent,
     EventTimelineSet,
     EventType,
+    LOCAL_NOTIFICATION_SETTINGS_PREFIX,
     MatrixClient,
     MatrixEvent,
     MatrixEventEvent,
@@ -89,6 +90,7 @@ describe("VoiceBroadcastRecording", () => {
     let voiceBroadcastRecording: VoiceBroadcastRecording;
     let onStateChanged: (state: VoiceBroadcastRecordingState) => void;
     let voiceBroadcastRecorder: VoiceBroadcastRecorder;
+    let audioElement: HTMLAudioElement;
 
     const mkVoiceBroadcastInfoEvent = (content: VoiceBroadcastInfoEventContent) => {
         return mkEvent({
@@ -251,6 +253,18 @@ describe("VoiceBroadcastRecording", () => {
                 };
             },
         );
+
+        audioElement = {
+            play: jest.fn(),
+        } as any as HTMLAudioElement;
+
+        jest.spyOn(document, "querySelector").mockImplementation((selector: string) => {
+            if (selector === "audio#errorAudio") {
+                return audioElement;
+            }
+
+            return null;
+        });
     });
 
     afterEach(() => {
@@ -501,6 +515,33 @@ describe("VoiceBroadcastRecording", () => {
                 });
             });
 
+            describe("and audible notifications are disabled", () => {
+                beforeEach(() => {
+                    const notificationSettings = mkEvent({
+                        event: true,
+                        type: `${LOCAL_NOTIFICATION_SETTINGS_PREFIX.name}.${client.getDeviceId()}`,
+                        user: client.getSafeUserId(),
+                        content: {
+                            is_silenced: true,
+                        },
+                    });
+                    mocked(client.getAccountData).mockReturnValue(notificationSettings);
+                });
+
+                describe("and a chunk has been recorded and sending the voice message fails", () => {
+                    beforeEach(() => {
+                        mocked(client.sendMessage).mockRejectedValue("Error");
+                        emitFirsChunkRecorded();
+                    });
+
+                    itShouldBeInState("connection_error");
+
+                    it("should not play a notification", () => {
+                        expect(audioElement.play).not.toHaveBeenCalled();
+                    });
+                });
+            });
+
             describe("and a chunk has been recorded and sending the voice message fails", () => {
                 beforeEach(() => {
                     mocked(client.sendMessage).mockRejectedValue("Error");
@@ -509,6 +550,10 @@ describe("VoiceBroadcastRecording", () => {
 
                 itShouldBeInState("connection_error");
 
+                it("should play a notification", () => {
+                    expect(audioElement.play).toHaveBeenCalled();
+                });
+
                 describe("and the connection is back", () => {
                     beforeEach(() => {
                         mocked(client.sendMessage).mockClear();