Repository logic for retrieving sms notifications #GCPActive (#401)

* functionality implemented

* all tests running green

* added integration test for get new notifications

* explicitly closing reader connection.

* Connection Idle Lifetime=60 for integration tests

* fixed code smells

* fixed pr comments

Author: acn-sbuad

src/Altinn.Notifications.Core/Models/Sms.cs

@@ -0,0 +1,51 @@
+using System.Text.Json;
+
+namespace Altinn.Notifications.Core.Models;
+
+/// <summary>
+/// Class representing an sms
+/// </summary>
+public class Sms
+{
+    /// <summary>
+    /// Gets or sets the id of the sms.
+    /// </summary>
+    public Guid NotificationId { get; set; }
+
+    /// <summary>
+    /// Gets or sets the sender of the sms message
+    /// </summary>
+    /// <remarks>
+    /// Can be a literal string or a phone number
+    /// </remarks>
+    public string Sender { get; set; }
+
+    /// <summary>
+    /// Gets or sets the recipient of the sms message
+    /// </summary>
+    public string Recipient { get; set; }
+
+    /// <summary>
+    /// Gets or sets the contents of the sms message
+    /// </summary>
+    public string Message { get; set; }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="Sms"/> class.
+    /// </summary>
+    public Sms(Guid notificationId, string sender, string recipient, string message)
+    {
+        NotificationId = notificationId;
+        Recipient = recipient;
+        Sender = sender;
+        Message = message;
+    }
+
+    /// <summary>
+    /// Json serializes the <see cref="Sms"/>
+    /// </summary>
+    public string Serialize()
+    {
+        return JsonSerializer.Serialize(this, JsonSerializerOptionsProvider.Options);
+    }
+}

src/Altinn.Notifications.Core/Persistence/ISmsNotificationRepository.cs

@@ -1,4 +1,5 @@
-using Altinn.Notifications.Core.Models.Notification;
+using Altinn.Notifications.Core.Models;
+using Altinn.Notifications.Core.Models.Notification;
 
 namespace Altinn.Notifications.Core.Persistence;
 
@@ -11,4 +12,10 @@ public interface ISmsNotificationRepository
     /// Adds a new sms notification to the database
     /// </summary>
     public Task AddNotification(SmsNotification notification, DateTime expiry);
+
+    /// <summary>
+    /// Retrieves all sms notifications with status 'New'
+    /// </summary>
+    /// <returns>A list of sms</returns>
+    public Task<List<Sms>> GetNewNotifications();
 }

src/Altinn.Notifications.Persistence/Migration/v0.18/01-setup-function.sql

@@ -0,0 +1,23 @@
+CREATE OR REPLACE FUNCTION notifications.getsms_statusnew_updatestatus()
+    RETURNS TABLE(alternateid uuid, sendernumber text, mobilenumber text, body text) 
+    LANGUAGE 'plpgsql'
+    COST 100
+    VOLATILE PARALLEL UNSAFE
+    ROWS 1000
+AS $BODY$
+BEGIN
+		
+    RETURN query 
+    WITH updated AS (
+        UPDATE notifications.smsnotifications
+        SET result = 'Sending', resulttime = now()
+        WHERE result = 'New' 
+        RETURNING notifications.smsnotifications.alternateid, _orderid, notifications.smsnotifications.mobilenumber)
+    SELECT u.alternateid, st.sendernumber, u.mobilenumber, st.body
+    FROM updated u, notifications.smstexts st
+    WHERE u._orderid = st._orderid;    
+END;
+$BODY$;
+
+ALTER FUNCTION notifications.getsms_statusnew_updatestatus()
+    OWNER TO platform_notifications_admin;

src/Altinn.Notifications.Persistence/Repository/EmailNotificationRepository.cs

@@ -11,7 +11,7 @@
 namespace Altinn.Notifications.Persistence.Repository;
 
 /// <summary>
-/// Implementation of order repository logic
+/// Implementation of email notification repository logic
 /// </summary>
 public class EmailNotificationRepository : IEmailNotificationRepository
 {

src/Altinn.Notifications.Persistence/Repository/SmsNotificationRepository.cs

@@ -1,7 +1,12 @@
-using Altinn.Notifications.Core.Models.Notification;
+using Altinn.Notifications.Core.Models;
+using Altinn.Notifications.Core.Models.Notification;
 using Altinn.Notifications.Core.Persistence;
+using Altinn.Notifications.Persistence.Extensions;
+
 using Microsoft.ApplicationInsights;
+
 using Npgsql;
+
 using NpgsqlTypes;
 
 namespace Altinn.Notifications.Persistence.Repository;
@@ -15,6 +20,7 @@ public class SmsNotificationRepository : ISmsNotificationRepository
     private readonly TelemetryClient? _telemetryClient;
 
     private const string _insertSmsNotificationSql = "call notifications.insertsmsnotification($1, $2, $3, $4, $5, $6, $7)"; // (__orderid, _alternateid, _recipientid, _mobilenumber, _result, _resulttime, _expirytime)
+    private const string _getSmsNotificationsSql = "select * from notifications.getsms_statusnew_updatestatus()";
 
     /// <summary>
     /// Initializes a new instance of the <see cref="SmsNotificationRepository"/> class.
@@ -44,4 +50,29 @@ public async Task AddNotification(SmsNotification notification, DateTime expiry)
         await pgcom.ExecuteNonQueryAsync();
         tracker.Track();
     }
