Merge pull request #185 from GetStream/feature/cleanup-before-release

sierpinskid · web-flow · commit cb80491371fe · 2024-09-20T16:27:13.000+02:00
Feature/cleanup before release
diff --git a/Assets/Plugins/StreamChat/Core/LowLevelClient/API/DeviceApi.cs b/Assets/Plugins/StreamChat/Core/LowLevelClient/API/DeviceApi.cs
@@ -5,7 +5,6 @@
 using StreamChat.Core.LowLevelClient.API.Internal;
 using StreamChat.Core.LowLevelClient.Requests;
 using StreamChat.Core.LowLevelClient.Responses;
-using StreamChat.Core.Responses;
 
 namespace StreamChat.Core.LowLevelClient.API
 {
diff --git a/Assets/Plugins/StreamChat/Core/LowLevelClient/IStreamChatLowLevelClient.cs b/Assets/Plugins/StreamChat/Core/LowLevelClient/IStreamChatLowLevelClient.cs
@@ -14,7 +14,10 @@ namespace StreamChat.Core.LowLevelClient
     public delegate void ConnectionStateChangeHandler(ConnectionState previous, ConnectionState current);
     
     /// <summary>
-    /// Stream Chat Client
+    /// Stream Low-Level Chat Client - maintains WebSockets connection, executes API calls and exposes Stream events to which you can subscribe.
+    /// There should be only one instance of this client in your application. This client does NOT maintain state.
+    ///
+    /// Unless you have a good reason to use the low-level client, you should be using the stateful <see cref="IStreamChatClient"/> which maintain client state
     /// </summary>
     public interface IStreamChatLowLevelClient : IAuthProvider, IConnectionProvider, IStreamRealtimeEventsProvider, IDisposable
     {
diff --git a/Assets/Plugins/StreamChat/Core/LowLevelClient/Models/ImageSize.cs b/Assets/Plugins/StreamChat/Core/LowLevelClient/Models/ImageSize.cs
@@ -1,5 +1,4 @@
-﻿using System;
-using StreamChat.Core.Helpers;
+﻿using StreamChat.Core.Helpers;
 using StreamChat.Core.InternalDTO.Models;
 
 namespace StreamChat.Core.LowLevelClient.Models
diff --git a/Assets/Plugins/StreamChat/Core/LowLevelClient/Models/MessageType.cs b/Assets/Plugins/StreamChat/Core/LowLevelClient/Models/MessageType.cs
@@ -2,7 +2,7 @@
 
 namespace StreamChat.Core.LowLevelClient.Models
 {
-    public struct MessageType : System.IEquatable<MessageType>,
+    public readonly struct MessageType : System.IEquatable<MessageType>,
         ILoadableFrom<MessageTypeInternalDTO, MessageType>,
         ISavableTo<MessageTypeInternalDTO>
     {
diff --git a/Assets/Plugins/StreamChat/Core/LowLevelClient/StreamChatLowLevelClient.cs b/Assets/Plugins/StreamChat/Core/LowLevelClient/StreamChatLowLevelClient.cs
@@ -39,10 +39,7 @@
 
 namespace StreamChat.Core.LowLevelClient
 {
-    /// <summary>
-    /// Stream Chat Client - maintains WebSockets connection, executes API calls and exposes Stream events to which you can subscribe.
-    /// There should be only one instance of this client in your application.
-    /// </summary>
+    /// <inheritdoc cref="IStreamChatLowLevelClient"/>
     public class StreamChatLowLevelClient : IStreamChatLowLevelClient
     {
         public const string MenuPrefix = "Stream/";
diff --git a/Assets/Plugins/StreamChat/Core/LowLevelClient/WSEventType.cs b/Assets/Plugins/StreamChat/Core/LowLevelClient/WSEventType.cs
@@ -1,4 +1,4 @@
-﻿namespace StreamChat.Core
+﻿namespace StreamChat.Core.LowLevelClient
 {
     /// <summary>
     /// Event types that can be received from WebSocket connection
diff --git a/Assets/Plugins/StreamChat/Core/LowLevelClient/WSEventType.cs.meta b/Assets/Plugins/StreamChat/Core/LowLevelClient/WSEventType.cs.meta
diff --git a/Assets/Plugins/StreamChat/Core/Models/OperationType.cs b/Assets/Plugins/StreamChat/Core/Models/OperationType.cs
@@ -1,5 +1,8 @@
 ﻿namespace StreamChat.Core.Models
 {
+    /// <summary>
+    /// Type of operation for the members changed event
+    /// </summary>
     public enum OperationType
     {
         Added,
diff --git a/Assets/Plugins/StreamChat/Core/StreamChatClient.cs b/Assets/Plugins/StreamChat/Core/StreamChatClient.cs
@@ -66,6 +66,7 @@ namespace StreamChat.Core
     /// </summary>
     public delegate void ChannelMemberRemovedHandler(IStreamChannel channel, IStreamChannelMember member);
 
+    /// <inheritdoc cref="IStreamChatClient"/>
     public sealed class StreamChatClient : IStreamChatClient
     {
         public event ConnectionMadeHandler Connected;
diff --git a/Assets/Plugins/StreamChat/Core/WSEventType.cs.meta b/Assets/Plugins/StreamChat/Core/WSEventType.cs.meta
diff --git a/Assets/Plugins/StreamChat/Readme.txt b/Assets/Plugins/StreamChat/Readme.txt
@@ -11,9 +11,9 @@ Documentation:
 https://getstream.io/chat/docs/unity/?language=unity
 
 Plugin directory structure:
-- *Config - sample config
 - Core - the main logic of the Stream Chat SDK
-- Libs - dependencies of Stream Chat SDK, SDK depends on interfaces so you can provide you're own implementation
+- *Editor Tools - Editor helpers tools (e.g. top menu option to enable debug mode)
+- Libs - libraries that the Stream Chat SDK is using, Core module depends on interfaces, so you can provide you're own implementation for Websocket, logging, http client, etc. if you'd need to
 - *SampleProject - example project
 - *Samples - code sample for example scenarios
 - *Tests - unit & integration tests
diff --git a/Assets/Plugins/StreamChat/Samples/ClientAndUsersCodeSamples.cs b/Assets/Plugins/StreamChat/Samples/ClientAndUsersCodeSamples.cs
@@ -6,7 +6,6 @@
 using StreamChat.Core.QueryBuilders.Filters.Users;
 using StreamChat.Core.QueryBuilders.Sort;
 using StreamChat.Core.Requests;
-using StreamChat.Core.StatefulModels;
 using StreamChat.Libs.Auth;
 using UnityEngine;
 
diff --git a/Assets/Plugins/StreamChat/Samples/LowLevelClient/ClientDocs/ModerationApiCodeSamples.cs b/Assets/Plugins/StreamChat/Samples/LowLevelClient/ClientDocs/ModerationApiCodeSamples.cs
@@ -38,8 +38,7 @@ await _lowLevelClient.ChannelApi.GetOrCreateChannelAsync("channel-type", "channe
             var banRequest = new BanRequest
             {
                 TargetUserId = "user-to-ban-id",
-                Id = channel.Id,
-                Type = channel.Type,
+                ChannelCid = channel.Cid,
                 Timeout = 60,
                 Reason = "Toxic behaviour towards other users"
             };
@@ -58,8 +57,7 @@ await _lowLevelClient.ChannelApi.GetOrCreateChannelAsync("channel-type", "channe
             var banRequest = new BanRequest
             {
                 TargetUserId = "user-to-ban-id",
-                Id = channel.Id,
-                Type = channel.Type,
+                ChannelCid = channel.Cid,
                 Reason = "Toxic behaviour towards other users",
             };
 
@@ -77,8 +75,7 @@ await _lowLevelClient.ChannelApi.GetOrCreateChannelAsync("channel-type", "channe
             var banRequest = new BanRequest
             {
                 TargetUserId = "user-to-ban-id",
-                Id = channel.Id,
-                Type = channel.Type,
+                ChannelCid = channel.Cid,
                 Timeout = 24 * 60,
                 Reason = "Toxic behaviour towards other users",
                 IpBan = true,
@@ -115,8 +112,7 @@ await _lowLevelClient.ChannelApi.GetOrCreateChannelAsync("channel-type", "channe
             var banRequest = new ShadowBanRequest
             {
                 TargetUserId = "user-to-ban-id",
-                Id = channel.Id,
-                Type = channel.Type,
+                ChannelCid = channel.Cid,
                 Timeout = 60 * 24,
                 Reason = "Toxic behaviour towards other users"
             };
@@ -152,8 +148,7 @@ await _lowLevelClient.ChannelApi.GetOrCreateChannelAsync("channel-type", "channe
             var shadowBanRequest = new ShadowBanRequest
             {
                 TargetUserId = "user-to-ban-id",
-                Id = channel.Id,
-                Type = channel.Type,
+                ChannelCid = channel.Cid,
                 Timeout = 24 * 60,
                 Reason = "Toxic behaviour towards other users",
             };
@@ -189,7 +184,8 @@ await _lowLevelClient.ChannelApi.GetOrCreateChannelAsync("channel-type", "channe
                 }
             };
 
-            var queryBannedUsersResponse = await _lowLevelClient.ModerationApi.QueryBannedUsersAsync(queryBannedUsersRequest);
+            var queryBannedUsersResponse
+                = await _lowLevelClient.ModerationApi.QueryBannedUsersAsync(queryBannedUsersRequest);
         }
 
         public async Task FlagMessage()
@@ -222,7 +218,8 @@ await _lowLevelClient.ChannelApi.GetOrCreateChannelAsync("channel-type", "channe
                 }
             };
 
-            var queryMessageFlagsResponse = await _lowLevelClient.ModerationApi.QueryMessageFlagsAsync(queryMessageFlagsRequest);
+            var queryMessageFlagsResponse
+                = await _lowLevelClient.ModerationApi.QueryMessageFlagsAsync(queryMessageFlagsRequest);
         }
 
         private IStreamChatLowLevelClient _lowLevelClient;
diff --git a/Assets/Plugins/StreamChat/StreamChatClientExample.cs b/Assets/Plugins/StreamChat/StreamChatClientExample.cs
@@ -1,9 +1,8 @@
-using StreamChat.Core;
 using StreamChat.Core.StatefulModels;
 using StreamChat.Libs.Utils;
 using UnityEngine;
 
-namespace StreamChat
+namespace StreamChat.Core
 {
     /// <summary>
     /// Example showing how to create instance of <see cref="IStreamChatClient"/>
diff --git a/Assets/Plugins/StreamChat/Tests/LowLevelClient/Integration/MessagesApiIntegrationTests.cs b/Assets/Plugins/StreamChat/Tests/LowLevelClient/Integration/MessagesApiIntegrationTests.cs
@@ -174,7 +174,6 @@ public IEnumerator UploadFile()
         {
             yield return LowLevelClient.WaitForClientToConnect();
 
-            //var filename = "pexels-rulo-davila-5380467.mp4"; //32MB
             var filename = "SampleVideo_1280x720_1mb.mp4"; //1MB
             
             // LoadAssetAtPath expects forward slashes
@@ -292,7 +291,6 @@ public IEnumerator DeleteFile()
         {
             yield return LowLevelClient.WaitForClientToConnect();
 
-            //var filename = "pexels-rulo-davila-5380467.mp4"; //32MB
             var filename = "SampleVideo_1280x720_1mb.mp4"; //1MB
             // LoadAssetAtPath expects forward slashes
             var videoFilePath = "Assets/Plugins/StreamChat/Tests/SampleFiles/" + filename;
diff --git a/Assets/Plugins/StreamChat/Tests/LowLevelClient/Integration/ModerationApiIntegrationTests.cs b/Assets/Plugins/StreamChat/Tests/LowLevelClient/Integration/ModerationApiIntegrationTests.cs
@@ -80,8 +80,7 @@ public IEnumerator Ban_user()
             var banRequest = new BanRequest
             {
                 TargetUserId = SecondUserId,
-                Id = channelState.Channel.Id,
-                Type = channelType,
+                ChannelCid = channelState.Channel.Cid,
                 Timeout = BanTimeout
             };
 
@@ -131,8 +130,7 @@ public IEnumerator Unban_user()
             var banRequest = new BanRequest
             {
                 TargetUserId = SecondUserId,
-                Id = channelState.Channel.Id,
-                Type = channelType,
+                ChannelCid = channelState.Channel.Cid,
                 Timeout = BanTimeout
             };
 
@@ -263,7 +261,8 @@ private async Task When_messages_flagged_expect_query_flagged_messages_return_th
             };
 
             var messageResponse2 = await
-                LowLevelClient.MessageApi.SendNewMessageAsync(channelType, channelState.Channel.Id, sendMessageRequest2);
+                LowLevelClient.MessageApi.SendNewMessageAsync(channelType, channelState.Channel.Id,
+                    sendMessageRequest2);
 
             //Flag messages
 
@@ -289,7 +288,8 @@ private async Task When_messages_flagged_expect_query_flagged_messages_return_th
                 }
             };
 
-            var flagsQueryResponse = await LowLevelClient.ModerationApi.QueryMessageFlagsAsync(queryMessageFlagsRequest);
+            var flagsQueryResponse
+                = await LowLevelClient.ModerationApi.QueryMessageFlagsAsync(queryMessageFlagsRequest);
 
             var message1 = flagsQueryResponse.Flags.FirstOrDefault(_ => _.Message.Id == messageResponse.Message.Id);
             var message2 = flagsQueryResponse.Flags.FirstOrDefault(_ => _.Message.Id == messageResponse2.Message.Id);
@@ -310,10 +310,10 @@ private async Task When_user_flagged_expect_response_target_user_id_match_Async(
         {
             const string channelType = "messaging";
             var channelState = await CreateTempUniqueChannelAsync(channelType, new ChannelGetOrCreateRequest());
-            
+
             var response = await LowLevelClient.ModerationApi.FlagUserAsync(SecondUserId);
             Assert.AreEqual(SecondUserId, response.Flag.TargetUser.Id);
-        } 
+        }
     }
 }
 #endif
diff --git a/Assets/Plugins/StreamChat/Tests/SampleFiles/pexels-rulo-davila-5380467.mp4 b/Assets/Plugins/StreamChat/Tests/SampleFiles/pexels-rulo-davila-5380467.mp4
diff --git a/Assets/Plugins/StreamChat/Tests/SampleFiles/pexels-rulo-davila-5380467.mp4.meta b/Assets/Plugins/StreamChat/Tests/SampleFiles/pexels-rulo-davila-5380467.mp4.meta

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,6 @@`
`5`	`5`	`using StreamChat.Core.LowLevelClient.API.Internal;`
`6`	`6`	`using StreamChat.Core.LowLevelClient.Requests;`
`7`	`7`	`using StreamChat.Core.LowLevelClient.Responses;`
`8`		`-using StreamChat.Core.Responses;`
`9`	`8`
`10`	`9`	`namespace StreamChat.Core.LowLevelClient.API`
`11`	`10`	`{`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace StreamChat.Core.LowLevelClient.Models`
`4`	`4`	`{`
`5`		`- public struct MessageType : System.IEquatable<MessageType>,`
	`5`	`+ public readonly struct MessageType : System.IEquatable<MessageType>,`
`6`	`6`	`ILoadableFrom<MessageTypeInternalDTO, MessageType>,`
`7`	`7`	`ISavableTo<MessageTypeInternalDTO>`
`8`	`8`	`{`
Original file line number	Diff line number	Diff line change
`@@ -39,10 +39,7 @@`
`39`	`39`
`40`	`40`	`namespace StreamChat.Core.LowLevelClient`
`41`	`41`	`{`
`42`		`- /// <summary>`
`43`		`- /// Stream Chat Client - maintains WebSockets connection, executes API calls and exposes Stream events to which you can subscribe.`
`44`		`- /// There should be only one instance of this client in your application.`
`45`		`- /// </summary>`
	`42`	`+ /// <inheritdoc cref="IStreamChatLowLevelClient"/>`
`46`	`43`	`public class StreamChatLowLevelClient : IStreamChatLowLevelClient`
`47`	`44`	`{`
`48`	`45`	`public const string MenuPrefix = "Stream/";`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-namespace StreamChat.Core`
	`1`	`+namespace StreamChat.Core.LowLevelClient`
`2`	`2`	`{`
`3`	`3`	`/// <summary>`
`4`	`4`	`/// Event types that can be received from WebSocket connection`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,8 @@`
`1`	`1`	`namespace StreamChat.Core.Models`
`2`	`2`	`{`
	`3`	`+ /// <summary>`
	`4`	`+ /// Type of operation for the members changed event`
	`5`	`+ /// </summary>`
`3`	`6`	`public enum OperationType`
`4`	`7`	`{`
`5`	`8`	`Added,`
Original file line number	Diff line number	Diff line change
`@@ -66,6 +66,7 @@ namespace StreamChat.Core`
`66`	`66`	`/// </summary>`
`67`	`67`	`public delegate void ChannelMemberRemovedHandler(IStreamChannel channel, IStreamChannelMember member);`
`68`	`68`
	`69`	`+ /// <inheritdoc cref="IStreamChatClient"/>`
`69`	`70`	`public sealed class StreamChatClient : IStreamChatClient`
`70`	`71`	`{`
`71`	`72`	`public event ConnectionMadeHandler Connected;`