ParseLiveQueryController initialization

theSlyest · theSlyest · commit 8740db29b1f7 · 2025-06-22T23:20:05.000Z
diff --git a/Parse/Abstractions/Infrastructure/CustomServiceHub.cs b/Parse/Abstractions/Infrastructure/CustomServiceHub.cs
@@ -32,6 +32,8 @@ public abstract class CustomServiceHub : ICustomServiceHub
 
     public virtual IParseCommandRunner CommandRunner => Services.CommandRunner;
 
+    public virtual IWebSocketClient WebSocketClient => Services.WebSocketClient;
+
     public virtual IParseCloudCodeController CloudCodeController => Services.CloudCodeController;
 
     public virtual IParseConfigurationController ConfigurationController => Services.ConfigurationController;
@@ -62,7 +64,7 @@ public abstract class CustomServiceHub : ICustomServiceHub
 
     public virtual IServerConnectionData ServerConnectionData => Services.ServerConnectionData;
 
-    public virtual IServerConnectionData LiveQueryServerConnectionData => Services.ServerConnectionData;
+    public virtual IServerConnectionData LiveQueryServerConnectionData => Services.LiveQueryServerConnectionData;
 
     public virtual IParseDataDecoder Decoder => Services.Decoder;
 
diff --git a/Parse/Abstractions/Infrastructure/IMutableServiceHub.cs b/Parse/Abstractions/Infrastructure/IMutableServiceHub.cs
@@ -19,6 +19,7 @@ namespace Parse.Abstractions.Infrastructure;
 public interface IMutableServiceHub : IServiceHub
 {
     IServerConnectionData ServerConnectionData { set; }
+    IServerConnectionData LiveQueryServerConnectionData { set; }
     IMetadataController MetadataController { set; }
 
     IServiceHubCloner Cloner { set; }
@@ -31,6 +32,7 @@ public interface IMutableServiceHub : IServiceHub
 
     IParseInstallationController InstallationController { set; }
     IParseCommandRunner CommandRunner { set; }
+    IWebSocketClient WebSocketClient { set; }
 
     IParseCloudCodeController CloudCodeController { set; }
     IParseConfigurationController ConfigurationController { set; }
diff --git a/Parse/Abstractions/Infrastructure/IServiceHub.cs b/Parse/Abstractions/Infrastructure/IServiceHub.cs
@@ -40,6 +40,7 @@ public interface IServiceHub
 
     IParseInstallationController InstallationController { get; }
     IParseCommandRunner CommandRunner { get; }
+    IWebSocketClient WebSocketClient { get; }
 
     IParseCloudCodeController CloudCodeController { get; }
     IParseConfigurationController ConfigurationController { get; }
diff --git a/Parse/Infrastructure/Execution/TextWebSocketClient.cs b/Parse/Infrastructure/Execution/TextWebSocketClient.cs
@@ -54,9 +54,12 @@ public async Task OpenAsync(string serverUri, CancellationToken cancellationToke
     {
         _webSocket ??= new ClientWebSocket();
 
+        Debug.WriteLine($"Status: {_webSocket.State.ToString()}");
         if (_webSocket.State != WebSocketState.Open && _webSocket.State != WebSocketState.Connecting)
         {
+            Debug.WriteLine($"Connecting to: {serverUri}");
             await _webSocket.ConnectAsync(new Uri(serverUri), cancellationToken);
+            Debug.WriteLine($"Status: {_webSocket.State.ToString()}");
             StartListening(cancellationToken);
         }
     }
@@ -138,7 +141,11 @@ private void StartListening(CancellationToken cancellationToken)
     /// </returns>
     public async Task SendAsync(string message, CancellationToken cancellationToken = default)
     {
+        Debug.WriteLine($"Sending: {message}");
         if (_webSocket is not null && _webSocket.State == WebSocketState.Open)
+        {
             await _webSocket.SendAsync(Encoding.UTF8.GetBytes(message), WebSocketMessageType.Text, true, cancellationToken);
+            Console.WriteLine("Sent");
+        }
     }
 }
diff --git a/Parse/Infrastructure/LateInitializedMutableServiceHub.cs b/Parse/Infrastructure/LateInitializedMutableServiceHub.cs
@@ -48,12 +48,6 @@ public IWebClient WebClient
         set => LateInitializer.SetValue(value);
     }
 