+
+    /// <inheritdoc/>
+    public async Task<List<Sms>> GetNewNotifications()
+    {
+        List<Sms> searchResult = new();
+        await using NpgsqlCommand pgcom = _dataSource.CreateCommand(_getSmsNotificationsSql);
+        using TelemetryTracker tracker = new(_telemetryClient, pgcom);
+
+        await using (NpgsqlDataReader reader = await pgcom.ExecuteReaderAsync())
+        {
+            while (await reader.ReadAsync())
+            {
+                var sms = new Sms(
+                    reader.GetValue<Guid>("alternateid"),
+                    reader.GetValue<string>("sendernumber"),
+                    reader.GetValue<string>("mobilenumber"),
+                    reader.GetValue<string>("body"));
+
+                searchResult.Add(sms);
+            }
+        }
+
+        tracker.Track();
+        return searchResult;
+    }
 }

test/Altinn.Notifications.IntegrationTests/Notifications.Persistence/OrderRepositoryTests.cs

@@ -10,7 +10,7 @@ namespace Altinn.Notifications.IntegrationTests.Notifications.Persistence
 {
     public class OrderRepositoryTests : IAsyncLifetime
     {
-        private List<Guid> orderIdsToDelete;
+        private readonly List<Guid> orderIdsToDelete;
 
         public OrderRepositoryTests()
         {
@@ -44,7 +44,8 @@ public async Task Create_OrderWithSmsTemplate_SmsTextsPersisted()
                 Templates = new List<INotificationTemplate>()
                 {
                     new SmsTemplate("Altinn", "This is the body")
-                }
+                },
+                RequestedSendTime = DateTime.UtcNow
             };
 
             orderIdsToDelete.Add(order.Id);

test/Altinn.Notifications.IntegrationTests/Notifications.Persistence/SmsRepositoryTests.cs renamed to test/Altinn.Notifications.IntegrationTests/Notifications.Persistence/SmsNotificationRepositoryTests.cs

@@ -1,18 +1,19 @@
-using Altinn.Notifications.Core.Enums;
+using Altinn.Notifications.Core.Models;
 using Altinn.Notifications.Core.Models.Notification;
 using Altinn.Notifications.Core.Models.Orders;
 using Altinn.Notifications.Core.Persistence;
 using Altinn.Notifications.IntegrationTests.Utils;
 using Altinn.Notifications.Persistence.Repository;
+
 using Xunit;
 
 namespace Altinn.Notifications.IntegrationTests.Notifications.Persistence;
 
-public class SmsRepositoryTests : IAsyncLifetime
+public class SmsNotificationRepositoryTests : IAsyncLifetime
 {
-    private List<Guid> orderIdsToDelete;
+    private readonly List<Guid> orderIdsToDelete;
 
-    public SmsRepositoryTests()
+    public SmsNotificationRepositoryTests()
     {
         orderIdsToDelete = [];
     }
@@ -29,7 +30,7 @@ public async Task DisposeAsync()
     }
 
     [Fact]
-    public async Task Create_SmsNotification()
+    public async Task AddNotification()
     {
         // Arrange
         Guid orderId = await PostgreUtil.PopulateDBWithOrderAndReturnId();
@@ -60,5 +61,23 @@ FROM notifications.smsnotifications o
         int actualCount = await PostgreUtil.RunSqlReturnOutput<int>(sql);
 
         Assert.Equal(1, actualCount);
-    }   
+    }
+
+    [Fact]
+    public async Task GetNewNotifications()
+    {
+        // Arrange
+        (NotificationOrder order, SmsNotification smsNotification) = await PostgreUtil.PopulateDBWithOrderAndSmsNotification();
+        orderIdsToDelete.Add(order.Id);
+
+        SmsNotificationRepository repo = (SmsNotificationRepository)ServiceUtil
+          .GetServices(new List<Type>() { typeof(ISmsNotificationRepository) })
+          .First(i => i.GetType() == typeof(SmsNotificationRepository));
+
+        // Act
+        List<Sms> smsToBeSent = await repo.GetNewNotifications();
+
+        // Assert
+        Assert.NotEmpty(smsToBeSent.Where(s => s.NotificationId == smsNotification.Id));
+    }
 }

test/Altinn.Notifications.IntegrationTests/Utils/PostgreUtil.cs

