Merge pull request #308 from slskd/search-hub

Add Search SignalR hub

src/slskd/Search/API/Hubs/SearchHub.cs

@@ -0,0 +1,83 @@
+// <copyright file="SearchHub.cs" company="slskd Team">
+//     Copyright (c) slskd Team. All rights reserved.
+//
+//     This program is free software: you can redistribute it and/or modify
+//     it under the terms of the GNU Affero General Public License as published
+//     by the Free Software Foundation, either version 3 of the License, or
+//     (at your option) any later version.
+//
+//     This program is distributed in the hope that it will be useful,
+//     but WITHOUT ANY WARRANTY; without even the implied warranty of
+//     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//     GNU Affero General Public License for more details.
+//
+//     You should have received a copy of the GNU Affero General Public License
+//     along with this program.  If not, see https://www.gnu.org/licenses/.
+// </copyright>
+
+using Microsoft.Extensions.Options;
+
+namespace slskd.Search.API
+{
+    using System;
+    using System.Threading.Tasks;
+    using Microsoft.AspNetCore.Authorization;
+    using Microsoft.AspNetCore.SignalR;
+
+    public static class SearchHubMethods
+    {
+        public static readonly string Response = "RESPONSE";
+        public static readonly string Update = "UPDATE";
+    }
+
+    /// <summary>
+    ///     Extension methods for the search SignalR hub.
+    /// </summary>
+    public static class SearchHubExtensions
+    {
+        /// <summary>
+        ///     Broadcast an update for a search.
+        /// </summary>
+        /// <param name="hub">The hub.</param>
+        /// <param name="search">The search to broadcast.</param>
+        /// <returns>The operation context.</returns>
+        public static Task BroadcastUpdateAsync(this IHubContext<SearchHub> hub, Search search)
+        {
+            return hub.Clients.All.SendAsync(SearchHubMethods.Update, search);
+        }
+
+        /// <summary>
+        ///     Broadcast the present application options.
+        /// </summary>
+        /// <param name="hub">The hub.</param>
+        /// <param name="searchId">The ID of the search associated with the response.</param>
+        /// <param name="response">The response to broadcast.</param>
+        /// <returns>The operation context.</returns>
+        public static Task BroadcastResponseAsync(this IHubContext<SearchHub> hub, Guid searchId, Soulseek.SearchResponse response)
+        {
+            return hub.Clients.All.SendAsync(SearchHubMethods.Response, new { searchId, response });
+        }
+    }
+
+    /// <summary>
+    ///     The search SignalR hub.
+    /// </summary>
+    [Authorize]
+    public class SearchHub : Hub
+    {
+        public SearchHub(
+            IStateMonitor<State> stateMonitor,
+            IOptionsMonitor<Options> optionsMonitor)
+        {
+            StateMonitor = stateMonitor;
+            OptionsMonitor = optionsMonitor;
+        }
+
+        private IStateMonitor<State> StateMonitor { get; }
+        private IOptionsMonitor<Options> OptionsMonitor { get; }
+
+        public override async Task OnConnectedAsync()
+        {
+        }
+    }
+}

src/slskd/Search/SearchService.cs

@@ -26,8 +26,10 @@ namespace slskd.Search
     using System.Linq.Expressions;
     using System.Threading;
     using System.Threading.Tasks;
+    using Microsoft.AspNetCore.SignalR;
     using Microsoft.EntityFrameworkCore;
     using Microsoft.Extensions.Logging;
+    using slskd.Search.API;
     using Soulseek;
     using SearchOptions = Soulseek.SearchOptions;
     using SearchQuery = Soulseek.SearchQuery;
@@ -43,18 +45,21 @@ public class SearchService : ISearchService
         /// <summary>
         ///     Initializes a new instance of the <see cref="SearchService"/> class.
         /// </summary>
+        /// <param name="searchHub"></param>
         /// <param name="optionsMonitor"></param>
         /// <param name="soulseekClient"></param>
         /// <param name="application"></param>
         /// <param name="contextFactory">The database context to use.</param>
         /// <param name="log">The logger.</param>
         public SearchService(
+            IHubContext<SearchHub> searchHub,
             IOptionsMonitor<Options> optionsMonitor,
             ISoulseekClient soulseekClient,
             IApplication application,
             IDbContextFactory<SearchDbContext> contextFactory,
             ILogger<SearchService> log)
         {
+            SearchHub = searchHub;
             OptionsMonitor = optionsMonitor;
             Client = soulseekClient;
             Application = application;
@@ -70,6 +75,7 @@ public class SearchService : ISearchService
         private ISoulseekClient Client { get; }
         private IDbContextFactory<SearchDbContext> ContextFactory { get; }
         private ILogger<SearchService> Log { get; set; }
+        private IHubContext<SearchHub> SearchHub { get; set; }
 
         /// <summary>
         ///     Performs a search for the specified <paramref name="query"/> and <paramref name="scope"/>.
@@ -96,7 +102,7 @@ public async Task<Search> CreateAsync(Guid id, SearchQuery query, SearchScope sc
             options ??= new SearchOptions();
             options = options.WithActions(
                 stateChanged: (args) => UpdateSearchState(search, args.Search),
-                responseReceived: (args) => UpdateSearchState(search, args.Search));
+                responseReceived: (args) => UpdateSearchResponses(search, args.Search, args.Response));
 
             try
             {
@@ -201,10 +207,20 @@ private void UpdateSearchState(Search search, SoulseekSearch soulseekSearch)
                 search.ResponseCount = soulseekSearch.ResponseCount;
                 search.State = soulseekSearch.State;
 
+                SearchHub.BroadcastUpdateAsync(search);
                 SaveSearchState(search);
             }
         }
 
+        private void UpdateSearchResponses(Search search, SoulseekSearch soulseekSearch, Soulseek.SearchResponse response)
+        {
+            if (CancellationTokens.ContainsKey(search.Id))
+            {
+                SearchHub.BroadcastResponseAsync(search.Id, response);
+                UpdateSearchState(search, soulseekSearch);
+            }
+        }
+
         private void SaveSearchState(Search search)
         {
             var context = ContextFactory.CreateDbContext();

src/slskd/Startup.cs

@@ -41,6 +41,7 @@ namespace slskd
     using slskd.Integrations.Pushbullet;
     using slskd.Messaging;
     using slskd.Search;
+    using slskd.Search.API;
     using slskd.Shares;
     using slskd.Transfers;
     using slskd.Users;
@@ -337,6 +338,7 @@ public void ConfigureServices(IServiceCollection services)
             {
                 endpoints.MapHub<ApplicationHub>("/hub/application");
                 endpoints.MapHub<LogsHub>("/hub/logs");
+                endpoints.MapHub<SearchHub>("/hub/search");
 
                 endpoints.MapControllers();
                 endpoints.MapHealthChecks("/health");