Update all tests clients from the background task instead of relying on test logic to update them (#174)

Author: sierpinskid

Assets/Plugins/StreamChat/Tests/LowLevelClient/Integration/DeviceApiIntegrationTests.cs

@@ -19,7 +19,7 @@ internal class DeviceApiIntegrationTests : BaseIntegrationTests
         public IEnumerator Test_complete_device_cycle_add_list_remove()
         {
             yield return LowLevelClient.WaitForClientToConnect();
-            yield return Test_complete_device_cycle_add_list_remove_Async().RunTaskAsEnumerator(LowLevelClient);
+            yield return Test_complete_device_cycle_add_list_remove_Async().RunTaskAsEnumerator();
         }
 
         private async Task Test_complete_device_cycle_add_list_remove_Async()

Assets/Plugins/StreamChat/Tests/StatefulClient/BaseStateIntegrationTests.cs

@@ -87,7 +87,7 @@ protected void SkipThisTempChannelDeletionInTearDown(IStreamChannel channel)
 
         protected static IEnumerator ConnectAndExecute(Func<Task> test)
         {
-            yield return ConnectAndExecuteAsync(test).RunAsIEnumerator(statefulClient: Client);
+            yield return ConnectAndExecuteAsync(test).RunAsIEnumerator();
         }
 
         protected Task<StreamChatClient> GetConnectedOtherClientAsync()

Assets/Plugins/StreamChat/Tests/StreamTestClients.cs

@@ -4,13 +4,15 @@
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.Linq;
+using System.Threading;
 using System.Threading.Tasks;
 using NUnit.Framework.Interfaces;
 using StreamChat.Core;
 using StreamChat.Core.Configs;
 using StreamChat.Core.LowLevelClient;
 using StreamChat.Core.LowLevelClient.Models;
 using StreamChat.Libs.Auth;
+using StreamChat.Libs.ChatInstanceRunner;
 using Debug = UnityEngine.Debug;
 using Random = UnityEngine.Random;
 
@@ -113,6 +115,9 @@ public Task<StreamChatClient> ConnectOtherStateClientAsync()
         private StreamChatClient _otherStateClient;
 
         private bool _runFinished;
+        
+        private Task _updateTask;
+        private CancellationTokenSource _updateTaskCts;
 
         private StreamTestClients()
         {
@@ -131,6 +136,32 @@ private StreamTestClients()
             AdminSecondaryCredentials = GetCredentialsFromSet(testAuthSets.Admins, optionalTestDataIndex + offset);
             UserPrimaryCredentials = GetCredentialsFromSet(testAuthSets.Admins, optionalTestDataIndex);
             UserSecondaryCredentials = GetCredentialsFromSet(testAuthSets.Admins, optionalTestDataIndex + offset);
+            
+            _updateTaskCts = new CancellationTokenSource();
+            _updateTask = UpdateTaskAsync();
+        }
+        
+        private async Task UpdateTaskAsync()
+        {
+            Debug.LogWarning("UpdateTaskAsync STARTED");
+            while (!_updateTaskCts.Token.IsCancellationRequested)
+            {
+                try
+                {
+                    _updateTaskCts.Token.ThrowIfCancellationRequested();
+                }
+                catch (Exception)
+                {
+                    Debug.LogWarning("UpdateTaskAsync STOPPED");
+                    throw;
+                }
+                
+                ((IStreamChatClientEventsListener)_stateClient)?.Update();
+                ((IStreamChatClientEventsListener)_otherStateClient)?.Update();
+                _lowLevelClient?.Update(0.1f);
+
+                await Task.Delay(1);
+            }
         }
 
         private AuthCredentials GetCredentialsFromSet(AuthCredentials[] set, int? forcedIndex)
@@ -209,6 +240,8 @@ private Task TryDisposeInstancesAsync()
 
             Debug.Log("------------  Tests finished - dispose client instances");
 
+            _updateTaskCts.Cancel();
+            
             DisposeLowLevelClient();
             return DisposeStateClientsAsync();
         }

Assets/Plugins/StreamChat/Tests/UnityTestUtils.cs

@@ -31,19 +31,18 @@ public static IEnumerator RunAsIEnumerator<TResponse>(this Task<TResponse> task,
                     onFaulted(ex);
                     yield break;
                 }
-                
+
                 throw ex;
             }
 
             onSuccess?.Invoke(task.Result);
         }
 
         public static IEnumerator RunAsIEnumerator(this Task task,
-            Action onSuccess = null, Action<Exception> onFaulted = null, IStreamChatClient statefulClient = null)
+            Action onSuccess = null, Action<Exception> onFaulted = null)
         {
             while (!task.IsCompleted)
             {
-                statefulClient?.Update();
                 yield return null;
             }
 
@@ -55,13 +54,13 @@ public static IEnumerator RunAsIEnumerator(this Task task,
                     onFaulted(ex);
                     yield break;
                 }
-                
+
                 throw ex;
             }
 
             onSuccess?.Invoke();
         }
-        
+
         public static IEnumerator RunAsIEnumerator(this Task task,
             IStreamChatLowLevelClient lowLevelClient, Action onSuccess = null, Action<Exception> onFaulted = null)
         {
@@ -79,7 +78,7 @@ public static IEnumerator RunAsIEnumerator(this Task task,
                     onFaulted(ex);
                     yield break;
                 }
-                
+
                 throw ex;
             }
 
@@ -92,7 +91,7 @@ public static IEnumerator WaitForClientToConnect(this IStreamChatLowLevelClient
             {
                 yield break;
             }
-            
+
             const float maxTimeToConnect = 3;
             var timeStarted = EditorApplication.timeSinceStartup;
 
@@ -106,8 +105,6 @@ public static IEnumerator WaitForClientToConnect(this IStreamChatLowLevelClient
                     break;
                 }
 
-                lowLevelClient.Update(0.1f);
-
                 if (lowLevelClient.ConnectionState == ConnectionState.Connecting)
                 {
                     yield return null;
@@ -126,19 +123,18 @@ public static IEnumerator WaitForClientToConnect(this IStreamChatLowLevelClient
             }
         }
 
-        public static IEnumerator RunTaskAsEnumerator(this Task task, IStreamChatLowLevelClient client)
+        public static IEnumerator RunTaskAsEnumerator(this Task task)
         {
             while (!task.IsCompleted)
             {
-                client.Update(0.1f);
                 yield return null;
             }
-            
+
             if (!task.IsFaulted)
             {
                 yield break;
             }
-            
+
             if (task.Exception is AggregateException aggregateException &&
                 aggregateException.InnerExceptions.Count == 1)
             {
@@ -147,8 +143,8 @@ public static IEnumerator RunTaskAsEnumerator(this Task task, IStreamChatLowLeve
 
             throw task.Exception;
         }
-        
-        public static string ToRfc3339String(this DateTime dateTime) 
+
+        public static string ToRfc3339String(this DateTime dateTime)
             => dateTime.ToString("yyyy-MM-dd'T'HH:mm:ss.fffzzz", DateTimeFormatInfo.InvariantInfo);
 
         private static Exception UnwrapAggregateException(Exception exception)