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

Feature/registration validation

Author: KFloodBCGov

frontend/src/app/features/components/registration-validation-history/registration-validation-history.component.ts

@@ -108,9 +108,7 @@ export class RegistrationValidationHistoryComponent {
       this.selectedPlatformId).subscribe({
       next: (records) => {
         this.currentPage = records.pageInfo;
-        this.registrationValidationHistory = records.sourceList.filter(
-          (item: any) => item.registrationStatus !== 'Not Applicable'
-        );
+        this.registrationValidationHistory = records.sourceList;
       },
       complete: () => {
         this.loaderService.loadingEnd();

server/StrDss.Common/Constants.cs

@@ -639,6 +639,7 @@ public static class UploadStatus
         public const string Pending = "Pending";
         public const string Processed = "Processed";
         public const string Failed = "Failed";
+        public const string NotApplicable = "Not Applicable";
     }
 
     public static class RegistrationValidationText
@@ -652,7 +653,7 @@ public static class RegistrationValidationText
         public const string ExemptionStatusNotFound = "Exemption status not found.";
         public const string StatusNotFound = "Registration validation Api did not return a registration status.";
         public const string ValidationException = "Registration validation Api threw an undhandled exception.";
-        public const string ValidationException404 = "Registration validation Api return a status of 404 (Permit not found).";
-        public const string ValidationException401 = "Registration validation Api return a status of 401 (Unauthorized access).";
+        public const string ValidationException404 = "404: Permit not found.";
+        public const string ValidationException401 = "401: Unauthorized access.";
     }
 }

server/StrDss.Data/Repositories/UploadDeliveryRepository.cs

