Move TimeOut and BufferSize to new LiveQueryServerConnectionData and many improvements

Author: theSlyest

Parse.sln

@@ -17,8 +17,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Parse.Tests", "Parse.Tests\Parse.Tests.csproj", "{FEB46D0F-384C-4F27-9E0E-F4A636768C90}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ParseApp", "ParseApp\ParseApp.csproj", "{71EF1783-2BAA-4119-A666-B7DCA3FD3085}"
-EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -33,10 +31,6 @@ Global
 		{FEB46D0F-384C-4F27-9E0E-F4A636768C90}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{FEB46D0F-384C-4F27-9E0E-F4A636768C90}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{FEB46D0F-384C-4F27-9E0E-F4A636768C90}.Release|Any CPU.Build.0 = Release|Any CPU
-		{71EF1783-2BAA-4119-A666-B7DCA3FD3085}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{71EF1783-2BAA-4119-A666-B7DCA3FD3085}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{71EF1783-2BAA-4119-A666-B7DCA3FD3085}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{71EF1783-2BAA-4119-A666-B7DCA3FD3085}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

Parse/Abstractions/Infrastructure/CustomServiceHub.cs

@@ -64,7 +64,7 @@ public abstract class CustomServiceHub : ICustomServiceHub
 
     public virtual IServerConnectionData ServerConnectionData => Services.ServerConnectionData;
 
-    public virtual IServerConnectionData LiveQueryServerConnectionData => Services.LiveQueryServerConnectionData;
+    public virtual ILiveQueryServerConnectionData LiveQueryServerConnectionData => Services.LiveQueryServerConnectionData;
 
     public virtual IParseDataDecoder Decoder => Services.Decoder;
 

Parse/Abstractions/Infrastructure/ILiveQueryServerConnectionData.cs

@@ -0,0 +1,25 @@
+namespace Parse.Abstractions.Infrastructure;
+
+public interface ILiveQueryServerConnectionData : IServerConnectionData
+{
+    /// <summary>
+    /// Represents the default timeout duration, in milliseconds.
+    /// </summary>
+    public const int DefaultTimeOut = 5000; // 5 seconds
+
+    /// <summary>
+    /// The timeout duration, in milliseconds, used for various operations, such as
+    /// establishing a connection or completing a subscription.
+    /// </summary>
+    int TimeOut { get; set; }
+
+    /// <summary>
+    /// The default buffer size, in bytes.
+    /// </summary>
+    public const int DefaultBufferSize = 4096; // 4MB
+
+    /// <summary>
+    /// The buffer size, in bytes, used for the WebSocket operations to handle incoming messages.
+    /// </summary>
+    int MessageBufferSize { get; set; }
+}

Parse/Abstractions/Infrastructure/IMutableServiceHub.cs

