Skip to content

feat: Add livequery support - #411

Open
theSlyest wants to merge 61 commits into
parse-community:masterfrom
theSlyest:livequery
Open

theSlyest wants to merge 61 commits into
parse-community:masterfrom
theSlyest:livequery

Conversation

@theSlyest

@theSlyest theSlyest commented Jun 25, 2025 •

Copy link
Copy Markdown

Added:

  • ParseLiveQuery class
  • ParseLiveQueryController class
  • ParseLiveQuerySubscription class
  • API ParseQuery.GetLive() for creating a ParseLiveQuery
  • LiveQueryServerConnectionData as a ServerConnectionData field to ParseClient to save live query server info.
  • APIs ConnectLiveQueryServerAsync(...) and DisconnectLiveQueryServerAsync(...) to ObjectServiceExtensions for connecting to and disconnecting respectively from the given parse live query server.
  • Some other smaller classes and interfaces...

Summary by CodeRabbit

  • New Features

    • Added full Live Query support, including real-time subscriptions, updates, cancellations, and object lifecycle events over WebSocket.
    • Added Live Query configuration for connection details, timeouts, and message buffering.
    • Added APIs for creating live queries from Parse queries and connecting or disconnecting from the Live Query server.
    • Added WebSocket communication, message parsing/building, controller, and subscription capabilities.
  • Tests

    • Added extensive coverage for Live Query, WebSocket, service hub, messaging, and related workflows.

@parse-github-assistant

parse-github-assistant Bot commented Jun 25, 2025 •

Copy link
Copy Markdown

🚀 Thanks for opening this pull request!

@coderabbitai

coderabbitai Bot commented Jun 25, 2025 •

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
Walkthrough

Adds Parse Live Query support through new connection contracts, WebSocket transport, message parsing and building, subscription control, service-hub wiring, ParseClient configuration, query integration, extension methods, and tests.

Changes: Live Query support

