Fix ignored exceptions in MqttHostedServer startup

Author: beppemarazzi

Source/MQTTnet.AspnetCore/MQTTnet.AspNetCore.csproj

@@ -1,5 +1,10 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
+    <!--TODO: remove before close https://github.com/dotnet/MQTTnet/pull/2102 WIP: Fix ignored exceptions in MqttHostedServer startup #2102 -->
+    <PropertyGroup>
+        <DefineConstants>$(DefineConstants);HOSTEDSERVER_WITHOUT_STARTUP_YIELD</DefineConstants>
+    </PropertyGroup>
+    
     <PropertyGroup>
         <TargetFramework>net8.0</TargetFramework>
         <AssemblyName>MQTTnet.AspNetCore</AssemblyName>

Source/MQTTnet.AspnetCore/MqttHostedServer.cs

@@ -1,3 +1,6 @@
+//TODO: remove before close https://github.com/dotnet/MQTTnet/pull/2102
+////WIP: Fix ignored exceptions in MqttHostedServer startup #2102
+#if !HOSTEDSERVER_WITHOUT_STARTUP_YIELD
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
@@ -45,4 +48,45 @@ void OnStarted()
     {
         _ = StartAsync();
     }
-}
+}
+
+#else
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System;
+using System.Collections.Generic;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Hosting;
+using MQTTnet.Diagnostics.Logger;
+using MQTTnet.Server;
+
+namespace MQTTnet.AspNetCore;
+
+public sealed class MqttHostedServer : BackgroundService
+{
+    readonly MqttServerFactory _mqttFactory;
+    public MqttHostedServer(
+        MqttServerFactory mqttFactory,
+        MqttServerOptions options,
+        IEnumerable<IMqttServerAdapter> adapters,
+        IMqttNetLogger logger
+        )
+    {
+        MqttServer = new(options, adapters, logger);
+        _mqttFactory = mqttFactory ?? throw new ArgumentNullException(nameof(mqttFactory));
+    }
+
+    public MqttServer MqttServer { get; }
+    protected override Task ExecuteAsync(CancellationToken stoppingToken)
+        => MqttServer.StartAsync();
+    public override async Task StopAsync(CancellationToken cancellationToken)
+    {
+        await MqttServer.StopAsync(_mqttFactory.CreateMqttServerStopOptionsBuilder().Build());
+        await base.StopAsync(cancellationToken);
+    }
+}
+
+#endif

Source/MQTTnet.AspnetCore/ServiceCollectionExtensions.cs

@@ -45,8 +45,16 @@ public static void AddHostedMqttServer(this IServiceCollection services)
         services.TryAddSingleton(new MqttServerFactory());
 
         services.AddSingleton<MqttHostedServer>();
+        //TODO: remove before close https://github.com/dotnet/MQTTnet/pull/2102
+        ////WIP: Fix ignored exceptions in MqttHostedServer startup #2102
+#if !HOSTEDSERVER_WITHOUT_STARTUP_YIELD
         services.AddSingleton<IHostedService>(s => s.GetService<MqttHostedServer>());
         services.AddSingleton<MqttServer>(s => s.GetService<MqttHostedServer>());
+#else
+        services.AddHostedService(s => s.GetService<MqttHostedServer>());
+        services.AddSingleton<MqttServer>(s => s.GetService<MqttHostedServer>().MqttServer);
+#endif
+
     }
 
     public static IServiceCollection AddHostedMqttServerWithServices(this IServiceCollection services, Action<AspNetMqttServerOptionsBuilder> configure)

Source/MQTTnet.Tests/ASP/MqttHostedServerStartup.cs

@@ -0,0 +1,66 @@
+using Microsoft.AspNetCore.Builder;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using MQTTnet.AspNetCore;
+using System.Net.Sockets;
+using System.Net;
+using System.Threading.Tasks;
+using Microsoft.Extensions.DependencyInjection;
+using MQTTnet.Server;
+using Microsoft.AspNetCore.Hosting;
+
+namespace MQTTnet.Tests.ASP
+{
+    [TestClass]
+    public class MqttHostedServerStartup
+    {
+        private async Task TestStartup(bool useOccupiedPort)
+        {
+            using TcpListener l = new TcpListener(IPAddress.Any, 0);
+            l.Start();
+            int port = ((IPEndPoint)l.LocalEndpoint).Port;
+
+            if(!useOccupiedPort)
+                l.Stop();
+
+
+            var builder = WebApplication.CreateBuilder();
+            builder.WebHost.UseUrls("http://127.0.0.1:0");
+
+            builder.Services.AddMqttTcpServerAdapter();
+            builder.Services.AddHostedMqttServer(cfg =>
+            {
+                cfg
+                    .WithDefaultEndpoint()
+                    .WithDefaultEndpointPort(port);
+            });
+
+
+            var app = builder.Build();
+
+            if(!useOccupiedPort)
+            {
+                await app.StartAsync();
+                var server = app.Services.GetRequiredService<MqttServer>();
+                Assert.IsTrue(server.IsStarted);
+                await app.StopAsync();
+            }
+            else
+            {
+                await Assert.ThrowsExceptionAsync<SocketException>(() =>
+                    app.StartAsync()
+                    );
+            }
+        }
+
+        [TestMethod]
+        [DoNotParallelize]
+        public Task TestSuccessfullyStartup()
+            => TestStartup(useOccupiedPort: false);
+
+        [TestMethod]
+        [DoNotParallelize]
+        public Task TestFailedStartup()
+            => TestStartup(useOccupiedPort: true);
+
+    }
+}