feat(Dashboard): Setting up dashboard (WIP)

Signed-off-by: Charles d'Avernas <charles.davernas@neuroglia.io>

Author: cdavernas

Synapse.sln

@@ -55,6 +55,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Synapse.Runtime.Containeriz
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Synapse.Runner", "src\runner\Synapse.Runner\Synapse.Runner.csproj", "{E5FAA9BA-07C3-49CF-AD3B-897AE1D0B018}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Synapse.Dashboard.StateManagement", "src\dashboard\Synapse.Dashboard.StateManagement\Synapse.Dashboard.StateManagement.csproj", "{91EF9F64-4997-407C-B353-C26B1421D0FB}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -125,6 +127,10 @@ Global
 		{E5FAA9BA-07C3-49CF-AD3B-897AE1D0B018}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{E5FAA9BA-07C3-49CF-AD3B-897AE1D0B018}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{E5FAA9BA-07C3-49CF-AD3B-897AE1D0B018}.Release|Any CPU.Build.0 = Release|Any CPU
+		{91EF9F64-4997-407C-B353-C26B1421D0FB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{91EF9F64-4997-407C-B353-C26B1421D0FB}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{91EF9F64-4997-407C-B353-C26B1421D0FB}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{91EF9F64-4997-407C-B353-C26B1421D0FB}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -153,6 +159,7 @@ Global
 		{DC24E506-602F-4FD9-B8C0-CEA6B2AD8888} = {175CE1C5-FE17-4C8B-8823-E812BAD4E527}
 		{F327B8F1-9A13-4924-AE1B-E69788AC73E7} = {175CE1C5-FE17-4C8B-8823-E812BAD4E527}
 		{E5FAA9BA-07C3-49CF-AD3B-897AE1D0B018} = {1DA47E5F-B23A-4D3C-96AA-4BD2662AB946}
+		{91EF9F64-4997-407C-B353-C26B1421D0FB} = {7DF998B8-0FB1-470E-8ED0-EA1CC7B16901}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {2A6C03D6-355A-4B39-9F2B-D0FDE429C0E2}

src/api/Synapse.Api.Client.Core/Services/IClusterResourceApiClient.cs

@@ -11,6 +11,14 @@ public interface IClusterResourceApiClient<TResource>
     where TResource : class, IResource, new()
 {
 
+    /// <summary>
+    /// Lists <see cref="IResource"/>s
+    /// </summary>
+    /// <param name="labelSelectors">An <see cref="IEnumerable{T}"/> containing the <see cref="LabelSelector"/>s used to select the <see cref="IResource"/>s to list by, if any</param>
+    /// <param name="cancellationToken">A <see cref="CancellationToken"/></param>
+    /// <returns>A new <see cref="IAsyncEnumerable{T}"/> used to asynchronously enumerate resulting <see cref="IResource"/>s</returns>
+    Task<IAsyncEnumerable<TResource>> ListAsync(IEnumerable<LabelSelector>? labelSelectors = null, CancellationToken cancellationToken = default);
+
     /// <summary>
     /// Gets the resource with the specified name
     /// </summary>
@@ -45,4 +53,4 @@ public interface IClusterResourceApiClient<TResource>
     /// <returns>A new awaitable <see cref="Task"/></returns>
     Task DeleteAsync(string name, CancellationToken cancellationToken = default);
 
-}
+}

src/api/Synapse.Api.Client.Core/Services/IDocumentApiClient.cs

@@ -13,7 +13,7 @@ public interface IDocumentApiClient
     /// <param name="content">The <see cref="Document"/>'s content</param>
     /// <param name="cancellationToken">A <see cref="CancellationToken"/></param>
     /// <returns>The newly created <see cref="Document"/></returns>
-    Task<Document> CreateAsync(string name, object? content, CancellationToken cancellationToken = default);
+    Task<Document> CreateAsync(string name, object content, CancellationToken cancellationToken = default);
 
     /// <summary>
     /// Gets the <see cref="Document"/> with the specified id

src/api/Synapse.Api.Client.Core/Services/INamespacedResourceApiClient.cs

