Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature/update mqtt3 to mqtt4 #140

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Feature/update mqtt3 to mqtt4 #140

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7b134b3
Update MQTTnet package to version 4.3.6.1152
saschadoemer Aug 20, 2024
50fe3c0
Update MQTT message handling in CapabilitiesServiceTest
saschadoemer Aug 20, 2024
c1fe677
Update MQTTnet namespace import.
saschadoemer Aug 20, 2024
f59799d
Update MQTT connection timeout method
saschadoemer Aug 20, 2024
7a08964
Refactor MQTT message publishing for clarity and consistency
saschadoemer Aug 20, 2024
7e2b3e0
Switch to async handler for MQTT message receiving
saschadoemer Aug 20, 2024
accba53
Merge branch 'main' into feature/update-mqtt3-to-mqtt4
saschadoemer Aug 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion agrirouter-sdk-dotnet-standard-api/Exception/CouldNotSendMqttMessageException.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
using System;
using MQTTnet.Client.Publishing;
using MQTTnet.Client;

namespace Agrirouter.Api.Exception
{
Expand Down
2 changes: 1 addition & 1 deletion agrirouter-sdk-dotnet-standard-api/agrirouter-sdk-dotnet-standard-api.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

<ItemGroup>
<PackageReference Include="agrirouter-api-protobuf-definitions" Version="1.1.0" />
<PackageReference Include="MQTTnet" Version="3.0.9" />
<PackageReference Include="MQTTnet" Version="4.3.6.1152" />
<PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
<PackageReference Include="Serilog" Version="2.9.0" />
<PackageReference Include="Serilog.Sinks.Console" Version="3.1.1" />
Expand Down
16 changes: 9 additions & 7 deletions agrirouter-sdk-dotnet-standard-impl/Service/Common/MqttMessagingService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
using Agrirouter.Api.Service.Parameters;
using MQTTnet;
using MQTTnet.Client;
using MQTTnet.Client.Publishing;
using MQTTnet.Protocol;
using Newtonsoft.Json;

namespace Agrirouter.Impl.Service.Common
Expand All @@ -25,7 +25,7 @@ public IMqttClient MqttClient
{
get { return _mqttClient; }
}

/// <summary>
/// Constructor.
/// </summary>
Expand Down Expand Up @@ -61,11 +61,13 @@ public async Task<MessagingResult> SendAsync(MessagingParameters messagingParame
var mqttMessage = BuildMqttApplicationMessage(messagingParameters);
var response = await _mqttClient.PublishAsync(mqttMessage, CancellationToken.None);

if (response.ReasonCode != MqttClientPublishReasonCode.Success) {
if (response.ReasonCode != MqttClientPublishReasonCode.Success)
{
throw new CouldNotSendMqttMessageException(response.ReasonCode, response.ReasonString);
}

return new MessagingResultBuilder().WithApplicationMessageId(messagingParameters.ApplicationMessageId).Build();
return new MessagingResultBuilder().WithApplicationMessageId(messagingParameters.ApplicationMessageId)
.Build();
}

private static MqttApplicationMessage BuildMqttApplicationMessage(MessagingParameters messagingParameters)
Expand All @@ -78,16 +80,16 @@ private static MqttApplicationMessage BuildMqttApplicationMessage(MessagingParam
};

foreach (var message in messagingParameters.EncodedMessages.Select(encodedMessage =>
new Api.Dto.Messaging.Inner.Message
{Content = encodedMessage, Timestamp = UtcDataService.NowAsUnixTimestamp()}))
new Api.Dto.Messaging.Inner.Message
{ Content = encodedMessage, Timestamp = UtcDataService.NowAsUnixTimestamp() }))
messageRequest.Messages.Add(message);

var messagePayload = JsonConvert.SerializeObject(messageRequest);

