voice chat tip frequency

Author: lorux0

Explorer/Assets/DCL/FeatureFlags/FeatureFlagsStrings.cs

@@ -82,6 +82,8 @@ public static class FeatureFlagsStrings
         public const string REPORT_USER = "alfa-report-user";
         public const string POINT_AT = "alfa-point-at";
         public const string NEARBY_VOICE_CHAT = "alfa-nearby-voice-chat";
+        public const string NEARBY_VOICE_CHAT_TIP = "alfa-nearby-voice-chat-tip";
+        public const string NEARBY_VOICE_CHAT_TIP_CONFIG_VARIANT = "config";
         public const string AVATAR_CONTEXT_MENU = "alfa-avatar-context-menu";
         public const string DOUBLE_CLICK_WALK = "alfa-double-click-walk";
         public const string BYTE_WEIGHTED_LOADING_PROGRESS = "alfa-byte-weighted-loading-progress";

Explorer/Assets/DCL/FeatureFlags/FeaturesRegistry.cs

@@ -83,6 +83,9 @@ public FeaturesRegistry(
             SetFeatureState(FeatureId.VoiceChat, IsEnabled(FeatureId.Friends) && IsEnabled(FeatureId.FriendsUserBlocking) && (isEditor || featureFlags.IsEnabled(FeatureFlagsStrings.VOICE_CHAT) || (appArgs.HasDebugFlag() && appArgs.HasFlag(AppArgsFlags.VOICE_CHAT))));
             SetFeatureState(FeatureId.CommunityVoiceChat, IsEnabled(FeatureId.VoiceChat));
             SetFeatureState(FeatureId.NearbyVoiceChat, IsEnabled(FeatureId.VoiceChat) && appArgs.ResolveFeatureFlagArg(AppArgsFlags.NEARBY_VOICE_CHAT, featureFlags.IsEnabled(FeatureFlagsStrings.NEARBY_VOICE_CHAT) || Application.isEditor));
+
+            // The intro tip is a kill switch: unlike the feature itself it stays off until the flag is explicitly enabled.
+            SetFeatureState(FeatureId.NearbyVoiceChatTip, IsEnabled(FeatureId.NearbyVoiceChat) && featureFlags.IsEnabled(FeatureFlagsStrings.NEARBY_VOICE_CHAT_TIP));
         }
 
         /// <summary>
@@ -218,5 +221,6 @@ public enum FeatureId
         UseCustomMediaPlayerWindows = 71,
         UseCustomMediaPlayerMacSilicon = 72,
         UseCustomMediaPlayerMacIntel = 73,
+        NearbyVoiceChatTip = 74,
     }
 }

Explorer/Assets/DCL/PluginSystem/Global/VoiceChatPlugin.cs

@@ -19,7 +19,6 @@
 using DCL.VoiceChat.Nearby.Audio;
 using DCL.VoiceChat.Nearby.Systems;
 using LiveKit.Rooms.Streaming;
-using LiveKit.Rooms.Streaming.Audio;
 using LiveKit.Rooms;
 using System;
 using System.Collections.Generic;
@@ -35,7 +34,6 @@
 using DCL.SceneBannedUsers;
 using DCL.VoiceChat.UI;
 using Utility;
-using Utility.Multithreading;
 using AudioSettings = UnityEngine.AudioSettings;
 using RustAudio;
 
@@ -85,7 +83,6 @@ public class VoiceChatPlugin : IDCLGlobalPlugin<VoiceChatPlugin.Settings>
         private NearbyMicrophoneAudioToggleHandler? nearbyMicrophoneAudioToggleHandler;
         private NearbyVoiceChatButtonController? nearbyButtonController;
         private NearbyVoiceWidgetController? nearbyWidgetController;