@@ -11,6 +11,15 @@ public interface INamespacedResourceApiClient<TResource>
     where TResource : class, IResource, new()
 {
 
+    /// <summary>
+    /// Lists <see cref="IResource"/>s
+    /// </summary>
+    /// <param name="namespace">The namespace the <see cref="IResource"/>s to list belong to</param>
+    /// <param name="labelSelectors">An <see cref="IEnumerable{T}"/> containing the <see cref="LabelSelector"/>s used to select the <see cref="IResource"/>s to list by, if any</param>
+    /// <param name="cancellationToken">A <see cref="CancellationToken"/></param>
+    /// <returns>A new <see cref="IAsyncEnumerable{T}"/> used to asynchronously enumerate resulting <see cref="IResource"/>s</returns>
+    Task<IAsyncEnumerable<TResource>> ListAsync(string @namespace, IEnumerable<LabelSelector>? labelSelectors = null, CancellationToken cancellationToken = default);
+
     /// <summary>
     /// Gets the resource with the specified name
     /// </summary>

src/api/Synapse.Api.Client.Core/Services/IResourceEventWatchHub.cs

@@ -0,0 +1,25 @@
+namespace Synapse.Api.Client.Services;
+
+/// <summary>
+/// Defines the fundamentals of a service used by clients to watch resource-related events
+/// </summary>
+public interface IResourceEventWatchHub
+{
+
+    /// <summary>
+    /// Subscribes to events produced by resources of the specified type
+    /// </summary>
+    /// <param name="resourceDefinition">The type of resources to watch</param>
+    /// <param name="namespace">The namespace the resources to watch belong to, if any</param>
+    /// <returns>A new awaitable <see cref="Task"/></returns>
+    Task Watch(ResourceDefinitionInfo resourceDefinition, string? @namespace = null);
+
+    /// <summary>
+    /// Unsubscribes from events produced by resources of the specified type
+    /// </summary>
+    /// <param name="resourceDefinition">The type of resources to stop watching</param>
+    /// <param name="namespace">The namespace the resources to stop watching belong to, if any</param>
+    /// <returns>A new awaitable <see cref="Task"/></returns>
+    Task StopWatching(ResourceDefinitionInfo resourceDefinition, string? @namespace = null);
+
+}

src/api/Synapse.Api.Client.Core/Services/IResourceEventWatchHubClient.cs

@@ -0,0 +1,16 @@
+namespace Synapse.Api.Client.Services;
+
+/// <summary>
+/// Defines the fundamentals of a service used by clients to watch resource-related events
+/// </summary>
+public interface IResourceEventWatchHubClient
+{
+
+    /// <summary>
+    /// Notifies clients about a resource-related event
+    /// </summary>
+    /// <param name="e">The <see cref="ResourceWatchEvent"/> that has been produced</param>
+    /// <returns>A new awaitable <see cref="Task"/></returns>
+    Task ResourceWatchEvent(object e);
+
+}

src/api/Synapse.Api.Client.Core/Synapse.Api.Client.Core.csproj

@@ -13,8 +13,4 @@
     <ProjectReference Include="..\..\core\Synapse.Core\Synapse.Core.csproj" />
   </ItemGroup>
 
-  <ItemGroup>
-    <Folder Include="Services\Interfaces\" />
-  </ItemGroup>
-
 </Project>

src/api/Synapse.Api.Client.Http/Configuration/SynapseHttpApiClientOptions.cs

@@ -0,0 +1,14 @@
+namespace Synapse.Api.Client.Http.Configuration;
+
+/// <summary>
+/// Represents the options used to configure a Synapse HTTP API client
+/// </summary>
+public class SynapseHttpApiClientOptions
+{
+
+    /// <summary>
+    /// Gets/sets the base address of the Cloud Streams API to connect to
+    /// </summary>
+    public required virtual Uri BaseAddress { get; set; }
+
+}

src/api/Synapse.Api.Client.Http/Extensions/IServiceCollectionExtensions.cs

@@ -1,5 +1,8 @@
-using Microsoft.Extensions.DependencyInjection;
+using Microsoft.AspNetCore.SignalR.Client;
+using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.DependencyInjection.Extensions;
+using Microsoft.Extensions.Options;
+using Synapse.Api.Client.Http.Configuration;
 using Synapse.Api.Client.Services;
 
 namespace Synapse.Api.Client;
@@ -14,12 +17,25 @@ public static class IServiceCollectionExtensions
     /// Adds and configures a client for the Synapse HTTP API
     /// </summary>
     /// <param name="services">The <see cref="IServiceCollection"/> to configure</param>
-    /// <param name="httpClientSetup">An <see cref="Action{T}"/> used to configure the <see cref="HttpClient"/> to use</param>
+    /// <param name="setup">An <see cref="Action{T}"/> used to configure the <see cref="SynapseHttpApiClientOptions"/> to use</param>
     /// <returns>The configured <see cref="IServiceCollection"/></returns>
-    public static IServiceCollection AddSynapseHttpApiClient(this IServiceCollection services, Action<HttpClient> httpClientSetup)
+    public static IServiceCollection AddSynapseHttpApiClient(this IServiceCollection services, Action<SynapseHttpApiClientOptions> setup)
     {
-        services.AddHttpClient(typeof(SynapseHttpApiClient).Name, http => httpClientSetup(http));
-        services.TryAddSingleton<ISynapseApiClient, SynapseHttpApiClient>();
+        services.Configure(setup);
+        services.AddHttpClient(typeof(SynapseHttpApiClient).Name, (provider, http) =>
+        {
+            http.BaseAddress = provider.GetRequiredService<IOptions<SynapseHttpApiClientOptions>>().Value.BaseAddress;
+        });
+        services.TryAddScoped<ISynapseApiClient, SynapseHttpApiClient>();
+        services.TryAddSingleton(provider =>
+        {
+            var options = provider.GetRequiredService<IOptions<SynapseHttpApiClientOptions>>().Value;
+            var connection = new HubConnectionBuilder()
+                .WithUrl(new Uri(options.BaseAddress, "api/ws/resources/watch"))
+                .WithAutomaticReconnect()
+                .Build();
+            return new ResourceWatchEventHubClient(connection);
+        });
         return services;
     }
 

src/api/Synapse.Api.Client.Http/Extensions/ISynapseApiClientExtensions.cs

@@ -0,0 +1,51 @@
+// Copyright © 2024-Present The Cloud Streams Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License"),
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using Neuroglia.Data.Infrastructure.ResourceOriented;
+using Synapse.Api.Client.Services;
+
+namespace Synapse.Api.Client;
+
+/// <summary>
+/// Defines extensions for <see cref="ISynapseApiClient"/>s
+/// </summary>
+public static class ISynapseApiClientExtensions
+{
+
+    /// <summary>
+    /// Gets the <see cref="IResourceApiClient{TResource}"/> for the specified <see cref="IResource"/> type
+    /// </summary>
+    /// <typeparam name="TResource">The type of <see cref="IResource"/> to get the <see cref="IResourceApiClient{TResource}"/> for</typeparam>
+    /// <param name="client">The extended <see cref="ISynapseApiClient"/></param>
+    /// <returns>The <see cref="IResourceApiClient{TResource}"/> for the specified <see cref="IResource"/> type</returns>
+    public static INamespacedResourceApiClient<TResource> ManageNamespaced<TResource>(this ISynapseApiClient client)
+        where TResource : class, IResource, new()
+    {
+        var apiProperty = client.GetType().GetProperties().SingleOrDefault(p => p.CanRead && typeof(INamespacedResourceApiClient<>).MakeGenericType(typeof(TResource)).IsAssignableFrom(p.PropertyType)) ?? throw new NullReferenceException($"Failed to find a management API for the specified resource type '{new TResource().Definition}'");
+        return (INamespacedResourceApiClient<TResource>)apiProperty.GetValue(client)!;
+    }
+
+    /// <summary>
+    /// Gets the <see cref="IResourceApiClient{TResource}"/> for the specified <see cref="IResource"/> type
+    /// </summary>
+    /// <typeparam name="TResource">The type of <see cref="IResource"/> to get the <see cref="IResourceApiClient{TResource}"/> for</typeparam>
+    /// <param name="client">The extended <see cref="ISynapseApiClient"/></param>
+    /// <returns>The <see cref="IResourceApiClient{TResource}"/> for the specified <see cref="IResource"/> type</returns>
+    public static IClusterResourceApiClient<TResource> ManageCluster<TResource>(this ISynapseApiClient client)
+        where TResource : class, IResource, new()
+    {
+        var apiProperty = client.GetType().GetProperties().SingleOrDefault(p => p.CanRead && typeof(IClusterResourceApiClient<>).MakeGenericType(typeof(TResource)).IsAssignableFrom(p.PropertyType)) ?? throw new NullReferenceException($"Failed to find a management API for the specified resource type '{new TResource().Definition}'");
+        return (IClusterResourceApiClient<TResource>)apiProperty.GetValue(client)!;
+    }
+
+}