var mqttMessage = new MqttApplicationMessageBuilder()
.WithTopic(messagingParameters.OnboardResponse.ConnectionCriteria.Measures)
.WithPayload(messagePayload)
.WithExactlyOnceQoS()
.WithQualityOfServiceLevel(MqttQualityOfServiceLevel.ExactlyOnce)
.WithRetainFlag()
.Build();
return mqttMessage;
Expand Down
3 changes: 1 addition & 2 deletions agrirouter-sdk-dotnet-standard-test/Helper/MqttConnectionHelper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
using Agrirouter.Api.Dto.Onboard;
using Agrirouter.Impl.Service.Common;
using MQTTnet.Client;
using MQTTnet.Client.Options;
using Xunit;

namespace Agrirouter.Test.Helper
Expand Down Expand Up @@ -36,18 +35,18 @@
/// <returns>No dedicated response.</returns>
public static async Task ConnectMqttClient(IMqttClient mqttClient, OnboardResponse onboardResponse)
{
var tlsParameters = new MqttClientOptionsBuilderTlsParameters

Check warning on line 38 in agrirouter-sdk-dotnet-standard-test/Helper/MqttConnectionHelper.cs

View workflow job for this annotation

GitHub Actions / build 

'MqttClientOptionsBuilderTlsParameters' is obsolete: 'Use methods from MqttClientOptionsBuilder instead.'
{
Certificates = new[] {X509CertificateService.GetCertificate(onboardResponse)},

Check warning on line 40 in agrirouter-sdk-dotnet-standard-test/Helper/MqttConnectionHelper.cs

View workflow job for this annotation

GitHub Actions / build 

'MqttClientOptionsBuilderTlsParameters.Certificates' is obsolete: 'Use CertificatesProvider instead.'
UseTls = true
};

var options = new MqttClientOptionsBuilder()

Check warning on line 44 in agrirouter-sdk-dotnet-standard-test/Helper/MqttConnectionHelper.cs

View workflow job for this annotation

GitHub Actions / build 

'MqttClientOptionsBuilder.WithTls(MqttClientOptionsBuilderTlsParameters)' is obsolete: 'Use WithTlsOptions(... configure) instead.'
.WithClientId(onboardResponse.ConnectionCriteria.ClientId)
.WithTcpServer(onboardResponse.ConnectionCriteria.Host,
int.Parse(onboardResponse.ConnectionCriteria.Port))
.WithTls(tlsParameters)
.WithCommunicationTimeout(TimeSpan.FromSeconds(20))
.WithTimeout(TimeSpan.FromSeconds(20))
.Build();

await mqttClient.ConnectAsync(options);
Expand Down
9 changes: 5 additions & 4 deletions agrirouter-sdk-dotnet-standard-test/Service/Messaging/Mqtt/CapabilitiesServiceTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
using Agrirouter.Test.Data;
using Agrirouter.Test.Helper;
using MQTTnet;
using MQTTnet.Client;
using Xunit;
using Agrirouter.Api.Dto.Messaging;
using Newtonsoft.Json;
Expand Down Expand Up @@ -52,15 +51,17 @@
var messageReceived = false;
var counter = 0;

mqttClient.UseApplicationMessageReceivedHandler(e =>
mqttClient.ApplicationMessageReceivedAsync += async e =>

Check warning on line 54 in agrirouter-sdk-dotnet-standard-test/Service/Messaging/Mqtt/CapabilitiesServiceTest.cs

View workflow job for this annotation

GitHub Actions / build 

This async method lacks 'await' operators and will run synchronously. Consider using the 'await' operator to await non-blocking API calls, or 'await Task.Run(...)' to do CPU-bound work on a background thread.
{
messageReceived = true;

MessageResponse msg = JsonConvert.DeserializeObject<MessageResponse>(Encoding.UTF8.GetString(e.ApplicationMessage.Payload));
MessageResponse msg =
JsonConvert.DeserializeObject<MessageResponse>(
Encoding.UTF8.GetString(e.ApplicationMessage.Payload));

Check warning on line 60 in agrirouter-sdk-dotnet-standard-test/Service/Messaging/Mqtt/CapabilitiesServiceTest.cs

View workflow job for this annotation

GitHub Actions / build 

'MqttApplicationMessage.Payload' is obsolete: 'Use PayloadSegment instead. This property will be removed in a future release.'
var decodedMessage = DecodeMessageService.Decode(msg.Command.Message);

Assert.Equal(201, decodedMessage.ResponseEnvelope.ResponseCode);
});
};