-        private CancellationTokenSource? nearbyTipCts;
         private VoiceChatConfiguration voiceChatConfiguration;
 
         public VoiceChatPlugin(
@@ -139,7 +136,6 @@ public VoiceChatPlugin(
 
         public void Dispose()
         {
-            nearbyTipCts.SafeCancelAndDispose();
             pluginScope.Dispose();
 
             if (voiceChatPluginSettingsAsset.Value != null)
@@ -260,16 +256,12 @@ public async UniTask InitializeAsync(Settings settings, CancellationToken ct)
                 pluginScope.Add(nearbyWidgetController);
 
                 // Intro FLUX
-                nearbyTipCts = new CancellationTokenSource();
-                RunNearbyVoiceTipAsync(nearbyVoiceTipView, loadingStatus, nearbyVoiceChatButtonView, nearbyTipCts.Token).Forget();
-            }
-        }
+                NearbyVoiceTipSchedule tipSchedule = FeaturesRegistry.Instance.IsEnabled(FeatureId.NearbyVoiceChatTip)
+                    ? NearbyVoiceTipSchedule.FromFeatureFlags(FeatureFlagsConfiguration.Instance)
+                    : NearbyVoiceTipSchedule.Disabled;
 
-        private static async UniTaskVoid RunNearbyVoiceTipAsync(NearbyVoiceTipView view, ILoadingStatus loadingStatus,
-            NearbyVoiceChatButtonView buttonView, CancellationToken ct)
-        {
-            if (await NearbyVoiceTipFlow.WaitAndShowAsync(view, loadingStatus, ct))
-                buttonView.Button.onClick.Invoke();
+                pluginScope.Add(new NearbyVoiceTipController(nearbyVoiceTipView, nearbyVoiceChatButtonView, stateModel, chatSharedAreaEventBus, loadingStatus, tipSchedule));
+            }
         }
 
         [Serializable]
@@ -283,38 +275,5 @@ public class VoiceChatConfigurationsReference : AssetReferenceT<VoiceChatPluginS
                 public VoiceChatConfigurationsReference(string guid) : base(guid) { }
             }
         }
-
-        private static class NearbyVoiceTipFlow
-        {
-            public static async UniTask<bool> WaitAndShowAsync(NearbyVoiceTipView view, ILoadingStatus loadingStatus, CancellationToken ct)
-            {
-                view.Hide();
-
-                if (DCLPlayerPrefs.GetBool(DCLPrefKeys.NEARBY_VOICE_TIP_DISMISSED))
-                    return false;
-
-                try
-                {
-                    await UniTask.WaitUntil(
-                        () => loadingStatus.CurrentStage.Value == LoadingStatus.LoadingStage.Completed,
-                        cancellationToken: ct);
-
-                    view.Show();
-
-                    int winner = await UniTask.WhenAny(
-                        view.CloseButton.OnClickAsync(ct),
-                        view.TryItNowButton.OnClickAsync(ct));
-
-                    DCLPlayerPrefs.SetBool(DCLPrefKeys.NEARBY_VOICE_TIP_DISMISSED, true, save: true);
-                    view.Hide();
-
-                    return winner == 1;
-                }
-                catch (OperationCanceledException)
-                {
-                    return false;
-                }
-            }
-        }
     }
 }

Explorer/Assets/DCL/Prefs/DCLPlayerPrefs.cs

@@ -184,7 +184,10 @@ private static bool ValidateClearDCLPlayerPrefs() =>
         [MenuItem("Decentraland/PlayerPrefs/Reset Nearby Voice Intro Tip")]
         private static void ResetNearbyVoiceIntroTip()
         {
-            DeleteKey(DCLPrefKeys.NEARBY_VOICE_TIP_DISMISSED, save: true);
+            DeleteKey(DCLPrefKeys.NEARBY_VOICE_TIP_DISMISSED);
+            DeleteKey(DCLPrefKeys.NEARBY_VOICE_TIP_SHOWN_COUNT);
+            DeleteKey(DCLPrefKeys.NEARBY_VOICE_TIP_LAST_SHOWN_LAUNCH);
+            DeleteKey(DCLPrefKeys.NEARBY_VOICE_USED, save: true);
             Debug.Log("Nearby Voice Intro Tip has been reset.");
         }
 #endif

