Merge pull request #881 from bcgov/feature/registration-validation

Listing Report Reg Check

Author: saikrishnametpalli-nttdata

server/StrDss.Data/Mappings/ModelToEntityProfile.cs

@@ -23,7 +23,7 @@ public ModelToEntityProfile()
                 .ForMember(dest => dest.PlatformListingNo, opt => opt.MapFrom(src => src.ListingId))
                 .ForMember(dest => dest.PlatformListingUrl, opt => opt.MapFrom(src => src.ListingUrl))
                 .ForMember(dest => dest.BusinessLicenceNo, opt => opt.MapFrom(src => src.BusLicNo))
-                .ForMember(dest => dest.BcRegistryNo, opt => opt.MapFrom(src => src.BcRegNo))
+                .ForMember(dest => dest.BcRegistryNo, opt => opt.MapFrom(src => src.RegNo))
                 .ForMember(dest => dest.IsEntireUnit, opt => opt.MapFrom(src => src.IsEntireUnit == "Y"))
                 .ForMember(dest => dest.AvailableBedroomsQty, opt => opt.MapFrom(src => CommonUtils.StringToShort(src.BedroomsQty)))
                 .ForMember(dest => dest.NightsBookedQty, opt => opt.MapFrom(src => CommonUtils.StringToShort(src.NightsBookedQty)))

server/StrDss.Service/HttpClients/RegistrationAPI/BaseRegistrationApiClient.cs renamed to server/StrDss.Service/HttpClients/RegistrationAPI/BaseRegistrationApi.cs