@@ -171,6 +171,10 @@ public async Task<PagedDto<UploadHistoryViewDto>> GetUploadHistory(long? orgId,
             if (reportTypes.Any())
             {
                 query = query.Where(x => reportTypes.Contains(x.UploadDeliveryType));
+                if (reportTypes.Contains(UploadDeliveryTypes.RegistrationData))
+                {
+                    query = query.Where(x => x.RegistrationStatus != "Not Applicable");
+                }
             }
 
             var history = await Page<DssRentalUploadHistoryView, UploadHistoryViewDto>(query, pageSize, pageNumber, orderBy, direction);

server/StrDss.Service/HttpClients/ServiceCollectionExtension.cs

@@ -46,7 +46,7 @@ public static void AddHttpClients(this IServiceCollection services, IConfigurati
                 var apiKey = config.GetValue<string>("REGISTRATION_API_KEY") ?? "";
 
                 client.BaseAddress = new Uri(baseAddress);
-                client.Timeout = new TimeSpan(0, 2, 0);
+                client.Timeout = new TimeSpan(0, 0, 20);
                 client.DefaultRequestHeaders.Clear();
                 client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
                 client.DefaultRequestHeaders.Add("x-apikey", apiKey);

server/StrDss.Service/PermitValidationService.cs

@@ -7,9 +7,17 @@
 using StrDss.Data.Repositories;
 using StrDss.Data.Entities;
 using NetTopologySuite.Geometries;
+using System.Text.RegularExpressions;
+using System.Text.Json;
 
 namespace StrDss.Service
 {
+    public class ApiErrorResponse
+    {
+        public string ErrorMessage { get; set; }
+        public string RootCause { get; set; }
+    }
+
     public interface IPermitValidationService
     {
         Task<(bool isValid, string registrationText)> ValidateRegistrationPermitAsync(string regNo, string unitNumber, string streetNumber, string postalCode);
@@ -51,10 +59,11 @@ public PermitValidationService(IRegistrationApiClient regApiClient, IGeocoderApi
             }
         };
 
+        Response resp;
         try
         {
             _logger.LogInformation("Calling validate permit.");
-           Response resp = await _regApiClient.ValidatePermitAsync(body, _apiAccount);
+           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))
@@ -67,27 +76,36 @@ public PermitValidationService(IRegistrationApiClient regApiClient, IGeocoderApi
                 else
                 {
                     _logger.LogInformation("Validate permit returned an error.");
-                    Dictionary<string, List<string>> errorDetails = resp.Errors
-                        .GroupBy(e => e.Code)
-                        .ToDictionary(g => g.Key, g => g.Select(e => e.Message).ToList());
-                    registrationText = errorDetails.ParseError();
+                    List<string> errorDetails = resp.Errors
+                        .Select(e => $"{e.Code}: {e.Message}")
+                        .ToList();
+
+                    registrationText = string.Join("\n", resp.Errors.Select(e => $"{e.Code}: {e.Message}"));
                 }
             }
-            else if (!string.Equals(resp.Status, "ACTIVE", StringComparison.OrdinalIgnoreCase))
+            else
             {
-                _logger.LogInformation("Permit status is not ACTIVE.");
-                isValid = false;
-                registrationText = resp.Status;
+                _logger.LogInformation("Permit status is: ." + resp.Status);
 
+                registrationText = resp.Status;
             }
         }
-        catch (ApiException ex)
+        catch (ApiException ex) when (ex.StatusCode == 401)
         {
-            _logger.LogInformation("Validate permit call threw an Api exception: " + ex.Message);
+            _logger.LogInformation("Validate permit call return 401: " + ex.Message);
             isValid = false;
-            registrationText = ex.StatusCode == 404 ? RegistrationValidationText.ValidationException404 :
-                ex.StatusCode == 401 ? RegistrationValidationText.ValidationException401 :
-                RegistrationValidationText.ValidationException;
+            registrationText = RegistrationValidationText.ValidationException401;
+        }
+        catch (ApiException ex) when (ex.StatusCode == 404)
+        {
+            _logger.LogInformation("Validate permit call returned 404: " + ex.Message);
+            isValid = false;
+            registrationText = RegistrationValidationText.ValidationException404;
+
+        }
+        catch (ApiException ex)
+        {
+            registrationText = HandleApiException(ex);
         }
         catch (Exception ex)
         {
@@ -156,4 +174,38 @@ public PermitValidationService(IRegistrationApiClient regApiClient, IGeocoderApi
 
         return (isExempt, registrationText);
     }
+
+    private string HandleApiException(ApiException ex)
+    {
+        if (ex.StatusCode == 401)
+        {
+            _logger.LogInformation("Validate permit call return 401: " + ex.Message);
+            return RegistrationValidationText.ValidationException401;
+        }
+        if (ex.StatusCode == 404)
+        {
+            _logger.LogInformation("Validate permit call returned 404: " + ex.Message);
+            return RegistrationValidationText.ValidationException404;
+
+        }
+        if (ex.StatusCode == 400)
+        {
+            var errorResponse = JsonSerializer.Deserialize<ApiErrorResponse>(ex.Response);
+            if (errorResponse?.RootCause != null)
+            {
+                var match = Regex.Match(errorResponse.RootCause, @"code:(?<code>[^,]+),message:(?<message>[^,\]]+)");
+                if (match.Success)
+                {
+                    string code = match.Groups["code"].Value;
+                    string message = match.Groups["message"].Value;
+                    return $"{code}: {message}";
+                }
+                else
+                {
+                    return errorResponse.RootCause; // Fallback to the raw rootCause
+                }
+            }
+        }
+        return RegistrationValidationText.ValidationException;
+    }
 }

server/StrDss.Service/UploadDeliveryService.cs

@@ -589,19 +589,30 @@ public async Task<PagedDto<UploadHistoryViewDto>> GetUploadHistory(long? orgId,
             var contents = new StringBuilder();
 
             csv.Read();
-            var header = "validation_result," + csv.Parser.RawRecord.TrimEndNewLine();
+            var header = "code,validation_result," + csv.Parser.RawRecord.TrimEndNewLine();
 
             contents.AppendLine(header);
 
             foreach (var lineId in lines)
             {
                 var line = await _uploadRepo.GetUploadLineWithError(lineId);
-                var text = line.RegistrationTxt;
-                if (string.IsNullOrEmpty(text))
+                var text = string.IsNullOrEmpty(line.RegistrationTxt) ? "Success" : line.RegistrationTxt;
+
+                string? code = null;
+                string? message = null;
+
+                if (text.Contains(":"))
                 {
-                    text = "Success";
+                    var parts = text.Split(':', 2);
+                    code = parts[0].Trim();
+                    message = parts.Length > 1 ? parts[1].Trim() : null;
                 }
-                contents.AppendLine($"\"{text}\"," + line.LineText.TrimEndNewLine());
+                else
+                {
+                    message = text;
+                }
+
+                contents.AppendLine($"\"{code}\",\"{message}\"," + line.LineText.TrimEndNewLine());
             }
 
             return Encoding.UTF8.GetBytes(contents.ToString());