NucuCar/NucuCar.Domain/Telemetry/TelemetryPublisherAzure.cs

using System;
using System.Collections.Generic;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Azure.Devices.Client;
using Microsoft.Extensions.Logging;
using Newtonsoft.Json;

namespace NucuCar.Domain.Telemetry
{
    public class TelemetryPublisherAzure : TelemetryPublisher
    {
        protected readonly DeviceClient DeviceClient;

        public TelemetryPublisherAzure(TelemetryPublisherBuilderOptions opts) : base(opts)
        {
            try
            {
                DeviceClient = DeviceClient.CreateFromConnectionString(ConnectionString, TransportType.Mqtt);
            }
            catch (FormatException)
            {
                Logger?.LogCritical("Can't start telemetry service! Malformed connection string!");
                throw;
            }

            Logger?.LogDebug("Started the AzureTelemetryPublisher!");
        }

        /// <summary>
        /// Creates an instance of <see cref="TelemetryPublisher"/> that is used to publish data to Microsoft Azure.
        /// </summary>
        /// <param name="connectionString">The device connection string for Microsoft Azure IoT hub device.</param>
        /// <returns>A <see cref="TelemetryPublisher"/> instance.</returns>
        public static TelemetryPublisher CreateFromConnectionString(string connectionString)
        {
            Guard.ArgumentNotNullOrWhiteSpace(nameof(connectionString), connectionString);
            return new TelemetryPublisherAzure(new TelemetryPublisherBuilderOptions()
                {ConnectionString = connectionString, TelemetrySource = "TelemetryPublisherAzure"});
        }

        /// <summary>
        /// Creates an instance of <see cref="TelemetryPublisher"/> that is used to publish data to Microsoft Azure.
        /// </summary>
        /// <param name="connectionString">Device connection string for Microsoft Azure IoT hub device.</param>
        /// <param name="telemetrySource">String that is used to identify the source of the telemetry data.</param>
        /// <returns>A <see cref="TelemetryPublisher"/> instance.</returns>
        public static TelemetryPublisher CreateFromConnectionString(string connectionString,
            string telemetrySource)
        {
            Guard.ArgumentNotNullOrWhiteSpace(nameof(connectionString), connectionString);
            Guard.ArgumentNotNullOrWhiteSpace(nameof(telemetrySource), telemetrySource);
            return new TelemetryPublisherAzure(new TelemetryPublisherBuilderOptions()
                {ConnectionString = connectionString, TelemetrySource = telemetrySource});
        }

        /// <summary>
        /// Creates an instance of <see cref="TelemetryPublisher"/> that is used to publish data to Microsoft Azure.
        /// </summary>
        /// <param name="connectionString">Device connection string for Microsoft Azure IoT hub device.</param>
        /// <param name="telemetrySource">String that is used to identify the source of the telemetry data.</param>
        /// <param name="logger">An <see cref="ILogger"/> logger instance. </param>
        /// <returns>A <see cref="TelemetryPublisher"/> instance.</returns>
        public static TelemetryPublisher CreateFromConnectionString(string connectionString,
            string telemetrySource, ILogger logger)
        {
            Guard.ArgumentNotNullOrWhiteSpace(nameof(connectionString), connectionString);
            Guard.ArgumentNotNullOrWhiteSpace(nameof(telemetrySource), telemetrySource);
            Guard.ArgumentNotNull(nameof(logger), logger);
            return new TelemetryPublisherAzure(new TelemetryPublisherBuilderOptions()
                {ConnectionString = connectionString, TelemetrySource = telemetrySource, Logger = logger});
        }

        public override async Task PublishAsync(CancellationToken cancellationToken)
        {
            var data = GetTelemetry();

            var messageString = JsonConvert.SerializeObject(data);
            Logger?.LogDebug($"Telemetry message: {messageString}");
            var message = new Message(Encoding.ASCII.GetBytes(messageString));

            await PublishToCloudAsync(message, cancellationToken);
        }

        private Dictionary<string, object> GetTelemetry()
        {
            var data = new List<Dictionary<string, object>>();
            foreach (var telemeter in RegisteredTelemeters)
            {
                var telemetryData = telemeter.GetTelemetryData();
                if (telemetryData == null)
                {
                    Logger?.LogWarning($"Warning! Data for {telemeter.GetIdentifier()} is null!");
                    continue;
                }

                telemetryData["_id"] = telemeter.GetIdentifier();
                data.Add(telemetryData);
            }

            var metadata = new Dictionary<string, object>
            {
                ["source"] = TelemetrySource ?? nameof(TelemetryPublisherAzure),
                ["timestamp"] = DateTime.Now,
                ["data"] = data.ToArray()
            };
            return metadata;
        }

        private async Task PublishToCloudAsync(Message message, CancellationToken cancellationToken, int maxRetries = 3)
        {
            var retry = 0;
            while (retry < maxRetries)
            {
                if (cancellationToken.IsCancellationRequested)
                {
                    Logger?.LogInformation("Publishing telemetry cancelled!");
                    break;
                }

                try
                {
                    var cts = new CancellationTokenSource();
                    cts.CancelAfter(5000);
                    cts.Token.ThrowIfCancellationRequested();

                    /* Should throw OperationCanceledException on timeout or cancel. */
                    await DeviceClient.SendEventAsync(message, cts.Token);
                    break;
                }
                catch (OperationCanceledException e)
                {
                    retry += 1;
                    Logger?.LogWarning($"Telemetry not sent! Retry {retry}.");
                }
            }
        }

        public override void Dispose()
        {
            DeviceClient?.CloseAsync().GetAwaiter().GetResult();
        }
    }
}