handle failed_transient error email status #GCPActive (#320)

README.md

@@ -63,6 +63,6 @@ In pgAdmin
 To run a Kafka broker and Kafdrop (visualization and administration tool) locally you need to have Docker installed on your machine.
 
 In a terminal navigate to the root of this repository
-and run command `docker-compose -f setup-kafka.yml up -d`
+and run command `docker compose -f setup-kafka.yml up -d`
 
 Kafdrop will be available on localhost:9000

src/Altinn.Notifications.Core/Enums/EmailNotificationResultType.cs

@@ -38,5 +38,18 @@ public enum EmailNotificationResultType
     /// <summary>
     /// Invalid format for email address
     /// </summary>
-    Failed_InvalidEmailFormat
+    Failed_InvalidEmailFormat,
+
+    /// <summary>
+    /// Recipient supressed by email service
+    /// </summary>
+    Failed_SupressedRecipient,
+
+    /// <summary>
+    /// Transient error, retry later
+    /// </summary>
+    /// <remarks>
+    /// Should not be used externally or persisted in db.
+    /// Only used for processing and logic in service layer.</remarks>
+    Failed_TransientError
 }

src/Altinn.Notifications.Core/Services/EmailNotificationService.cs

@@ -72,6 +72,12 @@ public async Task SendNotifications()
     /// <inheritdoc/>
     public async Task UpdateSendStatus(SendOperationResult sendOperationResult)
     {
+        // set to new to allow new iteration of regular proceessing if transient error
+        if (sendOperationResult.SendResult == EmailNotificationResultType.Failed_TransientError)
+        {
+            sendOperationResult.SendResult = EmailNotificationResultType.New;
+        }
+
         await _repository.UpdateSendStatus(sendOperationResult.NotificationId, (EmailNotificationResultType)sendOperationResult.SendResult!, sendOperationResult.OperationId);
     }
 

src/Altinn.Notifications.Core/Services/NotificationSummaryService.cs

@@ -20,7 +20,9 @@ public class NotificationSummaryService : INotificationSummaryService
                 { EmailNotificationResultType.Delivered, "The email was delivered to the recipient. No errors reported, making it likely it was received by the recipient." },
                 { EmailNotificationResultType.Failed, "The email was not sent due to an unspecified failure." },
                 { EmailNotificationResultType.Failed_RecipientNotIdentified, "The email was not sent because the recipient's email address was not found." },
-                { EmailNotificationResultType.Failed_InvalidEmailFormat, "The email was not sent because the recipient’s email address is in an invalid format." }
+                { EmailNotificationResultType.Failed_InvalidEmailFormat, "The email was not sent because the recipient’s email address is in an invalid format." },
+                { EmailNotificationResultType.Failed_SupressedRecipient, "The email was not sent because the recipient’s email address is suppressed by the third party email service." },
+                { EmailNotificationResultType.Failed_TransientError, "The email was not sent due to a transient error. We will retry sending the email." }                
             };
 
         private readonly static List<EmailNotificationResultType> _successResults = new()

test/Altinn.Notifications.Tests/Notifications.Core/TestingServices/EmailNotificationServiceTests.cs

@@ -162,6 +162,35 @@ public async Task UpdateSendStatus_SendResultDefined_Succeded()
         repoMock.Verify();
     }
 
+    [Fact]
+    public async Task UpdateSendStatus_TransientErrorResult_ConvertedToNew()
+    {
+        // Arrange
+        Guid notificationid = Guid.NewGuid();
+        string operationId = Guid.NewGuid().ToString();
+
+        SendOperationResult sendOperationResult = new()
+        {
+            NotificationId = notificationid,
+            OperationId = operationId,
+            SendResult = EmailNotificationResultType.Failed_TransientError
+        };
+
+        var repoMock = new Mock<IEmailNotificationRepository>();
+        repoMock.Setup(r => r.UpdateSendStatus(
+            It.Is<Guid>(n => n == notificationid), 
+            It.Is<EmailNotificationResultType>(e => e == EmailNotificationResultType.New), 
+            It.Is<string>(s => s.Equals(operationId))));
+
+        var service = GetTestService(repo: repoMock.Object);
+
+        // Act
+        await service.UpdateSendStatus(sendOperationResult);
+
+        // Assert
+        repoMock.Verify();
+    }
+
     private static EmailNotificationService GetTestService(IEmailNotificationRepository? repo = null, IKafkaProducer? producer = null, Guid? guidOutput = null, DateTime? dateTimeOutput = null)
     {
         var guidService = new Mock<IGuidService>();