feat: Enhanced the notification message when the credential is expired (#354)

Refs: #353
Reviewed-by: Phil Schneider <info@philschneider.de>

Author: leandro-cavalcante

src/credentials/SsiCredentialIssuer.Expiry.App/ExpiryCheckService.cs

@@ -170,18 +170,19 @@ private static async ValueTask HandleNotification(
 
         var content = JsonSerializer.Serialize(new
         {
-            Type = data.VerifiedCredentialExternalTypeId,
+            AssignedExternalCredentialType = data.VerifiedCredentialExternalTypeId?.GetEnumValue(),
             ExpiryDate = data.ExpiryDate?.ToString("O") ?? throw new ConflictException("Expiry Date must be set here"),
             Version = data.DetailVersion,
             CredentialId = data.Id,
-            ExpiryCheckTypeId = newExpiryCheckTypeId
+            CredentialType = data.verifiedCredentialTypeId.ToString(),
+            ExpiryCheckTypeId = newExpiryCheckTypeId.ToString()
         }, Options);
 
         if (Guid.TryParse(data.RequesterId, out var requesterId))
         {
             await portalService.AddNotification(content, requesterId, NotificationTypeId.CREDENTIAL_EXPIRY,
                 cancellationToken).ConfigureAwait(ConfigureAwaitOptions.None);
-            var typeValue = data.VerifiedCredentialExternalTypeId.GetEnumValue() ??
+            var typeValue = data.VerifiedCredentialExternalTypeId?.GetEnumValue() ??
                             throw new UnexpectedConditionException(
                                 $"VerifiedCredentialType {data.VerifiedCredentialExternalTypeId} does not exists");
             var mailParameters = new MailParameter[]

src/database/SsiCredentialIssuer.DbAccess/Models/CredentialExpiryData.cs

@@ -29,7 +29,8 @@ public record CredentialExpiryData(
     string? DetailVersion,
     string Bpnl,
     CompanySsiDetailStatusId CompanySsiDetailStatusId,
-    VerifiedCredentialExternalTypeId VerifiedCredentialExternalTypeId,
+    VerifiedCredentialTypeId verifiedCredentialTypeId,
+    VerifiedCredentialExternalTypeId? VerifiedCredentialExternalTypeId,
     CredentialScheduleData ScheduleData);
 
 public record CredentialScheduleData(

src/database/SsiCredentialIssuer.DbAccess/Repositories/CompanySsiDetailsRepository.cs

@@ -305,6 +305,7 @@ public IAsyncEnumerable<CredentialExpiryData> GetExpiryData(DateTimeOffset now,
                 x.Details.VerifiedCredentialExternalTypeDetailVersion!.Version,
                 x.Details.Bpnl,
                 x.Details.CompanySsiDetailStatusId,
+                x.Details.VerifiedCredentialTypeId,
                 x.Details.VerifiedCredentialType!.VerifiedCredentialTypeAssignedExternalType!.VerifiedCredentialExternalTypeId,
                 new CredentialScheduleData(
                     x.IsVcToDelete,

tests/credentials/SsiCredentialIssuer.Expiry.App.Tests/ExpiryCheckServiceTests.cs

@@ -21,7 +21,9 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
+using Microsoft.OpenApi.Extensions;
 using Org.Eclipse.TractusX.Portal.Backend.Framework.DateTimeProvider;
+using Org.Eclipse.TractusX.Portal.Backend.Framework.Models;
 using Org.Eclipse.TractusX.Portal.Backend.Framework.Processes.Library.DBAccess;
 using Org.Eclipse.TractusX.Portal.Backend.Framework.Processes.Library.Enums;
 using Org.Eclipse.TractusX.SsiCredentialIssuer.DBAccess;
@@ -32,6 +34,7 @@
 using Org.Eclipse.TractusX.SsiCredentialIssuer.Expiry.App.DependencyInjection;
 using Org.Eclipse.TractusX.SsiCredentialIssuer.Portal.Service.Models;
 using Org.Eclipse.TractusX.SsiCredentialIssuer.Portal.Service.Services;
+using System.Runtime.CompilerServices;
 
 namespace Org.Eclipse.TractusX.SsiCredentialIssuer.Expiry.App.Tests;
 
@@ -98,7 +101,7 @@ public async Task ExecuteAsync_WithInactiveAndEligibleForDeletion_RemovesEntry()
             .Create();
         var data = new CredentialExpiryData[]
         {
-            new(credentialId, Guid.NewGuid().ToString(), inactiveVcsToDelete.AddDays(-1), null, null, Bpnl, CompanySsiDetailStatusId.INACTIVE, VerifiedCredentialExternalTypeId.MEMBERSHIP_CREDENTIAL, credentialScheduleData)
+            new(credentialId, Guid.NewGuid().ToString(), inactiveVcsToDelete.AddDays(-1), null, null, Bpnl, CompanySsiDetailStatusId.INACTIVE, VerifiedCredentialTypeId.MEMBERSHIP, VerifiedCredentialExternalTypeId.MEMBERSHIP_CREDENTIAL, credentialScheduleData)
         };
         A.CallTo(() => _dateTimeProvider.OffsetNow).Returns(now);
         A.CallTo(() => _companySsiDetailsRepository.GetExpiryData(A<DateTimeOffset>._, A<DateTimeOffset>._, A<DateTimeOffset>._))
@@ -130,7 +133,7 @@ public async Task ExecuteAsync_WithPendingAndExpiryBeforeNow_DeclinesRequest()
             .Create();
         var data = new CredentialExpiryData[]
         {
-            new(ssiDetail.Id, ssiDetail.CreatorUserId, ssiDetail.ExpiryDate!.Value, ssiDetail.ExpiryCheckTypeId, null, Bpnl, ssiDetail.CompanySsiDetailStatusId, VerifiedCredentialExternalTypeId.MEMBERSHIP_CREDENTIAL, credentialScheduleData)
+            new(ssiDetail.Id, ssiDetail.CreatorUserId, ssiDetail.ExpiryDate!.Value, ssiDetail.ExpiryCheckTypeId, null, Bpnl, ssiDetail.CompanySsiDetailStatusId, VerifiedCredentialTypeId.MEMBERSHIP, VerifiedCredentialExternalTypeId.MEMBERSHIP_CREDENTIAL, credentialScheduleData)
         };
         A.CallTo(() => _dateTimeProvider.OffsetNow).Returns(now);
         A.CallTo(() => _companySsiDetailsRepository.GetExpiryData(A<DateTimeOffset>._, A<DateTimeOffset>._, A<DateTimeOffset>._))
@@ -178,7 +181,7 @@ public async Task ExecuteAsync_WithActiveCloseToExpiry_NotifiesCreator(int days,
             .Create();
         var data = new CredentialExpiryData[]
         {
-            new(ssiDetail.Id, ssiDetail.CreatorUserId, ssiDetail.ExpiryDate!.Value, ssiDetail.ExpiryCheckTypeId, null, Bpnl, ssiDetail.CompanySsiDetailStatusId, VerifiedCredentialExternalTypeId.MEMBERSHIP_CREDENTIAL, credentialScheduleData)
+            new(ssiDetail.Id, ssiDetail.CreatorUserId, ssiDetail.ExpiryDate!.Value, ssiDetail.ExpiryCheckTypeId, null, Bpnl, ssiDetail.CompanySsiDetailStatusId, VerifiedCredentialTypeId.MEMBERSHIP, VerifiedCredentialExternalTypeId.MEMBERSHIP_CREDENTIAL, credentialScheduleData)
         };
         A.CallTo(() => _dateTimeProvider.OffsetNow).Returns(now);
         A.CallTo(() => _companySsiDetailsRepository.GetExpiryData(A<DateTimeOffset>._, A<DateTimeOffset>._, A<DateTimeOffset>._))
@@ -190,16 +193,18 @@ public async Task ExecuteAsync_WithActiveCloseToExpiry_NotifiesCreator(int days,
                 initialize?.Invoke(ssiDetail);
                 updateFields.Invoke(ssiDetail);
             });
+        var credentialNotification = A.Captured<string>();
+        A.CallTo(() => _portalService.AddNotification(credentialNotification._, creatorUserId, NotificationTypeId.CREDENTIAL_EXPIRY, A<CancellationToken>._)).DoesNothing();
 
         // Act
         await _sut.ExecuteAsync(CancellationToken.None);
 
         // Assert
         A.CallTo(() => _companySsiDetailsRepository.RemoveSsiDetail(ssiDetail.Id, A<string>._, A<string>._)).MustNotHaveHappened();
         A.CallTo(() => _issuerRepositories.SaveAsync()).MustHaveHappenedOnceExactly();
-        A.CallTo(() => _portalService.AddNotification(A<string>._, creatorUserId, NotificationTypeId.CREDENTIAL_EXPIRY, A<CancellationToken>._)).MustHaveHappenedOnceExactly();
         A.CallTo(() => _portalService.TriggerMail("CredentialExpiry", creatorUserId, A<IEnumerable<MailParameter>>._, A<CancellationToken>._)).MustHaveHappenedOnceExactly();
 
+        credentialNotification.GetLastValue().Should().ContainAll(VerifiedCredentialExternalTypeId.MEMBERSHIP_CREDENTIAL.GetEnumValue(), VerifiedCredentialTypeId.MEMBERSHIP.GetEnumValue());
         ssiDetail.ExpiryCheckTypeId.Should().Be(expiryCheckTypeId);
     }
 }