@@ -71,6 +71,25 @@ public static async Task<NotificationOrder> PopulateDBWithOrderAndEmailNotificat
         return o;
     }
 
+    public static async Task<(NotificationOrder Order, SmsNotification SmsNotification)> PopulateDBWithOrderAndSmsNotification(string? sendersReference = null)
+    {
+        (NotificationOrder order, SmsNotification smsNotification) = TestdataUtil.GetOrderAndSmsNotification();
+        var serviceList = ServiceUtil.GetServices(new List<Type>() { typeof(IOrderRepository), typeof(ISmsNotificationRepository) });
+
+        OrderRepository orderRepo = (OrderRepository)serviceList.First(i => i.GetType() == typeof(OrderRepository));
+        SmsNotificationRepository notificationRepo = (SmsNotificationRepository)serviceList.First(i => i.GetType() == typeof(SmsNotificationRepository));
+
+        if (sendersReference != null)
+        {
+            order.SendersReference = sendersReference;
+        }
+
+        await orderRepo.Create(order);
+        await notificationRepo.AddNotification(smsNotification, DateTime.UtcNow.AddDays(1));
+
+        return (order, smsNotification);
+    }
+
     public static async Task DeleteOrderFromDb(string sendersRef)
     {
         string sql = $"delete from notifications.orders where sendersreference = '{sendersRef}'";
@@ -87,7 +106,6 @@ public static async Task<T> RunSqlReturnOutput<T>(string query)
         await reader.ReadAsync();
 
         T result = reader.GetValue<T>(0);
-
         return result;
     }
 

test/Altinn.Notifications.IntegrationTests/Utils/TestdataUtil.cs

@@ -9,6 +9,26 @@ namespace Altinn.Notifications.IntegrationTests.Utils;
 
 public static class TestdataUtil
 {
+    public static (NotificationOrder Order, SmsNotification Notification) GetOrderAndSmsNotification()
+    {
+        NotificationOrder order = NotificationOrder_SmsTemplate_OneRecipient();
+        order.Id = Guid.NewGuid();
+        var recipient = order.Recipients[0];
+        SmsAddressPoint? addressPoint = recipient.AddressInfo.Find(a => a.AddressType == AddressType.Sms) as SmsAddressPoint;
+
+        var smsNotification = new SmsNotification()
+        {
+            Id = Guid.NewGuid(),
+            OrderId = order.Id,
+            RequestedSendTime = order.RequestedSendTime,
+            RecipientNumber = addressPoint!.MobileNumber,
+            RecipientId = recipient.RecipientId,
+            SendResult = new(SmsNotificationResultType.New, DateTime.UtcNow)
+        };
+
+        return (order, smsNotification);
+    }
+
     public static (NotificationOrder Order, EmailNotification Notification) GetOrderAndEmailNotification()
     {
         NotificationOrder order = NotificationOrder_EmailTemplate_OneRecipient();
@@ -69,4 +89,43 @@ public static NotificationOrder NotificationOrder_EmailTemplate_OneRecipient()
             }
         };
     }
+
+    /// <summary>
+    /// NOTE! Overwrite id with a new GUID to ensure it is unique in the test scope.
+    /// </summary>
+    public static NotificationOrder NotificationOrder_SmsTemplate_OneRecipient()
+    {
+        return new NotificationOrder()
+        {
+            SendersReference = "local-testing",
+            Templates = new List<INotificationTemplate>()
+            {
+                new SmsTemplate()
+                {
+                    Type = NotificationTemplateType.Sms,
+                    Body = "email-body",
+                    SenderNumber = "Altinn local test"
+                }
+            },
+            RequestedSendTime = new DateTime(2023, 06, 16, 08, 50, 00, DateTimeKind.Utc),
+            NotificationChannel = NotificationChannel.Sms,
+            Creator = new("ttd"),
+            Created = new DateTime(2023, 06, 16, 08, 45, 00, DateTimeKind.Utc),
+            Recipients = new List<Recipient>()
+            {
+                new Recipient()
+                {
+                    RecipientId = "recipient1",
+                    AddressInfo = new()
+                    {
+                        new SmsAddressPoint()
+                        {
+                            AddressType = AddressType.Sms,
+                            MobileNumber = "+4799999999"
+                        }
+                    }
+                }
+            }
+        };
+    }
 }

test/Altinn.Notifications.IntegrationTests/appsettings.IntegrationTest.json

@@ -1,6 +1,8 @@
 {
   "PostgreSQLSettings": {
     "EnableDBConnection": true,
+    "AdminConnectionString": "Host=localhost;Port=5432;Username=platform_notifications_admin;Password={0};Database=notificationsdb;Connection Idle Lifetime=60",
+    "ConnectionString": "Host=localhost;Port=5432;Username=platform_notifications;Password={0};Database=notificationsdb;Connection Idle Lifetime=60",
     "MigrationScriptPath": "../../../../src/Altinn.Notifications.Persistence/Migration",
     "EnableDebug": false
   },