Explorer/Assets/DCL/Prefs/DCLPrefKeys.cs

@@ -107,6 +107,9 @@ public static class DCLPrefKeys
         public const string SKYBOX_FIXED_TIME = "Skybox_FixedTime";
 
         public const string NEARBY_VOICE_TIP_DISMISSED = "NearbyVoice_TipDismissed";
+        public const string NEARBY_VOICE_TIP_SHOWN_COUNT = "NearbyVoice_TipShownCount";
+        public const string NEARBY_VOICE_TIP_LAST_SHOWN_LAUNCH = "NearbyVoice_TipLastShownLaunch";
+        public const string NEARBY_VOICE_USED = "NearbyVoice_Used";
         public const string NEARBY_VOICE_CHAT_DISABLED = "NearbyVoice_Disabled";
         public const string SETTINGS_MUTE_MIC_IN_BACKGROUND = "Settings_MuteMicInBackground";
 

Explorer/Assets/DCL/Tests/PlayMode/PerformanceTests/EventsStateServiceLookupPerformanceTest.cs.meta

@@ -0,0 +1,169 @@
+using DCL.VoiceChat.UI;
+using NUnit.Framework;
+
+namespace DCL.VoiceChat.NearbyVoiceChat.Tests.EditMode
+{
+    /// <summary>
+    ///     Documents when the Nearby Voice Chat intro tip is due.
+    ///
+    ///     With the shipped defaults (every 5 sessions, at most 2 displays) a fresh user sees the tip on launch 5 and
+    ///     again on launch 10. The gap is measured from the last display, not from launch 0, so a returning user who
+    ///     is already past every threshold gets one display now and the next one 5 launches later — never two in a row.
+    /// </summary>
+    public class NearbyVoiceTipScheduleShould
+    {
+        private const int SHOW_EVERY_SESSIONS = 5;
+        private const int MAX_TIMES_SHOWN = 2;
+        private const int NEVER_SHOWN = 0;
+
+        private NearbyVoiceTipSchedule schedule;
+
+        [SetUp]
+        public void Setup()
+        {
+            schedule = new NearbyVoiceTipSchedule(SHOW_EVERY_SESSIONS, MAX_TIMES_SHOWN);
+        }
+
+        [TestCase(1)]
+        [TestCase(2)]
+        [TestCase(3)]
+        [TestCase(4)]
+        public void NotShowBeforeTheFirstThreshold(int launchCount)
+        {
+            //Act
+            bool shouldShow = schedule.ShouldShow(launchCount, timesShown: 0, lastShownAtLaunch: NEVER_SHOWN, hasUsedNearbyVoice: false);
+
+            //Assert
+            Assert.IsFalse(shouldShow);
+        }
+
+        [Test]
+        public void ShowAtTheFirstThreshold()
+        {
+            //Act
+            bool shouldShow = schedule.ShouldShow(launchCount: 5, timesShown: 0, lastShownAtLaunch: NEVER_SHOWN, hasUsedNearbyVoice: false);
+
+            //Assert
+            Assert.IsTrue(shouldShow);
+        }
+
+        [TestCase(6)]
+        [TestCase(7)]
+        [TestCase(8)]
+        [TestCase(9)]
+        public void NotShowBetweenThresholds(int launchCount)
+        {
+            //Act
+            bool shouldShow = schedule.ShouldShow(launchCount, timesShown: 1, lastShownAtLaunch: 5, hasUsedNearbyVoice: false);
+
+            //Assert
+            Assert.IsFalse(shouldShow);
+        }
+
+        [Test]
+        public void ShowAtTheSecondThreshold()
+        {
+            //Act
+            bool shouldShow = schedule.ShouldShow(launchCount: 10, timesShown: 1, lastShownAtLaunch: 5, hasUsedNearbyVoice: false);
+
+            //Assert
+            Assert.IsTrue(shouldShow);
+        }
+
+        [TestCase(10)]
+        [TestCase(11)]
+        [TestCase(100)]
+        public void NotShowOnceTheDisplayCapIsReached(int launchCount)
+        {
+            //Act
+            bool shouldShow = schedule.ShouldShow(launchCount, timesShown: MAX_TIMES_SHOWN, lastShownAtLaunch: 10, hasUsedNearbyVoice: false);
+
+            //Assert
+            Assert.IsFalse(shouldShow);
+        }
+
+        [TestCase(0)]
+        [TestCase(1)]
+        public void NotShowWhenTheUserAlreadyUsedNearbyVoice(int timesShown)
+        {
+            //Act
+            bool shouldShow = schedule.ShouldShow(launchCount: 100, timesShown, lastShownAtLaunch: NEVER_SHOWN, hasUsedNearbyVoice: true);
+
+            //Assert
+            Assert.IsFalse(shouldShow);
+        }
+
+        [Test]
+        public void ShowImmediatelyToReturningUsersWhoNeverSawIt()
+        {
+            //Act
+            bool shouldShow = schedule.ShouldShow(launchCount: 42, timesShown: 0, lastShownAtLaunch: NEVER_SHOWN, hasUsedNearbyVoice: false);
+
+            //Assert
+            Assert.IsTrue(shouldShow);
+        }
+
+        [TestCase(43)]
+        [TestCase(44)]
+        [TestCase(46)]
+        public void NotShowAgainRightAfterAReturningUsersFirstDisplay(int launchCount)
+        {
+            //Arrange
+            const int SHOWN_AT = 42;
+
+            //Act
+            bool shouldShow = schedule.ShouldShow(launchCount, timesShown: 1, lastShownAtLaunch: SHOWN_AT, hasUsedNearbyVoice: false);
+
+            //Assert
+            Assert.IsFalse(shouldShow);
+        }
+
+        [Test]
+        public void ShowTheSecondTimeAFullPeriodAfterAReturningUsersFirstDisplay()
+        {
+            //Act
+            bool shouldShow = schedule.ShouldShow(launchCount: 47, timesShown: 1, lastShownAtLaunch: 42, hasUsedNearbyVoice: false);
+
+            //Assert
+            Assert.IsTrue(shouldShow);
+        }
+
+        [TestCase(3, 0, 0, ExpectedResult = true)]
+        [TestCase(5, 1, 3, ExpectedResult = false)]
+        [TestCase(6, 1, 3, ExpectedResult = true)]
+        [TestCase(12, 3, 9, ExpectedResult = true)]
+        [TestCase(12, 4, 9, ExpectedResult = false)]
+        public bool FollowTheConfiguredFrequency(int launchCount, int timesShown, int lastShownAtLaunch)
+        {
+            //Arrange
+            var customSchedule = new NearbyVoiceTipSchedule(showEverySessions: 3, maxTimesShown: 4);
+
+            //Act
+            return customSchedule.ShouldShow(launchCount, timesShown, lastShownAtLaunch, hasUsedNearbyVoice: false);
+        }
+
+        [Test]
+        public void NeverShowWhenDisabled()
+        {
+            //Act
+            bool shouldShow = NearbyVoiceTipSchedule.Disabled.ShouldShow(launchCount: 100, timesShown: 0, lastShownAtLaunch: NEVER_SHOWN, hasUsedNearbyVoice: false);
+
+            //Assert
+            Assert.IsFalse(shouldShow);
+        }
+
+        [Test]
+        public void ClampANonPositivePeriodSoTheTipIsNotDueEveryLaunch()
+        {
+            //Arrange
+            var degenerateSchedule = new NearbyVoiceTipSchedule(showEverySessions: 0, maxTimesShown: 2);
+
+            //Act
+            bool shouldShow = degenerateSchedule.ShouldShow(launchCount: 5, timesShown: 1, lastShownAtLaunch: 5, hasUsedNearbyVoice: false);
+
+            //Assert
+            Assert.AreEqual(1, degenerateSchedule.ShowEverySessions);
+            Assert.IsFalse(shouldShow);
+        }
+    }
+}