hotfix: voice chat (#5591)

Author: kuruk-mm

browser-interface/packages/lib/redux/waitFor.ts

@@ -10,3 +10,12 @@ export function waitFor(selector: (state: any) => any, actionType?: string | str
     return result
   }
 }
+
+export function* waitForSelector(selector: (state: any) => any) {
+  if (yield select(selector)) return; // (1)
+
+  while (true) {
+    yield take('*'); // (1a)
+    if (yield select(selector)) return; // (1b)
+  }
+}

browser-interface/packages/shared/comms/adapters/voice/liveKitVoiceHandler.ts

@@ -140,15 +140,18 @@ export function createLiveKitVoiceHandler(room: Room, globalAudioStream: GlobalA
   logger.log('initialized')
 
   return {
-    setRecording(recording) {
-      room.localParticipant
-        .setMicrophoneEnabled(recording)
-        .then(() => {
-          if (recordingListener) {
-            recordingListener(recording)
-          }
-        })
-        .catch((err) => logger.error('Error: ', err, ', recording=', recording))
+    async setRecording(recording) {
+      try {
+        await room.localParticipant.setMicrophoneEnabled(recording)
+        if (recordingListener) {
+          recordingListener(recording)
+        }
+      } catch(err) {
+        logger.error('Error: ', err, ', recording=', recording)
+        if (recordingListener) {
+          recordingListener(false)
+        }
+      }
     },
     onUserTalking(cb) {
       onUserTalkingCallback = cb

browser-interface/packages/shared/comms/adapters/voice/opusVoiceHandler.ts

@@ -38,6 +38,7 @@ export const createOpusVoiceHandler = (): VoiceHandler => {
       } else {
         voiceCommunicator.pause()
       }
+      return Promise.resolve()
     },
     onUserTalking(cb) {
       voiceCommunicator.addStreamPlayingListener((streamId: string, playing: boolean) => {

browser-interface/packages/shared/voiceChat/VoiceHandler.ts

@@ -3,7 +3,7 @@ import * as rfc4 from 'shared/protocol/decentraland/kernel/comms/rfc4/comms.gen'
 export type VoiceHandler = {
   // UI Methods
   // setTalking is called from the UI or keyboard to broadcast audio
-  setRecording(recording: boolean): void
+  setRecording(recording: boolean): Promise<void>
 
   // used to know if a user is talking or not, for the UI
   onUserTalking(cb: (userId: string, talking: boolean) => void): void

browser-interface/packages/shared/voiceChat/actions.ts

@@ -32,13 +32,6 @@ export const REQUEST_VOICE_CHAT_RECORDING = '[VC] requestVoiceChatRecording'
 export const requestVoiceChatRecording = (recording: boolean) => action(REQUEST_VOICE_CHAT_RECORDING, { recording })
 export type RequestVoiceChatRecordingAction = ReturnType<typeof requestVoiceChatRecording>
 
-/**
- * Action to toggle voice chat recording
- */
-export const REQUEST_TOGGLE_VOICE_CHAT_RECORDING = '[VC] toggleVoiceChatRecording'
-export const requestToggleVoiceChatRecording = () => action(REQUEST_TOGGLE_VOICE_CHAT_RECORDING, {})
-export type RequestToggleVoiceChatRecordingAction = ReturnType<typeof requestToggleVoiceChatRecording>
-
 /**
  * Action triggered when recording starts or stops
  */
@@ -74,7 +67,6 @@ export type VoiceChatActions =
   | SetVoiceChatHandlerAction
   | SetVoiceChatErrorAction
   | RequestVoiceChatRecordingAction
-  | RequestToggleVoiceChatRecordingAction
   | VoiceRecordingUpdateAction
   | SetVoiceChatVolumeAction
   | SetVoiceChatMuteAction

browser-interface/packages/shared/voiceChat/reducer.ts

@@ -1,7 +1,6 @@
 import {
   JOIN_VOICE_CHAT,
   LEAVE_VOICE_CHAT,
-  REQUEST_TOGGLE_VOICE_CHAT_RECORDING,
   REQUEST_VOICE_CHAT_RECORDING,
   SET_AUDIO_DEVICE,
   SET_VOICE_CHAT_ERROR,
@@ -50,9 +49,6 @@ export function voiceChatReducer(state?: VoiceChatState, action?: VoiceChatActio
       const { payload } = action
       return { ...state, requestRecording: payload.recording }
     }
-    case REQUEST_TOGGLE_VOICE_CHAT_RECORDING: {
-      return { ...state, requestRecording: !state.requestRecording }
-    }
     case SET_VOICE_CHAT_VOLUME: {
       const { payload } = action
       return { ...state, volume: payload.volume }

browser-interface/packages/shared/voiceChat/sagas.ts

@@ -1,4 +1,4 @@
-import { apply, call, fork, put, select, take, takeEvery, takeLatest } from 'redux-saga/effects'
+import { apply, call, fork, put, select, take, takeEvery } from 'redux-saga/effects'
 import { trackEvent } from 'shared/analytics/trackEvent'
 import { positionReportToCommsPositionRfc4 } from 'shared/comms/interface/utils'
 import { receiveUserTalking } from 'shared/comms/peers'
@@ -10,7 +10,6 @@ import {
   JOIN_VOICE_CHAT,
   leaveVoiceChat,
   LEAVE_VOICE_CHAT,
-  REQUEST_TOGGLE_VOICE_CHAT_RECORDING,
   REQUEST_VOICE_CHAT_RECORDING,
   SetAudioDevice,
   setVoiceChatError,
@@ -37,7 +36,8 @@ import {
   getVoiceHandler,
   hasJoinedVoiceChat,
   isRequestedVoiceChatRecording,
-  isVoiceChatAllowedByCurrentScene
+  isVoiceChatAllowedByCurrentScene,
+  isVoiceChatRecording
 } from './selectors'
 import { RootVoiceChatState, VoiceChatState } from './types'
 import { VoiceHandler } from './VoiceHandler'
@@ -48,14 +48,14 @@ import { getCommsRoom } from 'shared/comms/selectors'
 import { waitForMetaConfigurationInitialization } from 'shared/meta/sagas'
 import { incrementCounter } from 'shared/analytics/occurences'
 import { RootWorldState } from 'shared/world/types'
+import { waitForSelector } from 'lib/redux'
 
 let audioRequestInitialized = false
 
 export function* voiceChatSaga() {
   yield fork(reactToNewVoiceChatHandler)
 
-  yield takeLatest(REQUEST_VOICE_CHAT_RECORDING, handleRecordingRequest)
-  yield takeLatest(REQUEST_TOGGLE_VOICE_CHAT_RECORDING, handleRecordingRequest)
+  yield takeEvery(REQUEST_VOICE_CHAT_RECORDING, handleRecordingRequest)
 
   yield takeEvery(VOICE_PLAYING_UPDATE, handleUserVoicePlaying)
 
@@ -107,17 +107,25 @@ function* handleConnectVoiceChatToRoom() {
   }
 }
 
+const notRecording = (store: RootVoiceChatState) => !store.voiceChat.recording
+
 function* handleRecordingRequest() {
   const { requestedRecording, voiceHandler, isAllowedByScene } = (yield select(
     getHandleRecordingRequestInfo
   )) as ReturnType<typeof getHandleRecordingRequestInfo>
 
   if (voiceHandler) {
     if (!isAllowedByScene || !requestedRecording) {
-      voiceHandler.setRecording(false)
+
+      // Ensure that we're recording, to stop recording
+      yield call(waitForSelector, isVoiceChatRecording)
+      yield call(voiceHandler.setRecording, false)
     } else {
       yield call(requestUserMediaIfNeeded)
-      voiceHandler.setRecording(true)
+
+      // Ensure that we're not recording, when we try to start recording
+      yield call(waitForSelector, notRecording)
+      yield call(voiceHandler.setRecording, true)
     }
   }
 }

browser-interface/packages/unity-interface/BrowserInterface.ts

@@ -89,7 +89,6 @@ import {
 import {
   joinVoiceChat,
   leaveVoiceChat,
-  requestToggleVoiceChatRecording,
   requestVoiceChatRecording,
   setAudioDevice,
   setVoiceChatPolicy,
@@ -847,10 +846,6 @@ export class BrowserInterface {
     store.dispatch(leaveVoiceChat())
   }
 
-  public ToggleVoiceChatRecording() {
-    store.dispatch(requestToggleVoiceChatRecording())
-  }
-
   public ApplySettings(settingsMessage: { voiceChatVolume: number; voiceChatAllowCategory: number }) {
     store.dispatch(setVoiceChatVolume(settingsMessage.voiceChatVolume))
     store.dispatch(setVoiceChatPolicy(settingsMessage.voiceChatAllowCategory))

unity-renderer/Assets/Scripts/MainScripts/DCL/Controllers/VoiceChat/DCLVoiceChatController.cs

@@ -1,43 +1,51 @@
-using UnityEngine;
+using DCL.Interface;
+using Newtonsoft.Json;
 using SocialFeaturesAnalytics;
-using System.Collections.Generic;
 using System;
-using Newtonsoft.Json;
+using System.Collections.Generic;
+using UnityEngine;
 
 namespace DCL
 {
     public class DCLVoiceChatController : MonoBehaviour
     {
         [Header("InputActions")]
         public InputAction_Hold voiceChatAction;
-        public InputAction_Trigger voiceChatToggleAction;
 
         private InputAction_Hold.Started voiceChatStartedDelegate;
         private InputAction_Hold.Finished voiceChatFinishedDelegate;
-        private InputAction_Trigger.Triggered voiceChatToggleDelegate;
 
         private bool firstTimeVoiceRecorded = true;
         private ISocialAnalytics socialAnalytics;
         private UserProfileWebInterfaceBridge userProfileWebInterfaceBridge;
         private double voiceMessageStartTime = 0;
-        private bool isVoiceChatToggledOn = false;
+
+        private bool isRecording;
 
         void Awake()
         {
             userProfileWebInterfaceBridge = new UserProfileWebInterfaceBridge();
 
             voiceChatStartedDelegate = (action) => DataStore.i.voiceChat.isRecording.Set(new KeyValuePair<bool, bool>(true, true));
             voiceChatFinishedDelegate = (action) => DataStore.i.voiceChat.isRecording.Set(new KeyValuePair<bool, bool>(false, true));
-            voiceChatToggleDelegate = (action) => ToggleVoiceChatRecording();
             voiceChatAction.OnStarted += voiceChatStartedDelegate;
             voiceChatAction.OnFinished += voiceChatFinishedDelegate;
-            voiceChatToggleAction.OnTriggered += voiceChatToggleDelegate;
 
             KernelConfig.i.EnsureConfigInitialized().Then(config => EnableVoiceChat(config.comms.voiceChatEnabled));
             KernelConfig.i.OnChange += OnKernelConfigChanged;
             DataStore.i.voiceChat.isRecording.OnChange += IsVoiceChatRecordingChanged;
         }
 
+
+        private void OnApplicationFocus(bool hasFocus)
+        {
+            if (!hasFocus)
+            {
+                StopRecording(true);
+                DataStore.i.voiceChat.isRecording.Set(new KeyValuePair<bool, bool>(false, true));
+            }
+        }
+
         void OnDestroy()
         {
             voiceChatAction.OnStarted -= voiceChatStartedDelegate;
@@ -61,50 +69,38 @@ private void IsVoiceChatRecordingChanged(KeyValuePair<bool, bool> current, KeyVa
             if (!DataStore.i.voiceChat.isJoinedToVoiceChat.Get())
                 return;
 
-            CreateSocialAnalyticsIfNeeded();
-
             if (current.Key)
-            {
-                if (!isVoiceChatToggledOn)
-                {
-                    Interface.WebInterface.SendSetVoiceChatRecording(true);
-                    SendFirstTimeMetricIfNeeded();
-                    voiceMessageStartTime = Time.realtimeSinceStartup;
-                }
-            }
+                StartRecording();
             else
-            {
-                Interface.WebInterface.SendSetVoiceChatRecording(false);
+                StopRecording(current.Value);
+        }
 
-                socialAnalytics.SendVoiceMessage(
-                    Time.realtimeSinceStartup - voiceMessageStartTime, 
-                    (current.Value || isVoiceChatToggledOn) ? VoiceMessageSource.Shortcut : VoiceMessageSource.Button, 
-                    userProfileWebInterfaceBridge.GetOwn().userId);
+        private void StartRecording()
+        {
+            if (isRecording) return;
 
-                isVoiceChatToggledOn = false;
-            }
+            WebInterface.SendSetVoiceChatRecording(true);
+
+            CreateSocialAnalyticsIfNeeded();
+            SendFirstTimeMetricIfNeeded();
+            voiceMessageStartTime = Time.realtimeSinceStartup;
+
+            isRecording = true;
         }
 
-        private void ToggleVoiceChatRecording()
+        private void StopRecording(bool usedShortcut)
         {
-            if (!DataStore.i.voiceChat.isJoinedToVoiceChat.Get())
-                return;
+            if (!isRecording) return;
 
-            Interface.WebInterface.ToggleVoiceChatRecording();
-            isVoiceChatToggledOn = !isVoiceChatToggledOn;
+            WebInterface.SendSetVoiceChatRecording(false);
 
-            if (isVoiceChatToggledOn)
-            {
-                SendFirstTimeMetricIfNeeded();
-                voiceMessageStartTime = Time.realtimeSinceStartup;
-            }
-            else
-            {
-                socialAnalytics.SendVoiceMessage(
-                    Time.realtimeSinceStartup - voiceMessageStartTime,
-                    VoiceMessageSource.Shortcut,
-                    userProfileWebInterfaceBridge.GetOwn().userId);
-            }
+            CreateSocialAnalyticsIfNeeded();
+            socialAnalytics.SendVoiceMessage(
+                Time.realtimeSinceStartup - voiceMessageStartTime,
+                usedShortcut ? VoiceMessageSource.Shortcut : VoiceMessageSource.Button,
+                userProfileWebInterfaceBridge.GetOwn().userId);
+
+            isRecording = false;
         }
 
         private void CreateSocialAnalyticsIfNeeded()
@@ -121,7 +117,6 @@ private void SendFirstTimeMetricIfNeeded()
         {
             if (firstTimeVoiceRecorded)
             {
-                CreateSocialAnalyticsIfNeeded();
                 socialAnalytics.SendVoiceMessageStartedByFirstTime();
                 firstTimeVoiceRecorded = false;
             }
@@ -133,4 +128,4 @@ public class VoiceChatStatusPayload
     {
         public bool isConnected;
     }
-}
+}