Merge pull request #183 from GetStream/PBE-5829-Enable-GetLatestUnreadCountsAsync-usage-in-a-full-offline-mode

Add option to set authorization credentials without connecting the user.

Author: sierpinskid

Assets/Plugins/StreamChat/Core/IStreamChatClient.cs

@@ -254,9 +254,18 @@ Task<StreamDeleteChannelsResponse> DeleteMultipleChannelsAsync(IEnumerable<IStre
         bool IsLocalUser(IStreamUser messageUser);
 
         /// <summary>
-        /// Get current state of unread counts for the user. Unread counts mean how many messages and threads are unread in the channels and threads the user is participating in
+        /// Get current state of unread counts for the user. Unread counts mean how many messages and threads are unread in the channels and threads the user is participating in.
+        ///
+        /// This method can be used in offline mode as well to poll the latest unread counts without establishing a connection.
+        /// To use it this way, you need to call the <see cref="SeAuthorizationCredentials"/> method first to set the authorization credentials for the API call.
         /// </summary>
-        /// <returns><see cref="StreamCurrentUnreadCounts"/></returns>
+        /// <returns><see cref="StreamCurrentUnreadCounts"/>Contains information about unread counts in channels and threads</returns>
         Task<StreamCurrentUnreadCounts> GetLatestUnreadCountsAsync();
+
+        /// <summary>
+        /// Set authorization credentials for the client to use when connecting to the API
+        /// </summary>
+        /// <param name="authCredentials">Credentials containing: api key, user ID, and a user Token</param>
+        void SeAuthorizationCredentials(AuthCredentials authCredentials);
     }
 }

Assets/Plugins/StreamChat/Core/LowLevelClient/IStreamChatLowLevelClient.cs

@@ -89,5 +89,11 @@ void SetReconnectStrategySettings(ReconnectStrategy reconnectStrategy, float? ex
         Task DisconnectAsync(bool permanent = false);
 
         Task FetchAndProcessEventsSinceLastReceivedEvent(IEnumerable<string> channelCids);
+
+        /// <summary>
+        /// Set authorization credentials for the client to use when connecting to the API
+        /// </summary>
+        /// <param name="authCredentials">Credentials containing: api key, user ID, and a user Token</param>
+        void SeAuthorizationCredentials(AuthCredentials authCredentials);
     }
 }

Assets/Plugins/StreamChat/Core/LowLevelClient/StreamChatLowLevelClient.cs