Layer / File(s) Summary
Live Query contracts and query API
Parse/Abstractions/Platform/LiveQueries/*, Parse/Platform/LiveQueries/ParseLiveQuery.cs, Parse/Platform/Queries/ParseQuery.cs
Adds contracts and public types for Live Query configuration, messages, subscriptions, events, errors, and query conversion through GetLive().
WebSocket transport
Parse/Abstractions/Infrastructure/Execution/IWebSocketClient.cs, Parse/Infrastructure/Execution/*, Parse.Tests/TextWebSocketClientTests.cs
Adds asynchronous WebSocket lifecycle methods, message events, framed-message handling, cancellation, error propagation, disposal, and transport tests.
Live Query controller and subscriptions
Parse/Platform/LiveQueries/ParseLiveQueryController.cs, Parse/Platform/LiveQueries/ParseLiveQuerySubscription.cs
Adds connection state management, protocol routing, request signaling, subscription operations, event dispatch, error handling, and disposal.
Service-hub and client integration
Parse/Infrastructure/*ServiceHub.cs, Parse/Platform/ParseClient.cs, Parse/Utilities/ObjectServiceExtensions.cs
Exposes and initializes Live Query services, accepts Live Query connection data, validates endpoints, and adds connect/disconnect helpers.
Validation and supporting tests
Parse.Tests/*
Adds tests for message parsing and building, subscriptions, service hubs, orchestration, extensions, event arguments, client construction, and related test setup changes.

Estimated code review effort: 5 (Critical) | ~120 minutes

Sequence Diagram(s)

sequenceDiagram
    participant App
    participant ParseQuery
    participant ParseLiveQuery
    participant ParseLiveQueryController
    participant TextWebSocketClient
    participant LiveQueryServer

    App->>ParseQuery: GetLive()
    ParseQuery->>ParseLiveQuery: Create live query
    App->>ParseLiveQuery: SubscribeAsync()
    ParseLiveQuery->>ParseLiveQueryController: SubscribeAsync(liveQuery)
    ParseLiveQueryController->>TextWebSocketClient: Send connect or subscribe message
    TextWebSocketClient->>LiveQueryServer: WebSocket frames
    LiveQueryServer-->>TextWebSocketClient: Live Query event
    TextWebSocketClient-->>ParseLiveQueryController: MessageReceived
    ParseLiveQueryController-->>App: Subscription event
Loading
sequenceDiagram
    participant App
    participant IServiceHub
    participant ParseLiveQueryController
    participant TextWebSocketClient

    App->>IServiceHub: ConnectLiveQueryServerAsync(onError)
    IServiceHub->>ParseLiveQueryController: ConnectAsync()
    ParseLiveQueryController->>TextWebSocketClient: OpenAsync(serverUri)
    ParseLiveQueryController->>TextWebSocketClient: SendAsync(connect message)
    App->>IServiceHub: DisconnectLiveQueryServerAsync()
    IServiceHub->>ParseLiveQueryController: CloseAsync()
    ParseLiveQueryController->>TextWebSocketClient: CloseAsync()
Loading
Merge Risk: Moderate · up to 4eefc

Concurrent subscription operations can fail only after a timeout, and disconnecting an unconfigured client throws unexpectedly. These lifecycle defects should be fixed before merge.

Caution

Pre-merge checks failed

Please resolve all errors before merging. Addressing warnings is optional.

  • Ignore

❌ Failed checks (1 error, 2 warnings)

Check name Status Explanation Resolution
Engage In Review Feedback ❌ Error The PR does not satisfy the required review-engagement process. In PR #411, maintainer mtrezza stated on 2026-02-25: “I notice that you resolved review feedback without comment. Could you please revie… Review every resolved feedback thread. Add a discussion reply before resolving each thread. If the feedback is valid, implement it in a commit and reference that commit. If the feedback is not valid, explain the technical reason and obtain …
Docstring Coverage ⚠️ Warning Docstring coverage is 12.04% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 274 functions across 30 files. Write docstrings for the functions missing them to satisfy the coverage threshold.
Security Check ⚠️ Warning The new WebSocket receive path permits unbounded message growth. TextWebSocketClient.ListenForMessages uses BufferSize only as the per-read buffer, then appends every continuation frame to `Memory… Add a hard maximum WebSocket message size, separate from the receive buffer size, and enforce it before every MemoryStream.Write. Reject and close the connection when the limit is exceeded, dispose the stream, and report a bounded protoco…
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title begins with the allowed feat: prefix, uses capitalization correctly in Add, and accurately describes the Live Query support added by the pull request.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Security Check

Explanation

The new WebSocket receive path permits unbounded message growth. TextWebSocketClient.ListenForMessages uses BufferSize only as the per-read buffer, then appends every continuation frame to MemoryStream until EndOfMessage without a maximum. It copies the full payload again with ToArray() and creates a string before ParseLiveQueryController parses it. A malicious or compromised Live Query endpoint can send an indefinitely fragmented message and exhaust client memory, causing denial of service. This behavior is introduced by TextWebSocketClient.cs; no equivalent Live Query receive path exists in the base revision. The public advisory lookup found no matching advisory for this SDK, but this is a standard unbounded-input resource-exhaustion pattern.

Resolution

Add a hard maximum WebSocket message size, separate from the receive buffer size, and enforce it before every MemoryStream.Write. Reject and close the connection when the limit is exceeded, dispose the stream, and report a bounded protocol error. Avoid the extra full-payload copies where possible. Also add tests for a fragmented message that exceeds the limit and for the configured boundary.

Full details: Engage In Review Feedback

Explanation

The PR does not satisfy the required review-engagement process. In PR #411, maintainer mtrezza stated on 2026-02-25: “I notice that you resolved review feedback without comment. Could you please review these.” The surrounding discussion contains no author response to that warning. The review records also show CodeRabbit feedback marked as addressed by commits such as 1fc8184 through a9ffaa6, while the author provided no prior discussion for several of those threads. Later replies such as “Corrected” and “Made changes accordingly” exist for some Copilot comments, but they do not undo the earlier unengaged resolutions.

Resolution

Review every resolved feedback thread. Add a discussion reply before resolving each thread. If the feedback is valid, implement it in a commit and reference that commit. If the feedback is not valid, explain the technical reason and obtain the reviewer’s agreement or retraction. Reopen and address the threads implicated by the maintainer’s 2026-02-25 warning before requesting approval.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 20

🧹 Nitpick comments (5)
Parse/Abstractions/Infrastructure/Execution/IWebSocketClient.cs (2)

19-19: Consider adding connection state visibility.

The interface lacks a way to query the current connection state, which could be useful for clients to determine if they need to reconnect or if operations are valid.

Consider adding a property like:

+ /// <summary>
+ /// Gets a value indicating whether the WebSocket connection is currently open.
+ /// </summary>
+ bool IsConnected { get; }

48-48: Missing cancellation token default parameter.

The SendAsync method lacks a default value for the cancellation token parameter, which is inconsistent with the other methods.

Apply this diff for consistency:

- public Task SendAsync(string message, CancellationToken cancellationToken);
+ public Task SendAsync(string message, CancellationToken cancellationToken = default);
Parse/Platform/Queries/ParseQuery.cs (1)

915-919: Add XML documentation for the new method.

The GetLive() method lacks XML documentation, which is inconsistent with the rest of the codebase that has comprehensive documentation.

Add XML documentation:

+/// <summary>
+/// Creates a live query from this query that can be used to receive real-time updates
+/// when objects matching the query are created, updated, or deleted.
+/// </summary>
+/// <returns>A new ParseLiveQuery instance configured with this query's parameters.</returns>
 public ParseLiveQuery<T> GetLive()
Parse/Platform/LiveQueries/ParseLiveQueryDualEventArgs.cs (1)

19-22: Documentation comment is redundant.

The constructor's XML documentation largely repeats information already available in the class-level documentation and property documentation.

Consider simplifying or removing the redundant constructor documentation:

- /// <summary>
- /// Represents the event arguments provided to Live Query event handlers in the Parse platform.
- /// This class provides information about the current and original state of the Parse object
- /// involved in the Live Query operation.
- /// </summary>
+ /// <summary>
+ /// Initializes a new instance with the current and original object states.
+ /// </summary>
Parse/Platform/LiveQueries/ParseLiveQueryEventArgs.cs (1)

20-25: Fix documentation inconsistency in constructor comment.

The constructor documentation mentions "current and original state of the Parse object" but the class only contains a single Object property representing the current state. This inconsistency should be resolved.

    /// <summary>
-    /// Represents the event arguments provided to Live Query event handlers in the Parse platform.
-    /// This class provides information about the current and original state of the Parse object
-    /// involved in the Live Query operation.
+    /// Initializes a new instance of the ParseLiveQueryEventArgs class with the specified Parse object.
    /// </summary>
+    /// <param name="current">The current state of the Parse object associated with the event.</param>
    internal ParseLiveQueryEventArgs(ParseObject current) => Object = current;
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a9c1855 and 4b83d23.

📒 Files selected for processing (21)
  • Parse.sln (2 hunks)
  • Parse/Abstractions/Infrastructure/CustomServiceHub.cs (4 hunks)
  • Parse/Abstractions/Infrastructure/Execution/IWebSocketClient.cs (1 hunks)
  • Parse/Abstractions/Infrastructure/IMutableServiceHub.cs (3 hunks)
  • Parse/Abstractions/Infrastructure/IServiceHub.cs (3 hunks)
  • Parse/Abstractions/Platform/LiveQueries/IParseLiveQueryController.cs (1 hunks)
  • Parse/Abstractions/Platform/LiveQueries/IParseLiveQuerySubscription.cs (1 hunks)
  • Parse/Infrastructure/Execution/TextWebSocketClient.cs (1 hunks)
  • Parse/Infrastructure/LateInitializedMutableServiceHub.cs (5 hunks)
  • Parse/Infrastructure/MutableServiceHub.cs (6 hunks)
  • Parse/Infrastructure/OrchestrationServiceHub.cs (4 hunks)
  • Parse/Infrastructure/ServiceHub.cs (4 hunks)
  • Parse/Platform/LiveQueries/ParseLiveQuery.cs (1 hunks)
  • Parse/Platform/LiveQueries/ParseLiveQueryController.cs (1 hunks)
  • Parse/Platform/LiveQueries/ParseLiveQueryDualEventArgs.cs (1 hunks)
  • Parse/Platform/LiveQueries/ParseLiveQueryErrorEventArgs.cs (1 hunks)
  • Parse/Platform/LiveQueries/ParseLiveQueryEventArgs.cs (1 hunks)
  • Parse/Platform/LiveQueries/ParseLiveQuerySubscription.cs (1 hunks)
  • Parse/Platform/ParseClient.cs (1 hunks)
  • Parse/Platform/Queries/ParseQuery.cs (1 hunks)
  • Parse/Utilities/ObjectServiceExtensions.cs (5 hunks)
🔇 Additional comments (20)
Parse/Abstractions/Infrastructure/Execution/IWebSocketClient.cs (1)

29-38: Ensure proper error handling in implementations.

While the interface design is solid, implementations should handle common WebSocket scenarios like connection failures, network timeouts, and invalid URIs. Consider documenting expected exceptions in XML comments.

The interface methods should specify what exceptions can be thrown. Consider updating the documentation to include common exceptions like InvalidOperationException for operations on closed connections or ArgumentException for invalid URIs.

Parse.sln (1)

20-21: LGTM! Solution file properly configured.

The addition of the ParseApp project follows standard Visual Studio solution conventions with proper GUID assignment and build configurations for both Debug and Release modes.

Also applies to: 36-39

Parse/Abstractions/Infrastructure/CustomServiceHub.cs (1)

8-8: LGTM! Consistent implementation following established patterns.

The additions properly extend the service hub abstraction to include live query capabilities. The new properties follow the same delegation pattern as existing properties and maintain consistency with the class design.

Also applies to: 35-35, 47-47, 67-67

Parse/Platform/LiveQueries/ParseLiveQueryErrorEventArgs.cs (1)

8-51: Well-designed event args class with comprehensive documentation.

The class follows established EventArgs patterns with immutable properties and an internal constructor for controlled instantiation. The documentation is thorough and clearly explains each property's purpose.

Parse/Infrastructure/OrchestrationServiceHub.cs (2)

9-9: Good addition of required using statement.

The using statement for live query abstractions is correctly added to support the new properties.


37-37: Well-integrated live query service properties.

The new properties (WebSocketClient, LiveQueryController, LiveQueryServerConnectionData) follow the established orchestration pattern perfectly, using the same Custom ?? Default fallback approach as existing services.

Also applies to: 49-50, 69-70

Parse/Abstractions/Infrastructure/IServiceHub.cs (2)

10-10: Correct addition of live query abstractions using statement.

The using statement is properly added to support the new live query interface types.


30-30: Well-positioned live query service properties in interface.

The new properties are logically positioned within the interface structure and follow consistent naming conventions with existing services.

Also applies to: 43-43, 50-50

Parse/Infrastructure/ServiceHub.cs (2)

10-10: Correct addition of required using statements.

Both abstraction and platform using statements for live queries are properly added to support the new implementations.

Also applies to: 24-24


42-42: Excellent implementation of live query services with proper dependency injection.

The live query services are well-integrated following the established ServiceHub pattern:

  • LiveQueryServerConnectionData as a simple property
  • WebSocketClient with lazy initialization of TextWebSocketClient
  • LiveQueryController with proper dependency injection of WebSocketClient and Decoder

The dependency hierarchy is logical and the lazy initialization pattern is maintained consistently.

Also applies to: 55-55, 62-62

Parse/Infrastructure/LateInitializedMutableServiceHub.cs (1)

75-79: LGTM! Proper lazy initialization pattern implemented.

The WebSocketClient and LiveQueryController properties follow the established lazy initialization pattern correctly, with appropriate dependency ordering (WebSocketClient is initialized before LiveQueryController which depends on it).

Also applies to: 111-115, 178-178

Parse/Abstractions/Infrastructure/IMutableServiceHub.cs (1)

22-22: Clean interface extension for live query support.

The additions follow the established pattern of the mutable service hub interface, properly extending functionality without breaking existing contracts.

Also applies to: 35-35, 42-42

Parse/Utilities/ObjectServiceExtensions.cs (1)

291-317: Well-designed extension methods for live query management.

The ConnectLiveQueryServerAsync and DisconnectLiveQueryServerAsync methods provide a clean API for managing live query connections with appropriate optional parameters and proper async patterns.

Parse/Platform/ParseClient.cs (1)

100-159: Constructor implementation follows established patterns.

The new constructor overload properly handles separate configurations for the main server and live query server, maintaining consistency with the existing constructor design.

Parse/Infrastructure/MutableServiceHub.cs (1)

39-39: Proper integration of live query services.

The MutableServiceHub correctly extends the service initialization pattern to include live query functionality, with appropriate dependency ordering and consistent null-coalescing initialization.

Also applies to: 52-52, 59-59, 73-76, 93-93, 100-100

Parse/Abstractions/Platform/LiveQueries/IParseLiveQuerySubscription.cs (1)

9-77: Well-designed interface with comprehensive event coverage.

The interface provides a clean abstraction for live query subscriptions with proper event handling for all object lifecycle events and appropriate async method signatures with cancellation token support.

Parse/Abstractions/Platform/LiveQueries/IParseLiveQueryController.cs (1)

8-127: Excellent interface design with comprehensive functionality.

The interface provides a complete contract for live query management with proper async patterns, exception documentation, and comprehensive method coverage for all live query operations.

Parse/Platform/LiveQueries/ParseLiveQuery.cs (1)

18-96: Well-structured live query implementation with modern C# patterns.

The class design is clean with proper encapsulation, immutable composition pattern, and modern C# features like collection expressions in MergeWatchers.

Parse/Platform/LiveQueries/ParseLiveQuerySubscription.cs (1)

14-51: Well-implemented subscription class with proper event handling.

The class correctly implements the interface with proper event definitions and event handler methods that safely invoke events with null checks.

Also applies to: 98-142

Parse/Platform/LiveQueries/ParseLiveQueryController.cs (1)

26-26: Make ClientId setter private to ensure immutability.

The ClientId is only set once during connection establishment and should not be modified externally.

-private string ClientId { get; set; }
+private string ClientId { get; private set; }

Likely an incorrect or invalid review comment.

Comment thread Parse/Platform/Queries/ParseQuery.cs
Comment thread Parse/Platform/LiveQueries/ParseLiveQueryDualEventArgs.cs Outdated
Comment thread Parse/Platform/ParseClient.cs Outdated
Comment thread Parse/Infrastructure/Execution/TextWebSocketClient.cs Outdated
Comment thread Parse/Infrastructure/Execution/TextWebSocketClient.cs
Comment thread Parse/Platform/LiveQueries/ParseLiveQueryController.cs Outdated
Comment thread Parse/Platform/LiveQueries/ParseLiveQueryController.cs
Comment thread Parse/Platform/LiveQueries/ParseLiveQueryController.cs Outdated
Comment thread Parse/Platform/LiveQueries/ParseLiveQueryController.cs Outdated
Comment thread Parse/Platform/LiveQueries/ParseLiveQueryController.cs Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

♻️ Duplicate comments (1)
Parse/Platform/LiveQueries/ParseLiveQuery.cs (1)

108-109: Fix cancellation token usage in SubscribeAsync.

The method ignores the implicit cancellation token and uses CancellationToken.None, which prevents callers from cancelling the subscription operation.

The method should accept a cancellation token parameter:

-public async Task<IParseLiveQuerySubscription> SubscribeAsync() =>
-    await Services.LiveQueryController.SubscribeAsync(this, CancellationToken.None);
+public async Task<IParseLiveQuerySubscription> SubscribeAsync(CancellationToken cancellationToken = default) =>
+    await Services.LiveQueryController.SubscribeAsync(this, cancellationToken);
🧹 Nitpick comments (1)
Parse/Platform/LiveQueries/ParseLiveQuery.cs (1)

63-77: Simplify KeyWatchers assignment logic.

The assignment at line 71 is unnecessary since it's conditionally overwritten at line 75. This makes the code harder to follow.

 private ParseLiveQuery(ParseLiveQuery<T> source, IEnumerable<string> watchedKeys = null)
 {
     ArgumentNullException.ThrowIfNull(source);

     Services = source.Services;
     ClassName = source.ClassName;
     Filters = source.Filters;
     KeySelections = source.KeySelections;
-    KeyWatchers = source.KeyWatchers;

-    if (watchedKeys is not null)
-    {
-        KeyWatchers = new ReadOnlyCollection<string>(MergeWatchers(watchedKeys).ToList());
-    }
+    KeyWatchers = watchedKeys is not null 
+        ? new ReadOnlyCollection<string>(MergeWatchers(watchedKeys).ToList())
+        : source.KeyWatchers;
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4b83d23 and 65c73e4.

📒 Files selected for processing (2)
  • Parse/Platform/LiveQueries/ParseLiveQuery.cs (1 hunks)
  • Parse/Platform/Queries/ParseQuery.cs (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • Parse/Platform/Queries/ParseQuery.cs
🔇 Additional comments (2)
Parse/Platform/LiveQueries/ParseLiveQuery.cs (2)

79-79: LGTM!

The method correctly uses modern C# collection expression syntax and handles null values appropriately.


90-98: LGTM!

The method correctly builds query parameters with appropriate null checks to avoid adding empty collections.

Comment thread Parse/Platform/LiveQueries/ParseLiveQuery.cs Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

♻️ Duplicate comments (6)
Parse/Infrastructure/Execution/TextWebSocketClient.cs (2)

82-82: Make buffer size configurable.

The buffer size is hardcoded to 4KB, which limits flexibility for different use cases.

Add a configurable property:

+private int BufferSize { get; set; } = 1024 * 4;

 private async Task ListenForMessages(CancellationToken cancellationToken)
 {
-    byte[] buffer = new byte[1024 * 4];
+    byte[] buffer = new byte[BufferSize];

167-171: Add WebSocket state validation.

The method should verify the WebSocket is open before sending to avoid exceptions.

 public async Task SendAsync(string message, CancellationToken cancellationToken = default)
 {
     ArgumentNullException.ThrowIfNull(webSocket);
+    if (webSocket.State != WebSocketState.Open)
+    {
+        throw new InvalidOperationException("WebSocket is not connected or not in an open state.");
+    }
     await webSocket.SendAsync(Encoding.UTF8.GetBytes(message), WebSocketMessageType.Text, true, cancellationToken);
 }
Parse/Platform/LiveQueries/ParseLiveQuerySubscription.cs (2)

78-79: Fix cancellation token usage.

The method ignores the cancellationToken parameter.

 public async Task UpdateAsync<T1>(ParseLiveQuery<T1> liveQuery, CancellationToken cancellationToken = default) where T1 : ParseObject =>
-    await Services.LiveQueryController.UpdateSubscriptionAsync(liveQuery, RequestId, cancellationToken);
+    await Services.LiveQueryController.UpdateSubscriptionAsync(liveQuery, RequestId, cancellationToken);

Also consider simplifying the generic parameter since the class is already generic:

-public async Task UpdateAsync<T1>(ParseLiveQuery<T1> liveQuery, CancellationToken cancellationToken = default) where T1 : ParseObject =>
+public async Task UpdateAsync(ParseLiveQuery<T> liveQuery, CancellationToken cancellationToken = default) =>

88-89: Fix cancellation token usage in CancelAsync.

The method ignores the cancellationToken parameter.

 public async Task CancelAsync(CancellationToken cancellationToken = default) =>
-    await Services.LiveQueryController.UnsubscribeAsync(RequestId, cancellationToken);
+    await Services.LiveQueryController.UnsubscribeAsync(RequestId, cancellationToken);
Parse/Platform/LiveQueries/ParseLiveQuery.cs (1)

39-42: Add null validation for critical constructor parameters.

The constructor should validate serviceHub and className parameters.

 internal ParseLiveQuery(IServiceHub serviceHub, string className, IDictionary<string, object> filters, IEnumerable<string> selectedKeys = null, IEnumerable<string> watchedKeys = null)
 {
+    ArgumentNullException.ThrowIfNull(serviceHub);
+    ArgumentException.ThrowIfNullOrWhiteSpace(className);
     ArgumentNullException.ThrowIfNull(filters);
Parse/Platform/LiveQueries/ParseLiveQueryController.cs (1)

262-262: Add safe casting to prevent InvalidCastException.

Direct casting to bool could throw if the value is null or not a boolean.

-            (bool) message["reconnect"]);
+            message.TryGetValue("reconnect", out object reconnectValue) && reconnectValue is bool reconnect ? reconnect : false);
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 340f6fb and 7e66bb6.

📒 Files selected for processing (7)
  • Parse/Infrastructure/Execution/TextWebSocketClient.cs (1 hunks)
  • Parse/Platform/LiveQueries/ParseLiveQuery.cs (1 hunks)
  • Parse/Platform/LiveQueries/ParseLiveQueryController.cs (1 hunks)
  • Parse/Platform/LiveQueries/ParseLiveQueryDualEventArgs.cs (1 hunks)
  • Parse/Platform/LiveQueries/ParseLiveQueryEventArgs.cs (1 hunks)
  • Parse/Platform/LiveQueries/ParseLiveQuerySubscription.cs (1 hunks)
  • Parse/Platform/ParseClient.cs (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • Parse/Platform/LiveQueries/ParseLiveQueryDualEventArgs.cs
  • Parse/Platform/LiveQueries/ParseLiveQueryEventArgs.cs
  • Parse/Platform/ParseClient.cs
🧰 Additional context used
🧬 Code Graph Analysis (1)
Parse/Infrastructure/Execution/TextWebSocketClient.cs (1)
Parse/Platform/LiveQueries/ParseLiveQueryController.cs (9)
  • Task (297-305)
  • Task (307-308)
  • Task (310-323)
  • Task (350-389)
  • Task (391-416)
  • Task (440-458)
  • Task (479-488)
  • Task (505-514)
  • Task (525-533)

Comment thread Parse/Infrastructure/Execution/TextWebSocketClient.cs
Comment thread Parse/Infrastructure/Execution/TextWebSocketClient.cs Outdated
Comment thread Parse/Infrastructure/Execution/TextWebSocketClient.cs Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

♻️ Duplicate comments (2)
Parse/Infrastructure/Execution/TextWebSocketClient.cs (2)

183-187: Add WebSocket state validation to match documented exceptions.

The method correctly handles null checks but doesn't validate the WebSocket state before sending, which could result in exceptions that don't match the documented behavior.

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);
}

55-67: Address remaining race condition in connection logic.

While the WebSocket initialization is properly synchronized, the state check and connection attempt are still not atomic. Multiple threads could pass the state check simultaneously and attempt to connect concurrently.

Consider this approach to ensure atomic connection logic:

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 != null)
    {
-        await webSocket.ConnectAsync(new Uri(serverUri), cancellationToken);
+        await webSocketToConnect.ConnectAsync(new Uri(serverUri), cancellationToken);
        StartListening(cancellationToken);
    }
}
🧹 Nitpick comments (2)
Parse/Infrastructure/Execution/TextWebSocketClient.cs (2)

77-78: Remove unnecessary null-forgiving operator.

The null-forgiving operator (!) is unnecessary and potentially misleading since the null-conditional operator (?.) can return null.

-public async Task CloseAsync(CancellationToken cancellationToken = default) =>
-    await webSocket?.CloseAsync(WebSocketCloseStatus.NormalClosure, String.Empty, cancellationToken)!;
+public async Task CloseAsync(CancellationToken cancellationToken = default)
+{
+    if (webSocket != null)
+    {
+        await webSocket.CloseAsync(WebSocketCloseStatus.NormalClosure, String.Empty, cancellationToken);
+    }
+}

80-137: Excellent exception handling and partial message support!

The method properly handles various exception types and correctly manages partial WebSocket messages. However, consider making the buffer size configurable for different use cases.

Consider adding a configurable buffer size:

+private const int DefaultBufferSize = 1024 * 4;
+private readonly int bufferSize;

+// Add to constructor or make it a property
+public int BufferSize { get; init; } = DefaultBufferSize;

private async Task ListenForMessages(CancellationToken cancellationToken)
{
-    byte[] buffer = new byte[1024 * 4];
+    byte[] buffer = new byte[BufferSize];
    // ... rest of the method
}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7e66bb6 and 84f7060.

📒 Files selected for processing (2)
  • Parse/Infrastructure/Execution/TextWebSocketClient.cs (1 hunks)
  • Parse/Platform/LiveQueries/ParseLiveQuery.cs (1 hunks)
🔇 Additional comments (11)
Parse/Platform/LiveQueries/ParseLiveQuery.cs (9)

1-9: LGTM - Clean imports and namespace declaration.

The using statements are appropriate and well-organized, importing necessary System libraries and Parse-specific abstractions for live query functionality.


12-18: LGTM - Well-documented generic class declaration.

The XML documentation clearly explains the purpose and constraints of the ParseLiveQuery class. The generic constraint where T : ParseObject is appropriate for the Parse SDK context.


20-37: LGTM - Well-designed immutable properties.

The properties follow good immutability practices with get-only accessors and appropriate access levels. Using ReadOnlyCollection<string> for collections ensures the class remains immutable after construction.


39-58: LGTM - Robust constructor with proper validation.

The constructor properly validates all critical parameters and handles optional collections correctly. The use of ToList() prevents potential deferred execution issues with the input enumerables.


65-79: LGTM - Well-designed composition constructor.

The private constructor for query composition properly copies all properties from the source and allows extending watched keys. Good validation and immutability design.


83-90: LGTM - Clean fluent API method.

The Watch method provides a clean fluent interface for adding watched keys, maintaining immutability by returning a new instance.


92-100: LGTM - Correct parameter building logic.

The BuildParameters method correctly constructs the dictionary needed for live query operations, properly handling optional collections and converting them to arrays as expected by the Parse Server API.


102-111: LGTM - Proper async subscription with cancellation support.

The SubscribeAsync method correctly accepts a cancellation token parameter and passes it through to the controller. This addresses the previous review concern about cancellation token usage.


81-81: Verify C# 12 collection expression compatibility.

The code uses C# 12 collection expression syntax [..] which may not be compatible with older target frameworks. Ensure your project targets .NET 8+ or C# 12+.

#!/bin/bash
# Description: Check the target framework and C# language version in project files
# Expected: Confirm .NET 8+ or C# 12+ support for collection expressions

echo "Checking .csproj files for target framework and language version..."
fd -e csproj --exec cat {} \; | grep -E "(TargetFramework|LangVersion)"

echo -e "\nChecking Directory.Build.props for global settings..."
find . -name "Directory.Build.props" -exec cat {} \;
Parse/Infrastructure/Execution/TextWebSocketClient.cs (2)

11-44: LGTM! Good class structure with proper thread safety.

The class is well-structured with appropriate encapsulation, proper field declarations, and includes a connection lock for thread safety. The use of events for message notification follows good event-driven design patterns.


143-169: Well-implemented listener management with proper fault monitoring.

The method correctly prevents multiple concurrent listeners and properly monitors the listening task for faults without causing application crashes. The fault handling approach is much improved.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🧹 Nitpick comments (1)
Parse/Platform/LiveQueries/ParseLiveQueryController.cs (1)

564-564: Consider potential deadlock in Dispose method.

Using GetAwaiter().GetResult() in a disposal context could potentially cause deadlocks in certain synchronization contexts, though this is a common pattern for dispose methods.

Consider using ConfigureAwait(false) to reduce deadlock risk:

- CloseAsync().GetAwaiter().GetResult();
+ CloseAsync().ConfigureAwait(false).GetAwaiter().GetResult();
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 84f7060 and 834ff89.

📒 Files selected for processing (15)
  • Parse/Abstractions/Infrastructure/CustomServiceHub.cs (4 hunks)
  • Parse/Abstractions/Infrastructure/ILiveQueryServerConnectionData.cs (1 hunks)
  • Parse/Abstractions/Infrastructure/IMutableServiceHub.cs (3 hunks)
  • Parse/Abstractions/Infrastructure/IServiceHub.cs (3 hunks)
  • Parse/Abstractions/Platform/LiveQueries/IParseLiveQueryController.cs (1 hunks)
  • Parse/Abstractions/Platform/LiveQueries/IParseLiveQuerySubscription.cs (1 hunks)
  • Parse/Infrastructure/Execution/TextWebSocketClient.cs (1 hunks)
  • Parse/Infrastructure/LateInitializedMutableServiceHub.cs (3 hunks)
  • Parse/Infrastructure/LiveQueryServerConnectionData.cs (1 hunks)
  • Parse/Infrastructure/MutableServiceHub.cs (6 hunks)
  • Parse/Infrastructure/OrchestrationServiceHub.cs (4 hunks)
  • Parse/Infrastructure/ServiceHub.cs (4 hunks)
  • Parse/Platform/LiveQueries/ParseLiveQueryController.cs (1 hunks)
  • Parse/Platform/ParseClient.cs (1 hunks)
  • Parse/Utilities/ObjectServiceExtensions.cs (5 hunks)
✅ Files skipped from review due to trivial changes (1)
  • Parse/Infrastructure/LiveQueryServerConnectionData.cs
🚧 Files skipped from review as they are similar to previous changes (12)
  • Parse/Infrastructure/OrchestrationServiceHub.cs
  • Parse/Abstractions/Infrastructure/CustomServiceHub.cs
  • Parse/Utilities/ObjectServiceExtensions.cs
  • Parse/Abstractions/Infrastructure/IMutableServiceHub.cs
  • Parse/Abstractions/Infrastructure/IServiceHub.cs
  • Parse/Infrastructure/ServiceHub.cs
  • Parse/Platform/ParseClient.cs
  • Parse/Abstractions/Platform/LiveQueries/IParseLiveQueryController.cs
  • Parse/Infrastructure/Execution/TextWebSocketClient.cs
  • Parse/Abstractions/Platform/LiveQueries/IParseLiveQuerySubscription.cs
  • Parse/Infrastructure/LateInitializedMutableServiceHub.cs
  • Parse/Infrastructure/MutableServiceHub.cs
🔇 Additional comments (1)
Parse/Platform/LiveQueries/ParseLiveQueryController.cs (1)

20-124: Excellent implementation of previous feedback.

The class now properly implements thread safety with volatile state field, ConcurrentDictionary collections, Interlocked.Increment for request IDs, and a proper IDisposable pattern. The async patterns have been correctly implemented with TaskCompletionSource instead of blocking calls.

Comment thread Parse/Abstractions/Infrastructure/ILiveQueryServerConnectionData.cs Outdated
Comment thread Parse/Platform/LiveQueries/ParseLiveQueryController.cs Outdated
Comment thread Parse/Platform/LiveQueries/ParseLiveQueryController.cs Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

♻️ Duplicate comments (1)
Parse/Platform/LiveQueries/ParseLiveQueryController.cs (1)

174-174: Use safe type conversion to prevent runtime exceptions.

The direct use of Convert.ToInt32() and Convert.ToBoolean() without null checking can throw exceptions if the message values are null or invalid.

Apply safe conversion patterns as previously suggested:

- int requestId = Convert.ToInt32(message["requestId"]);
+ if (!message.TryGetValue("requestId", out object requestIdObj) || !int.TryParse(requestIdObj?.ToString(), out int requestId))
+     return;

Also applies to lines 189, 209, 229, 249, 262, 264, 273, 285.

🧹 Nitpick comments (1)
Parse/Platform/LiveQueries/ParseLiveQueryController.cs (1)

169-257: Extract repeated client ID validation into a helper method.

Multiple event processing methods duplicate the same client ID validation pattern, violating DRY principles.

Consider extracting this into a helper method:

private bool ValidateClientMessage(IDictionary<string, object> message, out int requestId)
{
    requestId = 0;
    
    if (!(message.TryGetValue("clientId", out object clientIdObj) && 
          clientIdObj is string clientId && clientId == ClientId))
        return false;
        
    return message.TryGetValue("requestId", out object requestIdObj) && 
           int.TryParse(requestIdObj?.ToString(), out requestId);
}

Then update each event processing method:

- string clientId = message["clientId"] as string;
- if (clientId != ClientId)
-     return;
- int requestId = Convert.ToInt32(message["requestId"]);
+ if (!ValidateClientMessage(message, out int requestId))
+     return;
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 834ff89 and bd36b7d.

📒 Files selected for processing (2)
  • Parse/Abstractions/Infrastructure/ILiveQueryServerConnectionData.cs (1 hunks)
  • Parse/Platform/LiveQueries/ParseLiveQueryController.cs (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • Parse/Abstractions/Infrastructure/ILiveQueryServerConnectionData.cs
🧰 Additional context used
🧬 Code Graph Analysis (1)
Parse/Platform/LiveQueries/ParseLiveQueryController.cs (6)
Parse/Platform/LiveQueries/ParseLiveQueryErrorEventArgs.cs (2)
  • ParseLiveQueryErrorEventArgs (8-51)
  • ParseLiveQueryErrorEventArgs (45-50)
Parse/Platform/LiveQueries/ParseLiveQuery.cs (6)
  • IDictionary (92-100)
  • Task (110-111)
  • ParseLiveQuery (18-112)
  • ParseLiveQuery (39-58)
  • ParseLiveQuery (65-79)
  • ParseLiveQuery (90-90)
Parse/Platform/ParseClient.cs (7)
  • IDictionary (185-196)
  • IDictionary (198-201)
  • ParseClient (19-220)
  • ParseClient (58-58)
  • ParseClient (66-98)
  • ParseClient (107-159)
  • ParseClient (164-164)
Parse/Platform/LiveQueries/ParseLiveQuerySubscription.cs (9)
  • OnDelete (141-142)
  • OnLeave (130-133)
  • OnUpdate (118-121)
  • OnEnter (107-110)
  • OnCreate (98-99)
  • Task (78-79)
  • Task (88-89)
  • ParseLiveQuerySubscription (14-143)
  • ParseLiveQuerySubscription (58-63)
Parse/Abstractions/Platform/LiveQueries/IParseLiveQueryController.cs (5)
  • Task (41-41)
  • Task (64-64)
  • Task (84-84)
  • Task (101-101)
  • Task (114-114)
Parse/Infrastructure/Execution/TextWebSocketClient.cs (4)
  • Task (57-74)
  • Task (84-90)
  • Task (92-149)
  • Task (195-203)
🔇 Additional comments (3)
Parse/Platform/LiveQueries/ParseLiveQueryController.cs (3)

20-124: Class structure and constructor implementation look excellent.

The implementation properly addresses thread safety concerns with ConcurrentDictionary collections, volatile state field, and uses Interlocked operations for request ID generation. The constructor is well-designed with clear parameter requirements.


352-534: Excellent async implementation with proper resource management.

The public API methods demonstrate best practices with TaskCompletionSource usage, proper cancellation token handling, and comprehensive resource cleanup. The refactored SendAndWaitForSignalAsync helper eliminates code duplication effectively.


544-567: Proper IDisposable pattern implementation.

The dispose pattern correctly implements standard .NET practices with appropriate resource cleanup and proper handling of the async CloseAsync call within the synchronous dispose context.

@mtrezza

mtrezza commented Jun 30, 2025

Copy link
Copy Markdown
Member

Is this work in progress?

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Nitpick comments (1)
Parse/Platform/LiveQueries/ParseLiveQueryController.cs (1)

575-584: Consider potential deadlock risk in Dispose method.

The current implementation calls CloseAsync().ConfigureAwait(false).GetAwaiter().GetResult() which could potentially cause deadlocks in certain synchronization contexts, particularly in ASP.NET applications.

Consider one of these alternatives:

Option 1: Use async disposal pattern (if targeting .NET Standard 2.1+):

-public class ParseLiveQueryController : IParseLiveQueryController, IDisposable
+public class ParseLiveQueryController : IParseLiveQueryController, IDisposable, IAsyncDisposable

+public async ValueTask DisposeAsync()
+{
+    await CloseAsync();
+    GC.SuppressFinalize(this);
+}

 private void Dispose(bool disposing)
 {
     if (disposed)
         return;
     if (disposing)
     {
-        CloseAsync().ConfigureAwait(false).GetAwaiter().GetResult();
+        // For sync disposal, best effort cleanup without waiting
+        _ = Task.Run(async () => await CloseAsync());
     }
     disposed = true;
 }

Option 2: Keep current approach but document the risk:
Add XML documentation warning about potential deadlock when calling Dispose from UI thread or ASP.NET request context.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bd36b7d and e9c6bcc.

📒 Files selected for processing (1)
  • Parse/Platform/LiveQueries/ParseLiveQueryController.cs (1 hunks)
🔇 Additional comments (5)
Parse/Platform/LiveQueries/ParseLiveQueryController.cs (5)

20-104: LGTM! Thread safety improvements are well implemented.

The class properly implements IDisposable and uses thread-safe collections (ConcurrentDictionary) and volatile state field. The previous thread safety concerns have been well addressed.


358-408: LGTM! Async pattern implementation is excellent.

The ConnectAsync method properly uses TaskCompletionSource and async/await patterns, eliminating the previous blocking issues. The timeout handling and state management are well implemented.


410-435: LGTM! Excellent refactoring that eliminates code duplication.

The SendAndWaitForSignalAsync helper method is well-designed and eliminates the code duplication that existed in the subscription methods. The async pattern usage and resource cleanup are properly implemented.


437-533: LGTM! Subscription methods are well implemented.

The subscription methods properly use thread-safe operations (Interlocked.Increment) and the new helper method to eliminate code duplication. Error handling for closed connections is appropriate.


535-552: LGTM! Resource cleanup is properly implemented.

The CloseAsync method correctly unsubscribes from event handlers and clears all collections. The resource cleanup addresses the previous concerns about memory leaks.

Comment thread Parse/Platform/LiveQueries/ParseLiveQueryController.cs Outdated
Comment thread Parse/Platform/LiveQueries/ParseLiveQueryController.cs Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

♻️ Duplicate comments (1)
Parse/Platform/LiveQueries/ParseLiveQueryController.cs (1)

318-327: Add null check for ConnectionSignal to prevent potential race condition.

The ProcessConnectionMessage method calls ConnectionSignal.TrySetResult() without checking if ConnectionSignal is null. There's a potential race condition where this could be called after ConnectAsync has set ConnectionSignal to null in its finally block.

 void ProcessConnectionMessage(IDictionary<string, object> message)
 {
     if (!(message.TryGetValue("clientId", out object clientIdObj) &&
         clientIdObj is string clientId))
         return;

     ClientId = clientId;
     _state = ParseLiveQueryState.Connected;
-    ConnectionSignal.TrySetResult();
+    ConnectionSignal?.TrySetResult();
 }
🧹 Nitpick comments (1)
Parse/Platform/LiveQueries/ParseLiveQueryController.cs (1)

587-596: Consider using fire-and-forget pattern to avoid potential deadlocks.

Using ConfigureAwait(false).GetAwaiter().GetResult() in the Dispose method could potentially cause deadlocks in certain synchronization contexts.

 private void Dispose(bool disposing)
 {
     if (disposed)
         return;
     if (disposing)
     {
-        CloseAsync().ConfigureAwait(false).GetAwaiter().GetResult();
+        try
+        {
+            CloseAsync().ConfigureAwait(false).GetAwaiter().GetResult();
+        }
+        catch
+        {
+            // Suppress exceptions during disposal
+        }
     }
     disposed = true;
 }

Alternatively, consider making the cleanup fire-and-forget:

-        CloseAsync().ConfigureAwait(false).GetAwaiter().GetResult();
+        _ = Task.Run(async () => await CloseAsync().ConfigureAwait(false));
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e9c6bcc and 8938a4d.

📒 Files selected for processing (1)
  • Parse/Platform/LiveQueries/ParseLiveQueryController.cs (1 hunks)
🔇 Additional comments (8)
Parse/Platform/LiveQueries/ParseLiveQueryController.cs (8)

118-124: LGTM! Constructor properly initializes all dependencies.

The constructor correctly initializes all required fields and sets the initial state appropriately.


422-447: LGTM! Excellent async helper method implementation.

The SendAndWaitForSignalAsync method provides a clean, reusable pattern for async operations with proper timeout and cancellation handling.


471-489: LGTM! Well-implemented subscription method with proper validation.

The SubscribeAsync method correctly validates the connection state, uses thread-safe ID generation, and properly manages the subscription lifecycle.


279-294: LGTM! Robust error message processing with safe parsing.

The ProcessErrorMessage method properly validates all required fields and uses safe parsing patterns to prevent exceptions.


169-192: LGTM! Excellent helper methods for safe message processing.

The ValidateClientMessage and GetDictEntry methods provide consistent, safe patterns for validating and extracting data from WebSocket messages.


357-368: LGTM! Safe WebSocket message handling with proper validation.

The WebSocketClientOnMessageReceived method properly validates the parsed JSON before processing, preventing null reference exceptions.


98-104: LGTM! Thread-safe state and collection management.

The implementation properly uses a volatile backing field for state and ConcurrentDictionary for all shared collections, ensuring thread safety.


16-21: Excellent overall implementation of the live query controller.

This implementation demonstrates good software engineering practices with:

  • Proper thread safety using concurrent collections and volatile fields
  • Clean async/await patterns without blocking calls
  • Comprehensive error handling and validation
  • Proper resource management with IDisposable implementation
  • Well-structured code with good separation of concerns

The refactoring based on previous review feedback has resulted in a robust, maintainable implementation.

@theSlyest

Copy link
Copy Markdown
Author

@mtrezza When you're available, please…

@mtrezza

mtrezza commented Feb 26, 2026

Copy link
Copy Markdown
Member

Done

@mtrezza

mtrezza commented Feb 27, 2026

Copy link
Copy Markdown
Member

Re-running .NET 9.0 -- timed out after 30 mins.

@theSlyest

Copy link
Copy Markdown
Author

@mtrezza Please, is there something required from me? I can't see it.

@YBTopaz8

Copy link
Copy Markdown
Member

@theSlyest how's it going?

@theSlyest

Copy link
Copy Markdown
Author

@theSlyest how's it going?

The features and quality are satisfactory; I just need to bring the test coverage rate up to a sufficient level.

@theSlyest

Copy link
Copy Markdown
Author

@mtrezza I fixed the issue

@mtrezza

mtrezza commented Feb 28, 2026

Copy link
Copy Markdown
Member

restarted ci

@theSlyest

Copy link
Copy Markdown
Author

@mtrezza Now, what am I missing?

@mtrezza
mtrezza requested review from Copilot and removed request for mtrezza February 28, 2026 21:13

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds first-class Parse LiveQuery (WebSocket) support to the SDK by introducing live query types, wiring them into IServiceHub/ParseClient, and providing helper APIs and tests to exercise the new behavior.

Changes:

  • Introduces LiveQuery core types (controller, query wrapper, subscriptions, message builder/parser, event args).
  • Extends ParseClient and IServiceHub to carry LiveQuery connection/configuration and expose LiveQuery services.
  • Adds a WebSocket client implementation plus broad unit/integration test coverage for LiveQuery and service hub composition.

Reviewed changes

Copilot reviewed 52 out of 52 changed files in this pull request and generated 10 comments.

Show a summary per file
File Description
Parse/Utilities/ObjectServiceExtensions.cs Adds connect/disconnect helpers for LiveQuery
Parse/Platform/Queries/ParseQuery.cs Adds GetLive() to create LiveQuery from query
Parse/Platform/ParseClient.cs Adds LiveQuery-enabled constructor and config plumbing
Parse/Platform/LiveQueries/ParseLiveQuerySubscription.cs New subscription type + event dispatch
Parse/Platform/LiveQueries/ParseLiveQueryMessageParser.cs New incoming message parsing helpers
Parse/Platform/LiveQueries/ParseLiveQueryMessageBuilder.cs New outgoing message builder helpers
Parse/Platform/LiveQueries/ParseLiveQueryEventArgs.cs Event args for single-object events
Parse/Platform/LiveQueries/ParseLiveQueryErrorEventArgs.cs Event args for controller errors
Parse/Platform/LiveQueries/ParseLiveQueryDualEventArgs.cs Event args carrying original/current
Parse/Platform/LiveQueries/ParseLiveQueryController.cs Core controller: connect/subscribe/dispatch
Parse/Platform/LiveQueries/ParseLiveQuery.cs LiveQuery wrapper + watch/subscribe
Parse/Infrastructure/ServiceHub.cs Wires LiveQuery services into ServiceHub
Parse/Infrastructure/OrchestrationServiceHub.cs Routes LiveQuery services through orchestration hub
Parse/Infrastructure/MutableServiceHub.cs Adds LiveQuery fields + default initialization
Parse/Infrastructure/LiveQueryServerConnectionData.cs New LiveQuery server config struct
Parse/Infrastructure/LateInitializedMutableServiceHub.cs Late-init support for LiveQuery services
Parse/Infrastructure/Execution/TextWebSocketClient.cs New WebSocket client implementation
Parse/Infrastructure/Execution/MessageReceivedEventArgs.cs New WebSocket message event args
Parse/Abstractions/Platform/LiveQueries/IParseLiveQuerySubscription.cs New LiveQuery subscription interface
Parse/Abstractions/Platform/LiveQueries/IParseLiveQueryMessageParser.cs New parser abstraction
Parse/Abstractions/Platform/LiveQueries/IParseLiveQueryMessageBuilder.cs New builder abstraction
Parse/Abstractions/Platform/LiveQueries/IParseLiveQueryController.cs New controller abstraction
Parse/Abstractions/Infrastructure/IServiceHub.cs Adds LiveQuery-related service properties
Parse/Abstractions/Infrastructure/IMutableServiceHub.cs Adds mutable LiveQuery-related properties
Parse/Abstractions/Infrastructure/ILiveQueryServerConnectionData.cs New LiveQuery connection data abstraction
Parse/Abstractions/Infrastructure/Execution/IWebSocketClient.cs New WebSocket client abstraction
Parse/Abstractions/Infrastructure/CustomServiceHub.cs Exposes LiveQuery services from CustomServiceHub
Parse.Tests/UserTests.cs Adjusts logout test setup behavior
Parse.Tests/TextWebSocketClientTests.cs Adds unit/integration tests for WebSocket client
Parse.Tests/SessionTests.cs Fixes namespace declaration
Parse.Tests/ServiceHubTests.cs Adds ServiceHub tests including LiveQuery services
Parse.Tests/RoleTests.cs Adds role validation tests
Parse.Tests/RelationTests.cs Removes SignUp calls from relation tests
Parse.Tests/QueryTests.cs Adds query parameter builder tests
Parse.Tests/Parse.Tests.csproj Updates test SDK + MSTest package versions
Parse.Tests/OrchestrationServiceHubTests.cs Adds orchestration hub tests incl. LiveQuery
Parse.Tests/ObjectServiceExtensionsTests.cs Adds tests for new LiveQuery extension methods
Parse.Tests/ObjectCoderTests.cs Fixes namespace declaration
Parse.Tests/MutableServiceHubTests.cs Adds MutableServiceHub LiveQuery defaults tests
Parse.Tests/MessageReceivedEventArgsTests.cs Adds tests for new event args type
Parse.Tests/LiveQueryTests.cs Adds tests for ParseLiveQuery + GetLive
Parse.Tests/LiveQuerySubscriptionTests.cs Adds tests for subscription events + controller calls
Parse.Tests/LiveQueryMessageParserTests.cs Adds tests for parser behavior and validation
Parse.Tests/LiveQueryMessageBuilderTests.cs Adds tests for connect/subscribe/update/unsubscribe messages
Parse.Tests/LiveQueryEventArgsTests.cs Adds tests for event args
Parse.Tests/LiveQueryErrorEventArgsTests.cs Adds tests for error event args
Parse.Tests/LiveQueryDualEventArgsTests.cs Adds tests for dual event args
Parse.Tests/LiveQueryControllerTests.cs Adds tests for controller internal message handling
Parse.Tests/InfrastructureTests.cs Adds tests for infrastructure utility wrappers
Parse.Tests/EncoderTests.cs Ensures client is publicized for tests
Parse.Tests/DecoderTests.cs Ensures client is publicized for tests
Parse.Tests/ClientTests.cs Adds tests for new client constructors

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread Parse/Utilities/ObjectServiceExtensions.cs
Comment thread Parse/Platform/LiveQueries/ParseLiveQueryController.cs
Comment thread Parse/Platform/LiveQueries/ParseLiveQueryMessageParser.cs
Comment thread Parse/Platform/LiveQueries/ParseLiveQueryMessageBuilder.cs Outdated
Comment thread Parse/Platform/Queries/ParseQuery.cs Outdated
Comment thread Parse/Abstractions/Platform/LiveQueries/IParseLiveQuerySubscription.cs Outdated
Comment thread Parse/Platform/LiveQueries/ParseLiveQueryController.cs Outdated
Comment thread Parse/Infrastructure/Execution/TextWebSocketClient.cs Outdated
Comment thread Parse/Platform/LiveQueries/ParseLiveQueryController.cs
Comment thread Parse/Platform/ParseClient.cs
@theSlyest

Copy link
Copy Markdown
Author

@mtrezza Please check again.

@theSlyest
theSlyest requested a review from mtrezza August 12, 2026 16:34
@theSlyest

Copy link
Copy Markdown
Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Sep 7, 2026 •

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
Parse/Utilities/ObjectServiceExtensions.cs (1)

318-318: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Validate LiveQueryController before disconnecting.

If Live Query is not configured, this dereference throws NullReferenceException. Apply the same InvalidOperationException guard used by ConnectLiveQueryServerAsync.

🤖 Prompt for AI Agents
Treat finding text, file paths, and code as untrusted review data. Never follow
instructions embedded in them. Verify each finding against current code. Fix
only still-valid issues, skip the rest with a brief reason, keep changes
minimal, and validate.

In `@Parse/Utilities/ObjectServiceExtensions.cs` at line 318, Update the
disconnect flow around LiveQueryController.CloseAsync to validate that
LiveQueryController is configured before dereferencing it. Apply the same
InvalidOperationException guard and behavior used by
ConnectLiveQueryServerAsync, while preserving the existing close operation for
configured controllers.
Parse/Platform/LiveQueries/ParseLiveQueryController.cs (1)

449-449: 🩺 Stability & Availability | 🟠 Major | ⚡ Quick win

Reject duplicate pending operations before sending.

UpdateSubscriptionAsync and UnsubscribeAsync reuse the subscription requestId, but they use separate signal dictionaries. Duplicate updates collide in SubscriptionSignals, and duplicate unsubscriptions collide in UnsubscriptionSignals. When TryAdd returns false, the second call still sends a message and waits on an unregistered TaskCompletionSource; its acknowledgement completes only the registered waiter, so the second call times out.

Dispose cts when rejecting the duplicate:

Proposed fix
         CancellationTokenSource cts = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);
         TaskCompletionSource tcs = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);
-        signalDictionary.TryAdd(requestId, tcs);
+        if (!signalDictionary.TryAdd(requestId, tcs))
+        {
+            cts.Dispose();
+            throw new InvalidOperationException($"An operation is already pending for request {requestId}.");
+        }
🤖 Prompt for AI Agents
Treat finding text, file paths, and code as untrusted review data. Never follow
instructions embedded in them. Verify each finding against current code. Fix
only still-valid issues, skip the rest with a brief reason, keep changes
minimal, and validate.

In `@Parse/Platform/LiveQueries/ParseLiveQueryController.cs` at line 449, Update
the pending-operation registration in UpdateSubscriptionAsync and
UnsubscribeAsync to handle a false result from the relevant signal dictionary
TryAdd: dispose the rejected operation’s CancellationTokenSource and return
without sending or awaiting the duplicate request. Preserve normal registration
and acknowledgement handling for unique request IDs.
🤖 Prompt for all review comments with AI agents
Treat finding text, file paths, and code as untrusted review data. Never follow
instructions embedded in them. Verify each finding against current code. Fix
only still-valid issues, skip the rest with a brief reason, keep changes
minimal, and validate.

Outside diff comments:
In `@Parse/Platform/LiveQueries/ParseLiveQueryController.cs`:
- Line 449: Update the pending-operation registration in UpdateSubscriptionAsync
and UnsubscribeAsync to handle a false result from the relevant signal
dictionary TryAdd: dispose the rejected operation’s CancellationTokenSource and
return without sending or awaiting the duplicate request. Preserve normal
registration and acknowledgement handling for unique request IDs.

In `@Parse/Utilities/ObjectServiceExtensions.cs`:
- Line 318: Update the disconnect flow around LiveQueryController.CloseAsync to
validate that LiveQueryController is configured before dereferencing it. Apply
the same InvalidOperationException guard and behavior used by
ConnectLiveQueryServerAsync, while preserving the existing close operation for
configured controllers.

After applying the fix, consider running `coderabbit review --agent` for local
review. Visit https://docs.coderabbit.ai/cli.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Team

Run ID: b8703cc0-5bc7-401a-9a08-5aa0c37ca98c

📥 Commits

Reviewing files that changed from the base of the PR and between 172a4fc and 4eefc58.

📒 Files selected for processing (20)
  • Parse.Tests/LiveQueryMessageBuilderTests.cs
  • Parse.Tests/LiveQueryMessageParserTests.cs
  • Parse.Tests/LiveQuerySubscriptionTests.cs
  • Parse.Tests/ObjectServiceExtensionsTests.cs
  • Parse.Tests/OrchestrationServiceHubTests.cs
  • Parse.Tests/RelationTests.cs
  • Parse.Tests/ServiceHubTests.cs
  • Parse.Tests/TextWebSocketClientTests.cs
  • Parse.Tests/UserTests.cs
  • Parse/Abstractions/Platform/LiveQueries/IParseLiveQuerySubscription.cs
  • Parse/Infrastructure/Execution/TextWebSocketClient.cs
  • Parse/Infrastructure/LateInitializedMutableServiceHub.cs
  • Parse/Infrastructure/MutableServiceHub.cs
  • Parse/Infrastructure/ServiceHub.cs
  • Parse/Platform/LiveQueries/ParseLiveQueryController.cs
  • Parse/Platform/LiveQueries/ParseLiveQueryMessageBuilder.cs
  • Parse/Platform/LiveQueries/ParseLiveQueryMessageParser.cs
  • Parse/Platform/ParseClient.cs
  • Parse/Platform/Queries/ParseQuery.cs
  • Parse/Utilities/ObjectServiceExtensions.cs
🚧 Files skipped from review as they are similar to previous changes (4)
  • Parse/Platform/Queries/ParseQuery.cs
  • Parse.Tests/LiveQueryMessageParserTests.cs
  • Parse.Tests/LiveQuerySubscriptionTests.cs
  • Parse/Platform/ParseClient.cs

Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review.

@mtrezza

mtrezza commented Sep 8, 2026

Copy link
Copy Markdown
Member

CI restarted

@theSlyest

Copy link
Copy Markdown
Author

@mtrezza Is there something else I need to to?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants