Do enrichment in the right order.

Author: SebastianStehle

sdk/Notifo.SDK/INotifoMobilePush.ios.cs

@@ -22,9 +22,9 @@ public partial interface INotifoMobilePush
     /// Method for processing notification before delivery.
     /// </summary>
     /// <param name="request">The request that was received.</param>
-    /// <param name="bestAttemptContent">The notification content.</param>
+    /// <param name="content">The notification content to enrich.</param>
     /// <returns>A <see cref="Task"/> representing the result of the asynchronous operation.</returns>
-    Task DidReceiveNotificationRequestAsync(UNNotificationRequest request, UNMutableNotificationContent bestAttemptContent);
+    Task DidReceiveNotificationRequestAsync(UNNotificationRequest request, UNMutableNotificationContent content);
 
     /// <summary>
     /// Method for pulling pending notifications.

sdk/Notifo.SDK/NotifoMobilePush/NotifoMobilePushImplementation.android.cs

@@ -27,12 +27,14 @@ partial void SetupPlatform()
         OnNotificationReceived += PushEventsProvider_OnNotificationReceivedAndroid;
     }
 
+    /// <inheritdoc />
     public INotifoMobilePush SetNotificationHandler(INotificationHandler? notificationHandler)
     {
         this.notificationHandler = notificationHandler;
         return this;
     }
 
+    /// <inheritdoc />
     public INotifoMobilePush SetImageCacheCapacity(int capacity)
     {
         bitmapCache.EnsureCapacity(capacity);

sdk/Notifo.SDK/NotifoMobilePush/NotifoMobilePushImplementation.ios.cs

@@ -17,24 +17,36 @@ internal partial class NotifoMobilePushImplementation : NSObject
 {
     private INotificationHandler? notificationHandler;
 
+    /// <inheritdoc />
     public INotifoMobilePush SetNotificationHandler(INotificationHandler? notificationHandler)
     {
         this.notificationHandler = notificationHandler;
         return this;
     }
 
-    public async Task DidReceiveNotificationRequestAsync(UNNotificationRequest request, UNMutableNotificationContent bestAttemptContent)
+    /// <inheritdoc />
+    public async Task DidReceiveNotificationRequestAsync(UNNotificationRequest request, UNMutableNotificationContent content)
     {
         RaiseDebug(Strings.ReceivedNotification, this, request.Content.UserInfo);
 
         var notification = new UserNotificationDto().FromDictionary(request.Content.UserInfo.ToDictionary());
 
-        await EnrichNotificationContentAsync(bestAttemptContent, notification);
+        // We have ony limited time in the notification service, so we dot things in the right order.
 
-        // Always track our notifications as seen.
+        // 1. Do the cheap enrichment first.
+        await EnrichBasicAsync(content, notification);
+
+        // 2. Do the tracking to ensure that the request arrives.
         await TrackNotificationsAsync(notification);
+
+        // 3. Enrich with images, which need to be downloaded.
+        await EnrichImagesAsync(content, notification);
+
+        // 4. Custom enrichment code (could be potentially be expensive).
+        EnrichWithCustomCode(content, notification);
     }
 
+    /// <inheritdoc />
     public async Task DidReceivePullRefreshRequestAsync(PullRefreshOptions? options = null)
     {
         options ??= new PullRefreshOptions();
@@ -131,10 +143,15 @@ private void OnReceived(NotificationEventArgs eventArgs)
 
     private async Task ShowLocalNotificationAsync(UserNotificationDto notification)
     {
-        var content = new UNMutableNotificationContent();
+        var content = new UNMutableNotificationContent
+        {
+            UserInfo = notification.ToDictionary().ToNSDictionary()
+        };
+
+        await EnrichBasicAsync(content, notification);
+        await EnrichImagesAsync(content, notification);
 
-        content = await EnrichNotificationContentAsync(content, notification);
-        content.UserInfo = notification.ToDictionary().ToNSDictionary();
+        EnrichWithCustomCode(content, notification);
 
         var request = UNNotificationRequest.FromIdentifier(notification.Id.ToString(), content, trigger: null);
 
@@ -147,7 +164,7 @@ private async Task ShowLocalNotificationAsync(UserNotificationDto notification)
         });
     }
 
-    private async Task<UNMutableNotificationContent> EnrichNotificationContentAsync(UNMutableNotificationContent content, UserNotificationDto notification)
+    private async Task EnrichBasicAsync(UNMutableNotificationContent content, UserNotificationDto notification)
     {
         if (!string.IsNullOrWhiteSpace(notification.Subject))
         {
@@ -159,8 +176,6 @@ private async Task<UNMutableNotificationContent> EnrichNotificationContentAsync(
             content.Body = notification.Body;
         }
 
-        await AddImageAsync(content, notification);
-
         var actions = new List<UNNotificationAction>();
 
         if (!string.IsNullOrWhiteSpace(notification.ConfirmUrl) &&
@@ -226,12 +241,15 @@ private async Task<UNMutableNotificationContent> EnrichNotificationContentAsync(
 
         content.Sound ??= UNNotificationSound.Default;
 
-        notificationHandler?.OnBuildNotification(content, notification);
+        EnrichWithCustomCode(content, notification);
+    }
 
-        return content;
+    private void EnrichWithCustomCode(UNMutableNotificationContent content, UserNotificationDto notification)
+    {
+        notificationHandler?.OnBuildNotification(content, notification);
     }
 
-    private async Task AddImageAsync(UNMutableNotificationContent content, UserNotificationDto notification)
+    private async Task EnrichImagesAsync(UNMutableNotificationContent content, UserNotificationDto notification)
     {
         var image = string.IsNullOrWhiteSpace(notification.ImageLarge) ? notification.ImageSmall : notification.ImageLarge;