Fix Bug: Failed to delete a device that is not present in IoT Hub #1836…

… (#1839) * fix delete device * update unit test device service
CGI-FR · Mar 6, 2023 · 77b9268 · 77b9268
1 parent 4323ea0
commit 77b9268
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 5 deletions.
diff --git a/src/AzureIoTHub.Portal.Server/Services/DeviceService.cs b/src/AzureIoTHub.Portal.Server/Services/DeviceService.cs
@@ -17,6 +17,7 @@ namespace AzureIoTHub.Portal.Server.Services
     using Domain.Exceptions;
     using Domain.Repositories;
     using Infrastructure;
+    using Microsoft.Extensions.Logging;
     using Models.v10;
 
     public class DeviceService : DeviceServiceBase<DeviceDetails>
@@ -37,8 +38,9 @@ public DeviceService(IMapper mapper,
             IDeviceTagService deviceTagService,
             IDeviceModelImageManager deviceModelImageManager,
             IDeviceTwinMapper<DeviceListItem, DeviceDetails> deviceTwinMapper,
-            PortalDbContext portalDbContext)
-            : base(portalDbContext, mapper, externalDevicesService, deviceTagService, deviceModelImageManager, deviceTwinMapper)
+            PortalDbContext portalDbContext,
+            ILogger<DeviceService> logger)
+            : base(portalDbContext, mapper, externalDevicesService, deviceTagService, deviceModelImageManager, deviceTwinMapper, logger)
         {
             this.mapper = mapper;
             this.unitOfWork = unitOfWork;

diff --git a/src/AzureIoTHub.Portal.Server/Services/DeviceServiceBase.cs b/src/AzureIoTHub.Portal.Server/Services/DeviceServiceBase.cs
@@ -18,7 +18,9 @@ namespace AzureIoTHub.Portal.Server.Services
     using Infrastructure;
     using Infrastructure.Repositories;
     using Microsoft.Azure.Devices;
+    using Microsoft.Azure.Devices.Common.Exceptions;
     using Microsoft.EntityFrameworkCore;
+    using Microsoft.Extensions.Logging;
     using Models.v10;
     using Shared.Models.v1._0;
     using Shared.Models.v10.Filters;
@@ -33,20 +35,23 @@ public abstract class DeviceServiceBase<TDto> : IDeviceService<TDto>
         private readonly IDeviceTagService deviceTagService;
         private readonly IDeviceModelImageManager deviceModelImageManager;
         private readonly IDeviceTwinMapper<DeviceListItem, TDto> deviceTwinMapper;
+        private readonly ILogger<DeviceServiceBase<TDto>> logger;
 
         protected DeviceServiceBase(PortalDbContext portalDbContext,
             IMapper mapper,
             IExternalDeviceService externalDevicesService,
             IDeviceTagService deviceTagService,
             IDeviceModelImageManager deviceModelImageManager,
-            IDeviceTwinMapper<DeviceListItem, TDto> deviceTwinMapper)
+            IDeviceTwinMapper<DeviceListItem, TDto> deviceTwinMapper,
+            ILogger<DeviceServiceBase<TDto>> logger)
         {
             this.portalDbContext = portalDbContext;
             this.mapper = mapper;
             this.externalDevicesService = externalDevicesService;
             this.deviceTagService = deviceTagService;
             this.deviceModelImageManager = deviceModelImageManager;
             this.deviceTwinMapper = deviceTwinMapper;
+            this.logger = logger;
         }
 
         public async Task<PaginatedResult<DeviceListItem>> GetDevices(string searchText = null, bool? searchStatus = null, bool? searchState = null, int pageSize = 10,
@@ -181,7 +186,14 @@ public async Task<TDto> UpdateDevice(TDto device)
 
         public virtual async Task DeleteDevice(string deviceId)
         {
-            await this.externalDevicesService.DeleteDevice(deviceId);
+            try
+            {
+                await this.externalDevicesService.DeleteDevice(deviceId);
+            }
+            catch (DeviceNotFoundException e)
+            {
+                this.logger.LogWarning($"Unable to delete the device with ID {deviceId} because it doesn't exist on IoT Hub {e.Message}");
+            }
 
             await DeleteDeviceInDatabase(deviceId);
         }

diff --git a/src/AzureIoTHub.Portal.Server/Services/LoRaWanDeviceService.cs b/src/AzureIoTHub.Portal.Server/Services/LoRaWanDeviceService.cs
@@ -49,7 +49,7 @@ public LoRaWanDeviceService(
             PortalDbContext portalDbContext,
             IDeviceModelImageManager deviceModelImageManager,
             IDeviceTwinMapper<DeviceListItem, LoRaDeviceDetails> deviceTwinMapper)
-            : base(portalDbContext, mapper, externalDevicesService, deviceTagService, deviceModelImageManager, deviceTwinMapper)
+            : base(portalDbContext, mapper, externalDevicesService, deviceTagService, deviceModelImageManager, deviceTwinMapper, logger)
         {
             this.logger = logger;
             this.mapper = mapper;

diff --git a/src/AzureIoTHub.Portal.Tests.Unit/Server/Services/DeviceServiceTests.cs b/src/AzureIoTHub.Portal.Tests.Unit/Server/Services/DeviceServiceTests.cs
@@ -19,6 +19,7 @@ namespace AzureIoTHub.Portal.Tests.Unit.Server.Services
     using EntityFramework.Exceptions.Common;
     using FluentAssertions;
     using Microsoft.Azure.Devices;
+    using Microsoft.Azure.Devices.Common.Exceptions;
     using Microsoft.Azure.Devices.Shared;
     using Microsoft.EntityFrameworkCore;
     using Microsoft.Extensions.DependencyInjection;
@@ -652,5 +653,37 @@ public async Task GetAvailableLabels_LabelsExists_LabelsReturned()
             _ = result.Count().Should().Be(expectedLabels.Count);
             MockRepository.VerifyAll();
         }
+
+        [Test]
+        public async Task DeleteDevice_DeviceNotFoundOnAzure_DeviceDeletedInDatabase()
+        {
+            // Arrange
+            var deviceDto = new DeviceDetails
+            {
+                DeviceID = Fixture.Create<string>()
+            };
+
+            _ = this.mockExternalDevicesService.Setup(service => service.DeleteDevice(deviceDto.DeviceID))
+                .ThrowsAsync(new DeviceNotFoundException(deviceDto.DeviceID));
+
+            _ = this.mockDeviceRepository.Setup(repository => repository.GetByIdAsync(deviceDto.DeviceID, d => d.Tags, d => d.Labels))
+                .ReturnsAsync(new Device
+                {
+                    Tags = new List<DeviceTagValue>(),
+                    Labels = new List<Label>()
+                });
+
+            this.mockDeviceRepository.Setup(repository => repository.Delete(deviceDto.DeviceID))
+                .Verifiable();
+
+            _ = this.mockUnitOfWork.Setup(work => work.SaveAsync())
+                .Returns(Task.CompletedTask);
+
+            // Act
+            await this.deviceService.DeleteDevice(deviceDto.DeviceID);
+
+            // Assert
+            MockRepository.VerifyAll();
+        }
     }
 }