Set voice broadcast defaults (#9471)

src/SdkConfig.ts

@@ -47,7 +47,7 @@ export const DEFAULTS: IConfigOptions = {
         url: "https://element.io/get-started",
     },
     voice_broadcast: {
-        chunk_length: 60, // one minute
+        chunk_length: 120, // two minutes
     },
 };
 

src/voice-broadcast/audio/VoiceBroadcastRecorder.ts

@@ -17,8 +17,8 @@ limitations under the License.
 import { Optional } from "matrix-events-sdk";
 import { TypedEventEmitter } from "matrix-js-sdk/src/models/typed-event-emitter";
 
+import { getChunkLength } from "..";
 import { VoiceRecording } from "../../audio/VoiceRecording";
-import SdkConfig, { DEFAULTS } from "../../SdkConfig";
 import { concat } from "../../utils/arrays";
 import { IDestroyable } from "../../utils/IDestroyable";
 import { Singleflight } from "../../utils/Singleflight";
@@ -139,6 +139,5 @@ export class VoiceBroadcastRecorder
 }
 
 export const createVoiceBroadcastRecorder = (): VoiceBroadcastRecorder => {
-    const targetChunkLength = SdkConfig.get("voice_broadcast")?.chunk_length || DEFAULTS.voice_broadcast!.chunk_length;
-    return new VoiceBroadcastRecorder(new VoiceRecording(), targetChunkLength);
+    return new VoiceBroadcastRecorder(new VoiceRecording(), getChunkLength());
 };

src/voice-broadcast/index.ts

@@ -34,6 +34,7 @@ export * from "./components/molecules/VoiceBroadcastRecordingPip";
 export * from "./hooks/useVoiceBroadcastRecording";
 export * from "./stores/VoiceBroadcastPlaybacksStore";
 export * from "./stores/VoiceBroadcastRecordingsStore";
+export * from "./utils/getChunkLength";
 export * from "./utils/hasRoomLiveVoiceBroadcast";
 export * from "./utils/shouldDisplayAsVoiceBroadcastRecordingTile";
 export * from "./utils/shouldDisplayAsVoiceBroadcastTile";

src/voice-broadcast/utils/getChunkLength.ts

@@ -0,0 +1,29 @@
+/*
+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 SdkConfig, { DEFAULTS } from "../../SdkConfig";
+
+/**
+ * Returns the target chunk length for voice broadcasts:
+ * - Tries to get the value from the voice_broadcast.chunk_length config
+ * - If that fails from DEFAULTS
+ * - If that fails fall back to 120 (two minutes)
+ */
+export const getChunkLength = (): number => {
+    return SdkConfig.get("voice_broadcast")?.chunk_length
+        || DEFAULTS.voice_broadcast?.chunk_length
+        || 120;
+};

src/voice-broadcast/utils/startNewVoiceBroadcastRecording.tsx

@@ -28,6 +28,7 @@ import {
     VoiceBroadcastRecordingsStore,
     VoiceBroadcastRecording,
     hasRoomLiveVoiceBroadcast,
+    getChunkLength,
 } from "..";
 
 const startBroadcast = async (
@@ -67,7 +68,7 @@ const startBroadcast = async (
         {
             device_id: client.getDeviceId(),
             state: VoiceBroadcastInfoState.Started,
-            chunk_length: 300,
+            chunk_length: getChunkLength(),
         } as VoiceBroadcastInfoEventContent,
         client.getUserId(),
     );

test/voice-broadcast/models/VoiceBroadcastRecording-test.ts

@@ -442,7 +442,7 @@ describe("VoiceBroadcastRecording", () => {
             infoEvent = mkVoiceBroadcastInfoEvent({
                 device_id: client.getDeviceId(),
                 state: VoiceBroadcastInfoState.Started,
-                chunk_length: 300,
+                chunk_length: 120,
             });
 
             const relationsContainer = {

test/voice-broadcast/utils/getChunkLength-test.ts

@@ -0,0 +1,60 @@
+/*
+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 SdkConfig, { DEFAULTS } from "../../../src/SdkConfig";
+import { getChunkLength } from "../../../src/voice-broadcast/utils/getChunkLength";
+
+jest.mock("../../../src/SdkConfig");
+
+describe("getChunkLength", () => {
+    afterEach(() => {
+        jest.resetAllMocks();
+    });
+
+    describe("when there is a value provided by Sdk config", () => {
+        beforeEach(() => {
+            mocked(SdkConfig.get).mockReturnValue({ chunk_length: 42 });
+        });
+
+        it("should return this value", () => {
+            expect(getChunkLength()).toBe(42);
+        });
+    });
+
+    describe("when Sdk config does not provide a value", () => {
+        beforeEach(() => {
+            DEFAULTS.voice_broadcast = {
+                chunk_length: 23,
+            };
+        });
+
+        it("should return this value", () => {
+            expect(getChunkLength()).toBe(23);
+        });
+    });
+
+    describe("if there are no defaults", () => {
+        beforeEach(() => {
+            DEFAULTS.voice_broadcast = undefined;
+        });
+
+        it("should return the fallback value", () => {
+            expect(getChunkLength()).toBe(120);
+        });
+    });
+});

test/voice-broadcast/utils/startNewVoiceBroadcastRecording-test.ts

@@ -122,7 +122,7 @@ describe("startNewVoiceBroadcastRecording", () => {
                     roomId,
                     VoiceBroadcastInfoEventType,
                     {
-                        chunk_length: 300,
+                        chunk_length: 120,
                         device_id: client.getDeviceId(),
                         state: VoiceBroadcastInfoState.Started,
                     },