@@ -318,13 +318,13 @@ public StreamChatLowLevelClient(AuthCredentials authCredentials, IWebsocketClien
 
         public void ConnectUser(AuthCredentials userAuthCredentials)
         {
-            SetConnectionCredentials(userAuthCredentials);
+            SeAuthorizationCredentials(userAuthCredentials);
             Connect();
         }
 
         public void Connect()
         {
-            SetConnectionCredentials(_authCredentials);
+            SeAuthorizationCredentials(_authCredentials);
 
             if (!ConnectionState.IsValidToConnect())
             {
@@ -342,6 +342,18 @@ public void Connect()
 
             _websocketClient.ConnectAsync(connectionUri).LogIfFailed(_logs);
         }
+        
+        public void SeAuthorizationCredentials(AuthCredentials authCredentials)
+        {
+            if (authCredentials.IsAnyEmpty())
+            {
+                throw new StreamMissingAuthCredentialsException(
+                    "Please provide valid credentials: `Api Key`, 'User id`, `User token`");
+            }
+
+            _authCredentials = authCredentials;
+            _httpClient.SetDefaultAuthenticationHeader(authCredentials.UserToken);
+        }
 
         public async Task DisconnectAsync(bool permanent = false)
         {
@@ -562,7 +574,7 @@ private async Task RefreshAuthTokenFromProvider()
             {
                 var token = await _tokenProvider.GetTokenAsync(_authCredentials.UserId);
                 _authCredentials = _authCredentials.CreateWithNewUserToken(token);
-                SetConnectionCredentials(_authCredentials);
+                SeAuthorizationCredentials(_authCredentials);
 
 #if STREAM_DEBUG_ENABLED
                 _logs.Info($"auth token received for user `{_authCredentials.UserId}`: " + token);
@@ -935,18 +947,6 @@ private static string Base64UrlEncode(byte[] input)
                 .Replace('/', '_')
                 .Trim('=');
 
-        private void SetConnectionCredentials(AuthCredentials credentials)
-        {
-            if (credentials.IsAnyEmpty())
-            {
-                throw new StreamMissingAuthCredentialsException(
-                    "Please provide valid credentials: `Api Key`, 'User id`, `User token`");
-            }
-
-            _authCredentials = credentials;
-            _httpClient.SetDefaultAuthenticationHeader(credentials.UserToken);
-        }
-
         //StreamTodo: make it more clear that we either receive full set of credentials or apiKey, userId and the token provider
         private void SetPartialConnectionCredentials(string apiKey, string userId)
         {

Assets/Plugins/StreamChat/Core/StreamChatClient.cs

@@ -165,6 +165,9 @@ public static string CreateDeveloperAuthToken(string userId)
         /// <inheritdoc cref="StreamChatLowLevelClient.SanitizeUserId"/>
         public static string SanitizeUserId(string userId) => StreamChatLowLevelClient.SanitizeUserId(userId);
 
+        public void SeAuthorizationCredentials(AuthCredentials authCredentials)
+            => InternalLowLevelClient.SeAuthorizationCredentials(authCredentials);
+
         public Task<IStreamLocalUserData> ConnectUserAsync(AuthCredentials userAuthCredentials,
             CancellationToken cancellationToken = default)
         {
@@ -219,7 +222,7 @@ public async Task<StreamCurrentUnreadCounts> GetLatestUnreadCountsAsync()
         {
             var dto = await InternalLowLevelClient.InternalChannelApi.GetUnreadCountsAsync();
             var response = dto.ToDomain<WrappedUnreadCountsResponseInternalDTO, StreamCurrentUnreadCounts>();
-            
+
             _localUserData.TryUpdateFromDto<WrappedUnreadCountsResponseInternalDTO, StreamLocalUserData>(dto, _cache);
 
             return response;
@@ -453,7 +456,8 @@ public async Task<IEnumerable<IStreamUser>> UpsertUsers(IEnumerable<StreamUserUp
             StreamAsserts.AssertNotNullOrEmpty(userRequests, nameof(userRequests));
 
             //StreamTodo: items could be null
-            var requestDtos = userRequests.Select(_ => _.TrySaveToDto<UserRequestInternalDTO>()).ToDictionary(_ => _.Id, _ => _);
+            var requestDtos = userRequests.Select(_ => _.TrySaveToDto<UserRequestInternalDTO>())
+                .ToDictionary(_ => _.Id, _ => _);
 
             var response = await InternalLowLevelClient.InternalUserApi.UpsertManyUsersAsync(
                 new UpdateUsersRequestInternalDTO
@@ -720,7 +724,7 @@ private void TryCancelWaitingForUserConnection()
                 _connectUserTaskSource.TrySetCanceled();
             }
         }
-        
+
         private async Task InternalGetOrCreateChannelAsync(ChannelType channelType, string channelId)
         {
 #if STREAM_TESTS_ENABLED
@@ -749,7 +753,8 @@ private async Task InternalGetOrCreateChannelAsync(ChannelType channelType, stri
 
                     var delay = 4 * i;
 #if STREAM_TESTS_ENABLED
-                    _logs.Warning($"InternalGetOrCreateChannelAsync attempt failed due to rate limit. Wait {delay} seconds and try again");
+                    _logs.Warning(
+                        $"InternalGetOrCreateChannelAsync attempt failed due to rate limit. Wait {delay} seconds and try again");
 #endif
                     //StreamTodo: pass CancellationToken
                     await Task.Delay(delay * 1000);
@@ -1144,7 +1149,9 @@ private void OnReactionReceived(ReactionNewEventInternalDTO eventDto)
 
             if (_cache.Messages.TryGet(eventDto.Message.Id, out var message))
             {
-                var reaction = new StreamReaction().TryLoadFromDto<ReactionInternalDTO, StreamReaction>(eventDto.Reaction, _cache);
+                var reaction
+                    = new StreamReaction().TryLoadFromDto<ReactionInternalDTO, StreamReaction>(eventDto.Reaction,
+                        _cache);
                 message.HandleReactionNewEvent(eventDto, channel, reaction);
                 channel.InternalNotifyReactionReceived(message, reaction);
             }
@@ -1159,7 +1166,9 @@ private void OnReactionUpdated(ReactionUpdatedEventInternalDTO eventDto)
 
             if (_cache.Messages.TryGet(eventDto.Message.Id, out var message))
             {
-                var reaction = new StreamReaction().TryLoadFromDto<ReactionInternalDTO, StreamReaction>(eventDto.Reaction, _cache);
+                var reaction
+                    = new StreamReaction().TryLoadFromDto<ReactionInternalDTO, StreamReaction>(eventDto.Reaction,
+                        _cache);
                 message.HandleReactionUpdatedEvent(eventDto, channel, reaction);
                 channel.InternalNotifyReactionUpdated(message, reaction);
             }
@@ -1174,7 +1183,9 @@ private void OnReactionDeleted(ReactionDeletedEventInternalDTO eventDto)
 
             if (_cache.Messages.TryGet(eventDto.Message.Id, out var message))
             {
-                var reaction = new StreamReaction().TryLoadFromDto<ReactionInternalDTO, StreamReaction>(eventDto.Reaction, _cache);
+                var reaction
+                    = new StreamReaction().TryLoadFromDto<ReactionInternalDTO, StreamReaction>(eventDto.Reaction,
+                        _cache);
                 message.HandleReactionDeletedEvent(eventDto, channel, reaction);
                 channel.InternalNotifyReactionDeleted(message, reaction);
             }