Add Directory.Build.props. (#2120)

* Add Directory.Build.props.

* Adjust Analysis related properties and add conditional enablement for ContinuousIntegrationBuild.

* Adopt new changes in master

---------

Co-authored-by: christian <6939810+chkr1011@users.noreply.github.com>

Source/MQTTnet.Server/EnhancedAuthentication/ExchangeEnhancedAuthenticationOptionsFactory.cs

@@ -53,10 +53,7 @@ public sealed class ExchangeEnhancedAuthenticationOptionsFactory
 
     public ExchangeEnhancedAuthenticationOptionsFactory WithUserProperty(string name, string value)
     {
-        if (name == null)
-        {
-            throw new ArgumentNullException(nameof(name));
-        }
+        ArgumentNullException.ThrowIfNull(name);
 
         if (_options.UserProperties == null)
         {

Source/MQTTnet.Server/Events/InterceptingPacketEventArgs.cs

@@ -10,7 +10,7 @@ namespace MQTTnet.Server;
 
 public sealed class InterceptingPacketEventArgs : EventArgs
 {
-    public InterceptingPacketEventArgs(CancellationToken cancellationToken, string clientId, string userName, EndPoint remoteEndPoint, MqttPacket packet, IDictionary sessionItems)
+    public InterceptingPacketEventArgs(string clientId, string userName, EndPoint remoteEndPoint, MqttPacket packet, IDictionary sessionItems, CancellationToken cancellationToken)
     {
         CancellationToken = cancellationToken;
         ClientId = clientId ?? throw new ArgumentNullException(nameof(clientId));

Source/MQTTnet.Server/Events/InterceptingPublishEventArgs.cs

@@ -8,7 +8,7 @@ namespace MQTTnet.Server;
 
 public sealed class InterceptingPublishEventArgs : EventArgs
 {
-    public InterceptingPublishEventArgs(MqttApplicationMessage applicationMessage, CancellationToken cancellationToken, string clientId, string userName, IDictionary sessionItems)
+    public InterceptingPublishEventArgs(MqttApplicationMessage applicationMessage, string clientId, string userName, IDictionary sessionItems, CancellationToken cancellationToken)
     {
         ApplicationMessage = applicationMessage ?? throw new ArgumentNullException(nameof(applicationMessage));
         CancellationToken = cancellationToken;
@@ -30,11 +30,6 @@ public sealed class InterceptingPublishEventArgs : EventArgs
     /// </summary>
     public string ClientId { get; }
 
-    /// <summary>
-    /// Gets the user name of the client.
-    /// </summary>
-    public string UserName { get; }
-
     public bool CloseConnection { get; set; }
 
     /// <summary>
@@ -45,10 +40,15 @@ public sealed class InterceptingPublishEventArgs : EventArgs
     /// <summary>
     ///     Gets the response which will be sent to the client via the PUBACK etc. packets.
     /// </summary>
-    public PublishResponse Response { get; } = new PublishResponse();
+    public PublishResponse Response { get; } = new();
 
     /// <summary>
     ///     Gets or sets a key/value collection that can be used to share data within the scope of this session.
     /// </summary>
     public IDictionary SessionItems { get; }
+
+    /// <summary>
+    ///     Gets the user name of the client.
+    /// </summary>
+    public string UserName { get; }
 }

Source/MQTTnet.Server/Events/InterceptingSubscriptionEventArgs.cs

@@ -10,12 +10,12 @@ namespace MQTTnet.Server;
 public sealed class InterceptingSubscriptionEventArgs : EventArgs
 {
     public InterceptingSubscriptionEventArgs(
-        CancellationToken cancellationToken,
         string clientId,
         string userName,
         MqttSessionStatus session,
         MqttTopicFilter topicFilter,
-        List<MqttUserProperty> userProperties)
+        List<MqttUserProperty> userProperties,
+        CancellationToken cancellationToken)
     {
         CancellationToken = cancellationToken;
         ClientId = clientId;
@@ -36,11 +36,6 @@ public sealed class InterceptingSubscriptionEventArgs : EventArgs
     /// </summary>
     public string ClientId { get; }
 
-    /// <summary>
-    /// Gets the user name of the client.
-    /// </summary>
-    public string UserName { get; }
-
     /// <summary>
     ///     Gets or sets whether the broker should close the client connection.
     /// </summary>
@@ -61,7 +56,7 @@ public sealed class InterceptingSubscriptionEventArgs : EventArgs
     /// <summary>
     ///     Gets the response which will be sent to the client via the SUBACK packet.
     /// </summary>
-    public SubscribeResponse Response { get; } = new SubscribeResponse();
+    public SubscribeResponse Response { get; } = new();
 
     /// <summary>
     ///     Gets the current client session.
@@ -79,6 +74,11 @@ public sealed class InterceptingSubscriptionEventArgs : EventArgs
     /// </summary>
     public MqttTopicFilter TopicFilter { get; set; }
 
+    /// <summary>
+    ///     Gets the user name of the client.
+    /// </summary>
+    public string UserName { get; }
+
     /// <summary>
     ///     Gets or sets the user properties.
     ///     <remarks>MQTT 5.0.0+ feature.</remarks>

Source/MQTTnet.Server/Events/InterceptingUnsubscriptionEventArgs.cs

@@ -9,7 +9,7 @@ namespace MQTTnet.Server;
 
 public sealed class InterceptingUnsubscriptionEventArgs : EventArgs
 {
-    public InterceptingUnsubscriptionEventArgs(CancellationToken cancellationToken, string clientId, string userName, IDictionary sessionItems, string topic, List<MqttUserProperty> userProperties)
+    public InterceptingUnsubscriptionEventArgs(string clientId, string userName, IDictionary sessionItems, string topic, List<MqttUserProperty> userProperties, CancellationToken cancellationToken)
     {
         CancellationToken = cancellationToken;
         ClientId = clientId;

Source/MQTTnet.Server/Internal/MqttClientSessionsManager.cs

@@ -131,7 +131,7 @@ public sealed class MqttClientSessionsManager : ISubscriptionChangedNotification
         // Allow the user to intercept application message...
         if (_eventContainer.InterceptingPublishEvent.HasHandlers)
         {
-            var interceptingPublishEventArgs = new InterceptingPublishEventArgs(applicationMessage, cancellationToken, senderId, senderUserName, senderSessionItems);
+            var interceptingPublishEventArgs = new InterceptingPublishEventArgs(applicationMessage, senderId, senderUserName, senderSessionItems, cancellationToken);
             if (string.IsNullOrEmpty(interceptingPublishEventArgs.ApplicationMessage.Topic))
             {
                 // This can happen if a topic alias us used but the topic is
@@ -437,7 +437,7 @@ public sealed class MqttClientSessionsManager : ISubscriptionChangedNotification
         }
     }
 
-    public void OnSubscriptionsAdded(MqttSession clientSession, List<string> topics)
+    public void OnSubscriptionsAdded(MqttSession clientSession, List<string> subscriptionsTopics)
     {
         _sessionsManagementLock.EnterWriteLock();
         try
@@ -448,7 +448,7 @@ public sealed class MqttClientSessionsManager : ISubscriptionChangedNotification
                 _subscriberSessions.Add(clientSession);
             }
 
-            foreach (var topic in topics)
+            foreach (var topic in subscriptionsTopics)
             {
                 clientSession.AddSubscribedTopic(topic);
             }

Source/MQTTnet.Server/Internal/MqttClientSubscriptionsManager.cs

@@ -81,7 +81,7 @@ public sealed class MqttClientSubscriptionsManager : IDisposable
             return CheckSubscriptionsResult.NotSubscribed;
         }
 
-        var senderIsReceiver = string.Equals(senderId, _session.Id);
+        var senderIsReceiver = string.Equals(senderId, _session.Id, StringComparison.Ordinal);
         var maxQoSLevel = -1; // Not subscribed.
 
         HashSet<uint> subscriptionIdentifiers = null;
@@ -460,7 +460,7 @@ public sealed class MqttClientSubscriptionsManager : IDisposable
         List<MqttUserProperty> userProperties,
         CancellationToken cancellationToken)
     {
-        var eventArgs = new InterceptingSubscriptionEventArgs(cancellationToken, _session.Id, _session.UserName, new MqttSessionStatus(_session), topicFilter, userProperties);
+        var eventArgs = new InterceptingSubscriptionEventArgs(_session.Id, _session.UserName, new MqttSessionStatus(_session), topicFilter, userProperties, cancellationToken);
 
         if (topicFilter.QualityOfServiceLevel == MqttQualityOfServiceLevel.AtMostOnce)
         {
@@ -475,7 +475,7 @@ public sealed class MqttClientSubscriptionsManager : IDisposable
             eventArgs.Response.ReasonCode = MqttSubscribeReasonCode.GrantedQoS2;
         }
 
-        if (topicFilter.Topic.StartsWith("$share/"))
+        if (topicFilter.Topic.StartsWith("$share/", StringComparison.InvariantCulture))
         {
             eventArgs.Response.ReasonCode = MqttSubscribeReasonCode.SharedSubscriptionsNotSupported;
         }
@@ -493,7 +493,7 @@ public sealed class MqttClientSubscriptionsManager : IDisposable
         List<MqttUserProperty> userProperties,
         CancellationToken cancellationToken)
     {
-        var clientUnsubscribingTopicEventArgs = new InterceptingUnsubscriptionEventArgs(cancellationToken, _session.Id, _session.UserName, _session.Items, topicFilter, userProperties)
+        var clientUnsubscribingTopicEventArgs = new InterceptingUnsubscriptionEventArgs(_session.Id, _session.UserName, _session.Items, topicFilter, userProperties, cancellationToken)
         {
             Response =
             {

Source/MQTTnet.Server/Internal/MqttConnectedClient.cs

@@ -156,7 +156,7 @@ public sealed class MqttConnectedClient : IDisposable
                 // TODO: Maybe adding a configuration option is requested in the future.
                 if (disconnectOptions != null)
                 {
-                    if (disconnectOptions.ReasonCode != MqttDisconnectReasonCode.NormalDisconnection || disconnectOptions.UserProperties?.Any() == true ||
+                    if (disconnectOptions.ReasonCode != MqttDisconnectReasonCode.NormalDisconnection || disconnectOptions.UserProperties?.Count > 0 ||
                         !string.IsNullOrEmpty(disconnectOptions.ReasonString) || !string.IsNullOrEmpty(disconnectOptions.ServerReference))
                     {
                         // It is very important to send the DISCONNECT packet here BEFORE cancelling the
@@ -349,7 +349,7 @@ public sealed class MqttConnectedClient : IDisposable
             return packet;
         }
 
-        var interceptingPacketEventArgs = new InterceptingPacketEventArgs(cancellationToken, Id, UserName, RemoteEndPoint, packet, Session.Items);
+        var interceptingPacketEventArgs = new InterceptingPacketEventArgs(Id, UserName, RemoteEndPoint, packet, Session.Items, cancellationToken);
         await _eventContainer.InterceptingOutboundPacketEvent.InvokeAsync(interceptingPacketEventArgs).ConfigureAwait(false);
 
         if (!interceptingPacketEventArgs.ProcessPacket || packet == null)
@@ -395,7 +395,7 @@ public sealed class MqttConnectedClient : IDisposable
 
                 if (_eventContainer.InterceptingInboundPacketEvent.HasHandlers)
                 {
-                    var interceptingPacketEventArgs = new InterceptingPacketEventArgs(cancellationToken, Id, UserName, RemoteEndPoint, currentPacket, Session.Items);
+                    var interceptingPacketEventArgs = new InterceptingPacketEventArgs(Id, UserName, RemoteEndPoint, currentPacket, Session.Items, cancellationToken);
                     await _eventContainer.InterceptingInboundPacketEvent.InvokeAsync(interceptingPacketEventArgs).ConfigureAwait(false);
                     currentPacket = interceptingPacketEventArgs.Packet;
                     processPacket = interceptingPacketEventArgs.ProcessPacket;

Source/MQTTnet.Server/Internal/MqttRetainedMessagesManager.cs

@@ -7,13 +7,12 @@ using MQTTnet.Internal;
 
 namespace MQTTnet.Server.Internal;
 
-public sealed class MqttRetainedMessagesManager
+public sealed class MqttRetainedMessagesManager : IDisposable
 {
-    readonly Dictionary<string, MqttApplicationMessage> _messages = new(4096);
-    readonly AsyncLock _storageAccessLock = new();
-
     readonly MqttServerEventContainer _eventContainer;
     readonly MqttNetSourceLogger _logger;
+    readonly Dictionary<string, MqttApplicationMessage> _messages = new(4096);
+    readonly AsyncLock _storageAccessLock = new();
 
     public MqttRetainedMessagesManager(MqttServerEventContainer eventContainer, IMqttNetLogger logger)
     {
@@ -24,6 +23,46 @@ public sealed class MqttRetainedMessagesManager
         _logger = logger.WithSource(nameof(MqttRetainedMessagesManager));
     }
 
+    public async Task ClearMessages()
+    {
+        lock (_messages)
+        {
+            _messages.Clear();
+        }
+
+        using (await _storageAccessLock.EnterAsync().ConfigureAwait(false))
+        {
+            await _eventContainer.RetainedMessagesClearedEvent.InvokeAsync(EventArgs.Empty).ConfigureAwait(false);
+        }
+    }
+
+    public void Dispose()
+    {
+        _storageAccessLock.Dispose();
+    }
+
+    public Task<MqttApplicationMessage> GetMessage(string topic)
+    {
+        lock (_messages)
+        {
+            if (_messages.TryGetValue(topic, out var message))
+            {
+                return Task.FromResult(message);
+            }
+        }
+
+        return Task.FromResult<MqttApplicationMessage>(null);
+    }
+
+    public Task<IList<MqttApplicationMessage>> GetMessages()
+    {
+        lock (_messages)
+        {
+            var result = new List<MqttApplicationMessage>(_messages.Values);
+            return Task.FromResult((IList<MqttApplicationMessage>)result);
+        }
+    }
+
     public async Task Start()
     {
         try
@@ -79,8 +118,7 @@ public sealed class MqttRetainedMessagesManager
                     }
                     else
                     {
-                        if (existingMessage.QualityOfServiceLevel != applicationMessage.QualityOfServiceLevel ||
-                            !MqttMemoryHelper.SequenceEqual(existingMessage.Payload, payload))
+                        if (existingMessage.QualityOfServiceLevel != applicationMessage.QualityOfServiceLevel || !MqttMemoryHelper.SequenceEqual(existingMessage.Payload, payload))
                         {
                             _messages[applicationMessage.Topic] = applicationMessage;
                             saveIsRequired = true;
@@ -113,39 +151,4 @@ public sealed class MqttRetainedMessagesManager
             _logger.Error(exception, "Unhandled exception while handling retained messages.");
         }
     }
-
-    public Task<IList<MqttApplicationMessage>> GetMessages()
-    {
-        lock (_messages)
-        {
-            var result = new List<MqttApplicationMessage>(_messages.Values);
-            return Task.FromResult((IList<MqttApplicationMessage>)result);
-        }
-    }
-
-    public Task<MqttApplicationMessage> GetMessage(string topic)
-    {
-        lock (_messages)
-        {
-            if (_messages.TryGetValue(topic, out var message))
-            {
-                return Task.FromResult(message);
-            }
-        }
-
-        return Task.FromResult<MqttApplicationMessage>(null);
-    }
-
-    public async Task ClearMessages()
-    {
-        lock (_messages)
-        {
-            _messages.Clear();
-        }
-
-        using (await _storageAccessLock.EnterAsync().ConfigureAwait(false))
-        {
-            await _eventContainer.RetainedMessagesClearedEvent.InvokeAsync(EventArgs.Empty).ConfigureAwait(false);
-        }
-    }
 }

Source/MQTTnet.Server/MQTTnet.Server.csproj

@@ -1,56 +1,19 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
     <PropertyGroup>
-        <TargetFramework>net8.0</TargetFramework>
         <AssemblyName>MQTTnet.Server</AssemblyName>
         <RootNamespace>MQTTnet.Server</RootNamespace>
+        <IsAotCompatible>true</IsAotCompatible>
+
         <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
-        <Company>The contributors of MQTTnet</Company>
-        <Product>MQTTnet</Product>
         <GenerateDocumentationFile>true</GenerateDocumentationFile>
         <Description>This is the server implementation of MQTTnet.</Description>
-        <Authors>The contributors of MQTTnet</Authors>
         <PackageId>MQTTnet.Server</PackageId>
-        <DelaySign>false</DelaySign>
-        <SignAssembly>false</SignAssembly>
-        <PublishRepositoryUrl>true</PublishRepositoryUrl>
-        <IncludeSymbols>true</IncludeSymbols>
-        <SymbolPackageFormat>snupkg</SymbolPackageFormat>
-        <Copyright>Copyright (c) .NET Foundation and Contributors</Copyright>
-        <PackageProjectUrl>https://github.com/dotnet/MQTTnet</PackageProjectUrl>
-        <RepositoryUrl>https://github.com/dotnet/MQTTnet.git</RepositoryUrl>
-        <RepositoryType>git</RepositoryType>
         <PackageTags>MQTT Message Queue Telemetry Transport MQTTClient MQTTServer Server MQTTBroker Broker NETStandard IoT InternetOfThings Messaging Hardware Arduino Sensor Actuator M2M ESP Smart Home Cities Automation Xamarin Blazor</PackageTags>
-        <NeutralLanguage>en-US</NeutralLanguage>
-        <EnableNETAnalyzers>false</EnableNETAnalyzers>
-        <EnforceCodeStyleInBuild>false</EnforceCodeStyleInBuild>
-        <PackageIcon>nuget.png</PackageIcon>
-        <EmbedUntrackedSources>true</EmbedUntrackedSources>
-        <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
-        <PackageLicenseFile>LICENSE</PackageLicenseFile>
-        <DisableImplicitAspNetCoreAnalyzers>true</DisableImplicitAspNetCoreAnalyzers>
-        <NoWarn>1591;NETSDK1138;NU1803;NU1901;NU1902</NoWarn>
-        <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
-        <NuGetAuditMode>all</NuGetAuditMode>
-        <NuGetAudit>true</NuGetAudit>
-        <NuGetAuditLevel>low</NuGetAuditLevel>
-        <ImplicitUsings>enable</ImplicitUsings>
-        <Nullable>disable</Nullable>
-        <AnalysisLevel>latest-Recommended</AnalysisLevel>
-        <IsAotCompatible>true</IsAotCompatible>
     </PropertyGroup>
 
     <ItemGroup>
         <ProjectReference Include="..\MQTTnet\MQTTnet.csproj"/>
     </ItemGroup>
 
-    <ItemGroup>
-        <None Include="..\..\Images\nuget.png" Pack="true" PackagePath="" />
-        <None Include="..\..\LICENSE" Pack="true" PackagePath="" />
-    </ItemGroup>
-
-    <ItemGroup>
-        <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All"/>
-    </ItemGroup>
-
 </Project>

Source/MQTTnet.Server/MqttServerFactory.cs

@@ -2,12 +2,14 @@
 // 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.Diagnostics.CodeAnalysis;
 using MQTTnet.Diagnostics.Logger;
 using MQTTnet.Server.EnhancedAuthentication;
 using MQTTnet.Server.Internal.Adapter;
 
 namespace MQTTnet.Server;
 
+[SuppressMessage("Performance", "CA1822:Mark members as static")]
 public sealed class MqttServerFactory
 {
     public MqttServerFactory() : this(new MqttNetNullLogger())