while (!messageReceived && counter < 5)
{
Expand Down
8 changes: 4 additions & 4 deletions agrirouter-sdk-dotnet-standard-test/Service/Messaging/Mqtt/PingServiceTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,16 @@
var messageReceived = false;
var counter = 0;

mqttClient.UseApplicationMessageReceivedHandler(e =>
mqttClient.ApplicationMessageReceivedAsync += async e =>

Check warning on line 41 in agrirouter-sdk-dotnet-standard-test/Service/Messaging/Mqtt/PingServiceTest.cs

View workflow job for this annotation

GitHub Actions / build 

This async method lacks 'await' operators and will run synchronously. Consider using the 'await' operator to await non-blocking API calls, or 'await Task.Run(...)' to do CPU-bound work on a background thread.
{
messageReceived = true;

var msg = JsonConvert.DeserializeObject<MessageResponse>(
Encoding.UTF8.GetString(e.ApplicationMessage.Payload));

Check warning on line 46 in agrirouter-sdk-dotnet-standard-test/Service/Messaging/Mqtt/PingServiceTest.cs

View workflow job for this annotation

GitHub Actions / build 

'MqttApplicationMessage.Payload' is obsolete: 'Use PayloadSegment instead. This property will be removed in a future release.'

Check warning on line 46 in agrirouter-sdk-dotnet-standard-test/Service/Messaging/Mqtt/PingServiceTest.cs

View workflow job for this annotation

GitHub Actions / build 

'MqttApplicationMessage.Payload' is obsolete: 'Use PayloadSegment instead. This property will be removed in a future release.'
var decodedMessage = DecodeMessageService.Decode(msg.Command.Message);

Assert.Equal(200, decodedMessage.ResponseEnvelope.ResponseCode);
});
};

while (!messageReceived && counter < 5)
{
Expand Down Expand Up @@ -90,17 +90,17 @@
var messageReceived = false;
var counter = 0;

mqttClient.UseApplicationMessageReceivedHandler(e =>
mqttClient.ApplicationMessageReceivedAsync += async e =>

Check warning on line 93 in agrirouter-sdk-dotnet-standard-test/Service/Messaging/Mqtt/PingServiceTest.cs

View workflow job for this annotation

GitHub Actions / build 

This async method lacks 'await' operators and will run synchronously. Consider using the 'await' operator to await non-blocking API calls, or 'await Task.Run(...)' to do CPU-bound work on a background thread.
{
messageReceived = true;

var msg = JsonConvert.DeserializeObject<MessageResponse>(
Encoding.UTF8.GetString(e.ApplicationMessage.Payload));

Check warning on line 98 in agrirouter-sdk-dotnet-standard-test/Service/Messaging/Mqtt/PingServiceTest.cs

View workflow job for this annotation

GitHub Actions / build 

'MqttApplicationMessage.Payload' is obsolete: 'Use PayloadSegment instead. This property will be removed in a future release.'
var decodedMessage = DecodeMessageService.Decode(msg.Command.Message);

// your own application should remove the endpoint from your endpoint list/registry now!
Assert.Equal(400, decodedMessage.ResponseEnvelope.ResponseCode);
});
};

while (!messageReceived && counter < 5)
{
Expand Down
2 changes: 1 addition & 1 deletion agrirouter-sdk-dotnet-standard-test/agrirouter-sdk-dotnet-standard-test.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
<ItemGroup>
<PackageReference Include="Google.Protobuf" Version="3.20.1" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.4.0" />
<PackageReference Include="MQTTnet" Version="3.0.9" />
<PackageReference Include="MQTTnet" Version="4.3.6.1152" />
<PackageReference Include="Serilog.Sinks.Debug" Version="1.0.1" />
<PackageReference Include="xunit" Version="2.4.1" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.4.1" />
Expand Down
Loading