@@ -19,7 +19,7 @@ namespace Parse.Abstractions.Infrastructure;
 public interface IMutableServiceHub : IServiceHub
 {
     IServerConnectionData ServerConnectionData { set; }
-    IServerConnectionData LiveQueryServerConnectionData { set; }
+    ILiveQueryServerConnectionData LiveQueryServerConnectionData { set; }
     IMetadataController MetadataController { set; }
 
     IServiceHubCloner Cloner { set; }

Parse/Abstractions/Infrastructure/IServiceHub.cs

@@ -27,7 +27,7 @@ public interface IServiceHub
     /// The current server connection data that the Parse SDK has been initialized with.
     /// </summary>
     IServerConnectionData ServerConnectionData { get; }
-    IServerConnectionData LiveQueryServerConnectionData { get; }
+    ILiveQueryServerConnectionData LiveQueryServerConnectionData { get; }
     IMetadataController MetadataController { get; }
 
     IServiceHubCloner Cloner { get; }

Parse/Abstractions/Platform/LiveQueries/IParseLiveQueryController.cs

@@ -11,18 +11,6 @@ namespace Parse.Abstractions.Platform.LiveQueries;
 /// </summary>
 public interface IParseLiveQueryController
 {
-    /// <summary>
-    /// Gets or sets the timeout duration, in milliseconds, for operations performed by the LiveQuery controller.
-    /// </summary>
-    /// <remarks>
-    /// This property determines the maximum time the system will wait for an operation to complete
-    /// before timing out. It is particularly relevant to tasks such as establishing a connection
-    /// to the LiveQuery server or awaiting responses for subscription or query update requests.
-    /// Developers can use this property to configure timeouts based on the expected network
-    /// and performance conditions of the application environment.
-    /// </remarks>
-    public int TimeOut { get; set; }
-
     /// <summary>
     /// Event triggered when an error occurs during the operation of the ParseLiveQueryController.
     /// </summary>

Parse/Abstractions/Platform/LiveQueries/IParseLiveQuerySubscription.cs

@@ -6,11 +6,6 @@
 
 namespace Parse.Abstractions.Platform.LiveQueries;
 
-/// <summary>
-/// Represents a live query subscription that is used with Parse's Live Query service.
-/// It allows real-time monitoring and event handling for object changes that match
-/// a specified query.
-/// </summary>
 public interface IParseLiveQuerySubscription
 {
     /// <summary>

Parse/Infrastructure/Execution/TextWebSocketClient.cs

@@ -12,7 +12,7 @@ namespace Parse.Infrastructure.Execution;
 /// Represents a WebSocket client that allows connecting to a WebSocket server, sending messages, and receiving messages.
 /// Implements the <c>IWebSocketClient</c> interface for WebSocket operations.
 /// </summary>
-class TextWebSocketClient : IWebSocketClient
+class TextWebSocketClient(int bufferSize) : IWebSocketClient
 {
     /// <summary>
     /// A private instance of the ClientWebSocket class used to manage the WebSocket connection.
@@ -43,6 +43,8 @@ class TextWebSocketClient : IWebSocketClient
 
     private readonly object connectionLock = new object();
 
+    private int BufferSize { get; } = bufferSize;
+
     /// <summary>
     /// Opens a WebSocket connection to the specified server URI and starts listening for messages.
     /// If the connection is already open or in a connecting state, this method does nothing.
@@ -54,14 +56,19 @@ class TextWebSocketClient : IWebSocketClient
     /// </returns>
     public async Task OpenAsync(string serverUri, CancellationToken cancellationToken = default)
     {
+        ClientWebSocket webSocketToConnect = null;
         lock (connectionLock)
         {
             webSocket ??= new ClientWebSocket();
+            if (webSocket.State != WebSocketState.Open && webSocket.State != WebSocketState.Connecting)
+            {
+                webSocketToConnect = webSocket;
+            }
         }
 
-        if (webSocket.State != WebSocketState.Open && webSocket.State != WebSocketState.Connecting)
+        if (webSocketToConnect is not null)
         {
-            await webSocket.ConnectAsync(new Uri(serverUri), cancellationToken);
+            await webSocketToConnect.ConnectAsync(new Uri(serverUri), cancellationToken);
             StartListening(cancellationToken);
         }
     }
@@ -74,12 +81,17 @@ public async Task OpenAsync(string serverUri, CancellationToken cancellationToke
     /// <returns>
     /// A task representing the asynchronous operation of closing the WebSocket connection.
     /// </returns>
-    public async Task CloseAsync(CancellationToken cancellationToken = default) =>
-        await webSocket?.CloseAsync(WebSocketCloseStatus.NormalClosure, String.Empty, cancellationToken)!;
+    public async Task CloseAsync(CancellationToken cancellationToken = default)
+    {
+        if (webSocket is not null)
+        {
+            await webSocket?.CloseAsync(WebSocketCloseStatus.NormalClosure, String.Empty, cancellationToken)!;
+        }
+    }
 
     private async Task ListenForMessages(CancellationToken cancellationToken)
     {
-        byte[] buffer = new byte[1024 * 4];
+        byte[] buffer = new byte[BufferSize];
 
         try
         {
@@ -183,6 +195,10 @@ private void StartListening(CancellationToken cancellationToken)
     public async Task SendAsync(string message, CancellationToken cancellationToken = default)
     {
         ArgumentNullException.ThrowIfNull(webSocket);
+        if (webSocket.State != WebSocketState.Open)
+        {
+            throw new InvalidOperationException($"WebSocket is not in Open state. Current state: {webSocket.State}");
+        }
         await webSocket.SendAsync(Encoding.UTF8.GetBytes(message), WebSocketMessageType.Text, true, cancellationToken);
     }
 }

Parse/Infrastructure/LateInitializedMutableServiceHub.cs

@@ -72,12 +72,6 @@ public IParseCommandRunner CommandRunner
         set => LateInitializer.SetValue(value);
     }
 
-    public IWebSocketClient WebSocketClient
-    {
-        get => LateInitializer.GetValue<IWebSocketClient>(() => new TextWebSocketClient { });
-        set => LateInitializer.SetValue(value);
-    }
-
     public IParseCloudCodeController CloudCodeController
     {
         get => LateInitializer.GetValue<IParseCloudCodeController>(() => new ParseCloudCodeController(CommandRunner, Decoder));
@@ -108,12 +102,6 @@ public IParseQueryController QueryController
         set => LateInitializer.SetValue(value);
     }
 
-    public IParseLiveQueryController LiveQueryController
-    {
-        get => LateInitializer.GetValue<IParseLiveQueryController>(() => new ParseLiveQueryController(WebSocketClient, Decoder));
-        set => LateInitializer.SetValue(value);
-    }
-
     public IParseSessionController SessionController
     {
         get => LateInitializer.GetValue<IParseSessionController>(() => new ParseSessionController(CommandRunner, Decoder));
@@ -174,6 +162,19 @@ public IParseInstallationDataFinalizer InstallationDataFinalizer
         set => LateInitializer.SetValue(value);
     }
 
+
+    public IWebSocketClient WebSocketClient
+    {
+        get => LateInitializer.GetValue<IWebSocketClient>(() => LiveQueryServerConnectionData is null ? null : new TextWebSocketClient(LiveQueryServerConnectionData.MessageBufferSize));
+        set => LateInitializer.SetValue(value);
+    }
+
+    public IParseLiveQueryController LiveQueryController
+    {
+        get => LateInitializer.GetValue<IParseLiveQueryController>(() => LiveQueryServerConnectionData is null ? null : new ParseLiveQueryController(LiveQueryServerConnectionData.TimeOut, WebSocketClient, Decoder));
+        set => LateInitializer.SetValue(value);
+    }
+
     public IServerConnectionData ServerConnectionData { get; set; }
-    public IServerConnectionData LiveQueryServerConnectionData { get; set; }
+    public ILiveQueryServerConnectionData LiveQueryServerConnectionData { get; set; }
 }

Parse/Infrastructure/LiveQueryServerConnectionData.cs

@@ -0,0 +1,50 @@
+using System.Collections.Generic;
+using Parse.Abstractions.Infrastructure;
+
+namespace Parse.Infrastructure;
+
+/// <summary>
+/// Represents the configuration of the Parse Live Query server.
+/// </summary>
+public struct LiveQueryServerConnectionData : ILiveQueryServerConnectionData
+{
+    public LiveQueryServerConnectionData() { }
+
+    internal bool Test { get; set; }
+
+    /// <summary>
+    /// The timeout duration, in milliseconds, used for various operations, such as
+    /// establishing a connection or completing a subscription.
+    /// </summary>
+    public int TimeOut { get; set; } = ILiveQueryServerConnectionData.DefaultTimeOut;
+
+    /// <summary>
+    /// The buffer size, in bytes, used by the WebSocket client for communication operations.
+    /// </summary>
+    public int MessageBufferSize { get; set; } = ILiveQueryServerConnectionData.DefaultBufferSize;
+
+    /// <summary>
+    /// The App ID of your app.
+    /// </summary>
+    public string ApplicationID { get; set; }
+
+    /// <summary>
+    /// A URI pointing to the target Parse Server instance hosting the app targeted by <see cref="ApplicationID"/>.
+    /// </summary>
+    public string ServerURI { get; set; }
+
+    /// <summary>
+    /// The .NET Key for the Parse app targeted by <see cref="ServerURI"/>.
+    /// </summary>
+    public string Key { get; set; }
+
+    /// <summary>
+    /// The Master Key for the Parse app targeted by <see cref="Key"/>.
+    /// </summary>
+    public string MasterKey { get; set; }
+
+    /// <summary>
+    /// Additional HTTP headers to be sent with network requests from the SDK.
+    /// </summary>
+    public IDictionary<string, string> Headers { get; set; }
+}