E2E Test Coverage Part 2 & Add .NET 9.0 Support (#218)

Author: pglombardo

.github/workflows/build.yml

@@ -11,19 +11,15 @@ on:
   workflow_dispatch:
 
 env:
-  # Disable the .NET logo in the console output.
   DOTNET_NOLOGO: true
-  # Disable the .NET first time experience to skip caching NuGet packages and speed up the build.
   DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
-  # Disable sending .NET CLI telemetry to Microsoft.
   DOTNET_CLI_TELEMETRY_OPTOUT: true
-  # Set the build number in MinVer.
-  MINVERBUILDMETADATA: build.${{github.run_number}}
+  MINVERBUILDMETADATA: build.${{ github.run_number }}
 
 jobs:
   build:
-    name: pipeline-${{matrix.os}}-dotnet-${{matrix.dotnet-version}}
-    runs-on: ${{matrix.os}}
+    name: pipeline-${{ matrix.os }}-dotnet-${{ matrix.dotnet-version }}
+    runs-on: ${{ matrix.os }}
 
     services:
       hivemq:
@@ -41,33 +37,43 @@ jobs:
 
     strategy:
       matrix:
-        # Docker containers not supported on windows and macOS in Github runners.
-        # os: [ubuntu-latest, windows-latest, macOS-latest]
         os: [ubuntu-latest]
-        dotnet-version: ['6.0.x', '7.0.x', '8.0.x']
+        dotnet-version: ['6.0.x', '7.0.x', '8.0.x', '9.0.x']
     steps:
-      - name: "Checkout"
+      - name: Checkout
         uses: actions/checkout@v4.2.2
         with:
           lfs: true
           fetch-depth: 0
-      - name: "Install .NET Core SDK"
+
+      - name: Install .NET Core SDK
         uses: actions/setup-dotnet@v4
         with:
           dotnet-version: '${{ matrix.dotnet-version }}'
-      - name: "Dotnet Tool Restore"
+
+      - name: List Installed SDKs
+        run: dotnet --list-sdks
+
+      - name: Create temporary global.json
+        run: echo '{"sdk":{"version":"${{ matrix.dotnet-version }}"}}' > global.json
+
+      - name: Dotnet Tool Restore
         run: dotnet tool restore
         shell: pwsh
-      - name: "Dotnet Cake Build"
+
+      - name: Dotnet Cake Build
         run: dotnet cake --target=Build
         shell: pwsh
-      - name: "Dotnet Cake Test"
-        run: dotnet cake --target=Test
+
+      - name: Dotnet Cake Test
+        run: dotnet cake --target=Test --framework net${{ matrix.dotnet-version }}
         shell: pwsh
-      - name: "Dotnet Cake Pack"
+
+      - name: Dotnet Cake Pack
         run: dotnet cake --target=Pack
         shell: pwsh
-      - name: "Upload NuGet packages"
+
+      - name: Upload NuGet packages
         uses: actions/upload-artifact@v4
         with:
           name: nuget-packages-${{ matrix.dotnet-version }}
@@ -77,22 +83,30 @@ jobs:
     needs: build
     runs-on: ubuntu-latest
     steps:
-      - name: "Download NuGet packages"
+      - name: Download NuGet packages for .NET 6.0
         uses: actions/download-artifact@v4
         with:
           name: nuget-packages-6.0.x
           path: ./Artifacts
-      - name: "Download NuGet packages"
+
+      - name: Download NuGet packages for .NET 7.0
         uses: actions/download-artifact@v4
         with:
           name: nuget-packages-7.0.x
           path: ./Artifacts
-      - name: "Download NuGet packages"
+
+      - name: Download NuGet packages for .NET 8.0
         uses: actions/download-artifact@v4
         with:
           name: nuget-packages-8.0.x
           path: ./Artifacts
 
+      - name: Download NuGet packages for .NET 9.0
+        uses: actions/download-artifact@v4
+        with:
+          name: nuget-packages-9.0.x
+          path: ./Artifacts
+
       - name: Push to NuGet
         if: github.event_name == 'release'
         run: dotnet nuget push ./Artifacts/*.nupkg --api-key ${{ secrets.NUGET_API_KEY }} --source https://api.nuget.org/v3/index.json --skip-duplicate

README.md

@@ -9,15 +9,15 @@
 [![Nuget](https://img.shields.io/nuget/dt/HiveMQtt?style=for-the-badge)](https://www.nuget.org/packages/HiveMQtt)
 [![GitHub](https://img.shields.io/github/license/hivemq/hivemq-mqtt-client-dotnet?style=for-the-badge)](https://github.com/hivemq/hivemq-mqtt-client-dotnet/blob/main/LICENSE)
 
-
-![Static Badge](https://img.shields.io/badge/.NET%20Core-6-%23512BD4?style=for-the-badge)
-![Static Badge](https://img.shields.io/badge/.NET%20Core-7-%23512BD4?style=for-the-badge)
-![Static Badge](https://img.shields.io/badge/.NET%20Core-8-%23512BD4?style=for-the-badge)
+![Static Badge](https://img.shields.io/badge/.NET-6.0-%23512BD4?style=for-the-badge)
+![Static Badge](https://img.shields.io/badge/.NET-7.0-%23512BD4?style=for-the-badge)
+![Static Badge](https://img.shields.io/badge/.NET-8.0-%23512BD4?style=for-the-badge)
+![Static Badge](https://img.shields.io/badge/.NET-9.0-%23512BD4?style=for-the-badge)
 
 ### 💽 Installation & Compatibility
 * **Easy-to-Install**: Available as a [Nuget package](https://www.nuget.org/packages/HiveMQtt).
 * **Globally Compatible**: Built to be a fully compliant MQTT 5.0 client compatible with all modern MQTT brokers.
-* **Multi-Targeted**: Supports .NET 6.0, 7.0 & 8.0
+* **Multi-Targeted**: Supports .NET 6.0, 7.0, 8.0 & 9.0
 
 ### 🚀 Features
 * **MQTT 5.0 Support**: Fully compliant with the latest [MQTT 5.0 specification](https://docs.oasis-open.org/mqtt/mqtt/v5.0/mqtt-v5.0.html), ensuring compatibility with modern MQTT brokers.

Source/HiveMQtt/Client/Connection/ConnectionManager.cs

@@ -152,7 +152,7 @@ internal async Task CancelBackgroundTasksAsync()
         }
         else
         {
-            Logger.Error("ConnectionPublishWriterTask did not complete");
+            Logger.Trace("ConnectionPublishWriterTask did not complete in time");
         }
 
         if (this.ConnectionWriterTask is not null && this.ConnectionWriterTask.IsCompleted)
@@ -161,7 +161,7 @@ internal async Task CancelBackgroundTasksAsync()
         }
         else
         {
-            Logger.Error("ConnectionWriterTask did not complete");
+            Logger.Trace("ConnectionWriterTask did not complete in time");
         }
 
         if (this.ConnectionReaderTask is not null && this.ConnectionReaderTask.IsCompleted)
@@ -170,7 +170,7 @@ internal async Task CancelBackgroundTasksAsync()
         }
         else
         {
-            Logger.Error("ConnectionReaderTask did not complete");
+            Logger.Trace("ConnectionReaderTask did not complete in time");
         }
 
         if (this.ReceivedPacketsHandlerTask is not null && this.ReceivedPacketsHandlerTask.IsCompleted)
@@ -179,7 +179,7 @@ internal async Task CancelBackgroundTasksAsync()
         }
         else
         {
-            Logger.Error("ReceivedPacketsHandlerTask did not complete");
+            Logger.Trace("ReceivedPacketsHandlerTask did not complete in time");
         }
 
         if (this.ConnectionMonitorTask is not null && this.ConnectionMonitorTask.IsCompleted)
@@ -188,7 +188,7 @@ internal async Task CancelBackgroundTasksAsync()
         }
         else
         {
-            Logger.Error("ConnectionMonitorTask did not complete");
+            Logger.Trace("ConnectionMonitorTask did not complete in time");
         }
     }
 

Source/HiveMQtt/Client/Connection/ConnectionManagerTasks.cs

@@ -51,8 +51,13 @@ private async Task RunTaskHealthCheckAsync(Task? task, string taskName)
     private Task ConnectionMonitorAsync(CancellationToken cancellationToken) => Task.Run(
         async () =>
         {
-            var keepAlivePeriod = this.Client.Options.KeepAlive / 2;
             Logger.Trace($"{this.Client.Options.ClientId}-(CM)- Starting...{this.State}");
+            if (this.Client.Options.KeepAlive == 0)
+            {
+                Logger.Debug($"{this.Client.Options.ClientId}-(CM)- KeepAlive is 0.  No pings will be sent.");
+            }
+
+            var keepAlivePeriod = this.Client.Options.KeepAlive;
             this.lastCommunicationTimer.Start();
 
             while (true)
@@ -62,7 +67,7 @@ private Task ConnectionMonitorAsync(CancellationToken cancellationToken) => Task
                     // If connected and no recent packets have been sent, send a ping
                     if (this.State == ConnectState.Connected)
                     {
-                        if (this.lastCommunicationTimer.Elapsed > TimeSpan.FromSeconds(keepAlivePeriod))
+                        if (this.Client.Options.KeepAlive > 0 && this.lastCommunicationTimer.Elapsed > TimeSpan.FromSeconds(keepAlivePeriod))
                         {
                             // Send PingReq
                             Logger.Trace($"{this.Client.Options.ClientId}-(CM)- --> PingReq");

Source/HiveMQtt/Client/Exceptions/HiveMQttClientException.cs

@@ -15,11 +15,17 @@
  */
 namespace HiveMQtt.Client.Exceptions;
 
+using System.Runtime.Serialization;
+
 [Serializable]
 
 public class
 HiveMQttClientException : Exception
 {
+    protected HiveMQttClientException(SerializationInfo info, StreamingContext context)
+    {
+    }
+
     public HiveMQttClientException()
     {
     }

Source/HiveMQtt/Client/HiveMQClient.cs

@@ -232,7 +232,7 @@ public async Task<PublishResult> PublishAsync(MQTT5PublishMessage message, Cance
             // QoS 2: Assured Delivery
             var packetIdentifier = await this.Connection.PacketIDManager.GetAvailablePacketIDAsync().ConfigureAwait(false);
             var publishPacket = new PublishPacket(message, (ushort)packetIdentifier);
-            PublishResult? publishResult = null;
+            var publishResult = new PublishResult(publishPacket.Message);
 
             Logger.Trace($"Queuing QoS 2 publish packet for send: {publishPacket.GetType().Name} id={publishPacket.PacketIdentifier}");
             this.Connection.OutgoingPublishQueue.Enqueue(publishPacket);
@@ -472,4 +472,7 @@ public async Task<UnsubscribeResult> UnsubscribeAsync(UnsubscribeOptions unsubOp
         this.AfterUnsubscribeEventLauncher(unsubscribeResult);
         return unsubscribeResult;
     }
+
+    // Method to check if ping are sent based on the KeepAlive option
+    public bool IsPingSent() => this.Options.KeepAlive > 0;
 }

Source/HiveMQtt/Client/HiveMQClientUtil.cs

@@ -112,7 +112,9 @@ public static bool MatchTopic(string pattern, string candidate)
 
         // If pattern contains a multi-level wildcard character, it must be the last character in the pattern
         // and it must be preceded by a topic level separator.
+#pragma warning disable SYSLIB1045 // Convert to 'GeneratedRegexAttribute'.
         var mlwcValidityRegex = new Regex(@"(?<!/)#");
+#pragma warning restore SYSLIB1045 // Convert to 'GeneratedRegexAttribute'.
 
         if (pattern.Contains("/#/") | mlwcValidityRegex.IsMatch(pattern))
         {

Source/HiveMQtt/Client/Transport/WebSocketTransport.cs

@@ -117,7 +117,9 @@ public override async Task<TransportReadResult> ReadAsync(CancellationToken canc
             do
             {
                 result = await this.Socket.ReceiveAsync(buffer, CancellationToken.None).ConfigureAwait(false);
+#pragma warning disable CA1835 // Prefer the 'Memory'-based overloads for 'ReadAsync' and 'WriteAsync'
                 await ms.WriteAsync(buffer.Array, buffer.Offset, result.Count, cancellationToken).ConfigureAwait(false);
+#pragma warning restore CA1835 // Prefer the 'Memory'-based overloads for 'ReadAsync' and 'WriteAsync'
             }
             while (!result.EndOfMessage);
 

Source/HiveMQtt/Client/internal/Validator.cs

@@ -90,6 +90,7 @@ public static void ValidateTopicName(string topic)
     /// <exception cref="ArgumentNullException">Thrown when the topic filter is null.</exception>
     /// <exception cref="HiveMQttClientException">Thrown when the topic filter is longer than 65535 characters or empty.</exception>
     /// <exception cref="HiveMQttClientException">Thrown when the topic filter contains any null characters.</exception>
+    /// <exception cref="ArgumentException">Thrown when the topic filter contains invalid wildcard usage.</exception>
     public static void ValidateTopicFilter(string topic)
     {
         ArgumentNullException.ThrowIfNull(topic);
@@ -108,5 +109,29 @@ public static void ValidateTopicFilter(string topic)
         {
             throw new HiveMQttClientException("A topic name cannot contain any null characters.");
         }
+
+        // Check for invalid usage of '#' wildcard
+        if (topic.Contains('#'))
+        {
+            if (topic.IndexOf('#') != topic.Length - 1)
+            {
+                throw new ArgumentException("The '#' wildcard must be the last character in the topic filter.");
+            }
+
+            if (topic.Length > 1 && topic[^2] != '/')
+            {
+                throw new ArgumentException("The '#' wildcard must be preceded by a topic level separator or be the only character.");
+            }
+        }
+
+        // Check for invalid usage of '+' wildcard
+        var segments = topic.Split('/');
+        foreach (var segment in segments)
+        {
+            if (segment.Contains('+') && segment != "+")
+            {
+                throw new ArgumentException("The '+' wildcard must stand alone and cannot be part of another string.");
+            }
+        }
     }
 }

Source/HiveMQtt/HiveMQtt.csproj

@@ -1,7 +1,24 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup Label="Build">
-    <TargetFrameworks>net6.0;net7.0;net8.0;</TargetFrameworks>
+    <!-- Include net6.0 only if the SDK supports it -->
+    <TargetFrameworks Condition="'$(NETCoreSdkVersion)' >= '6.0.0'">net6.0</TargetFrameworks>
+
+    <!-- Add net7.0 conditionally if the SDK supports it -->
+    <TargetFrameworks Condition="'$(NETCoreSdkVersion)' >= '7.0.0'">
+      $(TargetFrameworks);net7.0
+    </TargetFrameworks>
+
+    <!-- Add net8.0 conditionally if the SDK supports it -->
+    <TargetFrameworks Condition="'$(NETCoreSdkVersion)' >= '8.0.0'">
+      $(TargetFrameworks);net8.0
+    </TargetFrameworks>
+
+    <!-- Add net9.0 conditionally if the SDK supports it -->
+    <TargetFrameworks Condition="'$(NETCoreSdkVersion)' >= '9.0.0'">
+      $(TargetFrameworks);net9.0
+    </TargetFrameworks>
+
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>