Add RealTime Comment Updates (#8868)

* Add Signal R package * Add SignalR Service * Push Comment Updates to All clients from controller * Hookup SignalR ClientSide * Two way comment push * Add Real Time Comment Updates
Azure · Aug 28, 2024 · 3051445 · 3051445
1 parent 5835f21
commit 3051445
Show file tree

Hide file tree

Showing 21 changed files with 600 additions and 137 deletions.
diff --git a/src/dotnet/APIView/APIViewWeb/DTOs/CommentUpdatesDto.cs b/src/dotnet/APIView/APIViewWeb/DTOs/CommentUpdatesDto.cs
@@ -0,0 +1,43 @@
+using System.Text.Json.Serialization;
+using APIViewWeb.LeanModels;
+
+namespace APIViewWeb.DTOs
+{
+    public enum CommentThreadUpdateAction
+    {
+        CommentCreated = 0,
+        CommentTextUpdate,
+        CommentResolved,
+        CommentUnResolved,
+        CommentUpVoteToggled,
+        CommentDeleted
+    }
+
+    public class CommentUpdatesDto
+    {
+        [JsonPropertyName("commentThreadUpdateAction")]
+        public CommentThreadUpdateAction CommentThreadUpdateAction { get; set; }
+        [JsonPropertyName("nodeId")]
+        public string NodeId { get; set; }
+        [JsonPropertyName("nodeIdHashed")]
+        public string NodeIdHashed { get; set; }
+        [JsonPropertyName("reviewId")]
+        public string ReviewId { get; set; }
+        [JsonPropertyName("revisionId")]
+        public string RevisionId { get; set; }
+        [JsonPropertyName("commentId")]
+        public string CommentId { get; set; }
+        [JsonPropertyName("elementId")]
+        public string ElementId { get; set; }
+        [JsonPropertyName("commentText")]
+        public string CommentText { get; set; }
+        [JsonPropertyName("comment")]
+        public CommentItemModel Comment { get; set; }
+        [JsonPropertyName("resolvedBy")]
+        public string ResolvedBy { get; set; }
+        [JsonPropertyName("associatedRowPositionInGroup")]
+        public int? AssociatedRowPositionInGroup { get; set; }
+        [JsonPropertyName("allowAnyOneToResolve")]
+        public bool? AllowAnyOneToResolve { get; set; }
+    }
+}
diff --git a/src/dotnet/APIView/APIViewWeb/Helpers/APIHelpers.cs b/src/dotnet/APIView/APIViewWeb/Helpers/APIHelpers.cs
@@ -73,6 +73,7 @@ public PagedList(IEnumerable<T> items, int noOfItemsRead, int totalCount, int pa
     public class LeanJsonResult : JsonResult
     {
         private readonly int _statusCode;
+        private readonly string _locationUrl;
 
         private static readonly JsonSerializerOptions _serializerOptions = new JsonSerializerOptions
         {
@@ -88,6 +89,12 @@ public LeanJsonResult(object value, int statusCode) : base(value)
             _statusCode = statusCode;
         }
 
+        public LeanJsonResult(object value, int statusCode, string locationUrl) : base(value)
+        {
+            _statusCode = statusCode;
+            _locationUrl = locationUrl;
+        }
+
         public override async Task ExecuteResultAsync(ActionContext context)
         {
             if (context == null)
@@ -99,6 +106,7 @@ public override async Task ExecuteResultAsync(ActionContext context)
 
             response.ContentType = !string.IsNullOrEmpty(ContentType) ? ContentType : "application/json";
             response.StatusCode = _statusCode;
+            response.Headers["Location"] = _locationUrl;
 
             var serializedValue = JsonSerializer.Serialize(Value, _serializerOptions);
             await response.WriteAsync(serializedValue);

diff --git a/src/dotnet/APIView/APIViewWeb/Hubs/SignalRHub.cs b/src/dotnet/APIView/APIViewWeb/Hubs/SignalRHub.cs
@@ -1,7 +1,7 @@
 using System.Threading.Tasks;
+using APIViewWeb.DTOs;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.SignalR;
-using Microsoft.Extensions.Logging;
 
 namespace APIViewWeb.Hubs
 {
@@ -26,5 +26,14 @@ public async Task PushComment(string reviewId, string elementId, string partialV
                 await Clients.Others.SendAsync("ReceiveComment", reviewId, elementId, partialViewResult);
             }
         }
-    }
+
+        /// <summary>
+        /// Endpoint Consumed by Client SPA
+        /// </summary>
+        /// <returns></returns>
+        public async Task PushCommentUpdates(CommentUpdatesDto commentUpdatesDto) 
+        {
+            await Clients.All.SendAsync("ReceiveCommentUpdates", commentUpdatesDto);
+        }
+    }   
 }
diff --git a/src/dotnet/APIView/APIViewWeb/LeanControllers/CommentsController.cs b/src/dotnet/APIView/APIViewWeb/LeanControllers/CommentsController.cs
@@ -1,8 +1,10 @@
 using APIViewWeb.Helpers;
+using APIViewWeb.Hubs;
 using APIViewWeb.LeanModels;
 using APIViewWeb.Managers;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.SignalR;
 using Microsoft.Extensions.Logging;
 using System;
 using System.Collections.Generic;
@@ -19,8 +21,8 @@ public class CommentsController : BaseApiController
         private readonly IReviewManager _reviewManager;
         private readonly INotificationManager _notificationManager;
 
-        public CommentsController(ILogger<CommentsController> logger,
-            ICommentsManager commentManager, IReviewManager reviewManager, INotificationManager notificationManager)
+        public CommentsController(ILogger<CommentsController> logger, ICommentsManager commentManager,
+            IReviewManager reviewManager, INotificationManager notificationManager)
         {
             _logger = logger;
             _commentsManager = commentManager;
@@ -126,7 +128,7 @@ public async Task<ActionResult> CreateCommentAsync(
             {
                 await _notificationManager.SubscribeAsync(review, User);
             }
-            return CreatedAtAction("GetComments", new { reviewId = reviewId }, comment);
+             return new LeanJsonResult(comment, StatusCodes.Status201Created, Url.Action("GetComments", new { reviewId = reviewId }));
         }
 
         /// <summary>

diff --git a/src/dotnet/APIView/APIViewWeb/LeanModels/ChangeHistory.cs b/src/dotnet/APIView/APIViewWeb/LeanModels/ChangeHistory.cs
@@ -4,6 +4,7 @@
 
 namespace APIViewWeb.LeanModels
 {
+    [System.Text.Json.Serialization.JsonConverter(typeof(System.Text.Json.Serialization.JsonStringEnumConverter))]
     [JsonConverter(typeof(StringEnumConverter))]
     public enum AICommentChangeAction
     {
@@ -12,6 +13,7 @@ public enum AICommentChangeAction
         Modified
     }
 
+    [System.Text.Json.Serialization.JsonConverter(typeof(System.Text.Json.Serialization.JsonStringEnumConverter))]
     [JsonConverter(typeof(StringEnumConverter))]
     public enum ReviewChangeAction
     {
@@ -24,6 +26,7 @@ public enum ReviewChangeAction
         UnDeleted
     }
 
+    [System.Text.Json.Serialization.JsonConverter(typeof(System.Text.Json.Serialization.JsonStringEnumConverter))]
     [JsonConverter(typeof(StringEnumConverter))]
     public enum APIRevisionChangeAction
     {
@@ -34,6 +37,7 @@ public enum APIRevisionChangeAction
         UnDeleted
     }
 
+    [System.Text.Json.Serialization.JsonConverter(typeof(System.Text.Json.Serialization.JsonStringEnumConverter))]
     [JsonConverter(typeof(StringEnumConverter))]
     public enum CommentChangeAction
     {

diff --git a/src/dotnet/APIView/APIViewWeb/LeanModels/CommentItemModel.cs b/src/dotnet/APIView/APIViewWeb/LeanModels/CommentItemModel.cs
@@ -5,6 +5,7 @@
 
 namespace APIViewWeb.LeanModels
 {
+    [System.Text.Json.Serialization.JsonConverter(typeof(System.Text.Json.Serialization.JsonStringEnumConverter))]
     [JsonConverter(typeof(StringEnumConverter))]
     public enum CommentType
     {
@@ -14,6 +15,7 @@ public enum CommentType
 
     public class CommentItemModel
     {
+        [System.Text.Json.Serialization.JsonPropertyName("id")]
         [JsonProperty("id")]
         public string Id { get; set; } = IdHelper.GenerateId();
         public string ReviewId { get; set; }