-    public IWebSocketClient WebSocketClient
-    {
-        get => LateInitializer.GetValue<IWebSocketClient>(() => new TextWebSocketClient { });
-        set => LateInitializer.SetValue(value);
-    }
-
     public ICacheController CacheController
     {
         get => LateInitializer.GetValue<ICacheController>(() => new CacheController { });
@@ -78,6 +72,12 @@ 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));
diff --git a/Parse/Infrastructure/MutableServiceHub.cs b/Parse/Infrastructure/MutableServiceHub.cs
@@ -20,6 +20,7 @@
 using Parse.Platform.Configuration;
 using Parse.Platform.Files;
 using Parse.Platform.Installations;
+using Parse.Platform.LiveQueries;
 using Parse.Platform.Objects;
 using Parse.Platform.Push;
 using Parse.Platform.Queries;
@@ -48,6 +49,7 @@ public class MutableServiceHub : IMutableServiceHub
 
     public IParseInstallationController InstallationController { get; set; }
     public IParseCommandRunner CommandRunner { get; set; }
+    public IWebSocketClient WebSocketClient { get; set; }
 
     public IParseCloudCodeController CloudCodeController { get; set; }
     public IParseConfigurationController ConfigurationController { get; set; }
@@ -68,9 +70,10 @@ public class MutableServiceHub : IMutableServiceHub
     public IParseCurrentInstallationController CurrentInstallationController { get; set; }
     public IParseInstallationDataFinalizer InstallationDataFinalizer { get; set; }
 
-    public MutableServiceHub SetDefaults(IServerConnectionData connectionData = default)
+    public MutableServiceHub SetDefaults(IServerConnectionData connectionData = default, IServerConnectionData liveQueryConnectionData = default)
     {
         ServerConnectionData ??= connectionData;
+        LiveQueryServerConnectionData ??= liveQueryConnectionData;
         MetadataController ??= new MetadataController
         {
             EnvironmentData = EnvironmentData.Inferred,
@@ -87,12 +90,14 @@ public MutableServiceHub SetDefaults(IServerConnectionData connectionData = defa
 
         InstallationController ??= new ParseInstallationController(CacheController);
         CommandRunner ??= new ParseCommandRunner(WebClient, InstallationController, MetadataController, ServerConnectionData, new Lazy<IParseUserController>(() => UserController));
+        WebSocketClient ??= new TextWebSocketClient { };
 
         CloudCodeController ??= new ParseCloudCodeController(CommandRunner, Decoder);
         ConfigurationController ??= new ParseConfigurationController(CommandRunner, CacheController, Decoder);
         FileController ??= new ParseFileController(CommandRunner);
         ObjectController ??= new ParseObjectController(CommandRunner, Decoder, ServerConnectionData);
         QueryController ??= new ParseQueryController(CommandRunner, Decoder);
+        LiveQueryController ??= new ParseLiveQueryController(WebSocketClient);
         SessionController ??= new ParseSessionController(CommandRunner, Decoder);
         UserController ??= new ParseUserController(CommandRunner, Decoder);
         CurrentUserController ??= new ParseCurrentUserController(CacheController, ClassController, Decoder);
diff --git a/Parse/Infrastructure/OrchestrationServiceHub.cs b/Parse/Infrastructure/OrchestrationServiceHub.cs
@@ -34,6 +34,7 @@ public class OrchestrationServiceHub : IServiceHub
     public IParseInstallationController InstallationController => Custom.InstallationController ?? Default.InstallationController;
 
     public IParseCommandRunner CommandRunner => Custom.CommandRunner ?? Default.CommandRunner;
+    public IWebSocketClient WebSocketClient => Custom.WebSocketClient ?? Default.WebSocketClient;
 
     public IParseCloudCodeController CloudCodeController => Custom.CloudCodeController ?? Default.CloudCodeController;
 
@@ -64,6 +65,7 @@ public class OrchestrationServiceHub : IServiceHub
     public IParseCurrentInstallationController CurrentInstallationController => Custom.CurrentInstallationController ?? Default.CurrentInstallationController;
 
     public IServerConnectionData ServerConnectionData => Custom.ServerConnectionData ?? Default.ServerConnectionData;
+
     public IServerConnectionData LiveQueryServerConnectionData => Custom.LiveQueryServerConnectionData ?? Default.LiveQueryServerConnectionData;
 
     public IParseDataDecoder Decoder => Custom.Decoder ?? Default.Decoder;
diff --git a/Parse/Infrastructure/ServiceHub.cs b/Parse/Infrastructure/ServiceHub.cs
@@ -52,7 +52,6 @@ public class ServiceHub : IServiceHub
 
     public IParseInstallationController InstallationController => LateInitializer.GetValue(() => new ParseInstallationController(CacheController));
     public IParseCommandRunner CommandRunner => LateInitializer.GetValue(() => new ParseCommandRunner(WebClient, InstallationController, MetadataController, ServerConnectionData, new Lazy<IParseUserController>(() => UserController)));
-
     public IWebSocketClient WebSocketClient => LateInitializer.GetValue(() => new TextWebSocketClient { });
 
     public IParseCloudCodeController CloudCodeController => LateInitializer.GetValue(() => new ParseCloudCodeController(CommandRunner, Decoder));
diff --git a/Parse/Platform/LiveQueries/ParseLiveQueryController.cs b/Parse/Platform/LiveQueries/ParseLiveQueryController.cs
@@ -88,8 +88,17 @@ public enum ParseLiveQueryState
 
     private IDictionary<int, ParseLiveQuerySubscription> Subscriptions { get; set; } = new Dictionary<int, ParseLiveQuerySubscription> { };
 
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ParseLiveQueryController"/> class.
+    /// </summary>
+    /// <param name="webSocketClient">
+    /// The <see cref="IWebSocketClient"/> implementation to use for the live query connection.
+    /// </param>
+    /// <remarks>
+    /// This constructor is used to initialize a new instance of the <see cref="ParseLiveQueryController"/> class
     public ParseLiveQueryController(IWebSocketClient webSocketClient)
     {
+        Debug.WriteLine("ParseLiveQueryController initialized.");
         WebSocketClient = webSocketClient;
         State = ParseLiveQueryState.Closed;
     }
@@ -99,7 +108,7 @@ private void ProcessMessage(IDictionary<string, object> message)
         int requestId;
         string clientId;
         ParseLiveQuerySubscription subscription;
-        switch (message["op"])
+        switch (message["op"] as string)
         {
             case "connected":
                 State = ParseLiveQueryState.Connected;
@@ -134,17 +143,10 @@ private void ProcessMessage(IDictionary<string, object> message)
                 break;
 
             case "error":
-                if ((bool)message["reconnect"])
-                {
-                    ConnectAsync();
-                }
-
-                ParseLiveQueryErrorEventArgs errorArgs = new ParseLiveQueryErrorEventArgs
-                {
-                    Error = message["error"] as string,
-                    Code = Convert.ToInt32(message["code"]),
-                    Reconnected = (bool)message["reconnect"]
-                };
+                ParseLiveQueryErrorEventArgs errorArgs = new ParseLiveQueryErrorEventArgs(
+                    Convert.ToInt32(message["code"]),
+                    message["error"] as string,
+                    (bool) message["reconnect"]);
                 Error?.Invoke(this, errorArgs);
                 break;
 
@@ -155,10 +157,7 @@ private void ProcessMessage(IDictionary<string, object> message)
                     requestId = Convert.ToInt32(message["requestId"]);
                     if (Subscriptions.TryGetValue(requestId, out subscription))
                     {
-                        ParseLiveQueryEventArgs args = new ParseLiveQueryEventArgs()
-                        {
-                            Object = message["object"]
-                        };
+                        ParseLiveQueryEventArgs args = new ParseLiveQueryEventArgs(message["object"]);
                         subscription.OnCreate(args);
                     }
                 }
@@ -171,11 +170,9 @@ private void ProcessMessage(IDictionary<string, object> message)
                     requestId = Convert.ToInt32(message["requestId"]);
                     if (Subscriptions.TryGetValue(requestId, out subscription))
                     {
-                        ParseLiveQueryEventArgs args = new ParseLiveQueryEventArgs()
-                        {
-                            Object = message["object"],
-                            Original = message["original"]
-                        };
+                        ParseLiveQueryEventArgs args = new ParseLiveQueryEventArgs(
+                            message["object"],
+                            message["original"]);
                         subscription.OnEnter(args);
                     }
                 }
@@ -188,11 +185,9 @@ private void ProcessMessage(IDictionary<string, object> message)
                     requestId = Convert.ToInt32(message["requestId"]);
                     if (Subscriptions.TryGetValue(requestId, out subscription))
                     {
-                        ParseLiveQueryEventArgs args = new ParseLiveQueryEventArgs()
-                        {
-                            Object = message["object"],
-                            Original = message["original"]
-                        };
+                        ParseLiveQueryEventArgs args = new ParseLiveQueryEventArgs(
+                            message["object"],
+                            message["original"]);
                         subscription.OnUpdate(args);
                     }
                 }
@@ -205,11 +200,9 @@ private void ProcessMessage(IDictionary<string, object> message)
                     requestId = Convert.ToInt32(message["requestId"]);
                     if (Subscriptions.TryGetValue(requestId, out subscription))
                     {
-                        ParseLiveQueryEventArgs args = new ParseLiveQueryEventArgs()
-                        {
-                            Object = message["object"],
-                            Original = message["original"]
-                        };
+                        ParseLiveQueryEventArgs args = new ParseLiveQueryEventArgs(
+                            message["object"],
+                            message["original"]);
                         subscription.OnLeave(args);
                     }
                 }
@@ -222,10 +215,7 @@ private void ProcessMessage(IDictionary<string, object> message)
                     requestId = Convert.ToInt32(message["requestId"]);
                     if (Subscriptions.TryGetValue(requestId, out subscription))
                     {
-                        ParseLiveQueryEventArgs args = new ParseLiveQueryEventArgs()
-                        {
-                            Object = message["object"],
-                        };
+                        ParseLiveQueryEventArgs args = new ParseLiveQueryEventArgs(message["object"]);
                         subscription.OnDelete(args);
                     }
                 }
@@ -291,7 +281,7 @@ public async Task ConnectAsync(CancellationToken cancellationToken = default)
             {
                 { "op", "connect" },
                 { "applicationId", ParseClient.Instance.Services.LiveQueryServerConnectionData.ApplicationID },
-                { "clientKey", ParseClient.Instance.Services.LiveQueryServerConnectionData.Key }
+                { "windowsKey", ParseClient.Instance.Services.LiveQueryServerConnectionData.Key }
             };
             await SendMessage(message, cancellationToken);
             ConnectionSignal = new CancellationTokenSource();
diff --git a/Parse/Platform/LiveQueries/ParseLiveQueryErrorEventArgs.cs b/Parse/Platform/LiveQueries/ParseLiveQueryErrorEventArgs.cs
@@ -2,9 +2,50 @@
 
 namespace Parse.Platform.LiveQueries;
 