@@ -6,7 +6,7 @@
 
 namespace StrDss.Service.HttpClients
 {
-    public abstract class BaseRegistrationApiClient
+    public abstract class BaseRegistrationApi
     {
         private string _apiKey;
 

server/StrDss.Service/HttpClients/RegistrationAPI/RegistrationApi.g.cs

@@ -139,7 +139,7 @@ public partial interface IRegistrationApiClient
     }
 
     [System.CodeDom.Compiler.GeneratedCode("NSwag", "14.2.0.0 (NJsonSchema v11.1.0.0 (Newtonsoft.Json v13.0.0.0))")]
-    public partial class RegistrationApiClient : StrDss.Service.HttpClients.BaseRegistrationApiClient, IRegistrationApiClient
+    public partial class RegistrationApiClient : StrDss.Service.HttpClients.BaseRegistrationApi, IRegistrationApiClient
     {
         private System.Net.Http.HttpClient _httpClient;
         private static System.Lazy<Newtonsoft.Json.JsonSerializerSettings> _settings = new System.Lazy<Newtonsoft.Json.JsonSerializerSettings>(CreateSerializerSettings, true);

server/StrDss.Service/HttpClients/RegistrationAPI/registration-api.nswag

@@ -11,7 +11,7 @@
   },
   "codeGenerators": {
     "openApiToCSharpClient": {
-      "clientBaseClass": "StrDss.Service.HttpClients.BaseRegistrationApiClient",
+      "clientBaseClass": "StrDss.Service.HttpClients.BaseRegistrationApi",
       "configurationClass": null,
       "generateClientClasses": true,
       "suppressClientClassesOutput": false,

server/StrDss.Service/PermitValidationService.cs

@@ -0,0 +1,99 @@
+using Microsoft.Extensions.Logging;
+using StrDss.Common;
+using StrDss.Data.Entities;
+using StrDss.Model;
+using StrDss.Service.HttpClients;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Logging;
+using System.Text.RegularExpressions;
+using StrDss.Service;
+
+namespace StrDss.Service
+{
+    public interface IPermitValidationService
+    {
+        Task<(bool isValid, Dictionary<string, List<string>> errors)> ValidateRegistrationPermitAsync(string regNo, string unitNumber, string streetNumber, string postalCode);
+    }
+}
+public class PermitValidationService : IPermitValidationService
+{
+    private IRegistrationApiClient _regApiClient;
+    private IConfiguration _config;
+    private ILogger<StrDssLogger> _logger;
+    private readonly string? _apiAccount;
+
+    public PermitValidationService(IRegistrationApiClient regApiClient, IConfiguration config, ILogger<StrDssLogger> logger)
+    {
+        _regApiClient = regApiClient;
+        _config = config;
+        _logger = logger;
+        _apiAccount = _config.GetValue<string>("REGISTRATION_API_ACCOUNT");
+    }
+
+    public async Task<(bool isValid, Dictionary<string, List<string>> errors)> ValidateRegistrationPermitAsync(string regNo, string unitNumber, string streetNumber, string postalCode)
+    {
+        bool isValid = true;
+        Dictionary<string, List<string>> errorDetails = new();
+
+        Body body = new()
+        {
+            Identifier = regNo,
+            Address = new()
+            {
+                UnitNumber = unitNumber,
+                StreetNumber = streetNumber,
+                PostalCode = postalCode
+            }
+        };
+
+        try
+        {
+            Response resp = await _regApiClient.ValidatePermitAsync(body, _apiAccount);
+
+            // If we didn't get a Status field back, then there was an error
+            if (string.IsNullOrEmpty(resp.Status))
+            {
+                isValid = false;
+                if (resp.Errors.Count == 0)
+                    errorDetails.Add("UNKNOWN ERROR", new List<string> { "Response did not contain a status or error message." });
+                else
+                    errorDetails = resp.Errors
+                        .GroupBy(e => e.Code)
+                        .ToDictionary(g => g.Key, g => g.Select(e => e.Message).ToList());
+            }
+            else if (!string.Equals(resp.Status, "ACTIVE", StringComparison.OrdinalIgnoreCase))
+            {
+                isValid = false;
+                errorDetails.Add("INACTIVE PERMIT", new List<string> { "Error: registration status returned as " + resp.Status });
+            }
+        }
+        catch (ApiException ex)
+        {
+            isValid = false;
+            if (ex.StatusCode == 404)
+            {
+                errorDetails.Add("NOT FOUND", new List<string> { "Error: Permit not found (404)." });
+            }
+            else if (ex.StatusCode == 401)
+            {
+                errorDetails.Add("UNAUTHORIZED", new List<string> { "Error: Unauthorized access (401)." });
+            }
+            else
+            {
+                errorDetails.Add("EXCEPTION", new List<string> { "Error: Service threw an undhandled exception." });
+            }
+        }
+        catch (Exception ex)
+        {
+            isValid = false;
+            errorDetails.Add("EXCEPTION", new List<string> { "Error: Service threw an undhandled exception." });
+        }
+
+        return (isValid, errorDetails);
+    }
+}

server/StrDss.Service/RegistrationService.cs

@@ -3,17 +3,14 @@
 using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.Logging;
-using NetTopologySuite.Geometries;
 using StrDss.Common;
 using StrDss.Data;
 using StrDss.Data.Entities;
 using StrDss.Data.Repositories;
 using StrDss.Model;
-using StrDss.Model.OrganizationDtos;
 using StrDss.Model.RentalReportDtos;
 using StrDss.Service.CsvHelpers;
 using StrDss.Service.EmailTemplates;
-using StrDss.Service.HttpClients;
 using System.Diagnostics;
 using System.Text;
 
@@ -32,12 +29,12 @@ public class RegistrationService : ServiceBase, IRegistrationService
         private IEmailMessageService _emailService;
         private IEmailMessageRepository _emailRepo;
         private IConfiguration _config;
-        private IRegistrationApiClient _regClient;
+        private IPermitValidationService _permitValidation;
         private string? _apiAccount;
 
         public RegistrationService(ICurrentUser currentUser, IFieldValidatorService validator, IUnitOfWork unitOfWork, IMapper mapper, IHttpContextAccessor httpContextAccessor,
             IUploadDeliveryRepository uploadRepo, IRentalListingReportRepository reportRepo, IPhysicalAddressRepository addressRepo,
-            IUserRepository userRepo, IEmailMessageService emailService, IEmailMessageRepository emailRepo, IConfiguration config, IRegistrationApiClient regClient,
+            IUserRepository userRepo, IEmailMessageService emailService, IEmailMessageRepository emailRepo, IConfiguration config, IPermitValidationService permitValidation,
             ILogger<StrDssLogger> logger)
             : base(currentUser, validator, unitOfWork, mapper, httpContextAccessor, logger)
         {
@@ -48,8 +45,7 @@ public RegistrationService(ICurrentUser currentUser, IFieldValidatorService vali
             _emailService = emailService;
             _emailRepo = emailRepo;
             _config = config;
-            _regClient = regClient;
-            _apiAccount = _config.GetValue<string>("REGISTRATION_API_ACCOUNT");
+            _permitValidation = permitValidation;
         }
 
         public async Task ProcessRegistrationDataUploadAsync(DssUploadDelivery upload)
@@ -132,7 +128,7 @@ public async Task ProcessRegistrationDataUploadAsync(DssUploadDelivery upload)
             {
                 UserName = $"{user!.GivenNm}",
                 NumErrors = errorCount,
-                Link = GetHostUrl() + "/upload-listing-history",
+                Link = GetHostUrl() + "/registration-validation-history",
                 To = new string[] { user!.EmailAddressDsc! },
                 Info = $"{EmailMessageTypes.ListingUploadError} for {user.FamilyNm}, {user.GivenNm}",
                 From = adminEmail
@@ -179,7 +175,7 @@ private async Task<bool> ProcessUploadLine(DssUploadDelivery upload, long OrgId,
                 return false;
             }
 
-            (bool isValid, Dictionary<string, List<string>> regErrors) = await ValidateRegistrationPermitAsync(row.RegNo, row.RentalUnit, row.RentalStreet, row.RentalPostal);
+            (bool isValid, Dictionary<string, List<string>> regErrors) = await _permitValidation.ValidateRegistrationPermitAsync(row.RegNo, row.RentalUnit, row.RentalStreet, row.RentalPostal);
             if (isValid)
             {
                 if (!string.IsNullOrEmpty(row.ListingId))
@@ -204,63 +200,15 @@ private async Task<bool> ProcessUploadLine(DssUploadDelivery upload, long OrgId,
                 }                
             }
 
-            SaveUploadLine(uploadLine, regErrors, false, !isValid);
+            SaveUploadLine(uploadLine, regErrors, false, !isValid, false);
             return isValid;
         }
 
-        public async Task<(bool isValid, Dictionary<string, List<string>> errors)> ValidateRegistrationPermitAsync(string regNo, string unitNumber, string streetNumber, string postalCode)
-        {
-            bool isValid = true;
-            Dictionary<string, List<string>> errorDetails = new();
-
-            StrDss.Service.HttpClients.Body body = new()
-            {
-                Identifier = regNo,
-                Address = new()
-                {
-                    UnitNumber = unitNumber,
-                    StreetNumber = streetNumber,
-                    PostalCode = postalCode
-                }
-            };
-
-            try
-            {
-                Response resp = await _regClient.ValidatePermitAsync(body, _apiAccount);
-
-                // If we didn't get a Status field back, then there was an error
-                if (string.IsNullOrEmpty(resp.Status))
-                {
-                    isValid = false;
-                    if (resp.Errors.Count == 0)
-                        errorDetails.Add("UNKNOWN ERROR", new List<string> { "Response did not contain a status or error message." });
-                    else
-                        errorDetails = resp.Errors
-                            .GroupBy(e => e.Code)
-                            .ToDictionary(g => g.Key, g => g.Select(e => e.Message).ToList());
-                }
-
-                // If the status is not "ACTIVE" then there is an issue with the registration
-                if (!string.Equals(resp.Status, "ACTIVE", StringComparison.OrdinalIgnoreCase))
-                {
-                    isValid = false;
-                    errorDetails.Add("INACTIVE PERMIT", new List<string> { "Error: registration status returned as " + resp.Status });
-                }
-            }
-            catch (Exception ex)
-            {
-                isValid = false;
-                errorDetails.Add("EXCEPTION", new List<string> { ex.Message });
-            }
-
-            return (isValid, errorDetails);
-        }
-
-        private void SaveUploadLine(DssUploadLine uploadLine, Dictionary<string, List<string>> errors, bool isValidationFailure, bool isSystemError)
+        private void SaveUploadLine(DssUploadLine uploadLine, Dictionary<string, List<string>> errors, bool isValidationFailure, bool isSystemError, bool useUnderscores = true)
         {
             uploadLine.IsValidationFailure = isValidationFailure;
             uploadLine.IsSystemFailure = isSystemError;
-            uploadLine.ErrorTxt = errors.ParseErrorWithUnderScoredKeyName();
+            uploadLine.ErrorTxt = useUnderscores ? errors.ParseErrorWithUnderScoredKeyName() : errors.ParseError();
             uploadLine.IsProcessed = true;
             _unitOfWork.Commit();
         }

server/StrDss.Service/RentalListingReportService.cs

@@ -35,12 +35,13 @@ public class RentalListingReportService : ServiceBase, IRentalListingReportServi
         private IEmailMessageService _emailService;
         private IEmailMessageRepository _emailRepo;
         private IBizLicenceRepository _bizLicRepo;
+        private IPermitValidationService _permitValidation;
         private IConfiguration _config;
 
         public RentalListingReportService(ICurrentUser currentUser, IFieldValidatorService validator, IUnitOfWork unitOfWork, IMapper mapper, IHttpContextAccessor httpContextAccessor,
             IOrganizationRepository orgRepo, IUploadDeliveryRepository uploadRepo, IRentalListingReportRepository reportRepo, IPhysicalAddressRepository addressRepo,
             IGeocoderApi geocoder, IUserRepository userRepo, IEmailMessageService emailService, IEmailMessageRepository emailRepo, IBizLicenceRepository bizLicRepo,
-            IConfiguration config, ILogger<StrDssLogger> logger)
+            IPermitValidationService permitValidation, IConfiguration config, ILogger<StrDssLogger> logger)
             : base(currentUser, validator, unitOfWork, mapper, httpContextAccessor, logger)
         {
             _orgRepo = orgRepo;
@@ -52,6 +53,7 @@ public RentalListingReportService(ICurrentUser currentUser, IFieldValidatorServi
             _emailService = emailService;
             _emailRepo = emailRepo;
             _bizLicRepo = bizLicRepo;
+            _permitValidation = permitValidation;
             _config = config;
         }
 
@@ -216,6 +218,17 @@ private async Task<bool> ProcessUploadLine(DssRentalListingReport report, DssUpl
                 return false;
             }
 
+            // Should we validate the Registration?
+            bool isRegistrationValid = false;
+            if (_currentUser.Permissions.Any(p => p == Permissions.ValidateRegistration))
+            {
+                // Do we have what we need to validate the registration?
+                if (!string.IsNullOrEmpty(row.RegNo) && !string.IsNullOrEmpty(row.RentalStreet) && !string.IsNullOrEmpty(row.RentalPostal))
+                {
+                    (isRegistrationValid, Dictionary<string, List<string>> regErrors) = await _permitValidation.ValidateRegistrationPermitAsync(row.RegNo, row.RentalUnit, row.RentalStreet, row.RentalPostal);
+                }
+            }
+
             var offeringOrg = await _orgRepo.GetOrganizationByOrgCdAsync(row.OrgCd); //already validated in the file upload
 
             using var tran = _unitOfWork.BeginTransaction();
@@ -224,7 +237,7 @@ private async Task<bool> ProcessUploadLine(DssRentalListingReport report, DssUpl
 
             AddContacts(listing, row);
 
-            var (physicalAddress, systemError) = await CreateOrGetPhysicalAddress(listing, row);
+            var (physicalAddress, systemError) = await CreateOrGetPhysicalAddress(listing, row, isRegistrationValid);
 
             listing.LocatingPhysicalAddress = physicalAddress;
 
@@ -262,6 +275,8 @@ private async Task<bool> ProcessUploadLine(DssRentalListingReport report, DssUpl
             }
 
             tran.Commit();
+
+
             return true;
         }
 
@@ -300,7 +315,7 @@ private async Task<DssRentalListing> CreateOrUpdateRentalListing(DssRentalListin
             return listing;
         }
 
-        private async Task<(DssPhysicalAddress, string)> CreateOrGetPhysicalAddress(DssRentalListing listing, RentalListingRowUntyped row)
+        private async Task<(DssPhysicalAddress, string)> CreateOrGetPhysicalAddress(DssRentalListing listing, RentalListingRowUntyped row, bool isRegistrationValid)
         {
             var address = row.RentalAddress;
 
@@ -312,10 +327,7 @@ private async Task<DssRentalListing> CreateOrUpdateRentalListing(DssRentalListin
             {
                 var newAddress = new DssPhysicalAddress
                 {
-                    OriginalAddressTxt = row.RentalAddress,
-                    RegRentalUnitNo = row.RentalUnit,
-                    RegRentalStreetNo = row.RentalStreet,
-                    RegRentalPostalCode = row.RentalPostal,
+                    OriginalAddressTxt = row.RentalAddress
                 };
 
                 error = await _geocoder.GetAddressAsync(newAddress);
@@ -350,9 +362,12 @@ private async Task<DssRentalListing> CreateOrUpdateRentalListing(DssRentalListin
 
                 listing.IsChangedOriginalAddress = true;
 
-                newAddress.RegRentalUnitNo = row.RentalUnit;
-                newAddress.RegRentalStreetNo = row.RentalStreet;
-                newAddress.RegRentalPostalCode = row.RentalPostal;
+                if (isRegistrationValid)
+                {
+                    newAddress.RegRentalUnitNo = row.RentalUnit;
+                    newAddress.RegRentalStreetNo = row.RentalStreet;
+                    newAddress.RegRentalPostalCode = row.RentalPostal;
+                }
 
                 _addressRepo.ReplaceAddress(listing, newAddress);
 
@@ -363,12 +378,16 @@ private async Task<DssRentalListing> CreateOrUpdateRentalListing(DssRentalListin
             {
                 var newAddress = new DssPhysicalAddress
                 {
-                    OriginalAddressTxt = row.RentalAddress,
-                    RegRentalUnitNo = row.RentalUnit,
-                    RegRentalStreetNo = row.RentalStreet,
-                    RegRentalPostalCode = row.RentalPostal,
+                    OriginalAddressTxt = row.RentalAddress
                 };
 
+                if (isRegistrationValid)
+                {
+                    newAddress.RegRentalUnitNo = row.RentalUnit;
+                    newAddress.RegRentalStreetNo = row.RentalStreet;
+                    newAddress.RegRentalPostalCode = row.RentalPostal;
+                }
+
                 error = await _geocoder.GetAddressAsync(newAddress);
 
                 if (error.IsEmpty() && newAddress.LocationGeometry is not null && newAddress.LocationGeometry is Point point)

server/StrDss.Service/UploadDeliveryService.cs

@@ -573,7 +573,12 @@ public async Task<PagedDto<UploadHistoryViewDto>> GetUploadHistory(long? orgId,
             foreach (var lineId in lines)
             {
                 var line = await _uploadRepo.GetUploadLineWithError(lineId);
-                contents.AppendLine($"\"{line.ErrorText ?? "Success"}\"," + line.LineText.TrimEndNewLine());
+                var text = line.ErrorText;
+                if (string.IsNullOrEmpty(text))
+                {
+                    text = "Success";
+                }
+                contents.AppendLine($"\"{text}\"," + line.LineText.TrimEndNewLine());
             }
 
             return Encoding.UTF8.GetBytes(contents.ToString());