From 6e1ec266a7da3ba1e802c95ec31ae0ae6c6af006 Mon Sep 17 00:00:00 2001 From: Christian <6939810+chkr1011@users.noreply.github.com> Date: Sun, 6 Nov 2022 10:49:19 +0100 Subject: [PATCH 01/11] Update ReleaseNotes.md --- .github/workflows/ReleaseNotes.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ReleaseNotes.md b/.github/workflows/ReleaseNotes.md index 95fe5078..cb58d55b 100644 --- a/.github/workflows/ReleaseNotes.md +++ b/.github/workflows/ReleaseNotes.md @@ -1,3 +1,4 @@ * [Core] Fixed several dead locks by implementing a new async signal (#1552) * [Server] Fixed duplicated invocation of the event _ClientAcknowledgedPublishPacketAsync_ for QoS level 2 (#1550) -* [Server] Fixed issue in upgrading and downgrading of QoS levels for subscriptions and retained messages (#1560) \ No newline at end of file +* [Server] Fixed issue in upgrading and downgrading of QoS levels for subscriptions and retained messages (#1560) +* [Server] Fixed memory leak when old sessions are discarded (#1553) \ No newline at end of file From e6c1ab4e4ccb7499e29888b498536756108a6dd1 Mon Sep 17 00:00:00 2001 From: Christian <6939810+chkr1011@users.noreply.github.com> Date: Sun, 6 Nov 2022 10:50:04 +0100 Subject: [PATCH 02/11] Fail all waiting tasks when the client connection gets closed (#1563) --- .github/workflows/ReleaseNotes.md | 1 + .../MQTTnet.Tests/Server/Publishing_Tests.cs | 31 ++++ .../MQTTnet.Tests/Server/Subscribe_Tests.cs | 16 +++ .../MQTTnet.Tests/Server/Unsubscribe_Tests.cs | 32 +++++ .../MqttClientDisconnectedException.cs | 16 +++ ...tUnexpectedDisconnectReceivedException.cs} | 7 +- Source/MQTTnet/Client/MqttClient.cs | 18 +-- .../Exceptions/MqttCommunicationException.cs | 6 +- Source/MQTTnet/MQTTnet.csproj.DotSettings | 1 + .../PacketDispatcher/MqttPacketDispatcher.cs | 135 ++++++++++++------ 10 files changed, 201 insertions(+), 62 deletions(-) create mode 100644 Source/MQTTnet.Tests/Server/Publishing_Tests.cs create mode 100644 Source/MQTTnet.Tests/Server/Unsubscribe_Tests.cs create mode 100644 Source/MQTTnet/Client/Exceptions/MqttClientDisconnectedException.cs rename Source/MQTTnet/{Exceptions/MqttUnexpectedDisconnectReceivedException.cs => Client/Exceptions/MqttClientUnexpectedDisconnectReceivedException.cs} (79%) diff --git a/.github/workflows/ReleaseNotes.md b/.github/workflows/ReleaseNotes.md index cb58d55b..3ef3a30e 100644 --- a/.github/workflows/ReleaseNotes.md +++ b/.github/workflows/ReleaseNotes.md @@ -1,4 +1,5 @@ * [Core] Fixed several dead locks by implementing a new async signal (#1552) +* [Client] All waiting tasks will now fail when the client connection gets closed. This fixes several freezes (#1561). * [Server] Fixed duplicated invocation of the event _ClientAcknowledgedPublishPacketAsync_ for QoS level 2 (#1550) * [Server] Fixed issue in upgrading and downgrading of QoS levels for subscriptions and retained messages (#1560) * [Server] Fixed memory leak when old sessions are discarded (#1553) \ No newline at end of file diff --git a/Source/MQTTnet.Tests/Server/Publishing_Tests.cs b/Source/MQTTnet.Tests/Server/Publishing_Tests.cs new file mode 100644 index 00000000..c5df97f7 --- /dev/null +++ b/Source/MQTTnet.Tests/Server/Publishing_Tests.cs @@ -0,0 +1,31 @@ +// 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.Threading.Tasks; +using Microsoft.VisualStudio.TestTools.UnitTesting; +using MQTTnet.Client; +using MQTTnet.Protocol; + +namespace MQTTnet.Tests.Server +{ + [TestClass] + public sealed class Publishing_Tests : BaseTestClass + { + [TestMethod] + [ExpectedException(typeof(MqttClientDisconnectedException))] + public async Task Disconnect_While_Publishing() + { + using (var testEnvironment = CreateTestEnvironment()) + { + var server = await testEnvironment.StartServer(); + + // The client will be disconnect directly after subscribing! + server.InterceptingPublishAsync += ev => server.DisconnectClientAsync(ev.ClientId, MqttDisconnectReasonCode.NormalDisconnection); + + var client = await testEnvironment.ConnectClient(); + await client.PublishStringAsync("test", qualityOfServiceLevel: MqttQualityOfServiceLevel.AtLeastOnce); + } + } + } +} \ No newline at end of file diff --git a/Source/MQTTnet.Tests/Server/Subscribe_Tests.cs b/Source/MQTTnet.Tests/Server/Subscribe_Tests.cs index b67adea9..d4631bc2 100644 --- a/Source/MQTTnet.Tests/Server/Subscribe_Tests.cs +++ b/Source/MQTTnet.Tests/Server/Subscribe_Tests.cs @@ -46,6 +46,22 @@ namespace MQTTnet.Tests.Server } } + [TestMethod] + [ExpectedException(typeof(MqttClientDisconnectedException))] + public async Task Disconnect_While_Subscribing() + { + using (var testEnvironment = CreateTestEnvironment()) + { + var server = await testEnvironment.StartServer(); + + // The client will be disconnect directly after subscribing! + server.ClientSubscribedTopicAsync += ev => server.DisconnectClientAsync(ev.ClientId, MqttDisconnectReasonCode.NormalDisconnection); + + var client = await testEnvironment.ConnectClient(); + await client.SubscribeAsync("#"); + } + } + [TestMethod] public async Task Enqueue_Message_After_Subscription() { diff --git a/Source/MQTTnet.Tests/Server/Unsubscribe_Tests.cs b/Source/MQTTnet.Tests/Server/Unsubscribe_Tests.cs new file mode 100644 index 00000000..5692fa8d --- /dev/null +++ b/Source/MQTTnet.Tests/Server/Unsubscribe_Tests.cs @@ -0,0 +1,32 @@ +// 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.Threading.Tasks; +using Microsoft.VisualStudio.TestTools.UnitTesting; +using MQTTnet.Client; +using MQTTnet.Protocol; + +namespace MQTTnet.Tests.Server +{ + [TestClass] + public sealed class Unsubscribe_Tests : BaseTestClass + { + [TestMethod] + [ExpectedException(typeof(MqttClientDisconnectedException))] + public async Task Disconnect_While_Unsubscribing() + { + using (var testEnvironment = CreateTestEnvironment()) + { + var server = await testEnvironment.StartServer(); + + // The client will be disconnect directly after subscribing! + server.ClientUnsubscribedTopicAsync += ev => server.DisconnectClientAsync(ev.ClientId, MqttDisconnectReasonCode.NormalDisconnection); + + var client = await testEnvironment.ConnectClient(); + await client.SubscribeAsync("#"); + await client.UnsubscribeAsync("#"); + } + } + } +} \ No newline at end of file diff --git a/Source/MQTTnet/Client/Exceptions/MqttClientDisconnectedException.cs b/Source/MQTTnet/Client/Exceptions/MqttClientDisconnectedException.cs new file mode 100644 index 00000000..ce548428 --- /dev/null +++ b/Source/MQTTnet/Client/Exceptions/MqttClientDisconnectedException.cs @@ -0,0 +1,16 @@ +// 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 MQTTnet.Exceptions; + +namespace MQTTnet.Client +{ + public sealed class MqttClientDisconnectedException : MqttCommunicationException + { + public MqttClientDisconnectedException(Exception innerException) : base("The MQTT client is disconnected.", innerException) + { + } + } +} \ No newline at end of file diff --git a/Source/MQTTnet/Exceptions/MqttUnexpectedDisconnectReceivedException.cs b/Source/MQTTnet/Client/Exceptions/MqttClientUnexpectedDisconnectReceivedException.cs similarity index 79% rename from Source/MQTTnet/Exceptions/MqttUnexpectedDisconnectReceivedException.cs rename to Source/MQTTnet/Client/Exceptions/MqttClientUnexpectedDisconnectReceivedException.cs index eca736fc..5501e39c 100644 --- a/Source/MQTTnet/Exceptions/MqttUnexpectedDisconnectReceivedException.cs +++ b/Source/MQTTnet/Client/Exceptions/MqttClientUnexpectedDisconnectReceivedException.cs @@ -3,14 +3,15 @@ // See the LICENSE file in the project root for more information. using System.Collections.Generic; +using MQTTnet.Exceptions; using MQTTnet.Packets; using MQTTnet.Protocol; -namespace MQTTnet.Exceptions +namespace MQTTnet.Client { - public class MqttUnexpectedDisconnectReceivedException : MqttCommunicationException + public sealed class MqttClientUnexpectedDisconnectReceivedException : MqttCommunicationException { - public MqttUnexpectedDisconnectReceivedException(MqttDisconnectPacket disconnectPacket) + public MqttClientUnexpectedDisconnectReceivedException(MqttDisconnectPacket disconnectPacket) : base($"Unexpected DISCONNECT (Reason code={disconnectPacket.ReasonCode}) received.") { ReasonCode = disconnectPacket.ReasonCode; diff --git a/Source/MQTTnet/Client/MqttClient.cs b/Source/MQTTnet/Client/MqttClient.cs index 48c32bf4..50e9223a 100644 --- a/Source/MQTTnet/Client/MqttClient.cs +++ b/Source/MQTTnet/Client/MqttClient.cs @@ -32,25 +32,21 @@ namespace MQTTnet.Client readonly object _disconnectLock = new object(); readonly AsyncEvent _inspectPacketEvent = new AsyncEvent(); readonly MqttNetSourceLogger _logger; - readonly MqttPacketDispatcher _packetDispatcher = new MqttPacketDispatcher(); readonly MqttPacketFactories _packetFactories = new MqttPacketFactories(); readonly MqttPacketIdentifierProvider _packetIdentifierProvider = new MqttPacketIdentifierProvider(); readonly IMqttNetLogger _rootLogger; IMqttChannelAdapter _adapter; - CancellationTokenSource _backgroundCancellationTokenSource; bool _cleanDisconnectInitiated; volatile int _connectionStatus; - MqttClientDisconnectReason _disconnectReason; string _disconnectReasonString; Task _keepAlivePacketsSenderTask; - DateTime _lastPacketSentTimestamp; + MqttPacketDispatcher _packetDispatcher; Task _packetReceiverTask; - AsyncQueue _publishPacketReceiverQueue; Task _publishPacketReceiverTask; @@ -128,7 +124,7 @@ namespace MQTTnet.Client } _packetIdentifierProvider.Reset(); - _packetDispatcher.CancelAll(); + _packetDispatcher = new MqttPacketDispatcher(); _backgroundCancellationTokenSource = new CancellationTokenSource(); var backgroundCancellationToken = _backgroundCancellationTokenSource.Token; @@ -414,6 +410,10 @@ namespace MQTTnet.Client _publishPacketReceiverQueue = null; _adapter?.Dispose(); + _adapter = null; + + _packetDispatcher?.Dispose(); + _packetDispatcher = null; } } @@ -447,6 +447,8 @@ namespace MQTTnet.Client try { + _packetDispatcher.Dispose(new MqttClientDisconnectedException(exception)); + var receiverTask = WaitForTaskAsync(_packetReceiverTask, sender); var publishPacketReceiverTask = WaitForTaskAsync(_publishPacketReceiverTask, sender); var keepAliveTask = WaitForTaskAsync(_keepAlivePacketsSenderTask, sender); @@ -558,7 +560,7 @@ namespace MQTTnet.Client _disconnectReasonString = disconnectPacket.ReasonString; // Also dispatch disconnect to waiting threads to generate a proper exception. - _packetDispatcher.FailAll(new MqttUnexpectedDisconnectReceivedException(disconnectPacket)); + _packetDispatcher.Dispose(new MqttClientUnexpectedDisconnectReceivedException(disconnectPacket)); return DisconnectInternalAsync(_packetReceiverTask, null, null); } @@ -776,7 +778,7 @@ namespace MQTTnet.Client } else { - _logger.Error(exception, "Error while receiving packets."); + _logger.Error(exception, $"Error while processing received packet ({packet.GetType().Name})."); } _packetDispatcher.FailAll(exception); diff --git a/Source/MQTTnet/Exceptions/MqttCommunicationException.cs b/Source/MQTTnet/Exceptions/MqttCommunicationException.cs index 6c6ba053..a78c1f7c 100644 --- a/Source/MQTTnet/Exceptions/MqttCommunicationException.cs +++ b/Source/MQTTnet/Exceptions/MqttCommunicationException.cs @@ -8,12 +8,8 @@ namespace MQTTnet.Exceptions { public class MqttCommunicationException : Exception { - protected MqttCommunicationException() - { - } - public MqttCommunicationException(Exception innerException) - : base(innerException.Message, innerException) + : base(innerException?.Message ?? "MQTT communication failed.", innerException) { } diff --git a/Source/MQTTnet/MQTTnet.csproj.DotSettings b/Source/MQTTnet/MQTTnet.csproj.DotSettings index 4af65895..a756552c 100644 --- a/Source/MQTTnet/MQTTnet.csproj.DotSettings +++ b/Source/MQTTnet/MQTTnet.csproj.DotSettings @@ -2,6 +2,7 @@ True True True + True True True True diff --git a/Source/MQTTnet/PacketDispatcher/MqttPacketDispatcher.cs b/Source/MQTTnet/PacketDispatcher/MqttPacketDispatcher.cs index dae92f73..85413a2c 100644 --- a/Source/MQTTnet/PacketDispatcher/MqttPacketDispatcher.cs +++ b/Source/MQTTnet/PacketDispatcher/MqttPacketDispatcher.cs @@ -2,48 +2,103 @@ // The .NET Foundation licenses this file to you under the MIT license. // See the LICENSE file in the project root for more information. -using MQTTnet.Packets; using System; using System.Collections.Generic; +using MQTTnet.Packets; namespace MQTTnet.PacketDispatcher { - public sealed class MqttPacketDispatcher + public sealed class MqttPacketDispatcher : IDisposable { - readonly List _awaitables = new List(); + readonly List _waiters = new List(); - public void FailAll(Exception exception) + bool _isDisposed; + + public MqttPacketAwaitable AddAwaitable(ushort packetIdentifier) where TResponsePacket : MqttPacket { - if (exception == null) throw new ArgumentNullException(nameof(exception)); + var awaitable = new MqttPacketAwaitable(packetIdentifier, this); - lock (_awaitables) + lock (_waiters) { - foreach (var awaitable in _awaitables) - { - awaitable.Fail(exception); - } - - _awaitables.Clear(); + _waiters.Add(awaitable); } + + return awaitable; } public void CancelAll() { - lock (_awaitables) + lock (_waiters) { - foreach (var awaitable in _awaitables) + foreach (var awaitable in _waiters) { awaitable.Cancel(); } - _awaitables.Clear(); + _waiters.Clear(); } } - + + public void Dispose() + { + Dispose(new ObjectDisposedException(nameof(MqttPacketDispatcher))); + } + + public void Dispose(Exception exception) + { + if (exception == null) + { + throw new ArgumentNullException(nameof(exception)); + } + + lock (_waiters) + { + FailAll(exception); + + // Make sure that no task can start waiting after this instance is already disposed. + // This will prevent unexpected freezes. + _isDisposed = true; + } + } + + public void FailAll(Exception exception) + { + if (exception == null) + { + throw new ArgumentNullException(nameof(exception)); + } + + lock (_waiters) + { + foreach (var awaitable in _waiters) + { + awaitable.Fail(exception); + } + + _waiters.Clear(); + } + } + + public void RemoveAwaitable(IMqttPacketAwaitable awaitable) + { + if (awaitable == null) + { + throw new ArgumentNullException(nameof(awaitable)); + } + + lock (_waiters) + { + _waiters.Remove(awaitable); + } + } + public bool TryDispatch(MqttPacket packet) { - if (packet == null) throw new ArgumentNullException(nameof(packet)); - + if (packet == null) + { + throw new ArgumentNullException(nameof(packet)); + } + ushort identifier = 0; if (packet is MqttPacketWithIdentifier packetWithIdentifier) { @@ -51,13 +106,15 @@ namespace MQTTnet.PacketDispatcher } var packetType = packet.GetType(); - var awaitables = new List(); - - lock (_awaitables) + var waiters = new List(); + + lock (_waiters) { - for (var i = _awaitables.Count - 1; i >= 0; i--) + ThrowIfDisposed(); + + for (var i = _waiters.Count - 1; i >= 0; i--) { - var entry = _awaitables[i]; + var entry = _waiters[i]; // Note: The PingRespPacket will also arrive here and has NO identifier but there // is code which waits for it. So the code must be able to deal with filters which @@ -66,39 +123,25 @@ namespace MQTTnet.PacketDispatcher { continue; } - - awaitables.Add(entry); - _awaitables.RemoveAt(i); + + waiters.Add(entry); + _waiters.RemoveAt(i); } } - - foreach (var matchingEntry in awaitables) + + foreach (var matchingEntry in waiters) { matchingEntry.Complete(packet); } - return awaitables.Count > 0; - } - - public MqttPacketAwaitable AddAwaitable(ushort packetIdentifier) where TResponsePacket : MqttPacket - { - var awaitable = new MqttPacketAwaitable(packetIdentifier, this); - - lock (_awaitables) - { - _awaitables.Add(awaitable); - } - - return awaitable; + return waiters.Count > 0; } - public void RemoveAwaitable(IMqttPacketAwaitable awaitable) + void ThrowIfDisposed() { - if (awaitable == null) throw new ArgumentNullException(nameof(awaitable)); - - lock (_awaitables) + if (_isDisposed) { - _awaitables.Remove(awaitable); + throw new ObjectDisposedException(nameof(MqttPacketDispatcher)); } } } From 97c46bea0f8b001671a3868e15c0805bf6853c5e Mon Sep 17 00:00:00 2001 From: Christian <6939810+chkr1011@users.noreply.github.com> Date: Sun, 6 Nov 2022 10:50:32 +0100 Subject: [PATCH 03/11] Update ReleaseNotes.md --- .github/workflows/ReleaseNotes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ReleaseNotes.md b/.github/workflows/ReleaseNotes.md index 3ef3a30e..d08fa6b0 100644 --- a/.github/workflows/ReleaseNotes.md +++ b/.github/workflows/ReleaseNotes.md @@ -1,5 +1,5 @@ * [Core] Fixed several dead locks by implementing a new async signal (#1552) -* [Client] All waiting tasks will now fail when the client connection gets closed. This fixes several freezes (#1561). +* [Client] All waiting tasks will now fail when the client connection gets closed. This fixes several freezes (#1561) * [Server] Fixed duplicated invocation of the event _ClientAcknowledgedPublishPacketAsync_ for QoS level 2 (#1550) * [Server] Fixed issue in upgrading and downgrading of QoS levels for subscriptions and retained messages (#1560) * [Server] Fixed memory leak when old sessions are discarded (#1553) \ No newline at end of file From 5c7472838721ac81b48884314510b66b18ba579d Mon Sep 17 00:00:00 2001 From: Christian <6939810+chkr1011@users.noreply.github.com> Date: Sun, 6 Nov 2022 13:28:41 +0100 Subject: [PATCH 04/11] Fix client session takeover --- .../Mockups/ConnectionContextMockup.cs | 26 - .../Mockups/ConnectionHandlerMockup.cs | 22 +- .../Mockups/DuplexPipeMockup.cs | 7 +- .../Mockups/LimitedMemoryPool.cs | 2 +- .../Mockups/MemoryOwner.cs | 8 +- .../MqttConnectionContextTest.cs | 115 ++- .../ReaderExtensionsTest.cs | 2 +- ...MqttPacketSerialization_V3_Binary_Tests.cs | 3 +- .../MqttPacketSerialization_V3_Tests.cs | 2 +- .../MqttPacketSerialization_V5_Tests.cs | 2 +- .../Server/MqttSubscriptionsManager_Tests.cs | 4 +- .../Server/Subscription_TopicHash_Tests.cs | 722 +++++++++--------- Source/MQTTnet.Tests/TopicGenerator.cs | 3 +- .../Formatter/MqttUnsubAckPacketFactory.cs | 8 +- Source/MQTTnet/Internal/AsyncEvent.cs | 2 +- Source/MQTTnet/Server/Internal/MqttClient.cs | 35 +- .../Internal/MqttClientSessionsManager.cs | 63 +- .../MqttClientSubscriptionsManager.cs | 66 +- Source/MQTTnet/Server/Internal/MqttSession.cs | 50 +- .../Server/Internal/MqttSubscription.cs | 2 +- ...ubscribeResult.cs => UnsubscribeResult.cs} | 2 +- 21 files changed, 588 insertions(+), 558 deletions(-) delete mode 100644 Source/MQTTnet.AspNetCore.Tests/Mockups/ConnectionContextMockup.cs rename Source/MQTTnet/Server/Internal/{MqttUnsubscribeResult.cs => UnsubscribeResult.cs} (90%) diff --git a/Source/MQTTnet.AspNetCore.Tests/Mockups/ConnectionContextMockup.cs b/Source/MQTTnet.AspNetCore.Tests/Mockups/ConnectionContextMockup.cs deleted file mode 100644 index 0ec946de..00000000 --- a/Source/MQTTnet.AspNetCore.Tests/Mockups/ConnectionContextMockup.cs +++ /dev/null @@ -1,26 +0,0 @@ -// 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.Collections.Generic; -using System.IO.Pipelines; -using Microsoft.AspNetCore.Connections; -using Microsoft.AspNetCore.Http.Features; - -namespace MQTTnet.AspNetCore.Tests.Mockups -{ - public class ConnectionContextMockup : ConnectionContext - { - public override string ConnectionId { get; set; } - - public override IFeatureCollection Features { get; } - - public override IDictionary Items { get; set; } - public override IDuplexPipe Transport { get; set; } - - public ConnectionContextMockup() - { - //Transport = new DefaultConnectionContext - } - } -} diff --git a/Source/MQTTnet.AspNetCore.Tests/Mockups/ConnectionHandlerMockup.cs b/Source/MQTTnet.AspNetCore.Tests/Mockups/ConnectionHandlerMockup.cs index 5f372c99..387e0bfb 100644 --- a/Source/MQTTnet.AspNetCore.Tests/Mockups/ConnectionHandlerMockup.cs +++ b/Source/MQTTnet.AspNetCore.Tests/Mockups/ConnectionHandlerMockup.cs @@ -2,20 +2,24 @@ // The .NET Foundation licenses this file to you under the MIT license. // See the LICENSE file in the project root for more information. -using Microsoft.AspNetCore.Connections; -using MQTTnet.Adapter; -using MQTTnet.Formatter; -using MQTTnet.Server; using System; using System.Threading.Tasks; +using Microsoft.AspNetCore.Connections; +using MQTTnet.Adapter; using MQTTnet.Diagnostics; +using MQTTnet.Formatter; +using MQTTnet.Server; namespace MQTTnet.AspNetCore.Tests.Mockups { - public class ConnectionHandlerMockup: IMqttServerAdapter + public sealed class ConnectionHandlerMockup : IMqttServerAdapter { - public TaskCompletionSource Context { get; } = new TaskCompletionSource(); public Func ClientHandler { get; set; } + public TaskCompletionSource Context { get; } = new TaskCompletionSource(); + + public void Dispose() + { + } public async Task OnConnectedAsync(ConnectionContext connection) { @@ -42,9 +46,5 @@ namespace MQTTnet.AspNetCore.Tests.Mockups { return Task.CompletedTask; } - - public void Dispose() - { - } } -} +} \ No newline at end of file diff --git a/Source/MQTTnet.AspNetCore.Tests/Mockups/DuplexPipeMockup.cs b/Source/MQTTnet.AspNetCore.Tests/Mockups/DuplexPipeMockup.cs index 24f85529..831b7b72 100644 --- a/Source/MQTTnet.AspNetCore.Tests/Mockups/DuplexPipeMockup.cs +++ b/Source/MQTTnet.AspNetCore.Tests/Mockups/DuplexPipeMockup.cs @@ -6,7 +6,7 @@ using System.IO.Pipelines; namespace MQTTnet.AspNetCore.Tests.Mockups { - public class DuplexPipeMockup : IDuplexPipe + public sealed class DuplexPipeMockup : IDuplexPipe { public DuplexPipeMockup() { @@ -20,9 +20,8 @@ namespace MQTTnet.AspNetCore.Tests.Mockups PipeWriter IDuplexPipe.Output => Send.Writer; + public Pipe Receive { get; } - public Pipe Receive { get; set; } - - public Pipe Send { get; set; } + public Pipe Send { get; } } } diff --git a/Source/MQTTnet.AspNetCore.Tests/Mockups/LimitedMemoryPool.cs b/Source/MQTTnet.AspNetCore.Tests/Mockups/LimitedMemoryPool.cs index c2f40502..242ba421 100644 --- a/Source/MQTTnet.AspNetCore.Tests/Mockups/LimitedMemoryPool.cs +++ b/Source/MQTTnet.AspNetCore.Tests/Mockups/LimitedMemoryPool.cs @@ -6,7 +6,7 @@ using System.Buffers; namespace MQTTnet.AspNetCore.Tests.Mockups { - public class LimitedMemoryPool : MemoryPool + public sealed class LimitedMemoryPool : MemoryPool { protected override void Dispose(bool disposing) { diff --git a/Source/MQTTnet.AspNetCore.Tests/Mockups/MemoryOwner.cs b/Source/MQTTnet.AspNetCore.Tests/Mockups/MemoryOwner.cs index 55e4e318..aad5e1c6 100644 --- a/Source/MQTTnet.AspNetCore.Tests/Mockups/MemoryOwner.cs +++ b/Source/MQTTnet.AspNetCore.Tests/Mockups/MemoryOwner.cs @@ -7,9 +7,9 @@ using System.Buffers; namespace MQTTnet.AspNetCore.Tests.Mockups { - public class MemoryOwner : IMemoryOwner + public sealed class MemoryOwner : IMemoryOwner { - private readonly byte[] _raw; + readonly byte[] _raw; public MemoryOwner(int size) { @@ -27,11 +27,11 @@ namespace MQTTnet.AspNetCore.Tests.Mockups Memory = _raw; } + public Memory Memory { get; } + public void Dispose() { ArrayPool.Shared.Return(_raw); } - - public Memory Memory { get; } } } \ No newline at end of file diff --git a/Source/MQTTnet.AspNetCore.Tests/MqttConnectionContextTest.cs b/Source/MQTTnet.AspNetCore.Tests/MqttConnectionContextTest.cs index 190ff485..a9b08a87 100644 --- a/Source/MQTTnet.AspNetCore.Tests/MqttConnectionContextTest.cs +++ b/Source/MQTTnet.AspNetCore.Tests/MqttConnectionContextTest.cs @@ -2,22 +2,21 @@ // The .NET Foundation licenses this file to you under the MIT license. // See the LICENSE file in the project root for more information. -using Microsoft.AspNetCore.Builder; -using Microsoft.AspNetCore.Connections; -using Microsoft.AspNetCore.Hosting; -using Microsoft.Extensions.DependencyInjection; -using Microsoft.VisualStudio.TestTools.UnitTesting; - using System; using System.Net; using System.Threading; using System.Threading.Tasks; +using Microsoft.AspNetCore.Builder; +using Microsoft.AspNetCore.Connections; +using Microsoft.AspNetCore.Hosting; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.VisualStudio.TestTools.UnitTesting; using MQTTnet.Adapter; using MQTTnet.AspNetCore.Tests.Mockups; +using MQTTnet.Client; using MQTTnet.Exceptions; using MQTTnet.Formatter; using MQTTnet.Packets; -using MQTTnet.Client; using MQTTnet.Protocol; using MQTTnet.Tests.Extensions; @@ -26,20 +25,6 @@ namespace MQTTnet.AspNetCore.Tests [TestClass] public class MqttConnectionContextTest { - [TestMethod] - public async Task TestReceivePacketAsyncThrowsWhenReaderCompleted() - { - var serializer = new MqttPacketFormatterAdapter(MqttProtocolVersion.V311, new MqttBufferWriter(4096, 65535)); - var pipe = new DuplexPipeMockup(); - var connection = new DefaultConnectionContext(); - connection.Transport = pipe; - var ctx = new MqttConnectionContext(serializer, connection); - - pipe.Receive.Writer.Complete(); - - await Assert.ThrowsExceptionAsync(() => ctx.ReceivePacketAsync(CancellationToken.None)); - } - [TestMethod] public async Task TestCorruptedConnectPacket() { @@ -49,13 +34,43 @@ namespace MQTTnet.AspNetCore.Tests var connection = new DefaultConnectionContext(); connection.Transport = pipe; var ctx = new MqttConnectionContext(serializer, connection); - + await pipe.Receive.Writer.WriteAsync(writer.AddMqttHeader(MqttControlPacketType.Connect, new byte[0])); await Assert.ThrowsExceptionAsync(() => ctx.ReceivePacketAsync(CancellationToken.None)); // the first exception should complete the pipes so if someone tries to use the connection after that it should throw immidiatly - await Assert.ThrowsExceptionAsync(() => ctx.ReceivePacketAsync(CancellationToken.None)); + await Assert.ThrowsExceptionAsync(() => ctx.ReceivePacketAsync(CancellationToken.None)); + } + + [TestMethod] + public async Task TestEndpoint() + { + var mockup = new ConnectionHandlerMockup(); + + + using (var host = new WebHostBuilder().UseKestrel(kestrel => kestrel.ListenLocalhost(1883, listener => listener.Use((ctx, next) => mockup.OnConnectedAsync(ctx)))) + .UseStartup() + .ConfigureServices( + (hostContext, services) => + { + services.AddHostedMqttServer(o => o.WithoutDefaultEndpoint()); + services.AddSingleton(mockup); + }) + .Build()) + + using (var client = new MqttFactory().CreateMqttClient()) + { + host.Start(); + await client.ConnectAsync(new MqttClientOptionsBuilder().WithTcpServer("localhost").Build(), CancellationToken.None); + + var ctx = await mockup.Context.Task; +#if NETCOREAPP3_1 + var ep = IPEndPoint.Parse(ctx.Endpoint); + Assert.IsNotNull(ep); +#endif + Assert.IsNotNull(ctx); + } } // COMMENTED OUT DUE TO DEAD LOCK? OR VERY VERY SLOW PERFORMANCE ON LOCAL DEV MACHINE. TEST WAS STILL RUNNING AFTER SEVERAL MINUTES! @@ -78,7 +93,7 @@ namespace MQTTnet.AspNetCore.Tests // await Task.WhenAll(tasks).ConfigureAwait(false); //} - + [TestMethod] public async Task TestLargePacket() { @@ -94,43 +109,25 @@ namespace MQTTnet.AspNetCore.Tests Assert.IsTrue(readResult.Buffer.Length > 20000); } - private class Startup + [TestMethod] + public async Task TestReceivePacketAsyncThrowsWhenReaderCompleted() + { + var serializer = new MqttPacketFormatterAdapter(MqttProtocolVersion.V311, new MqttBufferWriter(4096, 65535)); + var pipe = new DuplexPipeMockup(); + var connection = new DefaultConnectionContext(); + connection.Transport = pipe; + var ctx = new MqttConnectionContext(serializer, connection); + + pipe.Receive.Writer.Complete(); + + await Assert.ThrowsExceptionAsync(() => ctx.ReceivePacketAsync(CancellationToken.None)); + } + + class Startup { public void Configure(IApplicationBuilder app) - { + { } } - - [TestMethod] - public async Task TestEndpoint() - { - var mockup = new ConnectionHandlerMockup(); - - - using (var host = new WebHostBuilder() - .UseKestrel(kestrel => kestrel.ListenLocalhost(1883, listener => listener.Use((ctx, next) => mockup.OnConnectedAsync(ctx)))) - .UseStartup() - .ConfigureServices((hostContext, services) => - { - services.AddHostedMqttServer(o => o.WithoutDefaultEndpoint()); - services.AddSingleton(mockup); - }) - .Build()) - - using (var client = new MqttFactory().CreateMqttClient()) - { - host.Start(); - await client.ConnectAsync(new MqttClientOptionsBuilder() - .WithTcpServer("localhost") - .Build(), CancellationToken.None); - - var ctx = await mockup.Context.Task; -#if NETCOREAPP3_1 - var ep = IPEndPoint.Parse(ctx.Endpoint); - Assert.IsNotNull(ep); -#endif - Assert.IsNotNull(ctx); - } - } } -} +} \ No newline at end of file diff --git a/Source/MQTTnet.AspNetCore.Tests/ReaderExtensionsTest.cs b/Source/MQTTnet.AspNetCore.Tests/ReaderExtensionsTest.cs index 056a6abd..d711067b 100644 --- a/Source/MQTTnet.AspNetCore.Tests/ReaderExtensionsTest.cs +++ b/Source/MQTTnet.AspNetCore.Tests/ReaderExtensionsTest.cs @@ -12,7 +12,7 @@ using MQTTnet.Packets; namespace MQTTnet.AspNetCore.Tests { [TestClass] - public class ReaderExtensionsTest + public sealed class ReaderExtensionsTest { [TestMethod] public void TestTryDeserialize() diff --git a/Source/MQTTnet.Tests/Formatter/MqttPacketSerialization_V3_Binary_Tests.cs b/Source/MQTTnet.Tests/Formatter/MqttPacketSerialization_V3_Binary_Tests.cs index 8260b3f4..673e46b3 100644 --- a/Source/MQTTnet.Tests/Formatter/MqttPacketSerialization_V3_Binary_Tests.cs +++ b/Source/MQTTnet.Tests/Formatter/MqttPacketSerialization_V3_Binary_Tests.cs @@ -13,13 +13,12 @@ using MQTTnet.Adapter; using MQTTnet.Diagnostics; using MQTTnet.Exceptions; using MQTTnet.Formatter; -using MQTTnet.Internal; using MQTTnet.Packets; using MQTTnet.Protocol; using MQTTnet.Tests.Extensions; using MQTTnet.Tests.Mockups; -namespace MQTTnet.Tests +namespace MQTTnet.Tests.Formatter { [TestClass] public sealed class MqttPacketSerialization_V3_Binary_Tests diff --git a/Source/MQTTnet.Tests/Formatter/MqttPacketSerialization_V3_Tests.cs b/Source/MQTTnet.Tests/Formatter/MqttPacketSerialization_V3_Tests.cs index 5ae86cc1..e1135529 100644 --- a/Source/MQTTnet.Tests/Formatter/MqttPacketSerialization_V3_Tests.cs +++ b/Source/MQTTnet.Tests/Formatter/MqttPacketSerialization_V3_Tests.cs @@ -10,7 +10,7 @@ using MQTTnet.Formatter; using MQTTnet.Packets; using MQTTnet.Protocol; -namespace MQTTnet.Tests +namespace MQTTnet.Tests.Formatter { [TestClass] public sealed class MqttPacketSerialization_V3_Tests diff --git a/Source/MQTTnet.Tests/Formatter/MqttPacketSerialization_V5_Tests.cs b/Source/MQTTnet.Tests/Formatter/MqttPacketSerialization_V5_Tests.cs index 1d9e9740..fd7a70e2 100644 --- a/Source/MQTTnet.Tests/Formatter/MqttPacketSerialization_V5_Tests.cs +++ b/Source/MQTTnet.Tests/Formatter/MqttPacketSerialization_V5_Tests.cs @@ -9,7 +9,7 @@ using MQTTnet.Formatter; using MQTTnet.Packets; using MQTTnet.Protocol; -namespace MQTTnet.Tests +namespace MQTTnet.Tests.Formatter { [TestClass] public sealed class MqttPacketSerialization_V5_Tests diff --git a/Source/MQTTnet.Tests/Server/MqttSubscriptionsManager_Tests.cs b/Source/MQTTnet.Tests/Server/MqttSubscriptionsManager_Tests.cs index ea3e743c..19a4f427 100644 --- a/Source/MQTTnet.Tests/Server/MqttSubscriptionsManager_Tests.cs +++ b/Source/MQTTnet.Tests/Server/MqttSubscriptionsManager_Tests.cs @@ -130,9 +130,7 @@ namespace MQTTnet.Tests.Server CheckSubscriptionsResult CheckSubscriptions(string topic, MqttQualityOfServiceLevel applicationMessageQoSLevel, string senderClientId) { - ulong topicHashMask; // not needed - bool hasWildcard; // not needed - MqttSubscription.CalculateTopicHash(topic, out var topicHash, out topicHashMask, out hasWildcard); + MqttSubscription.CalculateTopicHash(topic, out var topicHash, out _, out _); return _subscriptionsManager.CheckSubscriptions(topic, topicHash, applicationMessageQoSLevel, senderClientId); } } diff --git a/Source/MQTTnet.Tests/Server/Subscription_TopicHash_Tests.cs b/Source/MQTTnet.Tests/Server/Subscription_TopicHash_Tests.cs index 70e9bffd..31e1ab05 100644 --- a/Source/MQTTnet.Tests/Server/Subscription_TopicHash_Tests.cs +++ b/Source/MQTTnet.Tests/Server/Subscription_TopicHash_Tests.cs @@ -1,9 +1,11 @@ using System; using System.Collections.Generic; +using System.Diagnostics; using System.Linq; using System.Text; using System.Threading.Tasks; using Microsoft.VisualStudio.TestTools.UnitTesting; +using MQTTnet.Packets; using MQTTnet.Protocol; using MQTTnet.Server; using MQTTnet.Tests.Mockups; @@ -13,43 +15,299 @@ namespace MQTTnet.Tests.Server [TestClass] public sealed class SubscriptionTopicHashTests { - enum TopicHashSelector { NoWildcard, SingleWildcard, MultiWildcard }; - MqttSession _clientSession; + /// + /// Even fairly regularly named topics as generated by the topic generator should result in shallow hash buckets + /// + /// [TestMethod] - public void Match_Hash_Test_SingleWildCard() + public void Check_Hash_Bucket_Depth() { - var l0 = "pub0"; - var l1 = "topic1"; - var l2 = "+"; - var l3 = "prop1"; - var topic = $"{l0}/{l1}/{l2}/{l3}"; + const int numPublishers = 5000; + const int numTopicsPerPublisher = 10; + + TopicGenerator.Generate( + numPublishers, + numTopicsPerPublisher, + out var topicsByPublisher, + out _, + out _); + + // There will be many 'similar' topics ending with, i.e. "sensor100", "sensor101", ... + // Hash bucket depths should remain low. + var bucketDepths = new Dictionary(); + var maxBucketDepth = 0; + ulong maxBucketDepthHash = 0; + + var topicsByHash = new Dictionary>(); + + foreach (var t in topicsByPublisher) + { + var topics = t.Value; + foreach (var topic in topics) + { + MqttSubscription.CalculateTopicHash(topic, out var topicHash, out var hashMask, out var hasWildcard); + + bucketDepths.TryGetValue(topicHash, out var currentValue); + ++currentValue; + bucketDepths[topicHash] = currentValue; + + if (currentValue > maxBucketDepth) + { + maxBucketDepth = currentValue; + maxBucketDepthHash = topicHash; + } + + if (!topicsByHash.TryGetValue(topicHash, out var topicList)) + { + topicList = new List(); + topicsByHash.Add(topicHash, topicList); + } + + topicList.Add(topic); + } + } + + var maxDepthTopics = topicsByHash[maxBucketDepthHash]; + + Console.Write("Max bucket depth is " + maxBucketDepth); + + // for the test case the bucket depth should be less than 100 + Assert.IsTrue(maxBucketDepth < 100, "Unexpected high topic hash bucket depth"); + } + + + [TestMethod] + public void Check_Selected_Topic_Hashes() + { + CheckTopicHash("client1/building1/level1/sensor1", 0x655D4AF100000000, 0xFFFFFFFFFFFFFFFF); + CheckTopicHash("client1/building1/+/sensor1", 0x655D00F100000000, 0xFFFF00FFFFFFFFFF); + CheckTopicHash("client1/+/level1/+", 0x65004A0000000000, 0xFF00FF00FFFFFFFF); + CheckTopicHash("client1/building1/level1/#", 0x655D4A0000000000, 0xFFFFFF0000000000); + CheckTopicHash("client1/+/level1/#", 0x65004A0000000000, 0xFF00FF0000000000); + } + + /// + /// Test long topic name with last level being # + /// + [TestMethod] + public void Match_Hash_Test_LongTopic_DetectMultiLevelWildcard() + { + var topic = "asdfasdf/asdfasdf/asdfasdf/asdfasdf/asdfas/dfaf/assfdgsdfgdf/#"; + + MqttSubscription.CalculateTopicHash(topic, out var topicHash, out var topicHashMask, out var topicHasWildcard); + + Assert.IsTrue(topicHasWildcard, "Wildcard not detected"); + } + + + /// + /// Test long topic name with last level being + + /// + [TestMethod] + public void Match_Hash_Test_LongTopic_DetectSingleLevelWildcard() + { + var topic = "asdfasdf/asdfasdf/asdfasdf/asdfasdf/asdfas/dfaf/assfdgsdfgdf/+"; + + MqttSubscription.CalculateTopicHash(topic, out var topicHash, out var topicHashMask, out var topicHasWildcard); + + Assert.IsTrue(topicHasWildcard, "Wildcard not detected"); + } + + /// + /// Test long topic name with last level being # + /// + [TestMethod] + public void Match_Hash_Test_LongTopic_MultiWildcard() + { + var sb = new StringBuilder(); + const int numLevels = 8; + var levelNames = new string[numLevels]; + for (var i = 0; i < numLevels; ++i) + { + if (i > 0) + { + sb.Append("/"); + } + + string levelName; + if (i == numLevels - 1) + { + // last one is # + levelName = "#"; + } + else + { + levelName = "level" + i; + } + + levelNames[i] = levelName; + sb.Append(levelName); + } + + var topic = sb.ToString(); + + // UInt64 is limited to 8 levels MqttSubscription.CalculateTopicHash(topic, out var topicHash, out var topicHashMask, out var topicHasWildcard); Assert.IsTrue(topicHasWildcard, "Wildcard not detected"); var hashBytes = GetBytes(topicHash); - Assert.AreNotEqual(hashBytes[0], 0, "checksum 0 mismatch"); - Assert.AreNotEqual(hashBytes[1], 0, "checksum 1 mismatch"); - Assert.AreEqual(hashBytes[2], 0, "checksum 2 mismatch"); - Assert.AreNotEqual(hashBytes[3], 0, "checksum 3 mismatch"); - Assert.AreEqual(hashBytes[4], 0, "checksum 4 mismatch"); - Assert.AreEqual(hashBytes[5], 0, "checksum 5 mismatch"); - Assert.AreEqual(hashBytes[6], 0, "checksum 6 mismatch"); - Assert.AreEqual(hashBytes[7], 0, "checksum 7 mismatch"); + // all bytes should contain checksum + var count = 0; + foreach (var h in hashBytes) + { + if (count < 7) + { + Assert.AreNotEqual(h, 0, "checksum mismatch"); + } + else + { + Assert.AreEqual(h, 0, "checksum mismatch"); + } - // The mask should have zeroes where the wildcard and ff at the end + ++count; + } + + // The mask should have ff except for last level var hashMaskBytes = GetBytes(topicHashMask); - Assert.AreEqual(hashMaskBytes[0], 0xff, "mask 0 mismatch"); - Assert.AreEqual(hashMaskBytes[1], 0xff, "mask 1 mismatch"); - Assert.AreEqual(hashMaskBytes[2], 0, "mask 2 mismatch"); - Assert.AreEqual(hashMaskBytes[3], 0xff, "mask 3 mismatch"); - Assert.AreEqual(hashMaskBytes[4], 0xff, "mask 4 mismatch"); - Assert.AreEqual(hashMaskBytes[5], 0xff, "mask 5 mismatch"); - Assert.AreEqual(hashMaskBytes[6], 0xff, "mask 6 mismatch"); - Assert.AreEqual(hashMaskBytes[7], 0xff, "mask 7 mismatch"); + count = 0; + foreach (var h in hashMaskBytes) + { + if (count < 7) + { + Assert.AreEqual(h, 0xff, "mask mismatch"); + } + else + { + Assert.AreEqual(h, 0, "last mask mismatch"); + } + + ++count; + } + } + + /// + /// Test long topic name exceeding 8 levels + /// + [TestMethod] + public void Match_Hash_Test_LongTopic_NoWildCard() + { + var sb = new StringBuilder(); + const int numLevels = 9; + var levelNames = new string[numLevels]; + for (var i = 0; i < numLevels; ++i) + { + if (i > 0) + { + sb.Append("/"); + } + + var levelName = "level" + i; + levelNames[i] = levelName; + sb.Append(levelName); + } + + var topic = sb.ToString(); + + MqttSubscription.CalculateTopicHash(topic, out var topicHash, out var topicHashMask, out var topicHasWildcard); + + Assert.IsFalse(topicHasWildcard, "Wildcard detected when not present"); + + + var hashBytes = GetBytes(topicHash); + // all bytes should contain checksum + var count = 0; + foreach (var h in hashBytes) + { + Assert.AreNotEqual(h, 0, "checksum mismatch"); + ++count; + } + + // The mask should have ff + var hashMaskBytes = GetBytes(topicHashMask); + count = 0; + foreach (var h in hashMaskBytes) + { + Assert.AreEqual(h, 0xff, "mask mismatch"); + ++count; + } + } + + /// + /// Test long topic name with last level being + + /// + [TestMethod] + public void Match_Hash_Test_LongTopic_SingleWildCard() + { + var sb = new StringBuilder(); + const int numLevels = 8; + var levelNames = new string[numLevels]; + for (var i = 0; i < numLevels; ++i) + { + if (i > 0) + { + sb.Append("/"); + } + + string levelName; + if (i == numLevels - 1) + { + // last one is + + levelName = "+"; + } + else + { + levelName = "level" + i; + } + + levelNames[i] = levelName; + sb.Append(levelName); + } + + var topic = sb.ToString(); + + MqttSubscription.CalculateTopicHash(topic, out var topicHash, out var topicHashMask, out var topicHasWildcard); + + Assert.IsTrue(topicHasWildcard, "Wildcard not detected"); + + + var hashBytes = GetBytes(topicHash); + // all bytes should contain checksum + var count = 0; + foreach (var h in hashBytes) + { + if (count < 7) + { + Assert.AreNotEqual(h, 0, "checksum mismatch"); + } + else + { + // wildcard position + Assert.AreEqual(h, 0, "checksum mismatch"); + } + + ++count; + } + + // The mask should have ff + var hashMaskBytes = GetBytes(topicHashMask); + count = 0; + foreach (var h in hashMaskBytes) + { + if (count < 7) + { + Assert.AreEqual(h, 0xff, "mask mismatch"); + } + else + { + Assert.AreEqual(h, 0, "last mask mismatch"); + } + + ++count; + } } [TestMethod] @@ -123,205 +381,13 @@ namespace MQTTnet.Tests.Server Assert.AreEqual(hashMaskBytes[7], 0xff, "mask 7 mismatch"); } - /// - /// Test long topic name with last level being # - /// [TestMethod] - public void Match_Hash_Test_LongTopic_MultiWildcard() + public async Task Match_Hash_Test_Search_MultiWildcard() { - var sb = new StringBuilder(); - const int numLevels = 8; - var levelNames = new string[numLevels]; - for (var i = 0; i < numLevels; ++i) - { - if (i > 0) - sb.Append("/"); - string levelName; - if (i == numLevels - 1) - { - // last one is # - levelName = "#"; - } - else - { - levelName = "level" + i; - } - levelNames[i] = levelName; - sb.Append(levelName); - } - var topic = sb.ToString(); - - // UInt64 is limited to 8 levels - - MqttSubscription.CalculateTopicHash(topic, out var topicHash, out var topicHashMask, out var topicHasWildcard); - - Assert.IsTrue(topicHasWildcard, "Wildcard not detected"); - - var hashBytes = GetBytes(topicHash); - // all bytes should contain checksum - int count = 0; - foreach (var h in hashBytes) - { - if (count < 7) - { - Assert.AreNotEqual(h, 0, "checksum mismatch"); - } - else - { - Assert.AreEqual(h, 0, "checksum mismatch"); - } - ++count; - } - // The mask should have ff except for last level - var hashMaskBytes = GetBytes(topicHashMask); - count = 0; - foreach (var h in hashMaskBytes) - { - if (count < 7) - { - Assert.AreEqual(h, 0xff, "mask mismatch"); - } - else - { - Assert.AreEqual(h, 0, "last mask mismatch"); - } - ++count; - } - } - - /// - /// Test long topic name with last level being + - /// - [TestMethod] - public void Match_Hash_Test_LongTopic_SingleWildCard() - { - var sb = new StringBuilder(); - const int numLevels = 8; - var levelNames = new string[numLevels]; - for (var i = 0; i < numLevels; ++i) - { - if (i > 0) - sb.Append("/"); - string levelName; - if (i == numLevels - 1) - { - // last one is + - levelName = "+"; - } - else - { - levelName = "level" + i; - } - levelNames[i] = levelName; - sb.Append(levelName); - } - var topic = sb.ToString(); - - MqttSubscription.CalculateTopicHash(topic, out var topicHash, out var topicHashMask, out var topicHasWildcard); - - Assert.IsTrue(topicHasWildcard, "Wildcard not detected"); - - - var hashBytes = GetBytes(topicHash); - // all bytes should contain checksum - int count = 0; - foreach (var h in hashBytes) - { - if (count < 7) - { - Assert.AreNotEqual(h, 0, "checksum mismatch"); - } - else - { - // wildcard position - Assert.AreEqual(h, 0, "checksum mismatch"); - } - ++count; - } - // The mask should have ff - var hashMaskBytes = GetBytes(topicHashMask); - count = 0; - foreach (var h in hashMaskBytes) - { - if (count < 7) - { - Assert.AreEqual(h, 0xff, "mask mismatch"); - } - else - { - Assert.AreEqual(h, 0, "last mask mismatch"); - } - ++count; - } - } - - /// - /// Test long topic name exceeding 8 levels - /// - [TestMethod] - public void Match_Hash_Test_LongTopic_NoWildCard() - { - var sb = new StringBuilder(); - const int numLevels = 9; - var levelNames = new string[numLevels]; - for(var i=0; i < numLevels; ++i) - { - if (i > 0) - sb.Append("/"); - var levelName = "level" + i; - levelNames[i] = levelName; - sb.Append(levelName); - } - var topic = sb.ToString(); - - MqttSubscription.CalculateTopicHash(topic, out var topicHash, out var topicHashMask, out var topicHasWildcard); - - Assert.IsFalse(topicHasWildcard, "Wildcard detected when not present"); - - - var hashBytes = GetBytes(topicHash); - // all bytes should contain checksum - int count = 0; - foreach(var h in hashBytes) - { - Assert.AreNotEqual(h, 0, "checksum mismatch"); - ++count; - } - // The mask should have ff - var hashMaskBytes = GetBytes(topicHashMask); - count = 0; - foreach (var h in hashMaskBytes) - { - Assert.AreEqual(h, 0xff, "mask mismatch"); - ++count; - } - } - - - /// - /// Test long topic name with last level being + - /// - [TestMethod] - public void Match_Hash_Test_LongTopic_DetectSingleLevelWildcard() - { - var topic = "asdfasdf/asdfasdf/asdfasdf/asdfasdf/asdfas/dfaf/assfdgsdfgdf/+"; - - MqttSubscription.CalculateTopicHash(topic, out var topicHash, out var topicHashMask, out var topicHasWildcard); - - Assert.IsTrue(topicHasWildcard, "Wildcard not detected"); - } - - /// - /// Test long topic name with last level being # - /// - [TestMethod] - public void Match_Hash_Test_LongTopic_DetectMultiLevelWildcard() - { - var topic = "asdfasdf/asdfasdf/asdfasdf/asdfasdf/asdfas/dfaf/assfdgsdfgdf/#"; - - MqttSubscription.CalculateTopicHash(topic, out var topicHash, out var topicHashMask, out var topicHasWildcard); - - Assert.IsTrue(topicHasWildcard, "Wildcard not detected"); + var topics = await PrepareTopicHashSubscriptions(TopicHashSelector.MultiWildcard); + var matchCount = CheckTopicSubscriptions(_clientSession, topics, "Multi Wildcard"); + // Should match all topics + Assert.AreEqual(topics.Count, matchCount, "Topics not matched"); } [TestMethod] @@ -373,77 +439,38 @@ namespace MQTTnet.Tests.Server } [TestMethod] - public async Task Match_Hash_Test_Search_MultiWildcard() + public void Match_Hash_Test_SingleWildCard() { - var topics = await PrepareTopicHashSubscriptions(TopicHashSelector.MultiWildcard); - var matchCount = CheckTopicSubscriptions(_clientSession, topics, "Multi Wildcard"); - // Should match all topics - Assert.AreEqual(topics.Count, matchCount, "Topics not matched"); - } + var l0 = "pub0"; + var l1 = "topic1"; + var l2 = "+"; + var l3 = "prop1"; + var topic = $"{l0}/{l1}/{l2}/{l3}"; - /// - /// Even fairly regularly named topics as generated by the topic generator should result in shallow hash buckets - /// - /// - [TestMethod] - public void Check_Hash_Bucket_Depth() - { - const int numPublishers = 5000; - const int numTopicsPerPublisher = 10; + MqttSubscription.CalculateTopicHash(topic, out var topicHash, out var topicHashMask, out var topicHasWildcard); - TopicGenerator.Generate(numPublishers, numTopicsPerPublisher, out var topicsByPublisher, out var singleWildcardTopicsByPublisher, out var multiWildcardTopicsByPublisher); + Assert.IsTrue(topicHasWildcard, "Wildcard not detected"); - // There will be many 'similar' topics ending with, i.e. "sensor100", "sensor101", ... - // Hash bucket depths should remain low. - var bucketDepths = new Dictionary(); - int maxBucketDepth = 0; - UInt64 maxBucketDepthHash = 0; + var hashBytes = GetBytes(topicHash); + Assert.AreNotEqual(hashBytes[0], 0, "checksum 0 mismatch"); + Assert.AreNotEqual(hashBytes[1], 0, "checksum 1 mismatch"); + Assert.AreEqual(hashBytes[2], 0, "checksum 2 mismatch"); + Assert.AreNotEqual(hashBytes[3], 0, "checksum 3 mismatch"); + Assert.AreEqual(hashBytes[4], 0, "checksum 4 mismatch"); + Assert.AreEqual(hashBytes[5], 0, "checksum 5 mismatch"); + Assert.AreEqual(hashBytes[6], 0, "checksum 6 mismatch"); + Assert.AreEqual(hashBytes[7], 0, "checksum 7 mismatch"); - var topicsByHash = new Dictionary>(); - - foreach (var t in topicsByPublisher) - { - var topics = t.Value; - foreach (var topic in topics) - { - MqttSubscription.CalculateTopicHash(topic, out var topicHash, out var hashMask, out var hasWildcard); - - bucketDepths.TryGetValue(topicHash, out var currentValue); - ++currentValue; - bucketDepths[topicHash] = currentValue; - - if (currentValue > maxBucketDepth) - { - maxBucketDepth = currentValue; - maxBucketDepthHash = topicHash; - } - - if (!topicsByHash.TryGetValue(topicHash, out var topicList)) - { - topicList = new List(); - topicsByHash.Add(topicHash, topicList); - } - topicList.Add(topic); - } - } - - var maxDepthTopics = topicsByHash[maxBucketDepthHash]; - - Console.Write("Max bucket depth is " + maxBucketDepth); - - // for the test case the bucket depth should be less than 100 - Assert.IsTrue(maxBucketDepth < 100, "Unexpected high topic hash bucket depth"); - } - - - [TestMethod] - public void Check_Selected_Topic_Hashes() - { - CheckTopicHash("client1/building1/level1/sensor1", 0x655D4AF100000000, 0xFFFFFFFFFFFFFFFF); - CheckTopicHash("client1/building1/+/sensor1", 0x655D00F100000000, 0xFFFF00FFFFFFFFFF); - CheckTopicHash("client1/+/level1/+", 0x65004A0000000000, 0xFF00FF00FFFFFFFF); - CheckTopicHash("client1/building1/level1/#", 0x655D4A0000000000, 0xFFFFFF0000000000); - CheckTopicHash("client1/+/level1/#", 0x65004A0000000000, 0xFF00FF0000000000); + // The mask should have zeroes where the wildcard and ff at the end + var hashMaskBytes = GetBytes(topicHashMask); + Assert.AreEqual(hashMaskBytes[0], 0xff, "mask 0 mismatch"); + Assert.AreEqual(hashMaskBytes[1], 0xff, "mask 1 mismatch"); + Assert.AreEqual(hashMaskBytes[2], 0, "mask 2 mismatch"); + Assert.AreEqual(hashMaskBytes[3], 0xff, "mask 3 mismatch"); + Assert.AreEqual(hashMaskBytes[4], 0xff, "mask 4 mismatch"); + Assert.AreEqual(hashMaskBytes[5], 0xff, "mask 5 mismatch"); + Assert.AreEqual(hashMaskBytes[6], 0xff, "mask 6 mismatch"); + Assert.AreEqual(hashMaskBytes[7], 0xff, "mask 7 mismatch"); } void CheckTopicHash(string topic, ulong expectedHash, ulong expectedHashMask) @@ -459,13 +486,66 @@ namespace MQTTnet.Tests.Server Assert.AreEqual(expectedHashMask, hashMask, "Topic hash mask not as expected"); } + int CheckTopicSubscriptions(MqttSession clientSession, List topicsToFind, string subject) + { + var matchCount = 0; + + { + var resultCount = 0; + + var stopWatch = new Stopwatch(); + stopWatch.Start(); + var countUp = 0; + var countDown = topicsToFind.Count - 1; + for (; countUp < topicsToFind.Count; ++countUp, --countDown) + { + var topicToFind = topicsToFind[countDown]; + + MqttSubscription.CalculateTopicHash(topicToFind, out var topicHash, out _, out _); + + clientSession.TryCheckSubscriptions(topicToFind, topicHash, MqttQualityOfServiceLevel.AtMostOnce, "OtherClient", out var result); + if (result.IsSubscribed) + { + ++matchCount; + } + + ++resultCount; + } + + stopWatch.Stop(); + + Console.Write("Match count: " + matchCount + "; "); + + Console.WriteLine(subject + " lookup milliseconds: " + stopWatch.ElapsedMilliseconds); + } + + return matchCount; + } + + byte[] GetBytes(ulong value) + { + var bytes = BitConverter.GetBytes(value); + // Ensure that highest byte comes first for comparison left to right + if (BitConverter.IsLittleEndian) + { + return bytes.Reverse().ToArray(); + } + + return bytes; + } + async Task> PrepareTopicHashSubscriptions(TopicHashSelector selector) { const int numPublishers = 1; const int numTopicsPerPublisher = 10000; - TopicGenerator.Generate(numPublishers, numTopicsPerPublisher, out var topicsByPublisher, out var singleWildcardTopicsByPublisher, out var multiWildcardTopicsByPublisher); + TopicGenerator.Generate( + numPublishers, + numTopicsPerPublisher, + out var topicsByPublisher, + out var singleWildcardTopicsByPublisher, + out var multiWildcardTopicsByPublisher); var topics = topicsByPublisher.FirstOrDefault().Value; var singleWildcardTopics = singleWildcardTopicsByPublisher.FirstOrDefault().Value; @@ -477,15 +557,7 @@ namespace MQTTnet.Tests.Server var eventContainer = new MqttServerEventContainer(); var retainedMessagesManager = new MqttRetainedMessagesManager(eventContainer, logger); var sessionManager = new MqttClientSessionsManager(serverOptions, retainedMessagesManager, eventContainer, logger); - _clientSession = new MqttSession( - clientId, - false, - new Dictionary(), - serverOptions, - eventContainer, - retainedMessagesManager, - sessionManager - ); + _clientSession = new MqttSession(clientId, false, new Dictionary(), serverOptions, eventContainer, retainedMessagesManager, sessionManager); List topicsToSubscribe; @@ -501,62 +573,26 @@ namespace MQTTnet.Tests.Server topicsToSubscribe = topics; break; } + foreach (var t in topicsToSubscribe) { - var subPacket = new Packets.MqttSubscribePacket(); - var filter = new Packets.MqttTopicFilter + var subPacket = new MqttSubscribePacket(); + var filter = new MqttTopicFilter { Topic = t }; subPacket.TopicFilters.Add(filter); - await _clientSession.SubscriptionsManager.Subscribe(subPacket, default); + await _clientSession.Subscribe(subPacket, default); } return topics; } - int CheckTopicSubscriptions(MqttSession clientSession, List topicsToFind, string subject) + enum TopicHashSelector { - var matchCount = 0; - - { - int resultCount = 0; - - var stopWatch = new System.Diagnostics.Stopwatch(); - stopWatch.Start(); - var countUp = 0; - var countDown = topicsToFind.Count - 1; - for (; countUp < topicsToFind.Count; ++countUp, --countDown) - { - var topicToFind = topicsToFind[countDown]; - - MqttSubscription.CalculateTopicHash(topicToFind, out var topicHash, out var hashMask, out var hasWildcard); - - var result = clientSession.SubscriptionsManager.CheckSubscriptions(topicToFind, topicHash, MqttQualityOfServiceLevel.AtMostOnce, "OtherClient"); - if (result.IsSubscribed) - { - ++matchCount; - } - ++resultCount; - } - - stopWatch.Stop(); - - Console.Write("Match count: " + matchCount + "; "); - - Console.WriteLine(subject + " lookup milliseconds: " + stopWatch.ElapsedMilliseconds); - } - - return matchCount; - } - - byte[] GetBytes(UInt64 value) - { - var bytes = BitConverter.GetBytes(value); - // Ensure that highest byte comes first for comparison left to right - if (BitConverter.IsLittleEndian) - return bytes.Reverse().ToArray(); - return bytes; + NoWildcard, + SingleWildcard, + MultiWildcard } } -} +} \ No newline at end of file diff --git a/Source/MQTTnet.Tests/TopicGenerator.cs b/Source/MQTTnet.Tests/TopicGenerator.cs index 64ae1144..ddfbe709 100644 --- a/Source/MQTTnet.Tests/TopicGenerator.cs +++ b/Source/MQTTnet.Tests/TopicGenerator.cs @@ -1,8 +1,7 @@ using System; using System.Collections.Generic; -using System.Text; -namespace MQTTnet.Tests.Server +namespace MQTTnet.Tests { public class TopicGenerator { diff --git a/Source/MQTTnet/Formatter/MqttUnsubAckPacketFactory.cs b/Source/MQTTnet/Formatter/MqttUnsubAckPacketFactory.cs index 18da46a1..88cbbbc6 100644 --- a/Source/MQTTnet/Formatter/MqttUnsubAckPacketFactory.cs +++ b/Source/MQTTnet/Formatter/MqttUnsubAckPacketFactory.cs @@ -10,16 +10,16 @@ namespace MQTTnet.Formatter { public sealed class MqttUnsubAckPacketFactory { - public MqttUnsubAckPacket Create(MqttUnsubscribePacket unsubscribePacket, MqttUnsubscribeResult mqttUnsubscribeResult) + public MqttUnsubAckPacket Create(MqttUnsubscribePacket unsubscribePacket, UnsubscribeResult unsubscribeResult) { if (unsubscribePacket == null) { throw new ArgumentNullException(nameof(unsubscribePacket)); } - if (mqttUnsubscribeResult == null) + if (unsubscribeResult == null) { - throw new ArgumentNullException(nameof(mqttUnsubscribeResult)); + throw new ArgumentNullException(nameof(unsubscribeResult)); } var unsubAckPacket = new MqttUnsubAckPacket @@ -28,7 +28,7 @@ namespace MQTTnet.Formatter }; // MQTTv5.0.0 only. - unsubAckPacket.ReasonCodes = mqttUnsubscribeResult.ReasonCodes; + unsubAckPacket.ReasonCodes = unsubscribeResult.ReasonCodes; return unsubAckPacket; } diff --git a/Source/MQTTnet/Internal/AsyncEvent.cs b/Source/MQTTnet/Internal/AsyncEvent.cs index 8e988d75..e7adc7b5 100644 --- a/Source/MQTTnet/Internal/AsyncEvent.cs +++ b/Source/MQTTnet/Internal/AsyncEvent.cs @@ -123,7 +123,7 @@ namespace MQTTnet.Internal } catch (Exception exception) { - logger.Warning(exception, $"Error while invoking event ({typeof(TEventArgs)})."); + logger.Warning(exception, $"Error while invoking event with arguments of type {typeof(TEventArgs)}."); } } } diff --git a/Source/MQTTnet/Server/Internal/MqttClient.cs b/Source/MQTTnet/Server/Internal/MqttClient.cs index 1bc51152..674a262f 100644 --- a/Source/MQTTnet/Server/Internal/MqttClient.cs +++ b/Source/MQTTnet/Server/Internal/MqttClient.cs @@ -33,6 +33,7 @@ namespace MQTTnet.Server readonly Dictionary _topicAlias = new Dictionary(); CancellationTokenSource _cancellationToken; + bool _disconnectPacketSent; public MqttClient( MqttConnectPacket connectPacket, @@ -146,19 +147,22 @@ namespace MQTTnet.Server { IsRunning = false; - // Sending DISCONNECT packets from the server to the client is only supported when using MQTTv5+. - if (ChannelAdapter.PacketFormatterAdapter.ProtocolVersion == MqttProtocolVersion.V500) + if (!_disconnectPacketSent) { - // The Client or Server MAY send a DISCONNECT packet before closing the Network Connection. - // This library does not sent a DISCONNECT packet for a normal disconnection. Maybe adding - // a configuration option is requested in the future. - if (reason != MqttDisconnectReasonCode.NormalDisconnection) + // Sending DISCONNECT packets from the server to the client is only supported when using MQTTv5+. + if (ChannelAdapter.PacketFormatterAdapter.ProtocolVersion == MqttProtocolVersion.V500) { - // Is is very important to send the DISCONNECT packet here BEFORE cancelling the - // token because the entire connection is closed (disposed) as soon as the cancellation - // token is cancelled. To there is no chance that the DISCONNECT packet will ever arrive - // at the client! - await TrySendDisconnectPacket(reason).ConfigureAwait(false); + // The Client or Server MAY send a DISCONNECT packet before closing the Network Connection. + // This library does not sent a DISCONNECT packet for a normal disconnection. Maybe adding + // a configuration option is requested in the future. + if (reason != MqttDisconnectReasonCode.NormalDisconnection) + { + // Is is very important to send the DISCONNECT packet here BEFORE cancelling the + // token because the entire connection is closed (disposed) as soon as the cancellation + // token is cancelled. To there is no chance that the DISCONNECT packet will ever arrive + // at the client! + await TrySendDisconnectPacket(reason).ConfigureAwait(false); + } } } @@ -282,7 +286,7 @@ namespace MQTTnet.Server async Task HandleIncomingSubscribePacket(MqttSubscribePacket subscribePacket, CancellationToken cancellationToken) { - var subscribeResult = await Session.SubscriptionsManager.Subscribe(subscribePacket, cancellationToken).ConfigureAwait(false); + var subscribeResult = await Session.Subscribe(subscribePacket, cancellationToken).ConfigureAwait(false); var subAckPacket = _packetFactories.SubAck.Create(subscribePacket, subscribeResult); @@ -306,7 +310,7 @@ namespace MQTTnet.Server async Task HandleIncomingUnsubscribePacket(MqttUnsubscribePacket unsubscribePacket, CancellationToken cancellationToken) { - var unsubscribeResult = await Session.SubscriptionsManager.Unsubscribe(unsubscribePacket, cancellationToken).ConfigureAwait(false); + var unsubscribeResult = await Session.Unsubscribe(unsubscribePacket, cancellationToken).ConfigureAwait(false); var unsubAckPacket = _packetFactories.UnsubAck.Create(unsubscribePacket, unsubscribeResult); @@ -484,7 +488,7 @@ namespace MQTTnet.Server try { - while (!cancellationToken.IsCancellationRequested) + while (!cancellationToken.IsCancellationRequested && !IsTakenOver && IsRunning) { packetBusItem = await Session.DequeuePacketAsync(cancellationToken).ConfigureAwait(false); @@ -566,6 +570,9 @@ namespace MQTTnet.Server { try { + // This also indicates that it was tried at least! + _disconnectPacketSent = true; + var disconnectPacket = _packetFactories.Disconnect.Create(reasonCode); using (var timeout = new CancellationTokenSource(_serverOptions.DefaultCommunicationTimeout)) diff --git a/Source/MQTTnet/Server/Internal/MqttClientSessionsManager.cs b/Source/MQTTnet/Server/Internal/MqttClientSessionsManager.cs index 87fcdd34..186a15ca 100644 --- a/Source/MQTTnet/Server/Internal/MqttClientSessionsManager.cs +++ b/Source/MQTTnet/Server/Internal/MqttClientSessionsManager.cs @@ -150,11 +150,17 @@ namespace MQTTnet.Server foreach (var session in subscriberSessions) { - var checkSubscriptionsResult = session.SubscriptionsManager.CheckSubscriptions( + if(!session.TryCheckSubscriptions( applicationMessage.Topic, topicHash, applicationMessage.QualityOfServiceLevel, - senderId); + senderId, + out var checkSubscriptionsResult)) + { + // Checking the subscriptions has failed for the session. The session + // will be ignored. + continue; + } if (!checkSubscriptionsResult.IsSubscribed) { @@ -301,7 +307,7 @@ namespace MQTTnet.Server channelAdapter.Endpoint, client.Session.Items); - await _eventContainer.ClientConnectedEvent.InvokeAsync(eventArgs).ConfigureAwait(false); + await _eventContainer.ClientConnectedEvent.TryInvokeAsync(eventArgs, _logger).ConfigureAwait(false); } await client.RunAsync().ConfigureAwait(false); @@ -414,7 +420,7 @@ namespace MQTTnet.Server var clientSession = GetClientSession(clientId); - var subscribeResult = await clientSession.SubscriptionsManager.Subscribe(fakeSubscribePacket, CancellationToken.None).ConfigureAwait(false); + var subscribeResult = await clientSession.Subscribe(fakeSubscribePacket, CancellationToken.None).ConfigureAwait(false); if (subscribeResult.RetainedMessages != null) { @@ -441,7 +447,7 @@ namespace MQTTnet.Server var fakeUnsubscribePacket = new MqttUnsubscribePacket(); fakeUnsubscribePacket.TopicFilters.AddRange(topicFilters); - return GetClientSession(clientId).SubscriptionsManager.Unsubscribe(fakeUnsubscribePacket, CancellationToken.None); + return GetClientSession(clientId).Unsubscribe(fakeUnsubscribePacket, CancellationToken.None); } MqttClient CreateClient(MqttConnectPacket connectPacket, IMqttChannelAdapter channelAdapter, MqttSession session) @@ -484,10 +490,14 @@ namespace MQTTnet.Server using (await _createConnectionSyncRoot.EnterAsync().ConfigureAwait(false)) { - MqttSession session; MqttSession oldSession; + MqttClient oldClient; + lock (_sessionsManagementLock) { + MqttSession session; + + // Create a new session (if required). if (!_sessions.TryGetValue(connectPacket.ClientId, out oldSession)) { session = CreateSession(connectPacket.ClientId, validatingConnectionEventArgs.SessionItems, sessionShouldPersist); @@ -505,6 +515,7 @@ namespace MQTTnet.Server _logger.Verbose("Reusing existing session of client '{0}'.", connectPacket.ClientId); session = oldSession; oldSession = null; + // Session persistence could change for MQTT 5 clients that reconnect with different SessionExpiryInterval session.IsPersistent = sessionShouldPersist; connAckPacket.IsSessionPresent = true; @@ -513,39 +524,41 @@ namespace MQTTnet.Server } _sessions[connectPacket.ClientId] = session; + + // Create a new client (always required). + _clients.TryGetValue(connectPacket.ClientId, out oldClient); + if (oldClient != null) + { + // This will stop the current client from sending and receiving but remains the connection active + // for a later DISCONNECT packet. + oldClient.IsTakenOver = true; + } + + client = CreateClient(connectPacket, channelAdapter, session); + + _clients[connectPacket.ClientId] = client; } if (!connAckPacket.IsSessionPresent) { // TODO: This event is not yet final. It can already be used but restoring sessions from storage will be added later! var preparingSessionEventArgs = new PreparingSessionEventArgs(); - await _eventContainer.PreparingSessionEvent.InvokeAsync(preparingSessionEventArgs).ConfigureAwait(false); + await _eventContainer.PreparingSessionEvent.TryInvokeAsync(preparingSessionEventArgs, _logger).ConfigureAwait(false); } - - MqttClient existingClient; - - lock (_clients) + + if (oldClient != null) { - _clients.TryGetValue(connectPacket.ClientId, out existingClient); - client = CreateClient(connectPacket, channelAdapter, session); - - _clients[connectPacket.ClientId] = client; - } - - if (existingClient != null) - { - existingClient.IsTakenOver = true; - await existingClient.StopAsync(MqttDisconnectReasonCode.SessionTakenOver).ConfigureAwait(false); + await oldClient.StopAsync(MqttDisconnectReasonCode.SessionTakenOver).ConfigureAwait(false); if (_eventContainer.ClientDisconnectedEvent.HasHandlers) { var eventArgs = new ClientDisconnectedEventArgs( - existingClient.Id, + oldClient.Id, MqttClientDisconnectType.Takeover, - existingClient.Endpoint, - existingClient.Session.Items); + oldClient.Endpoint, + oldClient.Session.Items); - await _eventContainer.ClientDisconnectedEvent.InvokeAsync(eventArgs).ConfigureAwait(false); + await _eventContainer.ClientDisconnectedEvent.TryInvokeAsync(eventArgs, _logger).ConfigureAwait(false); } } diff --git a/Source/MQTTnet/Server/Internal/MqttClientSubscriptionsManager.cs b/Source/MQTTnet/Server/Internal/MqttClientSubscriptionsManager.cs index a6542d14..6fb45371 100644 --- a/Source/MQTTnet/Server/Internal/MqttClientSubscriptionsManager.cs +++ b/Source/MQTTnet/Server/Internal/MqttClientSubscriptionsManager.cs @@ -7,6 +7,7 @@ using System.Collections.Generic; using System.Linq; using System.Threading; using System.Threading.Tasks; +using MQTTnet.Internal; using MQTTnet.Packets; using MQTTnet.Protocol; @@ -30,7 +31,7 @@ namespace MQTTnet.Server readonly Dictionary _subscriptions = new Dictionary(); // Use subscription lock to maintain consistency across subscriptions and topic hash dictionaries - readonly SemaphoreSlim _subscriptionsLock = new SemaphoreSlim(1); + readonly AsyncLock _subscriptionsLock = new AsyncLock(); readonly Dictionary _wildcardSubscriptionsByTopicHash = new Dictionary(); public MqttClientSubscriptionsManager( @@ -45,13 +46,12 @@ namespace MQTTnet.Server _subscriptionChangedNotification = subscriptionChangedNotification; } - public CheckSubscriptionsResult CheckSubscriptions(string topic, ulong topicHash, MqttQualityOfServiceLevel applicationMessageQoSLevel, string senderClientId) + public CheckSubscriptionsResult CheckSubscriptions(string topic, ulong topicHash, MqttQualityOfServiceLevel qualityOfServiceLevel, string senderId) { var possibleSubscriptions = new List(); // Check for possible subscriptions. They might have collisions but this is fine. - _subscriptionsLock.Wait(); - try + using (_subscriptionsLock.EnterAsync(CancellationToken.None).GetAwaiter().GetResult()) { if (_noWildcardSubscriptionsByTopicHash.TryGetValue(topicHash, out var noWildcardSubscriptions)) { @@ -63,18 +63,14 @@ namespace MQTTnet.Server var wildcardSubscriptions = wcs.Value; var subscriptionHash = wcs.Key; var subscriptionHashMask = wildcardSubscriptions.HashMask; - + if ((topicHash & subscriptionHashMask) == subscriptionHash) { possibleSubscriptions.AddRange(wildcardSubscriptions.Subscriptions.ToList()); } } } - finally - { - _subscriptionsLock.Release(); - } - + // The pre check has evaluated that nothing is subscribed. // If there were some possible candidates they get checked below // again to avoid collisions. @@ -83,7 +79,7 @@ namespace MQTTnet.Server return CheckSubscriptionsResult.NotSubscribed; } - var senderIsReceiver = string.Equals(senderClientId, _session.Id); + var senderIsReceiver = string.Equals(senderId, _session.Id); var maxQoSLevel = -1; // Not subscribed. HashSet subscriptionIdentifiers = null; @@ -136,7 +132,7 @@ namespace MQTTnet.Server SubscriptionIdentifiers = subscriptionIdentifiers?.ToList() ?? EmptySubscriptionIdentifiers, // Start with the same QoS as the publisher. - QualityOfServiceLevel = applicationMessageQoSLevel + QualityOfServiceLevel = qualityOfServiceLevel }; // Now downgrade if required. @@ -148,7 +144,7 @@ namespace MQTTnet.Server // Subscribing to a Topic Filter at QoS 2 is equivalent to saying "I would like to receive Messages matching this filter at the QoS with which they were published". // This means a publisher is responsible for determining the maximum QoS a Message can be delivered at, but a subscriber is able to require that the Server // downgrades the QoS to one more suitable for its usage. - if (maxQoSLevel < (int)applicationMessageQoSLevel) + if (maxQoSLevel < (int)qualityOfServiceLevel) { result.QualityOfServiceLevel = (MqttQualityOfServiceLevel)maxQoSLevel; } @@ -209,7 +205,7 @@ namespace MQTTnet.Server // This call will add the new subscription to the internal storage. // So the event _ClientSubscribedTopicEvent_ must be called afterwards. _subscriptionChangedNotification?.OnSubscriptionsAdded(_session, addedSubscriptions); - + if (_eventContainer.ClientSubscribedTopicEvent.HasHandlers) { foreach (var finalTopicFilter in finalTopicFilters) @@ -218,23 +214,22 @@ namespace MQTTnet.Server await _eventContainer.ClientSubscribedTopicEvent.InvokeAsync(eventArgs).ConfigureAwait(false); } } - + return result; } - public async Task Unsubscribe(MqttUnsubscribePacket unsubscribePacket, CancellationToken cancellationToken) + public async Task Unsubscribe(MqttUnsubscribePacket unsubscribePacket, CancellationToken cancellationToken) { if (unsubscribePacket == null) { throw new ArgumentNullException(nameof(unsubscribePacket)); } - var result = new MqttUnsubscribeResult(); + var result = new UnsubscribeResult(); var removedSubscriptions = new List(); - await _subscriptionsLock.WaitAsync(cancellationToken).ConfigureAwait(false); - try + using (await _subscriptionsLock.EnterAsync(cancellationToken).ConfigureAwait(false)) { foreach (var topicFilter in unsubscribePacket.TopicFilters) { @@ -265,7 +260,7 @@ namespace MQTTnet.Server if (existingSubscription != null) { var topicHash = existingSubscription.TopicHash; - + if (existingSubscription.TopicHasWildcard) { if (_wildcardSubscriptionsByTopicHash.TryGetValue(topicHash, out var subscriptions)) @@ -294,11 +289,8 @@ namespace MQTTnet.Server } } } - finally - { - _subscriptionsLock.Release(); - _subscriptionChangedNotification?.OnSubscriptionsRemoved(_session, removedSubscriptions); - } + + _subscriptionChangedNotification?.OnSubscriptionsRemoved(_session, removedSubscriptions); if (_eventContainer.ClientUnsubscribedTopicEvent.HasHandlers) { @@ -345,8 +337,7 @@ namespace MQTTnet.Server // Add to subscriptions and maintain topic hash dictionaries - _subscriptionsLock.Wait(); - try + using (_subscriptionsLock.EnterAsync(CancellationToken.None).GetAwaiter().GetResult()) { MqttSubscription.CalculateTopicHash(topicFilter.Topic, out var topicHash, out var topicHashMask, out var hasWildcard); @@ -396,10 +387,6 @@ namespace MQTTnet.Server subscriptions.Add(subscription); } } - finally - { - _subscriptionsLock.Release(); - } return new CreateSubscriptionResult { @@ -493,23 +480,20 @@ namespace MQTTnet.Server async Task InterceptUnsubscribe(string topicFilter, MqttSubscription mqttSubscription, CancellationToken cancellationToken) { - var clientUnsubscribingTopicEventArgs = new InterceptingUnsubscriptionEventArgs(cancellationToken, topicFilter, _session.Items, topicFilter); - - if (mqttSubscription == null) + var clientUnsubscribingTopicEventArgs = new InterceptingUnsubscriptionEventArgs(cancellationToken, topicFilter, _session.Items, topicFilter) { - clientUnsubscribingTopicEventArgs.Response.ReasonCode = MqttUnsubscribeReasonCode.NoSubscriptionExisted; - } - else - { - clientUnsubscribingTopicEventArgs.Response.ReasonCode = MqttUnsubscribeReasonCode.Success; - } + Response = + { + ReasonCode = mqttSubscription == null ? MqttUnsubscribeReasonCode.NoSubscriptionExisted : MqttUnsubscribeReasonCode.Success + } + }; await _eventContainer.InterceptingUnsubscriptionEvent.InvokeAsync(clientUnsubscribingTopicEventArgs).ConfigureAwait(false); return clientUnsubscribingTopicEventArgs; } - public sealed class CreateSubscriptionResult + sealed class CreateSubscriptionResult { public bool IsNewSubscription { get; set; } diff --git a/Source/MQTTnet/Server/Internal/MqttSession.cs b/Source/MQTTnet/Server/Internal/MqttSession.cs index de9ff74d..a5a045bf 100644 --- a/Source/MQTTnet/Server/Internal/MqttSession.cs +++ b/Source/MQTTnet/Server/Internal/MqttSession.cs @@ -23,6 +23,7 @@ namespace MQTTnet.Server readonly MqttPacketIdentifierProvider _packetIdentifierProvider = new MqttPacketIdentifierProvider(); readonly MqttServerOptions _serverOptions; + readonly MqttClientSubscriptionsManager _subscriptionsManager; readonly ConcurrentDictionary _unacknowledgedPublishPackets = new ConcurrentDictionary(); @@ -45,7 +46,7 @@ namespace MQTTnet.Server _serverOptions = serverOptions ?? throw new ArgumentNullException(nameof(serverOptions)); _clientSessionsManager = clientSessionsManager ?? throw new ArgumentNullException(nameof(clientSessionsManager)); - SubscriptionsManager = new MqttClientSubscriptionsManager(this, eventContainer, retainedMessagesManager, clientSessionsManager); + _subscriptionsManager = new MqttClientSubscriptionsManager(this, eventContainer, retainedMessagesManager, clientSessionsManager); } public DateTime CreatedTimestamp { get; } = DateTime.UtcNow; @@ -67,18 +68,8 @@ namespace MQTTnet.Server public long PendingDataPacketsCount => _packetBus.PartitionItemsCount(MqttPacketBusPartition.Data); - public MqttClientSubscriptionsManager SubscriptionsManager { get; } - public bool WillMessageSent { get; set; } - public MqttPublishPacket PeekAcknowledgePublishPacket(ushort packetIdentifier) - { - // This will only return the matching PUBLISH packet but does not remove it. - // This is required for QoS 2. - _unacknowledgedPublishPackets.TryGetValue(packetIdentifier, out var publishPacket); - return publishPacket; - } - public MqttPublishPacket AcknowledgePublishPacket(ushort packetIdentifier) { _unacknowledgedPublishPackets.TryRemove(packetIdentifier, out var publishPacket); @@ -107,8 +98,8 @@ namespace MQTTnet.Server public void Dispose() { - _packetBus?.Dispose(); - SubscriptionsManager.Dispose(); + _packetBus.Dispose(); + _subscriptionsManager.Dispose(); } public void EnqueueControlPacket(MqttPacketBusItem packetBusItem) @@ -150,6 +141,14 @@ namespace MQTTnet.Server _packetBus.EnqueueItem(packetBusItem, MqttPacketBusPartition.Health); } + public MqttPublishPacket PeekAcknowledgePublishPacket(ushort packetIdentifier) + { + // This will only return the matching PUBLISH packet but does not remove it. + // This is required for QoS 2. + _unacknowledgedPublishPackets.TryGetValue(packetIdentifier, out var publishPacket); + return publishPacket; + } + public void Recover() { // TODO: Keep the bus and only insert pending items again. @@ -167,5 +166,30 @@ namespace MQTTnet.Server { _subscribedTopics?.Remove(topic); } + + public Task Subscribe(MqttSubscribePacket subscribePacket, CancellationToken cancellationToken) + { + return _subscriptionsManager.Subscribe(subscribePacket, cancellationToken); + } + + public bool TryCheckSubscriptions(string topic, ulong topicHash, MqttQualityOfServiceLevel qualityOfServiceLevel, string senderId, out CheckSubscriptionsResult result) + { + result = null; + + try + { + result = _subscriptionsManager.CheckSubscriptions(topic, topicHash, qualityOfServiceLevel, senderId); + return true; + } + catch + { + return false; + } + } + + public Task Unsubscribe(MqttUnsubscribePacket unsubscribePacket, CancellationToken cancellationToken) + { + return _subscriptionsManager.Unsubscribe(unsubscribePacket, cancellationToken); + } } } \ No newline at end of file diff --git a/Source/MQTTnet/Server/Internal/MqttSubscription.cs b/Source/MQTTnet/Server/Internal/MqttSubscription.cs index ec532425..930d3c72 100644 --- a/Source/MQTTnet/Server/Internal/MqttSubscription.cs +++ b/Source/MQTTnet/Server/Internal/MqttSubscription.cs @@ -179,7 +179,7 @@ namespace MQTTnet.Server RetainAsPublished = retainAsPublished; GrantedQualityOfServiceLevel = qualityOfServiceLevel; Identifier = identifier; - + CalculateTopicHash(Topic, out var hash, out var hashMask, out var hasWildcard); TopicHash = hash; TopicHashMask = hashMask; diff --git a/Source/MQTTnet/Server/Internal/MqttUnsubscribeResult.cs b/Source/MQTTnet/Server/Internal/UnsubscribeResult.cs similarity index 90% rename from Source/MQTTnet/Server/Internal/MqttUnsubscribeResult.cs rename to Source/MQTTnet/Server/Internal/UnsubscribeResult.cs index 9e482dcf..5a93d997 100644 --- a/Source/MQTTnet/Server/Internal/MqttUnsubscribeResult.cs +++ b/Source/MQTTnet/Server/Internal/UnsubscribeResult.cs @@ -7,7 +7,7 @@ using MQTTnet.Protocol; namespace MQTTnet.Server { - public sealed class MqttUnsubscribeResult + public sealed class UnsubscribeResult { public List ReasonCodes { get; } = new List(128); From 5ee0bb4b65a3ce63c9867176e231c6edd33fa978 Mon Sep 17 00:00:00 2001 From: Christian <6939810+chkr1011@users.noreply.github.com> Date: Wed, 9 Nov 2022 19:56:29 +0100 Subject: [PATCH 05/11] 1565 high cpu load from asyncsignal (#1566) --- .../Internal/AsyncSignal_Tests.cs | 16 +++++++++- Source/MQTTnet.Tests/Server/Load_Tests.cs | 2 +- Source/MQTTnet.Tests/Server/Session_Tests.cs | 4 +-- Source/MQTTnet/Internal/AsyncQueue.cs | 30 +++++++++++-------- .../Internal/AsyncQueueDequeueResult.cs | 9 +++++- Source/MQTTnet/Internal/AsyncSignal.cs | 26 ++++++++++++++-- 6 files changed, 67 insertions(+), 20 deletions(-) diff --git a/Source/MQTTnet.Tests/Internal/AsyncSignal_Tests.cs b/Source/MQTTnet.Tests/Internal/AsyncSignal_Tests.cs index 88ec56fa..9adac5dc 100644 --- a/Source/MQTTnet.Tests/Internal/AsyncSignal_Tests.cs +++ b/Source/MQTTnet.Tests/Internal/AsyncSignal_Tests.cs @@ -52,12 +52,26 @@ namespace MQTTnet.Tests.Internal } [TestMethod] - public async Task Loop_Signal() + public async Task Reset_Signal() { var asyncSignal = new AsyncSignal(); + // WaitAsync should fail because no signal is available. for (var i = 0; i < 10; i++) { + try + { + using (var timeout = new CancellationTokenSource(TimeSpan.FromMilliseconds(100))) + { + await asyncSignal.WaitAsync(timeout.Token); + } + + Assert.Fail("This must fail because the signal is not yet set."); + } + catch (OperationCanceledException) + { + } + asyncSignal.Set(); // WaitAsync should return directly because the signal is available. diff --git a/Source/MQTTnet.Tests/Server/Load_Tests.cs b/Source/MQTTnet.Tests/Server/Load_Tests.cs index 7c446ee0..112d1d80 100644 --- a/Source/MQTTnet.Tests/Server/Load_Tests.cs +++ b/Source/MQTTnet.Tests/Server/Load_Tests.cs @@ -55,7 +55,7 @@ namespace MQTTnet.Tests.Server }); } - SpinWait.SpinUntil(() => receivedMessages == 100000, TimeSpan.FromSeconds(90)); + SpinWait.SpinUntil(() => receivedMessages == 100000, TimeSpan.FromSeconds(120)); Assert.AreEqual(100000, receivedMessages); } diff --git a/Source/MQTTnet.Tests/Server/Session_Tests.cs b/Source/MQTTnet.Tests/Server/Session_Tests.cs index d86d2e8d..6b9af994 100644 --- a/Source/MQTTnet.Tests/Server/Session_Tests.cs +++ b/Source/MQTTnet.Tests/Server/Session_Tests.cs @@ -150,7 +150,7 @@ namespace MQTTnet.Tests.Server // Try to connect 50 clients at the same time. var clients = await Task.WhenAll(Enumerable.Range(0, 50).Select(i => ConnectAndSubscribe(testEnvironment, options, OnReceive))); - await Task.Delay(5000); + await Task.Delay(TimeSpan.FromSeconds(10)); var connectedClients = clients.Where(c => c?.TryPingAsync().GetAwaiter().GetResult() == true).ToList(); @@ -162,7 +162,7 @@ namespace MQTTnet.Tests.Server var sendClient = await testEnvironment.ConnectClient(option2); await sendClient.PublishStringAsync("aaa", "1"); - await Task.Delay(3000); + await Task.Delay(TimeSpan.FromSeconds(5)); Assert.AreEqual(true, hasReceive); } diff --git a/Source/MQTTnet/Internal/AsyncQueue.cs b/Source/MQTTnet/Internal/AsyncQueue.cs index c54f5467..52381a32 100644 --- a/Source/MQTTnet/Internal/AsyncQueue.cs +++ b/Source/MQTTnet/Internal/AsyncQueue.cs @@ -29,7 +29,7 @@ namespace MQTTnet.Internal { lock (_syncRoot) { - _signal?.Dispose(); + _signal.Dispose(); _isDisposed = true; } @@ -48,10 +48,10 @@ namespace MQTTnet.Internal { if (_queue.TryDequeue(out var item)) { - return new AsyncQueueDequeueResult(true, item); + return AsyncQueueDequeueResult.Success(item); } - return new AsyncQueueDequeueResult(false, default); + return AsyncQueueDequeueResult.NonSuccess; } public async Task> TryDequeueAsync(CancellationToken cancellationToken) @@ -60,36 +60,42 @@ namespace MQTTnet.Internal { try { - Task task; + Task task = null; lock (_syncRoot) { if (_isDisposed) { - return new AsyncQueueDequeueResult(false, default); + return AsyncQueueDequeueResult.NonSuccess; } - task = _signal.WaitAsync(cancellationToken); + if (_queue.IsEmpty) + { + task = _signal.WaitAsync(cancellationToken); + } } - await task.ConfigureAwait(false); - + if (task != null) + { + await task.ConfigureAwait(false); + } + if (cancellationToken.IsCancellationRequested) { - return new AsyncQueueDequeueResult(false, default); + return AsyncQueueDequeueResult.NonSuccess; } if (_queue.TryDequeue(out var item)) { - return new AsyncQueueDequeueResult(true, item); + return AsyncQueueDequeueResult.Success(item); } } catch (OperationCanceledException) { - return new AsyncQueueDequeueResult(false, default); + return AsyncQueueDequeueResult.NonSuccess; } } - return new AsyncQueueDequeueResult(false, default); + return AsyncQueueDequeueResult.NonSuccess; } } } \ No newline at end of file diff --git a/Source/MQTTnet/Internal/AsyncQueueDequeueResult.cs b/Source/MQTTnet/Internal/AsyncQueueDequeueResult.cs index 6848e1fd..09543238 100644 --- a/Source/MQTTnet/Internal/AsyncQueueDequeueResult.cs +++ b/Source/MQTTnet/Internal/AsyncQueueDequeueResult.cs @@ -4,8 +4,10 @@ namespace MQTTnet.Internal { - public class AsyncQueueDequeueResult + public sealed class AsyncQueueDequeueResult { + public static readonly AsyncQueueDequeueResult NonSuccess = new AsyncQueueDequeueResult(false, default); + public AsyncQueueDequeueResult(bool isSuccess, TItem item) { IsSuccess = isSuccess; @@ -15,5 +17,10 @@ namespace MQTTnet.Internal public bool IsSuccess { get; } public TItem Item { get; } + + public static AsyncQueueDequeueResult Success(TItem item) + { + return new AsyncQueueDequeueResult(true, item); + } } } \ No newline at end of file diff --git a/Source/MQTTnet/Internal/AsyncSignal.cs b/Source/MQTTnet/Internal/AsyncSignal.cs index cde8532c..217a5cce 100644 --- a/Source/MQTTnet/Internal/AsyncSignal.cs +++ b/Source/MQTTnet/Internal/AsyncSignal.cs @@ -33,9 +33,17 @@ namespace MQTTnet.Internal { _isSignaled = true; + Cleanup(); + // If there is already a waiting task let it run. - _waiter?.Approve(); - _waiter = null; + if (_waiter != null) + { + _waiter.Approve(); + _waiter = null; + + // Since we already got a waiter the signal must be reset right now! + _isSignaled = false; + } } } @@ -47,8 +55,11 @@ namespace MQTTnet.Internal { ThrowIfDisposed(); + Cleanup(); + if (_isSignaled) { + _isSignaled = false; return CompletedTask.Instance; } @@ -58,7 +69,7 @@ namespace MQTTnet.Internal { throw new InvalidOperationException("Only one waiting task is permitted per async signal."); } - + _waiter.Dispose(); } @@ -67,6 +78,15 @@ namespace MQTTnet.Internal } } + void Cleanup() + { + // Cleanup if the previous waiter was cancelled. + if (_waiter != null && _waiter.Task.IsCanceled) + { + _waiter = null; + } + } + void ThrowIfDisposed() { if (_isDisposed) From 56f0a2c31ca817cbd1eceed44b54333afbc33863 Mon Sep 17 00:00:00 2001 From: Christian <6939810+chkr1011@users.noreply.github.com> Date: Wed, 9 Nov 2022 20:13:59 +0100 Subject: [PATCH 06/11] Fix validation of topic in managed client (#1567) --- .github/workflows/ReleaseNotes.md | 3 ++- Source/MQTTnet.Extensions.ManagedClient/ManagedMqttClient.cs | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ReleaseNotes.md b/.github/workflows/ReleaseNotes.md index d08fa6b0..1614de15 100644 --- a/.github/workflows/ReleaseNotes.md +++ b/.github/workflows/ReleaseNotes.md @@ -1,5 +1,6 @@ * [Core] Fixed several dead locks by implementing a new async signal (#1552) * [Client] All waiting tasks will now fail when the client connection gets closed. This fixes several freezes (#1561) +* [ManagedClient] The topic is no longer declared as invalid if a topic alias is used (#1395). * [Server] Fixed duplicated invocation of the event _ClientAcknowledgedPublishPacketAsync_ for QoS level 2 (#1550) * [Server] Fixed issue in upgrading and downgrading of QoS levels for subscriptions and retained messages (#1560) -* [Server] Fixed memory leak when old sessions are discarded (#1553) \ No newline at end of file +* [Server] Fixed memory leak when old sessions are discarded (#1553) diff --git a/Source/MQTTnet.Extensions.ManagedClient/ManagedMqttClient.cs b/Source/MQTTnet.Extensions.ManagedClient/ManagedMqttClient.cs index 2583a605..c979627c 100644 --- a/Source/MQTTnet.Extensions.ManagedClient/ManagedMqttClient.cs +++ b/Source/MQTTnet.Extensions.ManagedClient/ManagedMqttClient.cs @@ -160,7 +160,7 @@ namespace MQTTnet.Extensions.ManagedClient throw new InvalidOperationException("call StartAsync before publishing messages"); } - MqttTopicValidator.ThrowIfInvalid(applicationMessage.ApplicationMessage.Topic); + MqttTopicValidator.ThrowIfInvalid(applicationMessage.ApplicationMessage); ManagedMqttApplicationMessage removedMessage = null; ApplicationMessageSkippedEventArgs applicationMessageSkippedEventArgs = null; From bfec9dc5ad58bc08a64432b1497f4e2cbc3f1346 Mon Sep 17 00:00:00 2001 From: Christian <6939810+chkr1011@users.noreply.github.com> Date: Wed, 9 Nov 2022 21:14:53 +0100 Subject: [PATCH 07/11] 802 client isnt being notified if message is not delivered (#1568) --- .github/workflows/ReleaseNotes.md | 1 + Source/MQTTnet.Tests/MQTTv5/Client_Tests.cs | 4 +- Source/MQTTnet.Tests/Server/Publish_Tests.cs | 58 +++++++++++++++++++ .../Publishing/MqttClientPublishResult.cs | 31 ++++++---- .../Formatter/MqttPubAckPacketFactory.cs | 38 ++++++------ .../Formatter/MqttPubRecPacketFactory.cs | 10 +++- .../MQTTnet/Protocol/MqttPubAckReasonCode.cs | 5 ++ .../DispatchApplicationMessageResult.cs | 16 +++++ Source/MQTTnet/Server/Internal/MqttClient.cs | 7 ++- .../Internal/MqttClientSessionsManager.cs | 25 ++++---- 10 files changed, 146 insertions(+), 49 deletions(-) create mode 100644 Source/MQTTnet.Tests/Server/Publish_Tests.cs create mode 100644 Source/MQTTnet/Server/Internal/DispatchApplicationMessageResult.cs diff --git a/.github/workflows/ReleaseNotes.md b/.github/workflows/ReleaseNotes.md index 1614de15..608f1589 100644 --- a/.github/workflows/ReleaseNotes.md +++ b/.github/workflows/ReleaseNotes.md @@ -4,3 +4,4 @@ * [Server] Fixed duplicated invocation of the event _ClientAcknowledgedPublishPacketAsync_ for QoS level 2 (#1550) * [Server] Fixed issue in upgrading and downgrading of QoS levels for subscriptions and retained messages (#1560) * [Server] Fixed memory leak when old sessions are discarded (#1553) +* [Server] When using MQTTv5 the reason code _NoMatchingSubscribers_ is returned when no client is subscribed to a published topic (#802) diff --git a/Source/MQTTnet.Tests/MQTTv5/Client_Tests.cs b/Source/MQTTnet.Tests/MQTTv5/Client_Tests.cs index ac7b8792..29fd74e9 100644 --- a/Source/MQTTnet.Tests/MQTTv5/Client_Tests.cs +++ b/Source/MQTTnet.Tests/MQTTv5/Client_Tests.cs @@ -154,7 +154,7 @@ namespace MQTTnet.Tests.MQTTv5 var result = await client.PublishStringAsync("a", "b", MqttQualityOfServiceLevel.AtLeastOnce); await client.DisconnectAsync(); - Assert.AreEqual(MqttClientPublishReasonCode.Success, result.ReasonCode); + Assert.AreEqual(MqttClientPublishReasonCode.NoMatchingSubscribers, result.ReasonCode); } } @@ -169,7 +169,7 @@ namespace MQTTnet.Tests.MQTTv5 var result = await client.PublishStringAsync("a", "b", MqttQualityOfServiceLevel.ExactlyOnce); await client.DisconnectAsync(); - Assert.AreEqual(MqttClientPublishReasonCode.Success, result.ReasonCode); + Assert.AreEqual(MqttClientPublishReasonCode.NoMatchingSubscribers, result.ReasonCode); } } diff --git a/Source/MQTTnet.Tests/Server/Publish_Tests.cs b/Source/MQTTnet.Tests/Server/Publish_Tests.cs new file mode 100644 index 00000000..c2293f0a --- /dev/null +++ b/Source/MQTTnet.Tests/Server/Publish_Tests.cs @@ -0,0 +1,58 @@ +// 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.Threading.Tasks; +using Microsoft.VisualStudio.TestTools.UnitTesting; +using MQTTnet.Client; +using MQTTnet.Formatter; +using MQTTnet.Protocol; + +namespace MQTTnet.Tests.Server +{ + [TestClass] + public sealed class Publish_Tests : BaseTestClass + { + [TestMethod] + public async Task Return_Success_When_Subscribed() + { + using (var testEnvironment = CreateTestEnvironment(MqttProtocolVersion.V500)) + { + await testEnvironment.StartServer(); + + var sender = await testEnvironment.ConnectClient(); + var receiver = await testEnvironment.ConnectClient(); + + await receiver.SubscribeAsync("A"); + + // AtLeastOnce is required to get an ACK packet from the server. + var publishResult = await sender.PublishStringAsync("A", "Payload", MqttQualityOfServiceLevel.AtLeastOnce); + + Assert.AreEqual(MqttClientPublishReasonCode.Success, publishResult.ReasonCode); + + Assert.AreEqual(true, publishResult.IsSuccess); + } + } + + [TestMethod] + public async Task Return_NoMatchingSubscribers_When_Not_Subscribed() + { + using (var testEnvironment = CreateTestEnvironment(MqttProtocolVersion.V500)) + { + await testEnvironment.StartServer(); + + var sender = await testEnvironment.ConnectClient(); + var receiver = await testEnvironment.ConnectClient(); + + await receiver.SubscribeAsync("A"); + + // AtLeastOnce is required to get an ACK packet from the server. + var publishResult = await sender.PublishStringAsync("B", "Payload", MqttQualityOfServiceLevel.AtLeastOnce); + + Assert.AreEqual(MqttClientPublishReasonCode.NoMatchingSubscribers, publishResult.ReasonCode); + + Assert.AreEqual(true, publishResult.IsSuccess); + } + } + } +} \ No newline at end of file diff --git a/Source/MQTTnet/Client/Publishing/MqttClientPublishResult.cs b/Source/MQTTnet/Client/Publishing/MqttClientPublishResult.cs index 47d338eb..6fd2dcd8 100644 --- a/Source/MQTTnet/Client/Publishing/MqttClientPublishResult.cs +++ b/Source/MQTTnet/Client/Publishing/MqttClientPublishResult.cs @@ -10,29 +10,38 @@ namespace MQTTnet.Client public sealed class MqttClientPublishResult { /// - /// Gets the packet identifier which was used for this publish. + /// Returns if the overall status of the publish is a success. This can be the reason code _Success_ or + /// _NoMatchingSubscribers_. _NoMatchingSubscribers_ usually indicates only that no other client is interested in the topic but overall transmit + /// to the server etc. was a success. + /// + public bool IsSuccess => ReasonCode == MqttClientPublishReasonCode.Success || ReasonCode == MqttClientPublishReasonCode.NoMatchingSubscribers; + + /// + /// Gets the packet identifier which was used for this publish. /// public ushort? PacketIdentifier { get; set; } /// - /// Gets or sets the reason code. - /// Hint: MQTT 5 feature only. + /// Gets or sets the reason code. + /// Hint: MQTT 5 feature only. /// public MqttClientPublishReasonCode ReasonCode { get; set; } = MqttClientPublishReasonCode.Success; /// - /// Gets or sets the reason string. - /// Hint: MQTT 5 feature only. + /// Gets or sets the reason string. + /// Hint: MQTT 5 feature only. /// public string ReasonString { get; set; } /// - /// Gets or sets the user properties. - /// In MQTT 5, user properties are basic UTF-8 string key-value pairs that you can append to almost every type of MQTT packet. - /// As long as you don’t exceed the maximum message size, you can use an unlimited number of user properties to add metadata to MQTT messages and pass information between publisher, broker, and subscriber. - /// The feature is very similar to the HTTP header concept. - /// Hint: MQTT 5 feature only. + /// Gets or sets the user properties. + /// In MQTT 5, user properties are basic UTF-8 string key-value pairs that you can append to almost every type of MQTT + /// packet. + /// As long as you don’t exceed the maximum message size, you can use an unlimited number of user properties to add + /// metadata to MQTT messages and pass information between publisher, broker, and subscriber. + /// The feature is very similar to the HTTP header concept. + /// Hint: MQTT 5 feature only. /// public IReadOnlyCollection UserProperties { get; internal set; } } -} +} \ No newline at end of file diff --git a/Source/MQTTnet/Formatter/MqttPubAckPacketFactory.cs b/Source/MQTTnet/Formatter/MqttPubAckPacketFactory.cs index 4d6c6870..536ec011 100644 --- a/Source/MQTTnet/Formatter/MqttPubAckPacketFactory.cs +++ b/Source/MQTTnet/Formatter/MqttPubAckPacketFactory.cs @@ -12,7 +12,10 @@ namespace MQTTnet.Formatter { public sealed class MqttPubAckPacketFactory { - public MqttPubAckPacket Create(MqttPublishPacket publishPacket, InterceptingPublishEventArgs interceptingPublishEventArgs) + public MqttPubAckPacket Create( + MqttPublishPacket publishPacket, + InterceptingPublishEventArgs interceptingPublishEventArgs, + DispatchApplicationMessageResult dispatchApplicationMessageResult) { if (publishPacket == null) { @@ -21,10 +24,19 @@ namespace MQTTnet.Formatter var pubAckPacket = new MqttPubAckPacket { - PacketIdentifier = publishPacket.PacketIdentifier, - ReasonCode = MqttPubAckReasonCode.Success + PacketIdentifier = publishPacket.PacketIdentifier }; + if (dispatchApplicationMessageResult.MatchingSubscribersCount == 0) + { + // NoMatchingSubscribers is ONLY sent by the server! + pubAckPacket.ReasonCode = MqttPubAckReasonCode.NoMatchingSubscribers; + } + else + { + pubAckPacket.ReasonCode = MqttPubAckReasonCode.Success; + } + if (interceptingPublishEventArgs != null) { pubAckPacket.ReasonCode = (MqttPubAckReasonCode)(int)interceptingPublishEventArgs.Response.ReasonCode; @@ -42,24 +54,12 @@ namespace MQTTnet.Formatter throw new ArgumentNullException(nameof(applicationMessageReceivedEventArgs)); } - var pubAckPacket = Create(applicationMessageReceivedEventArgs.PublishPacket, applicationMessageReceivedEventArgs.ReasonCode); - pubAckPacket.UserProperties = applicationMessageReceivedEventArgs.ResponseUserProperties; - pubAckPacket.ReasonString = applicationMessageReceivedEventArgs.ResponseReasonString; - - return pubAckPacket; - } - - static MqttPubAckPacket Create(MqttPublishPacket publishPacket, MqttApplicationMessageReceivedReasonCode applicationMessageReceivedReasonCode) - { - if (publishPacket == null) - { - throw new ArgumentNullException(nameof(publishPacket)); - } - var pubAckPacket = new MqttPubAckPacket { - PacketIdentifier = publishPacket.PacketIdentifier, - ReasonCode = (MqttPubAckReasonCode)(int)applicationMessageReceivedReasonCode + PacketIdentifier = applicationMessageReceivedEventArgs.PublishPacket.PacketIdentifier, + ReasonCode = (MqttPubAckReasonCode)(int)applicationMessageReceivedEventArgs.ReasonCode, + UserProperties = applicationMessageReceivedEventArgs.ResponseUserProperties, + ReasonString = applicationMessageReceivedEventArgs.ResponseReasonString }; return pubAckPacket; diff --git a/Source/MQTTnet/Formatter/MqttPubRecPacketFactory.cs b/Source/MQTTnet/Formatter/MqttPubRecPacketFactory.cs index 5c0726d8..0a6bba24 100644 --- a/Source/MQTTnet/Formatter/MqttPubRecPacketFactory.cs +++ b/Source/MQTTnet/Formatter/MqttPubRecPacketFactory.cs @@ -25,7 +25,10 @@ namespace MQTTnet.Formatter return pubRecPacket; } - public MqttPacket Create(MqttPublishPacket publishPacket, InterceptingPublishEventArgs interceptingPublishEventArgs) + public MqttPacket Create( + MqttPublishPacket publishPacket, + InterceptingPublishEventArgs interceptingPublishEventArgs, + DispatchApplicationMessageResult dispatchApplicationMessageResult) { if (publishPacket == null) { @@ -38,6 +41,11 @@ namespace MQTTnet.Formatter ReasonCode = MqttPubRecReasonCode.Success }; + if (dispatchApplicationMessageResult.MatchingSubscribersCount == 0) + { + pubRecPacket.ReasonCode = MqttPubRecReasonCode.NoMatchingSubscribers; + } + if (interceptingPublishEventArgs != null) { pubRecPacket.ReasonCode = (MqttPubRecReasonCode)(int)interceptingPublishEventArgs.Response.ReasonCode; diff --git a/Source/MQTTnet/Protocol/MqttPubAckReasonCode.cs b/Source/MQTTnet/Protocol/MqttPubAckReasonCode.cs index 9eded18c..50de497f 100644 --- a/Source/MQTTnet/Protocol/MqttPubAckReasonCode.cs +++ b/Source/MQTTnet/Protocol/MqttPubAckReasonCode.cs @@ -7,7 +7,12 @@ namespace MQTTnet.Protocol public enum MqttPubAckReasonCode { Success = 0, + + /// + /// The message is accepted but there are no subscribers. This is sent only by the Server. If the Server knows that there are no matching subscribers, it MAY use this Reason Code instead of 0x00 (Success). + /// NoMatchingSubscribers = 16, + UnspecifiedError = 128, ImplementationSpecificError = 131, NotAuthorized = 135, diff --git a/Source/MQTTnet/Server/Internal/DispatchApplicationMessageResult.cs b/Source/MQTTnet/Server/Internal/DispatchApplicationMessageResult.cs new file mode 100644 index 00000000..bc4637a1 --- /dev/null +++ b/Source/MQTTnet/Server/Internal/DispatchApplicationMessageResult.cs @@ -0,0 +1,16 @@ +// 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. + +namespace MQTTnet.Server +{ + public sealed class DispatchApplicationMessageResult + { + public DispatchApplicationMessageResult(int matchingSubscribersCount) + { + MatchingSubscribersCount = matchingSubscribersCount; + } + + public int MatchingSubscribersCount { get; } + } +} \ No newline at end of file diff --git a/Source/MQTTnet/Server/Internal/MqttClient.cs b/Source/MQTTnet/Server/Internal/MqttClient.cs index 674a262f..f9f7e695 100644 --- a/Source/MQTTnet/Server/Internal/MqttClient.cs +++ b/Source/MQTTnet/Server/Internal/MqttClient.cs @@ -237,9 +237,10 @@ namespace MQTTnet.Server return; } + DispatchApplicationMessageResult dispatchResult = null; if (processPublish && applicationMessage != null) { - await _sessionsManager.DispatchApplicationMessage(Id, applicationMessage).ConfigureAwait(false); + dispatchResult = await _sessionsManager.DispatchApplicationMessage(Id, applicationMessage).ConfigureAwait(false); } switch (publishPacket.QualityOfServiceLevel) @@ -251,13 +252,13 @@ namespace MQTTnet.Server } case MqttQualityOfServiceLevel.AtLeastOnce: { - var pubAckPacket = _packetFactories.PubAck.Create(publishPacket, interceptingPublishEventArgs); + var pubAckPacket = _packetFactories.PubAck.Create(publishPacket, interceptingPublishEventArgs, dispatchResult); Session.EnqueueControlPacket(new MqttPacketBusItem(pubAckPacket)); break; } case MqttQualityOfServiceLevel.ExactlyOnce: { - var pubRecPacket = _packetFactories.PubRec.Create(publishPacket, interceptingPublishEventArgs); + var pubRecPacket = _packetFactories.PubRec.Create(publishPacket, interceptingPublishEventArgs, dispatchResult); Session.EnqueueControlPacket(new MqttPacketBusItem(pubRecPacket)); break; } diff --git a/Source/MQTTnet/Server/Internal/MqttClientSessionsManager.cs b/Source/MQTTnet/Server/Internal/MqttClientSessionsManager.cs index 186a15ca..9fb9ca18 100644 --- a/Source/MQTTnet/Server/Internal/MqttClientSessionsManager.cs +++ b/Source/MQTTnet/Server/Internal/MqttClientSessionsManager.cs @@ -127,21 +127,20 @@ namespace MQTTnet.Server _logger.Verbose("Session for client '{0}' deleted.", clientId); } - - public async Task DispatchApplicationMessage(string senderId, MqttApplicationMessage applicationMessage) + + public async Task DispatchApplicationMessage(string senderId, MqttApplicationMessage applicationMessage) { + var matchingSubscribersCount = 0; try { if (applicationMessage.Retain) { await _retainedMessagesManager.UpdateMessage(senderId, applicationMessage).ConfigureAwait(false); } - - var deliveryCount = 0; + List subscriberSessions; lock (_sessionsManagementLock) { - // only subscriber clients are of interest here. subscriberSessions = _subscriberSessions.ToList(); } @@ -187,17 +186,22 @@ namespace MQTTnet.Server } session.EnqueueDataPacket(new MqttPacketBusItem(newPublishPacket)); - deliveryCount++; + matchingSubscribersCount++; _logger.Verbose("Client '{0}': Queued PUBLISH packet with topic '{1}'.", session.Id, applicationMessage.Topic); } - await FireApplicationMessageNotConsumedEvent(applicationMessage, deliveryCount, senderId); + if (matchingSubscribersCount == 0) + { + await FireApplicationMessageNotConsumedEvent(applicationMessage, senderId).ConfigureAwait(false); + } } catch (Exception exception) { _logger.Error(exception, "Unhandled exception while processing next queued application message."); } + + return new DispatchApplicationMessageResult(matchingSubscribersCount); } public void Dispose() @@ -575,13 +579,8 @@ namespace MQTTnet.Server return new MqttSession(clientId, isPersistent, sessionItems, _options, _eventContainer, _retainedMessagesManager, this); } - async Task FireApplicationMessageNotConsumedEvent(MqttApplicationMessage applicationMessage, int deliveryCount, string senderId) + async Task FireApplicationMessageNotConsumedEvent(MqttApplicationMessage applicationMessage, string senderId) { - if (deliveryCount > 0) - { - return; - } - if (!_eventContainer.ApplicationMessageNotConsumedEvent.HasHandlers) { return; From db1fc7625d9ae5c512bd42747c4aa901db75035b Mon Sep 17 00:00:00 2001 From: Christian <6939810+chkr1011@users.noreply.github.com> Date: Fri, 11 Nov 2022 08:14:15 +0100 Subject: [PATCH 08/11] 1546 possible bug in server repeatedly sending the same message to client subscribed with cleansession=false (#1569) --- .github/workflows/ReleaseNotes.md | 3 +- .../IManagedMqttClient.cs | 2 +- .../ManagedMqttClient.cs | 12 +- .../Client/LowLevelMqttClient_Tests.cs | 10 +- .../Client/ManagedMqttClient_Tests.cs | 61 ++++++- .../Internal/MqttPacketBusItem_Tests.cs | 43 +++++ .../Internal/MqttPacketBus_Tests.cs | 168 +++++++++--------- .../TestApplicationMessageReceivedHandler.cs | 29 ++- .../MQTTnet.Tests/Mockups/TestEnvironment.cs | 21 ++- Source/MQTTnet.Tests/Server/QoS_Tests.cs | 51 ++++++ Source/MQTTnet/Adapter/MqttChannelAdapter.cs | 4 +- Source/MQTTnet/Client/MqttClientExtensions.cs | 51 +++--- .../Formatter/ReadFixedHeaderResult.cs | 6 +- Source/MQTTnet/Internal/MqttPacketBusItem.cs | 48 +++-- Source/MQTTnet/Server/Internal/MqttClient.cs | 8 +- Source/MQTTnet/Server/Internal/MqttSession.cs | 50 +++++- Source/MQTTnet/Server/MqttServerExtensions.cs | 78 +++++++- .../Server/Status/MqttSessionStatus.cs | 2 +- 18 files changed, 475 insertions(+), 172 deletions(-) create mode 100644 Source/MQTTnet.Tests/Internal/MqttPacketBusItem_Tests.cs diff --git a/.github/workflows/ReleaseNotes.md b/.github/workflows/ReleaseNotes.md index 608f1589..ace201e0 100644 --- a/.github/workflows/ReleaseNotes.md +++ b/.github/workflows/ReleaseNotes.md @@ -1,7 +1,8 @@ * [Core] Fixed several dead locks by implementing a new async signal (#1552) * [Client] All waiting tasks will now fail when the client connection gets closed. This fixes several freezes (#1561) -* [ManagedClient] The topic is no longer declared as invalid if a topic alias is used (#1395). +* [ManagedClient] The topic is no longer declared as invalid if a topic alias is used (#1395) * [Server] Fixed duplicated invocation of the event _ClientAcknowledgedPublishPacketAsync_ for QoS level 2 (#1550) * [Server] Fixed issue in upgrading and downgrading of QoS levels for subscriptions and retained messages (#1560) * [Server] Fixed memory leak when old sessions are discarded (#1553) * [Server] When using MQTTv5 the reason code _NoMatchingSubscribers_ is returned when no client is subscribed to a published topic (#802) +* [Server] Fix sending of duplicate messages with QoS > 0 when session is recovered and session is reused (#1546) diff --git a/Source/MQTTnet.Extensions.ManagedClient/IManagedMqttClient.cs b/Source/MQTTnet.Extensions.ManagedClient/IManagedMqttClient.cs index 20f51d83..49add6a3 100644 --- a/Source/MQTTnet.Extensions.ManagedClient/IManagedMqttClient.cs +++ b/Source/MQTTnet.Extensions.ManagedClient/IManagedMqttClient.cs @@ -43,7 +43,7 @@ namespace MQTTnet.Extensions.ManagedClient Task StartAsync(ManagedMqttClientOptions options); - Task StopAsync(); + Task StopAsync(bool cleanDisconnect = true); Task SubscribeAsync(ICollection topicFilters); diff --git a/Source/MQTTnet.Extensions.ManagedClient/ManagedMqttClient.cs b/Source/MQTTnet.Extensions.ManagedClient/ManagedMqttClient.cs index c979627c..0c04c663 100644 --- a/Source/MQTTnet.Extensions.ManagedClient/ManagedMqttClient.cs +++ b/Source/MQTTnet.Extensions.ManagedClient/ManagedMqttClient.cs @@ -62,6 +62,7 @@ namespace MQTTnet.Extensions.ManagedClient CancellationTokenSource _publishingCancellationToken; ManagedMqttClientStorageManager _storageManager; + bool _isCleanDisconnect; public ManagedMqttClient(IMqttClient mqttClient, IMqttNetLogger logger) { @@ -255,10 +256,12 @@ namespace MQTTnet.Extensions.ManagedClient _logger.Info("Started"); } - public async Task StopAsync() + public async Task StopAsync(bool cleanDisconnect = true) { ThrowIfDisposed(); + _isCleanDisconnect = cleanDisconnect; + StopPublishing(); StopMaintainingConnection(); @@ -382,9 +385,12 @@ namespace MQTTnet.Extensions.ManagedClient { try { - using (var disconnectTimeout = new CancellationTokenSource(Options.ClientOptions.Timeout)) + if (_isCleanDisconnect) { - await InternalClient.DisconnectAsync(new MqttClientDisconnectOptions(), disconnectTimeout.Token).ConfigureAwait(false); + using (var disconnectTimeout = new CancellationTokenSource(Options.ClientOptions.Timeout)) + { + await InternalClient.DisconnectAsync(new MqttClientDisconnectOptions(), disconnectTimeout.Token).ConfigureAwait(false); + } } } catch (OperationCanceledException) diff --git a/Source/MQTTnet.Tests/Client/LowLevelMqttClient_Tests.cs b/Source/MQTTnet.Tests/Client/LowLevelMqttClient_Tests.cs index ae8fcebe..e7366d3e 100644 --- a/Source/MQTTnet.Tests/Client/LowLevelMqttClient_Tests.cs +++ b/Source/MQTTnet.Tests/Client/LowLevelMqttClient_Tests.cs @@ -64,7 +64,7 @@ namespace MQTTnet.Tests.Client await client.ConnectAsync(options, CancellationToken.None).ConfigureAwait(false); } - + [TestMethod] [ExpectedException(typeof(MqttCommunicationException))] public async Task Connect_To_Wrong_Host() @@ -80,6 +80,8 @@ namespace MQTTnet.Tests.Client { using (var testEnvironment = CreateTestEnvironment()) { + testEnvironment.IgnoreServerLogErrors = true; + testEnvironment.ServerPort = 8364; var server = await testEnvironment.StartServer(); @@ -116,6 +118,8 @@ namespace MQTTnet.Tests.Client { using (var testEnvironment = CreateTestEnvironment()) { + testEnvironment.IgnoreServerLogErrors = true; + var server = await testEnvironment.StartServer(); using (var lowLevelClient = testEnvironment.CreateLowLevelClient()) @@ -123,7 +127,7 @@ namespace MQTTnet.Tests.Client Assert.IsFalse(lowLevelClient.IsConnected); var clientOptions = new MqttClientOptionsBuilder().WithTcpServer("127.0.0.1", testEnvironment.ServerPort).WithTimeout(TimeSpan.FromSeconds(1)).Build(); - + await lowLevelClient.ConnectAsync(clientOptions, CancellationToken.None); Assert.IsTrue(lowLevelClient.IsConnected); @@ -148,7 +152,7 @@ namespace MQTTnet.Tests.Client catch { } - + Assert.IsFalse(lowLevelClient.IsConnected); } } diff --git a/Source/MQTTnet.Tests/Client/ManagedMqttClient_Tests.cs b/Source/MQTTnet.Tests/Client/ManagedMqttClient_Tests.cs index 554cc663..bfa662ac 100644 --- a/Source/MQTTnet.Tests/Client/ManagedMqttClient_Tests.cs +++ b/Source/MQTTnet.Tests/Client/ManagedMqttClient_Tests.cs @@ -11,6 +11,7 @@ using Microsoft.VisualStudio.TestTools.UnitTesting; using MQTTnet.Client; using MQTTnet.Diagnostics; using MQTTnet.Extensions.ManagedClient; +using MQTTnet.Formatter; using MQTTnet.Internal; using MQTTnet.Protocol; using MQTTnet.Server; @@ -21,6 +22,65 @@ namespace MQTTnet.Tests.Client [TestClass] public sealed class ManagedMqttClient_Tests : BaseTestClass { + [TestMethod] + public async Task Receive_While_Not_Cleanly_Disconnected() + { + using (var testEnvironment = CreateTestEnvironment(MqttProtocolVersion.V500)) + { + await testEnvironment.StartServer(o => o.WithPersistentSessions()); + + var senderClient = await testEnvironment.ConnectClient(); + + // Prepare managed client. + var managedClient = testEnvironment.Factory.CreateManagedMqttClient(); + await managedClient.SubscribeAsync("#"); + var receivedMessages = testEnvironment.CreateApplicationMessageHandler(managedClient); + + var managedClientOptions = new ManagedMqttClientOptions + { + ClientOptions = testEnvironment.Factory.CreateClientOptionsBuilder() + .WithTcpServer("127.0.0.1", testEnvironment.ServerPort) + .WithClientId(nameof(Receive_While_Not_Cleanly_Disconnected) + "_managed") + .WithCleanSession(false) + .Build() + }; + + await managedClient.StartAsync(managedClientOptions); + await LongTestDelay(); + + // Send test data. + await senderClient.PublishStringAsync("topic1"); + await LongTestDelay(); + + receivedMessages.AssertReceivedCountEquals(1); + + // Stop the managed client but keep session at server (not clean disconnect required). + await managedClient.StopAsync(false); + await LongTestDelay(); + + // Send new messages in the meantime. + await senderClient.PublishStringAsync("topic2", qualityOfServiceLevel: MqttQualityOfServiceLevel.ExactlyOnce); + await LongTestDelay(); + + // Start the managed client, it should receive the new message. + await managedClient.StartAsync(managedClientOptions); + await LongTestDelay(); + + receivedMessages.AssertReceivedCountEquals(2); + + // Stop and start again, no new message should be received. + for (var i = 0; i < 3; i++) + { + await managedClient.StopAsync(false); + await LongTestDelay(); + await managedClient.StartAsync(managedClientOptions); + await LongTestDelay(); + } + + receivedMessages.AssertReceivedCountEquals(2); + } + } + [TestMethod] public async Task Connect_To_Invalid_Server() { @@ -33,7 +93,6 @@ namespace MQTTnet.Tests.Client var managedClient = testEnvironment.Factory.CreateManagedMqttClient(mqttClient); ConnectingFailedEventArgs connectingFailedEventArgs = null; - managedClient.ConnectingFailedAsync += args => { connectingFailedEventArgs = args; diff --git a/Source/MQTTnet.Tests/Internal/MqttPacketBusItem_Tests.cs b/Source/MQTTnet.Tests/Internal/MqttPacketBusItem_Tests.cs new file mode 100644 index 00000000..912d38a0 --- /dev/null +++ b/Source/MQTTnet.Tests/Internal/MqttPacketBusItem_Tests.cs @@ -0,0 +1,43 @@ +// 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.Threading.Tasks; +using Microsoft.VisualStudio.TestTools.UnitTesting; +using MQTTnet.Internal; +using MQTTnet.Packets; + +namespace MQTTnet.Tests.Internal +{ + [TestClass] + public sealed class MqttPacketBusItem_Tests + { + [TestMethod] + public void Fire_Completed_Event() + { + var eventFired = false; + + var item = new MqttPacketBusItem(new MqttPublishPacket()); + item.Completed += (_, __) => + { + eventFired = true; + }; + + item.Complete(); + + Assert.IsTrue(eventFired); + } + + [TestMethod] + [ExpectedException(typeof(TaskCanceledException))] + public async Task Wait_Packet_Bus_Item_After_Already_Canceled() + { + var item = new MqttPacketBusItem(new MqttPublishPacket()); + + // Finish the item before the actual + item.Cancel(); + + await item.WaitAsync(); + } + } +} \ No newline at end of file diff --git a/Source/MQTTnet.Tests/Internal/MqttPacketBus_Tests.cs b/Source/MQTTnet.Tests/Internal/MqttPacketBus_Tests.cs index b09159fd..40ff02aa 100644 --- a/Source/MQTTnet.Tests/Internal/MqttPacketBus_Tests.cs +++ b/Source/MQTTnet.Tests/Internal/MqttPacketBus_Tests.cs @@ -13,69 +13,26 @@ namespace MQTTnet.Tests.Internal { [TestClass] public sealed class MqttPacketBus_Tests - { - [TestMethod] - [ExpectedException(typeof(TaskCanceledException))] - public async Task Wait_With_Empty_Bus() - { - var bus = new MqttPacketBus(); - - using (var timeout = new CancellationTokenSource(TimeSpan.FromSeconds(1))) - { - await bus.DequeueItemAsync(timeout.Token); - } - } - - [TestMethod] - public async Task Fill_From_Different_Task() - { - const int MessageCount = 500; - - var delayRandom = new Random(); - - var bus = new MqttPacketBus(); - - _ = Task.Run( - () => - { - for (int i = 0; i < MessageCount; i++) - { - bus.EnqueueItem(new MqttPacketBusItem(MqttPingReqPacket.Instance), MqttPacketBusPartition.Health); - - Thread.Sleep(delayRandom.Next(0, 10)); - } - }); - - for (var i = 0; i < MessageCount; i++) - { - using (var timeout = new CancellationTokenSource(TimeSpan.FromSeconds(10))) - { - await bus.DequeueItemAsync(timeout.Token); - } - } - - Assert.AreEqual(0, bus.TotalItemsCount); - } - + { [TestMethod] public void Alternate_Priorities() { var bus = new MqttPacketBus(); - + bus.EnqueueItem(new MqttPacketBusItem(new MqttPublishPacket()), MqttPacketBusPartition.Data); bus.EnqueueItem(new MqttPacketBusItem(new MqttPublishPacket()), MqttPacketBusPartition.Data); bus.EnqueueItem(new MqttPacketBusItem(new MqttPublishPacket()), MqttPacketBusPartition.Data); - + bus.EnqueueItem(new MqttPacketBusItem(new MqttSubAckPacket()), MqttPacketBusPartition.Control); bus.EnqueueItem(new MqttPacketBusItem(new MqttSubAckPacket()), MqttPacketBusPartition.Control); bus.EnqueueItem(new MqttPacketBusItem(new MqttSubAckPacket()), MqttPacketBusPartition.Control); - + bus.EnqueueItem(new MqttPacketBusItem(new MqttPingRespPacket()), MqttPacketBusPartition.Health); bus.EnqueueItem(new MqttPacketBusItem(new MqttPingRespPacket()), MqttPacketBusPartition.Health); bus.EnqueueItem(new MqttPacketBusItem(new MqttPingRespPacket()), MqttPacketBusPartition.Health); Assert.AreEqual(9, bus.TotalItemsCount); - + Assert.IsInstanceOfType(bus.DequeueItemAsync(CancellationToken.None).Result.Packet, typeof(MqttPublishPacket)); Assert.IsInstanceOfType(bus.DequeueItemAsync(CancellationToken.None).Result.Packet, typeof(MqttSubAckPacket)); Assert.IsInstanceOfType(bus.DequeueItemAsync(CancellationToken.None).Result.Packet, typeof(MqttPingRespPacket)); @@ -85,33 +42,10 @@ namespace MQTTnet.Tests.Internal Assert.IsInstanceOfType(bus.DequeueItemAsync(CancellationToken.None).Result.Packet, typeof(MqttPublishPacket)); Assert.IsInstanceOfType(bus.DequeueItemAsync(CancellationToken.None).Result.Packet, typeof(MqttSubAckPacket)); Assert.IsInstanceOfType(bus.DequeueItemAsync(CancellationToken.None).Result.Packet, typeof(MqttPingRespPacket)); - + Assert.AreEqual(0, bus.TotalItemsCount); } - - [TestMethod] - public void Export_Packets_Without_Dequeue() - { - var bus = new MqttPacketBus(); - bus.EnqueueItem(new MqttPacketBusItem(new MqttPublishPacket()), MqttPacketBusPartition.Data); - bus.EnqueueItem(new MqttPacketBusItem(new MqttPublishPacket()), MqttPacketBusPartition.Data); - bus.EnqueueItem(new MqttPacketBusItem(new MqttPublishPacket()), MqttPacketBusPartition.Data); - - Assert.AreEqual(3, bus.TotalItemsCount); - - var exportedPackets = bus.ExportPackets(MqttPacketBusPartition.Control); - Assert.AreEqual(0, exportedPackets.Count); - - exportedPackets = bus.ExportPackets(MqttPacketBusPartition.Health); - Assert.AreEqual(0, exportedPackets.Count); - - exportedPackets = bus.ExportPackets(MqttPacketBusPartition.Data); - Assert.AreEqual(3, exportedPackets.Count); - - Assert.AreEqual(3, bus.TotalItemsCount); - } - [TestMethod] public void Await_Single_Packet() { @@ -121,31 +55,97 @@ namespace MQTTnet.Tests.Internal var item1 = new MqttPacketBusItem(new MqttPublishPacket()); var item2 = new MqttPacketBusItem(new MqttPublishPacket()); - + var item3 = new MqttPacketBusItem(new MqttPublishPacket()); - item3.Delivered += (_, __) => + item3.Completed += (_, __) => { delivered = true; }; - + bus.EnqueueItem(item1, MqttPacketBusPartition.Data); bus.EnqueueItem(item2, MqttPacketBusPartition.Data); bus.EnqueueItem(item3, MqttPacketBusPartition.Data); - + Assert.IsFalse(delivered); - bus.DequeueItemAsync(CancellationToken.None).Result.MarkAsDelivered(); - + bus.DequeueItemAsync(CancellationToken.None).Result.Complete(); + Assert.IsFalse(delivered); - - bus.DequeueItemAsync(CancellationToken.None).Result.MarkAsDelivered(); - + + bus.DequeueItemAsync(CancellationToken.None).Result.Complete(); + Assert.IsFalse(delivered); - - bus.DequeueItemAsync(CancellationToken.None).Result.MarkAsDelivered(); - + + bus.DequeueItemAsync(CancellationToken.None).Result.Complete(); + // The third packet has the event attached. Assert.IsTrue(delivered); } + + [TestMethod] + public void Export_Packets_Without_Dequeue() + { + var bus = new MqttPacketBus(); + + bus.EnqueueItem(new MqttPacketBusItem(new MqttPublishPacket()), MqttPacketBusPartition.Data); + bus.EnqueueItem(new MqttPacketBusItem(new MqttPublishPacket()), MqttPacketBusPartition.Data); + bus.EnqueueItem(new MqttPacketBusItem(new MqttPublishPacket()), MqttPacketBusPartition.Data); + + Assert.AreEqual(3, bus.TotalItemsCount); + + var exportedPackets = bus.ExportPackets(MqttPacketBusPartition.Control); + Assert.AreEqual(0, exportedPackets.Count); + + exportedPackets = bus.ExportPackets(MqttPacketBusPartition.Health); + Assert.AreEqual(0, exportedPackets.Count); + + exportedPackets = bus.ExportPackets(MqttPacketBusPartition.Data); + Assert.AreEqual(3, exportedPackets.Count); + + Assert.AreEqual(3, bus.TotalItemsCount); + } + + [TestMethod] + public async Task Fill_From_Different_Task() + { + const int MessageCount = 500; + + var delayRandom = new Random(); + + var bus = new MqttPacketBus(); + + _ = Task.Run( + () => + { + for (var i = 0; i < MessageCount; i++) + { + bus.EnqueueItem(new MqttPacketBusItem(MqttPingReqPacket.Instance), MqttPacketBusPartition.Health); + + Thread.Sleep(delayRandom.Next(0, 10)); + } + }); + + for (var i = 0; i < MessageCount; i++) + { + using (var timeout = new CancellationTokenSource(TimeSpan.FromSeconds(10))) + { + await bus.DequeueItemAsync(timeout.Token); + } + } + + Assert.AreEqual(0, bus.TotalItemsCount); + } + + [TestMethod] + [ExpectedException(typeof(OperationCanceledException))] + public async Task Wait_With_Empty_Bus() + { + var bus = new MqttPacketBus(); + + using (var timeout = new CancellationTokenSource(TimeSpan.FromSeconds(1))) + { + await bus.DequeueItemAsync(timeout.Token); + } + } } } \ No newline at end of file diff --git a/Source/MQTTnet.Tests/Mockups/TestApplicationMessageReceivedHandler.cs b/Source/MQTTnet.Tests/Mockups/TestApplicationMessageReceivedHandler.cs index c1a7c482..7556709a 100644 --- a/Source/MQTTnet.Tests/Mockups/TestApplicationMessageReceivedHandler.cs +++ b/Source/MQTTnet.Tests/Mockups/TestApplicationMessageReceivedHandler.cs @@ -2,8 +2,10 @@ // 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.Linq; +using System.Text; using System.Threading.Tasks; using Microsoft.VisualStudio.TestTools.UnitTesting; using MQTTnet.Client; @@ -17,7 +19,12 @@ namespace MQTTnet.Tests.Mockups public TestApplicationMessageReceivedHandler(IMqttClient mqttClient) { - mqttClient.ApplicationMessageReceivedAsync += MqttClientOnApplicationMessageReceivedAsync; + if (mqttClient == null) + { + throw new ArgumentNullException(nameof(mqttClient)); + } + + mqttClient.ApplicationMessageReceivedAsync += OnApplicationMessageReceivedAsync; } public List ReceivedEventArgs @@ -39,7 +46,25 @@ namespace MQTTnet.Tests.Mockups } } - Task MqttClientOnApplicationMessageReceivedAsync(MqttApplicationMessageReceivedEventArgs eventArgs) + public string GeneratePayloadSequence() + { + var sequence = new StringBuilder(); + + lock (_receivedEventArgs) + { + foreach (var receivedEventArg in _receivedEventArgs) + { + var payload = receivedEventArg.ApplicationMessage.ConvertPayloadToString(); + + // An empty payload is not part of the sequence! + sequence.Append(payload); + } + } + + return sequence.ToString(); + } + + Task OnApplicationMessageReceivedAsync(MqttApplicationMessageReceivedEventArgs eventArgs) { lock (_receivedEventArgs) { diff --git a/Source/MQTTnet.Tests/Mockups/TestEnvironment.cs b/Source/MQTTnet.Tests/Mockups/TestEnvironment.cs index 6b79a963..44d692d9 100644 --- a/Source/MQTTnet.Tests/Mockups/TestEnvironment.cs +++ b/Source/MQTTnet.Tests/Mockups/TestEnvironment.cs @@ -11,6 +11,7 @@ using System.Threading.Tasks; using Microsoft.VisualStudio.TestTools.UnitTesting; using MQTTnet.Client; using MQTTnet.Diagnostics; +using MQTTnet.Extensions.ManagedClient; using MQTTnet.Extensions.Rpc; using MQTTnet.Formatter; using MQTTnet.Internal; @@ -109,7 +110,7 @@ namespace MQTTnet.Tests.Mockups configureOptions.Invoke(optionsBuilder); var options = optionsBuilder.Build(); - + var client = CreateClient(); if (timeout == TimeSpan.Zero) @@ -137,7 +138,7 @@ namespace MQTTnet.Tests.Mockups options = options.WithTcpServer("127.0.0.1", ServerPort); var client = CreateClient(); - + if (timeout == TimeSpan.Zero) { await client.ConnectAsync(options.Build()).ConfigureAwait(false); @@ -161,7 +162,7 @@ namespace MQTTnet.Tests.Mockups } var client = CreateClient(); - + if (timeout == TimeSpan.Zero) { await client.ConnectAsync(options).ConfigureAwait(false); @@ -199,6 +200,16 @@ namespace MQTTnet.Tests.Mockups return new TestApplicationMessageReceivedHandler(mqttClient); } + public TestApplicationMessageReceivedHandler CreateApplicationMessageHandler(IManagedMqttClient managedClient) + { + if (managedClient == null) + { + throw new ArgumentNullException(nameof(managedClient)); + } + + return new TestApplicationMessageReceivedHandler(managedClient.InternalClient); + } + public IMqttClient CreateClient() { lock (_clients) @@ -325,7 +336,7 @@ namespace MQTTnet.Tests.Mockups var options = optionsBuilder.Build(); var server = CreateServer(options); await server.StartAsync(); - + // The OS has chosen the port to we have to properly expose it to the tests. ServerPort = options.DefaultEndpointOptions.Port; return server; @@ -344,7 +355,7 @@ namespace MQTTnet.Tests.Mockups var options = optionsBuilder.Build(); var server = CreateServer(options); await server.StartAsync(); - + // The OS has chosen the port to we have to properly expose it to the tests. ServerPort = options.DefaultEndpointOptions.Port; return server; diff --git a/Source/MQTTnet.Tests/Server/QoS_Tests.cs b/Source/MQTTnet.Tests/Server/QoS_Tests.cs index 7e5a9491..d6c9e644 100644 --- a/Source/MQTTnet.Tests/Server/QoS_Tests.cs +++ b/Source/MQTTnet.Tests/Server/QoS_Tests.cs @@ -15,6 +15,57 @@ namespace MQTTnet.Tests.Server [TestClass] public sealed class QoS_Tests : BaseTestClass { + [TestMethod] + public async Task Preserve_Message_Order_For_Queued_Messages() + { + using (var testEnvironment = CreateTestEnvironment()) + { + var server = await testEnvironment.StartServer(o => o.WithPersistentSessions()); + + // Create a session which will contain the messages. + var dummyClient = await testEnvironment.ConnectClient(o => o.WithClientId("A").WithCleanSession(false)); + await dummyClient.SubscribeAsync("#", MqttQualityOfServiceLevel.AtLeastOnce); + dummyClient.Dispose(); + + // Now inject messages which are appended to the queue of the client. + await server.InjectApplicationMessage("T", "0", qualityOfServiceLevel: MqttQualityOfServiceLevel.AtLeastOnce); + + await server.InjectApplicationMessage("T", "2", qualityOfServiceLevel: MqttQualityOfServiceLevel.AtLeastOnce); + await server.InjectApplicationMessage("T", "1", qualityOfServiceLevel: MqttQualityOfServiceLevel.AtLeastOnce); + + await server.InjectApplicationMessage("T", "4", qualityOfServiceLevel: MqttQualityOfServiceLevel.AtLeastOnce); + await server.InjectApplicationMessage("T", "3", qualityOfServiceLevel: MqttQualityOfServiceLevel.AtLeastOnce); + + await server.InjectApplicationMessage("T", "6", qualityOfServiceLevel: MqttQualityOfServiceLevel.AtLeastOnce); + await server.InjectApplicationMessage("T", "5", qualityOfServiceLevel: MqttQualityOfServiceLevel.AtLeastOnce); + + await server.InjectApplicationMessage("T", "8", qualityOfServiceLevel: MqttQualityOfServiceLevel.AtLeastOnce); + await server.InjectApplicationMessage("T", "7", qualityOfServiceLevel: MqttQualityOfServiceLevel.AtLeastOnce); + + await server.InjectApplicationMessage("T", "9", qualityOfServiceLevel: MqttQualityOfServiceLevel.AtLeastOnce); + + await LongTestDelay(); + + // Create a new client for the existing message. + var client = await testEnvironment.ConnectClient(o => o.WithClientId("A").WithCleanSession(false)); + var messages = testEnvironment.CreateApplicationMessageHandler(client); + + await LongTestDelay(); + + var payloadSequence = messages.GeneratePayloadSequence(); + Assert.AreEqual("0214365879", payloadSequence); + + // Disconnect and reconnect to make sure that the server will not send the messages twice. + await client.DisconnectAsync(); + await LongTestDelay(); + await client.ReconnectAsync(); + await LongTestDelay(); + + payloadSequence = messages.GeneratePayloadSequence(); + Assert.AreEqual("0214365879", payloadSequence); + } + } + [TestMethod] public async Task Fire_Event_On_Client_Acknowledges_QoS_0() { diff --git a/Source/MQTTnet/Adapter/MqttChannelAdapter.cs b/Source/MQTTnet/Adapter/MqttChannelAdapter.cs index 4b030150..308d5477 100644 --- a/Source/MQTTnet/Adapter/MqttChannelAdapter.cs +++ b/Source/MQTTnet/Adapter/MqttChannelAdapter.cs @@ -86,7 +86,7 @@ namespace MQTTnet.Adapter await Task.WhenAny(connectTask, timeout.Task).ConfigureAwait(false); if (timeout.Task.IsCompleted && !connectTask.IsCompleted) { - throw new OperationCanceledException("MQTT connect cancelled.", cancellationToken); + throw new OperationCanceledException("MQTT connect canceled.", cancellationToken); } // Make sure that the exception from the connect task gets thrown. @@ -317,7 +317,7 @@ namespace MQTTnet.Adapter if (cancellationToken.IsCancellationRequested) { - return ReadFixedHeaderResult.Cancelled; + return ReadFixedHeaderResult.Canceled; } if (bytesRead == 0) diff --git a/Source/MQTTnet/Client/MqttClientExtensions.cs b/Source/MQTTnet/Client/MqttClientExtensions.cs index 9f936bdd..ba917aad 100644 --- a/Source/MQTTnet/Client/MqttClientExtensions.cs +++ b/Source/MQTTnet/Client/MqttClientExtensions.cs @@ -14,26 +14,6 @@ namespace MQTTnet.Client { public static class MqttClientExtensions { - public static async Task TryPingAsync(this IMqttClient client, CancellationToken cancellationToken = default) - { - if (client == null) - { - throw new ArgumentNullException(nameof(client)); - } - - try - { - await client.PingAsync(cancellationToken).ConfigureAwait(false); - return true; - } - catch - { - // Ignore errors. - } - - return false; - } - public static Task DisconnectAsync(this IMqttClient client, MqttClientDisconnectReason reason = MqttClientDisconnectReason.NormalDisconnection, string reasonString = null) { if (client == null) @@ -89,6 +69,17 @@ namespace MQTTnet.Client return mqttClient.PublishBinaryAsync(topic, payloadBuffer, qualityOfServiceLevel, retain, cancellationToken); } + public static Task ReconnectAsync(this IMqttClient client, CancellationToken cancellationToken = default) + { + if (client.Options == null) + { + throw new InvalidOperationException( + "The MQTT client was not connected before. A reconnect is only permitted when the client was already connected or at least tried to."); + } + + return client.ConnectAsync(client.Options, cancellationToken); + } + public static Task SendExtendedAuthenticationExchangeDataAsync(this IMqttClient client, MqttExtendedAuthenticationExchangeData data) { if (client == null) @@ -137,6 +128,26 @@ namespace MQTTnet.Client return mqttClient.SubscribeAsync(subscribeOptions, cancellationToken); } + public static async Task TryPingAsync(this IMqttClient client, CancellationToken cancellationToken = default) + { + if (client == null) + { + throw new ArgumentNullException(nameof(client)); + } + + try + { + await client.PingAsync(cancellationToken).ConfigureAwait(false); + return true; + } + catch + { + // Ignore errors. + } + + return false; + } + public static Task UnsubscribeAsync(this IMqttClient mqttClient, string topic, CancellationToken cancellationToken = default) { if (mqttClient == null) diff --git a/Source/MQTTnet/Formatter/ReadFixedHeaderResult.cs b/Source/MQTTnet/Formatter/ReadFixedHeaderResult.cs index 58663933..a471a6a7 100644 --- a/Source/MQTTnet/Formatter/ReadFixedHeaderResult.cs +++ b/Source/MQTTnet/Formatter/ReadFixedHeaderResult.cs @@ -6,9 +6,9 @@ namespace MQTTnet.Formatter { public struct ReadFixedHeaderResult { - public static ReadFixedHeaderResult Cancelled { get; } = new ReadFixedHeaderResult + public static ReadFixedHeaderResult Canceled { get; } = new ReadFixedHeaderResult { - IsCancelled = true + IsCanceled = true }; public static ReadFixedHeaderResult ConnectionClosed { get; } = new ReadFixedHeaderResult @@ -16,7 +16,7 @@ namespace MQTTnet.Formatter IsConnectionClosed = true }; - public bool IsCancelled { get; set; } + public bool IsCanceled { get; set; } public bool IsConnectionClosed { get; set; } diff --git a/Source/MQTTnet/Internal/MqttPacketBusItem.cs b/Source/MQTTnet/Internal/MqttPacketBusItem.cs index 91224533..b94654cf 100644 --- a/Source/MQTTnet/Internal/MqttPacketBusItem.cs +++ b/Source/MQTTnet/Internal/MqttPacketBusItem.cs @@ -10,40 +10,36 @@ namespace MQTTnet.Internal { public sealed class MqttPacketBusItem { - readonly AsyncTaskCompletionSource _promise = new AsyncTaskCompletionSource(); - + readonly AsyncTaskCompletionSource _promise = new AsyncTaskCompletionSource(); + public MqttPacketBusItem(MqttPacket packet) { Packet = packet ?? throw new ArgumentNullException(nameof(packet)); } - + + public event EventHandler Completed; + public MqttPacket Packet { get; } - public event EventHandler Delivered; - - public Task WaitForDeliveryAsync() - { - return _promise.Task; - } - - public void MarkAsDelivered() - { - if (_promise.TrySetResult(0)) - { - Delivered?.Invoke(this, EventArgs.Empty); - } - } - - public void MarkAsFailed(Exception exception) - { - if (exception == null) throw new ArgumentNullException(nameof(exception)); - - _promise.TrySetException(exception); - } - - public void MarkAsCancelled() + public void Cancel() { _promise.TrySetCanceled(); } + + public void Complete() + { + _promise.TrySetResult(true); + Completed?.Invoke(this, EventArgs.Empty); + } + + public void Fail(Exception exception) + { + _promise.TrySetException(exception); + } + + public Task WaitAsync() + { + return _promise.Task; + } } } \ No newline at end of file diff --git a/Source/MQTTnet/Server/Internal/MqttClient.cs b/Source/MQTTnet/Server/Internal/MqttClient.cs index f9f7e695..f505b00c 100644 --- a/Source/MQTTnet/Server/Internal/MqttClient.cs +++ b/Source/MQTTnet/Server/Internal/MqttClient.cs @@ -507,15 +507,15 @@ namespace MQTTnet.Server try { await SendPacketAsync(packetBusItem.Packet, cancellationToken).ConfigureAwait(false); - packetBusItem.MarkAsDelivered(); + packetBusItem.Complete(); } catch (OperationCanceledException) { - packetBusItem.MarkAsCancelled(); + packetBusItem.Cancel(); } catch (Exception exception) { - packetBusItem.MarkAsFailed(exception); + packetBusItem.Fail(exception); } finally { @@ -563,7 +563,7 @@ namespace MQTTnet.Server catch (ObjectDisposedException) { // This can happen when connections are created and dropped very quickly. - // It is not an issue if the cancellation token cannot be cancelled multiple times. + // It is not an issue if the cancellation token cannot be canceled multiple times. } } diff --git a/Source/MQTTnet/Server/Internal/MqttSession.cs b/Source/MQTTnet/Server/Internal/MqttSession.cs index a5a045bf..b40c2645 100644 --- a/Source/MQTTnet/Server/Internal/MqttSession.cs +++ b/Source/MQTTnet/Server/Internal/MqttSession.cs @@ -4,7 +4,6 @@ using System; using System.Collections; -using System.Collections.Concurrent; using System.Collections.Generic; using System.Linq; using System.Threading; @@ -25,7 +24,8 @@ namespace MQTTnet.Server readonly MqttServerOptions _serverOptions; readonly MqttClientSubscriptionsManager _subscriptionsManager; - readonly ConcurrentDictionary _unacknowledgedPublishPackets = new ConcurrentDictionary(); + // Do not use a dictionary in order to keep the ordering of the messages. + readonly List _unacknowledgedPublishPackets = new List(); // Bookkeeping to know if this is a subscribing client; lazy initialize later. HashSet _subscribedTopics; @@ -72,7 +72,14 @@ namespace MQTTnet.Server public MqttPublishPacket AcknowledgePublishPacket(ushort packetIdentifier) { - _unacknowledgedPublishPackets.TryRemove(packetIdentifier, out var publishPacket); + MqttPublishPacket publishPacket; + + lock (_unacknowledgedPublishPackets) + { + publishPacket = _unacknowledgedPublishPackets.FirstOrDefault(p => p.PacketIdentifier.Equals(packetIdentifier)); + _unacknowledgedPublishPackets.Remove(publishPacket); + } + return publishPacket; } @@ -130,7 +137,10 @@ namespace MQTTnet.Server { publishPacket.PacketIdentifier = _packetIdentifierProvider.GetNextPacketIdentifier(); - _unacknowledgedPublishPackets[publishPacket.PacketIdentifier] = publishPacket; + lock (_unacknowledgedPublishPackets) + { + _unacknowledgedPublishPackets.Add(publishPacket); + } } _packetBus.EnqueueItem(packetBusItem, MqttPacketBusPartition.Data); @@ -145,8 +155,10 @@ namespace MQTTnet.Server { // This will only return the matching PUBLISH packet but does not remove it. // This is required for QoS 2. - _unacknowledgedPublishPackets.TryGetValue(packetIdentifier, out var publishPacket); - return publishPacket; + lock (_unacknowledgedPublishPackets) + { + return _unacknowledgedPublishPackets.FirstOrDefault(p => p.PacketIdentifier.Equals(packetIdentifier)); + } } public void Recover() @@ -154,9 +166,33 @@ namespace MQTTnet.Server // TODO: Keep the bus and only insert pending items again. // TODO: Check if packet identifier must be restarted or not. // TODO: Recover package identifier. + + /* + The Session state in the Client consists of: + · QoS 1 and QoS 2 messages which have been sent to the Server, but have not been completely acknowledged. + · QoS 2 messages which have been received from the Server, but have not been completely acknowledged. + + The Session state in the Server consists of: + · The existence of a Session, even if the rest of the Session state is empty. + · The Client’s subscriptions. + · QoS 1 and QoS 2 messages which have been sent to the Client, but have not been completely acknowledged. + · QoS 1 and QoS 2 messages pending transmission to the Client. + · QoS 2 messages which have been received from the Client, but have not been completely acknowledged. + · Optionally, QoS 0 messages pending transmission to the Client. + */ + + // Create a copy of all currently unacknowledged publish packets and clear the storage. + // We must re-enqueue them in order to trigger other code. + List unacknowledgedPublishPackets; + lock (_unacknowledgedPublishPackets) + { + unacknowledgedPublishPackets = _unacknowledgedPublishPackets.ToList(); + _unacknowledgedPublishPackets.Clear(); + } + _packetBus.Clear(); - foreach (var publishPacket in _unacknowledgedPublishPackets.Values.ToList()) + foreach (var publishPacket in unacknowledgedPublishPackets) { EnqueueDataPacket(new MqttPacketBusItem(publishPacket)); } diff --git a/Source/MQTTnet/Server/MqttServerExtensions.cs b/Source/MQTTnet/Server/MqttServerExtensions.cs index 22d8538c..13746e50 100644 --- a/Source/MQTTnet/Server/MqttServerExtensions.cs +++ b/Source/MQTTnet/Server/MqttServerExtensions.cs @@ -3,29 +3,89 @@ // See the LICENSE file in the project root for more information. using System; +using System.Text; using System.Threading.Tasks; +using MQTTnet.Internal; using MQTTnet.Packets; +using MQTTnet.Protocol; namespace MQTTnet.Server { public static class MqttServerExtensions { + public static Task InjectApplicationMessage( + this MqttServer server, + string topic, + string payload = null, + MqttQualityOfServiceLevel qualityOfServiceLevel = MqttQualityOfServiceLevel.AtMostOnce, + bool retain = false) + { + if (server == null) + { + throw new ArgumentNullException(nameof(server)); + } + + if (topic == null) + { + throw new ArgumentNullException(nameof(topic)); + } + + var payloadBuffer = EmptyBuffer.Array; + if (payload is string stringPayload) + { + payloadBuffer = Encoding.UTF8.GetBytes(stringPayload); + } + + return server.InjectApplicationMessage( + new InjectedMqttApplicationMessage( + new MqttApplicationMessage + { + Topic = topic, + Payload = payloadBuffer, + QualityOfServiceLevel = qualityOfServiceLevel, + Retain = retain + })); + } + public static Task SubscribeAsync(this MqttServer server, string clientId, params MqttTopicFilter[] topicFilters) { - if (server == null) throw new ArgumentNullException(nameof(server)); - if (clientId == null) throw new ArgumentNullException(nameof(clientId)); - if (topicFilters == null) throw new ArgumentNullException(nameof(topicFilters)); + if (server == null) + { + throw new ArgumentNullException(nameof(server)); + } + + if (clientId == null) + { + throw new ArgumentNullException(nameof(clientId)); + } + + if (topicFilters == null) + { + throw new ArgumentNullException(nameof(topicFilters)); + } return server.SubscribeAsync(clientId, topicFilters); } - + public static Task SubscribeAsync(this MqttServer server, string clientId, string topic) { - if (server == null) throw new ArgumentNullException(nameof(server)); - if (clientId == null) throw new ArgumentNullException(nameof(clientId)); - if (topic == null) throw new ArgumentNullException(nameof(topic)); + if (server == null) + { + throw new ArgumentNullException(nameof(server)); + } - return server.SubscribeAsync(clientId, new MqttTopicFilterBuilder().WithTopic(topic).Build()); + if (clientId == null) + { + throw new ArgumentNullException(nameof(clientId)); + } + + if (topic == null) + { + throw new ArgumentNullException(nameof(topic)); + } + + var topicFilters = new MqttTopicFilterBuilder().WithTopic(topic).Build(); + return server.SubscribeAsync(clientId, topicFilters); } } -} +} \ No newline at end of file diff --git a/Source/MQTTnet/Server/Status/MqttSessionStatus.cs b/Source/MQTTnet/Server/Status/MqttSessionStatus.cs index 6cea318b..c6df1da5 100644 --- a/Source/MQTTnet/Server/Status/MqttSessionStatus.cs +++ b/Source/MQTTnet/Server/Status/MqttSessionStatus.cs @@ -45,7 +45,7 @@ namespace MQTTnet.Server var packetBusItem = new MqttPacketBusItem(publishPacketFactory.Create(applicationMessage)); _session.EnqueueDataPacket(packetBusItem); - return packetBusItem.WaitForDeliveryAsync(); + return packetBusItem.WaitAsync(); } public Task DeleteAsync() From 4eb6e77eb50b4ec6e42cf597e63ea47a6ff3e7a3 Mon Sep 17 00:00:00 2001 From: Christian <6939810+chkr1011@users.noreply.github.com> Date: Fri, 11 Nov 2022 14:41:28 +0100 Subject: [PATCH 09/11] Fix build errors due to merge conflicts --- Source/MQTTnet/Adapter/MqttChannelAdapter.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Source/MQTTnet/Adapter/MqttChannelAdapter.cs b/Source/MQTTnet/Adapter/MqttChannelAdapter.cs index 308d5477..8e08dd0f 100644 --- a/Source/MQTTnet/Adapter/MqttChannelAdapter.cs +++ b/Source/MQTTnet/Adapter/MqttChannelAdapter.cs @@ -298,7 +298,7 @@ namespace MQTTnet.Adapter // Check two times for cancellation because the call to _ReadAsync_ might block for some time. if (cancellationToken.IsCancellationRequested) { - return ReadFixedHeaderResult.Cancelled; + return ReadFixedHeaderResult.Canceled; } int bytesRead; @@ -308,7 +308,7 @@ namespace MQTTnet.Adapter } catch (OperationCanceledException) { - return ReadFixedHeaderResult.Cancelled; + return ReadFixedHeaderResult.Canceled; } catch (SocketException) { From e4b07f2b8caa3295b80b4580263f2d61fa775202 Mon Sep 17 00:00:00 2001 From: Christian <6939810+chkr1011@users.noreply.github.com> Date: Sat, 12 Nov 2022 09:43:55 +0100 Subject: [PATCH 10/11] Fix build errors --- Source/MQTTnet.Tests/Internal/MqttPacketBus_Tests.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Source/MQTTnet.Tests/Internal/MqttPacketBus_Tests.cs b/Source/MQTTnet.Tests/Internal/MqttPacketBus_Tests.cs index 40ff02aa..62f547ef 100644 --- a/Source/MQTTnet.Tests/Internal/MqttPacketBus_Tests.cs +++ b/Source/MQTTnet.Tests/Internal/MqttPacketBus_Tests.cs @@ -137,7 +137,7 @@ namespace MQTTnet.Tests.Internal } [TestMethod] - [ExpectedException(typeof(OperationCanceledException))] + [ExpectedException(typeof(TaskCanceledException))] public async Task Wait_With_Empty_Bus() { var bus = new MqttPacketBus(); From e88b280eb0fac04267487555399bff7241af4349 Mon Sep 17 00:00:00 2001 From: Christian <6939810+chkr1011@users.noreply.github.com> Date: Sat, 12 Nov 2022 12:53:54 +0100 Subject: [PATCH 11/11] Reset release notes --- .github/workflows/ReleaseNotes.md | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/.github/workflows/ReleaseNotes.md b/.github/workflows/ReleaseNotes.md index ace201e0..8b137891 100644 --- a/.github/workflows/ReleaseNotes.md +++ b/.github/workflows/ReleaseNotes.md @@ -1,8 +1 @@ -* [Core] Fixed several dead locks by implementing a new async signal (#1552) -* [Client] All waiting tasks will now fail when the client connection gets closed. This fixes several freezes (#1561) -* [ManagedClient] The topic is no longer declared as invalid if a topic alias is used (#1395) -* [Server] Fixed duplicated invocation of the event _ClientAcknowledgedPublishPacketAsync_ for QoS level 2 (#1550) -* [Server] Fixed issue in upgrading and downgrading of QoS levels for subscriptions and retained messages (#1560) -* [Server] Fixed memory leak when old sessions are discarded (#1553) -* [Server] When using MQTTv5 the reason code _NoMatchingSubscribers_ is returned when no client is subscribed to a published topic (#802) -* [Server] Fix sending of duplicate messages with QoS > 0 when session is recovered and session is reused (#1546) +