+/// <summary>
+/// Represents the arguments for an error event that occurs during a live query in the Parse platform.
+/// </summary>
 public class ParseLiveQueryErrorEventArgs : EventArgs
 {
-    public string Error { get; set; }
-    public int Code { get; set; }
-    public bool Reconnected { get; set; }
+    /// <summary>
+    /// Represents the arguments for an error event that occurs during a live query in the Parse platform.
+    /// </summary>
+    internal ParseLiveQueryErrorEventArgs(int code, string error, bool reconnect)
+    {
+        Error = error;
+        Code = code;
+        Reconnect = reconnect;
+    }
+
+    /// <summary>
+    /// Gets or sets the error message associated with a live query operation.
+    /// </summary>
+    /// <remarks>
+    /// The <see cref="Error"/> property contains a description of the error that occurred during
+    /// a live query operation. It can provide detailed information about the nature of the issue,
+    /// which can be helpful for debugging or logging purposes.
+    /// </remarks>
+    public string Error { get; private set; }
+
+    /// <summary>
+    /// Gets or sets the error code associated with a live query operation.
+    /// </summary>
+    /// <remarks>
+    /// The <see cref="Code"/> property contains a numerical identifier that represents
+    /// the type or category of the error that occurred during a live query operation.
+    /// This is used alongside the error message to provide detailed diagnostics or logging.
+    /// </remarks>
+    public int Code { get; private set; }
+
+    /// <summary>
+    /// Gets or sets a value indicating whether the client should attempt to reconnect
+    /// after an error occurs during a live query operation.
+    /// </summary>
+    /// <remarks>
+    /// The <see cref="Reconnect"/> property specifies whether a reconnection to the
+    /// live query server is recommended or required following certain error events.
+    /// This can be used to determine the client's behavior in maintaining a continuous
+    /// connection with the server.
+    /// </remarks>
+    public bool Reconnect { get; private set; }
 }
diff --git a/Parse/Platform/LiveQueries/ParseLiveQueryEventArgs.cs b/Parse/Platform/LiveQueries/ParseLiveQueryEventArgs.cs
@@ -9,6 +9,31 @@ namespace Parse.Platform.LiveQueries;
 /// </summary>
 public class ParseLiveQueryEventArgs : EventArgs
 {
-    public object Object { get; set; }
-    public object Original { get; set; }
+    /// <summary>
+    /// Event arguments for events triggered by Parse's Live Query service.
+    /// </summary>
+    /// <remarks>
+    /// This class handles the encapsulation of event-related details for Live Query operations,
+    /// such as the current Parse object state and the original state before updates.
+    /// </remarks>
+    internal ParseLiveQueryEventArgs(object current, object original = null)
+    {
+        Object = current;
+        Original = original;
+    }
+
+    /// <summary>
+    /// Gets the associated object involved in the live query event.
+    /// This property provides the current state of the Parse object
+    /// that triggered the event. The object may vary depending on the live query event
+    /// type, such as create, update, enter, or leave.
+    /// </summary>
+    public object Object { get; private set; }
+
+    /// <summary>
+    /// Gets the original state of the Parse object before the live query event occurred.
+    /// This property holds the state of the object as it was prior to the event that
+    /// triggered the live query event, such as an update or leave operation.
+    /// </summary>
+    public object Original { get; private set; }
 }
