Add observable deployment monitoring

sharpbrick#36 non-breaking

Author: tthiery

examples/SharpBrick.PoweredUp.Examples/ExampleMixedBag.cs

@@ -15,7 +15,7 @@ public static async Task ExecuteAsync(PoweredUpHost host, IServiceProvider servi
 
             using (var technicMediumHub = host.FindByType<TechnicMediumHub>())
             {
-                await technicMediumHub.VerifyAsync(modelBuilder => modelBuilder
+                await technicMediumHub.VerifyDeploymentModelAsync(modelBuilder => modelBuilder
                     .AddHub<TechnicMediumHub>(hubBuilder => hubBuilder
                         .AddDevice<TechnicXLargeLinearMotor>(technicMediumHub.A)
                     )

examples/SharpBrick.PoweredUp.Examples/ExampleMotorControl.cs

@@ -10,7 +10,7 @@ public static async Task ExecuteAsync(PoweredUpHost host, IServiceProvider servi
         {
             using (var technicMediumHub = host.FindByType<TechnicMediumHub>())
             {
-                await technicMediumHub.VerifyAsync(modelBuilder => modelBuilder
+                await technicMediumHub.VerifyDeploymentModelAsync(modelBuilder => modelBuilder
                     .AddHub<TechnicMediumHub>(hubBuilder => hubBuilder
                         .AddDevice<TechnicXLargeLinearMotor>(technicMediumHub.A)
                     )

examples/SharpBrick.PoweredUp.Examples/ExampleMotorInputAbsolutePosition.cs

@@ -15,7 +15,7 @@ public static async Task ExecuteAsync(PoweredUpHost host, IServiceProvider servi
 
             using (var technicMediumHub = host.FindByType<TechnicMediumHub>())
             {
-                await technicMediumHub.VerifyAsync(modelBuilder => modelBuilder
+                await technicMediumHub.VerifyDeploymentModelAsync(modelBuilder => modelBuilder
                     .AddHub<TechnicMediumHub>(hubBuilder => hubBuilder
                         .AddDevice<TechnicXLargeLinearMotor>(technicMediumHub.A)
                     )

examples/SharpBrick.PoweredUp.Examples/ExampleMotorInputCombinedMode.cs

@@ -15,7 +15,7 @@ public static async Task ExecuteAsync(PoweredUpHost host, IServiceProvider servi
 
             using (var technicMediumHub = host.FindByType<TechnicMediumHub>())
             {
-                await technicMediumHub.VerifyAsync(modelBuilder => modelBuilder
+                await technicMediumHub.VerifyDeploymentModelAsync(modelBuilder => modelBuilder
                     .AddHub<TechnicMediumHub>(hubBuilder => hubBuilder
                         .AddDevice<TechnicXLargeLinearMotor>(technicMediumHub.A)
                     )

examples/SharpBrick.PoweredUp.Examples/ExampleMotorVirtualPort.cs

@@ -10,7 +10,7 @@ public static async Task ExecuteAsync(PoweredUpHost host, IServiceProvider servi
         {
             using (var technicMediumHub = host.FindByType<TechnicMediumHub>())
             {
-                await technicMediumHub.VerifyAsync(modelBuilder => modelBuilder
+                await technicMediumHub.VerifyDeploymentModelAsync(modelBuilder => modelBuilder
                     .AddHub<TechnicMediumHub>(hubBuilder => hubBuilder
                         .AddDevice<TechnicXLargeLinearMotor>(0)
                         .AddDevice<TechnicXLargeLinearMotor>(2)

src/SharpBrick.PoweredUp/Deployment/DeploymentModel.cs

@@ -1,7 +1,6 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using System.Threading.Tasks;
 using SharpBrick.PoweredUp.Protocol;
 
 namespace SharpBrick.PoweredUp.Deployment
@@ -20,14 +19,14 @@ public DeploymentModel(DeploymentHubModel[] hubs)
             Hubs = hubs;
         }
 
-        public Task<DeploymentModelError[]> VerifyAsync(params IPoweredUpProtocol[] protocols)
+        public DeploymentModelError[] Verify(params IPoweredUpProtocol[] protocols)
         {
             //TODO: match best hub with best protocol
 
-            return VerifyAsync(protocols[0], 0x00, Hubs[0]);
+            return Verify(protocols[0], 0x00, Hubs[0]);
         }
 
-        public Task<DeploymentModelError[]> VerifyAsync(IPoweredUpProtocol protocol, byte hubId, DeploymentHubModel hubModel)
+        public DeploymentModelError[] Verify(IPoweredUpProtocol protocol, byte hubId, DeploymentHubModel hubModel)
         {
             if (protocol is null)
             {
@@ -75,7 +74,7 @@ public Task<DeploymentModelError[]> VerifyAsync(IPoweredUpProtocol protocol, byt
                     }
                 )));
 
-            return Task.FromResult(result.ToArray());
+            return result.ToArray();
         }
     }
 }

src/SharpBrick.PoweredUp/Deployment/HubExtensions.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Reactive.Linq;
 using System.Threading.Tasks;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
@@ -8,37 +9,86 @@ namespace SharpBrick.PoweredUp
 {
     public static class HubExtensions
     {
-        public static async Task<DeploymentModelError[]> VerifyAsync(this Hub self, Action<DeploymentModelBuilder> configure)
+        public static async Task VerifyDeploymentModelAsync(this Hub self, Action<DeploymentModelBuilder> configure)
         {
             if (self is null)
             {
                 throw new ArgumentNullException(nameof(self));
             }
 
-            if (configure is null)
-            {
-                throw new ArgumentNullException(nameof(configure));
-            }
+            var model = BuildModel(configure);
 
-            var deploymentModelBuilder = new DeploymentModelBuilder();
+            var awaitable = self.VerifyObservable(model)
+                .Do(LogErrors(self))
+                .Where(x => x.Length == 0)
+                .FirstAsync()
+                .GetAwaiter();
 
-            configure(deploymentModelBuilder);
+            var firstErors = model.Verify(self.Protocol);
 
-            var model = deploymentModelBuilder.Build();
+            if (firstErors.Length > 0)
+            {
+                LogErrors(self)(firstErors);
 
-            var errors = await model.VerifyAsync(self.Protocol);
+                await awaitable;
+            }
+        }
 
-            if (errors.Length > 0)
+        private static Action<DeploymentModelError[]> LogErrors(Hub self)
+        {
+            return errors =>
             {
                 var logger = self.ServiceProvider.GetService<ILoggerFactory>().CreateLogger<Hub>();
+                if (errors.Length > 0)
+                {
 
-                foreach (var error in errors)
+                    foreach (var error in errors)
+                    {
+                        logger.LogError($"ERROR {error.ErrorCode} @ {error.HubId}-{error.PortId}: {error.Message}");
+                    }
+                }
+                else
                 {
-                    logger.LogError($"ERROR {error.ErrorCode} @ {error.HubId}-{error.PortId}: {error.Message}");
+                    logger.LogInformation("Deployment Validation Successful");
                 }
+            };
+        }
+
+        public static IObservable<DeploymentModelError[]> VerifyObservable(this Hub self, Action<DeploymentModelBuilder> configure)
+        {
+            if (self is null)
+            {
+                throw new ArgumentNullException(nameof(self));
             }
 
-            return errors;
+            var model = BuildModel(configure);
+
+            return self.VerifyObservable(model);
+        }
+
+        public static IObservable<DeploymentModelError[]> VerifyObservable(this Hub self, DeploymentModel model)
+        {
+            if (model is null)
+            {
+                throw new ArgumentNullException(nameof(model));
+            }
+
+            return self.Protocol.UpstreamMessages.Select(msg => model.Verify(self.Protocol));
+        }
+
+        private static DeploymentModel BuildModel(Action<DeploymentModelBuilder> configure)
+        {
+            if (configure is null)
+            {
+                throw new ArgumentNullException(nameof(configure));
+            }
+
+            var deploymentModelBuilder = new DeploymentModelBuilder();
+
+            configure(deploymentModelBuilder);
+
+            var model = deploymentModelBuilder.Build();
+            return model;
         }
     }
 }