diff --git a/Parse/Platform/ParseClient.cs b/Parse/Platform/ParseClient.cs
@@ -150,7 +150,7 @@ public ParseClient(IServerConnectionData configuration, IServerConnectionData li
         {
             Services = serviceHub switch
             {
-                IMutableServiceHub { } mutableServiceHub => BuildHub((Hub: mutableServiceHub, mutableServiceHub.ServerConnectionData = serviceHub.ServerConnectionData ?? Services.ServerConnectionData).Hub, Services, configurators),
+                IMutableServiceHub { } mutableServiceHub => BuildHub((Hub: mutableServiceHub, mutableServiceHub.ServerConnectionData = serviceHub.ServerConnectionData ?? Services.ServerConnectionData, mutableServiceHub.LiveQueryServerConnectionData = serviceHub.LiveQueryServerConnectionData ?? Services.LiveQueryServerConnectionData).Hub, Services, configurators),
                 { } => BuildHub(default, Services, configurators)
             };
         }
diff --git a/Parse/Platform/Queries/ParseQueryController.cs b/Parse/Platform/Queries/ParseQueryController.cs
@@ -24,6 +24,7 @@ internal class ParseQueryController : IParseQueryController
 
     public ParseQueryController(IParseCommandRunner commandRunner, IParseDataDecoder decoder)
     {
+        Debug.WriteLine("ParseQueryController initialized");
         CommandRunner = commandRunner;
         Decoder = decoder;
     }

Original file line number	Diff line number	Diff line change
`@@ -54,9 +54,12 @@ public async Task OpenAsync(string serverUri, CancellationToken cancellationToke`
`54`	`54`	`{`
`55`	`55`	`_webSocket ??= new ClientWebSocket();`
`56`	`56`
	`57`	`+ Debug.WriteLine($"Status: {_webSocket.State.ToString()}");`
`57`	`58`	`if (_webSocket.State != WebSocketState.Open && _webSocket.State != WebSocketState.Connecting)`
`58`	`59`	`{`
	`60`	`+ Debug.WriteLine($"Connecting to: {serverUri}");`
`59`	`61`	`await _webSocket.ConnectAsync(new Uri(serverUri), cancellationToken);`
	`62`	`+ Debug.WriteLine($"Status: {_webSocket.State.ToString()}");`
`60`	`63`	`StartListening(cancellationToken);`
`61`	`64`	`}`
`62`	`65`	`}`
`@@ -138,7 +141,11 @@ private void StartListening(CancellationToken cancellationToken)`
`138`	`141`	`/// </returns>`
`139`	`142`	`public async Task SendAsync(string message, CancellationToken cancellationToken = default)`
`140`	`143`	`{`
	`144`	`+ Debug.WriteLine($"Sending: {message}");`
`141`	`145`	`if (_webSocket is not null && _webSocket.State == WebSocketState.Open)`
	`146`	`+ {`
`142`	`147`	`await _webSocket.SendAsync(Encoding.UTF8.GetBytes(message), WebSocketMessageType.Text, true, cancellationToken);`
	`148`	`+ Console.WriteLine("Sent");`
	`149`	`+ }`
`143`	`150`	`}`
`144`	`151`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,12 +48,6 @@ public IWebClient WebClient`
`48`	`48`	`set => LateInitializer.SetValue(value);`
`49`	`49`	`}`
`50`	`50`
`51`		`- public IWebSocketClient WebSocketClient`
`52`		`- {`
`53`		`- get => LateInitializer.GetValue<IWebSocketClient>(() => new TextWebSocketClient { });`
`54`		`- set => LateInitializer.SetValue(value);`
`55`		`- }`
`56`		`-`
`57`	`51`	`public ICacheController CacheController`
`58`	`52`	`{`
`59`	`53`	`get => LateInitializer.GetValue<ICacheController>(() => new CacheController { });`
`@@ -78,6 +72,12 @@ public IParseCommandRunner CommandRunner`
`78`	`72`	`set => LateInitializer.SetValue(value);`
`79`	`73`	`}`
`80`	`74`
	`75`	`+ public IWebSocketClient WebSocketClient`
	`76`	`+ {`
	`77`	`+ get => LateInitializer.GetValue<IWebSocketClient>(() => new TextWebSocketClient { });`
	`78`	`+ set => LateInitializer.SetValue(value);`
	`79`	`+ }`
	`80`	`+`
`81`	`81`	`public IParseCloudCodeController CloudCodeController`
`82`	`82`	`{`
`83`	`83`	`get => LateInitializer.GetValue<IParseCloudCodeController>(() => new ParseCloudCodeController(CommandRunner, Decoder));`