Improvements to tracking.

SebastianStehle · SebastianStehle · commit 5054b4c17ff0 · 2022-11-18T13:41:02.000+01:00
diff --git a/sample/Sample.iOS.Shared/Sample.iOS.Shared.csproj b/sample/Sample.iOS.Shared/Sample.iOS.Shared.csproj
@@ -50,7 +50,7 @@
     </ProjectReference>
   </ItemGroup>
   <ItemGroup>
-    <PackageReference Include="Notifo.SDK" Version="1.3.0" />
+    <PackageReference Include="Notifo.SDK" Version="1.5.1" />
   </ItemGroup>
   <Import Project="$(MSBuildExtensionsPath)\Xamarin\iOS\Xamarin.iOS.CSharp.targets" />
 </Project>
diff --git a/sample/Sample.iOS/Application.cs b/sample/Sample.iOS/Application.cs
@@ -5,7 +5,6 @@
 //  All rights reserved. Licensed under the MIT license.
 // ==========================================================================
 
-using Foundation;
 using UIKit;
 
 #pragma warning disable SA1300 // Element should begin with upper-case letter
diff --git a/sample/SampleNotificationServiceExtension/SampleNotificationServiceExtension.csproj b/sample/SampleNotificationServiceExtension/SampleNotificationServiceExtension.csproj
@@ -90,8 +90,8 @@
     <Reference Include="Newtonsoft.Json, Version=13.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed, processorArchitecture=MSIL">
       <HintPath>..\..\packages\Newtonsoft.Json.13.0.1\lib\netstandard2.0\Newtonsoft.Json.dll</HintPath>
     </Reference>
-    <Reference Include="Notifo.SDK, Version=1.3.0.0, Culture=neutral, processorArchitecture=MSIL">
-      <HintPath>..\..\packages\Notifo.SDK.1.3.0\lib\netstandard2.1\Notifo.SDK.dll</HintPath>
+    <Reference Include="Notifo.SDK, Version=1.5.1.0, Culture=neutral, processorArchitecture=MSIL">
+      <HintPath>..\..\packages\Notifo.SDK.1.5.1\lib\netstandard2.1\Notifo.SDK.dll</HintPath>
     </Reference>
     <Reference Include="System" />
     <Reference Include="System.Xml" />
diff --git a/sample/SampleNotificationServiceExtension/packages.config b/sample/SampleNotificationServiceExtension/packages.config
@@ -1,6 +1,6 @@
 ﻿<?xml version="1.0" encoding="utf-8"?>
 <packages>
   <package id="Newtonsoft.Json" version="13.0.1" targetFramework="xamarinios10" />
-  <package id="Notifo.SDK" version="1.3.0" targetFramework="xamarinios10" />
+  <package id="Notifo.SDK" version="1.5.1" targetFramework="xamarinios10" />
   <package id="System.ComponentModel.Annotations" version="5.0.0" targetFramework="xamarinios10" />
 </packages>
diff --git a/sdk/Notifo.SDK.FirebasePlugin/Notifo.SDK.FirebasePlugin.csproj b/sdk/Notifo.SDK.FirebasePlugin/Notifo.SDK.FirebasePlugin.csproj
@@ -53,7 +53,7 @@
   </ItemGroup>
 
   <ItemGroup>
-	<PackageReference Include="Notifo.SDK" Version="1.3.0" />
+	<PackageReference Include="Notifo.SDK" Version="1.5.1" />
 	<PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="5.0.0" />
   </ItemGroup>
 
diff --git a/sdk/Notifo.SDK.FirebasePlugin/NotifoMobilePushExtensions.cs b/sdk/Notifo.SDK.FirebasePlugin/NotifoMobilePushExtensions.cs
@@ -23,9 +23,7 @@ public static class NotifoMobilePushExtensions
         /// <summary>
         /// Use the firebase plugin as the push events provider.
         /// </summary>
-        /// <param name="notifoMobilePush">
-        /// The <see cref="INotifoMobilePush"/> instance.
-        /// </param>
+        /// <param name="notifoMobilePush">The <see cref="INotifoMobilePush"/> instance.</param>
         /// <returns>The current instance.</returns>
         public static INotifoMobilePush UseFirebasePluginEventsProvider(this INotifoMobilePush notifoMobilePush)
         {
diff --git a/sdk/Notifo.SDK/ApiVersion.cs b/sdk/Notifo.SDK/ApiVersion.cs
@@ -0,0 +1,25 @@
+﻿// ==========================================================================
+//  Notifo.io
+// ==========================================================================
+//  Copyright (c) Sebastian Stehle
+//  All rights reserved. Licensed under the MIT license.
+// ==========================================================================
+
+namespace Notifo.SDK
+{
+    /// <summary>
+    /// The target version.
+    /// </summary>
+    public enum ApiVersion
+    {
+        /// <summary>
+        /// Uses only old API versions.
+        /// </summary>
+        Version_1_0,
+
+        /// <summary>
+        /// Uses also APIs that are only available after 1.5.
+        /// </summary>
+        Version_1_5
+    }
+}
diff --git a/sdk/Notifo.SDK/Constants.cs b/sdk/Notifo.SDK/Constants.cs
@@ -47,6 +47,8 @@ internal static class Constants
 
         public const string SubjectKey = "subject";
 
-        public const string TrackingUrlKey = "trackingUrl";
+        public const string TrackingTokenKey = "trackingToken";
+
+        public const string TrackSeenUrlKey = "trackingUrl";
     }
 }
diff --git a/sdk/Notifo.SDK/Extensions/UserNotificationDtoExtensions.cs b/sdk/Notifo.SDK/Extensions/UserNotificationDtoExtensions.cs
@@ -63,9 +63,14 @@ public static Dictionary<string, string> ToDictionary(this UserNotificationDto n
 
             data[Constants.SilentKey] = notification.Silent.ToString();
 
+            if (!string.IsNullOrWhiteSpace(notification.TrackingToken))
+            {
+                data[Constants.TrackingTokenKey] = notification.TrackingToken;
+            }
+
             if (!string.IsNullOrWhiteSpace(notification.TrackSeenUrl))
             {
-                data[Constants.TrackingUrlKey] = notification.TrackSeenUrl;
+                data[Constants.TrackSeenUrlKey] = notification.TrackSeenUrl;
             }
 
             if (!string.IsNullOrWhiteSpace(notification.Data))
@@ -141,7 +146,12 @@ public static UserNotificationDto FromDictionary(this UserNotificationDto notifi
                 notification.Silent = Convert.ToBoolean(silent.ToString());
             }
 
-            if (data.TryGetValue(Constants.TrackingUrlKey, out var trackingUrl))
+            if (data.TryGetValue(Constants.TrackingTokenKey, out var trackingToken))
+            {
+                notification.TrackingToken = trackingToken.ToString();
+            }
+
+            if (data.TryGetValue(Constants.TrackSeenUrlKey, out var trackingUrl))
             {
                 notification.TrackSeenUrl = trackingUrl.ToString();
             }
diff --git a/sdk/Notifo.SDK/INotifoMobilePush.cs b/sdk/Notifo.SDK/INotifoMobilePush.cs
@@ -31,29 +31,37 @@ public partial interface INotifoMobilePush : INotifoClient
         event EventHandler<NotificationErrorEventArgs> OnError;
 
         /// <summary>
-        /// Sets the api key to use.
+        /// The used API version.
+        /// </summary>
+        ApiVersion ApiVersion { get; }
+
+        /// <summary>
+        /// Sets the API key to use.
         /// </summary>
         /// <param name="apiKey">
-        /// The api key.
+        /// The API key.
         /// </param>
         /// <returns>The current instance.</returns>
         INotifoMobilePush SetApiKey(string apiKey);
 
+        /// <summary>
+        /// Sets the API version to use.
+        /// </summary>
+        /// <param name="apiVersion">The API version.</param>
+        /// <returns>The current instance.</returns>
+        INotifoMobilePush SetApiVersion(ApiVersion apiVersion);
+
         /// <summary>
         /// Sets the api URL to use.
         /// </summary>
-        /// <param name="baseUrl">
-        /// The api URL. Default: https://app.notifo.io.
-        /// </param>
+        /// <param name="baseUrl">The api URL. Default: https://app.notifo.io.</param>
         /// <returns>The current instance.</returns>
         INotifoMobilePush SetBaseUrl(string baseUrl);
 
         /// <summary>
         /// Sets the push events provider.
         /// </summary>
-        /// <param name="pushEventsProvider">
-        /// The <see cref="IPushEventsProvider"/> implementation.
-        /// </param>
+        /// <param name="pushEventsProvider">The <see cref="IPushEventsProvider"/> implementation. </param>
         /// <returns>The current instance.</returns>
         INotifoMobilePush SetPushEventsProvider(IPushEventsProvider pushEventsProvider);
 
diff --git a/sdk/Notifo.SDK/Notifo.SDK.Core.csproj b/sdk/Notifo.SDK/Notifo.SDK.Core.csproj
@@ -48,7 +48,7 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="5.0.0" />
     <PackageReference Include="Microsoft.Extensions.Http.Polly" Version="5.0.1" />
-    <PackageReference Include="Notifo.SDK" Version="1.3.0" />
+    <PackageReference Include="Notifo.SDK" Version="1.5.1" />
     <PackageReference Include="Polly" Version="7.2.1" />
     <PackageReference Include="RefactoringEssentials" Version="5.6.0">
       <PrivateAssets>all</PrivateAssets>
diff --git a/sdk/Notifo.SDK/NotifoMobilePush/Device.cs b/sdk/Notifo.SDK/NotifoMobilePush/Device.cs
@@ -0,0 +1,33 @@
+﻿// ==========================================================================
+//  Notifo.io
+// ==========================================================================
+//  Copyright (c) Sebastian Stehle
+//  All rights reserved. Licensed under the MIT license.
+// ==========================================================================
+
+using System;
+using Xamarin.Essentials;
+
+namespace Notifo.SDK.NotifoMobilePush
+{
+    internal static class Device
+    {
+        private static string value;
+
+        public static string DeviceIdentifier
+        {
+            get
+            {
+                if (value != null)
+                {
+                    return value;
+                }
+
+                value = Guid.NewGuid().ToString();
+
+                Preferences.Set(nameof(DeviceIdentifier), value);
+                return value;
+            }
+        }
+    }
+}
diff --git a/sdk/Notifo.SDK/NotifoMobilePush/NotifoMobilePushImplementation.ios.cs b/sdk/Notifo.SDK/NotifoMobilePush/NotifoMobilePushImplementation.ios.cs
@@ -10,6 +10,7 @@
 using System.IO;
 using System.Linq;
 using System.Net.Http;
+using System.Threading;
 using System.Threading.Tasks;
 using Foundation;
 using Notifo.SDK.Extensions;
@@ -53,7 +54,7 @@ public async Task DidReceivePullRefreshRequestAsync(PullRefreshOptions? options
             options ??= new PullRefreshOptions();
 
             // iOS does not maintain a queue of undelivered notifications, therefore we have to query here.
-            var notifications = await GetPendingNotificationsAsync(options.Take, options.Period);
+            var notifications = await GetPendingNotificationsAsync(options.Take, options.Period, default);
 
             foreach (var notification in notifications)
             {
@@ -76,36 +77,42 @@ public async Task DidReceivePullRefreshRequestAsync(PullRefreshOptions? options
             await TrackNotificationsAsync(notifications.ToArray());
         }
 
-        private async Task<IEnumerable<UserNotificationDto>> GetPendingNotificationsAsync(int take, TimeSpan maxAge)
+        private async Task<IEnumerable<UserNotificationDto>> GetPendingNotificationsAsync(int take, TimeSpan maxAge,
+            CancellationToken ct)
         {
             try
             {
-                var notificationPending = await Notifications.GetMyNotificationsAsync(take: take);
+                var after = DateTime.UtcNow.Subtract(maxAge);
 
-                if (notificationPending.Items.Count == 0)
+                List<UserNotificationDto> notifications;
+
+                if (ApiVersion == ApiVersion.Version_1_0)
                 {
-                    return Enumerable.Empty<UserNotificationDto>();
+                    notifications = await GetPendingNotifications1_0Async(take, after, ct);
+                }
+                else
+                {
+                    try
+                    {
+                        notifications = await GetPendingNotifications1_4Async(take, after, ct);
+                    }
+                    catch (NotifoException ex) when (ex.StatusCode == 404)
+                    {
+                        notifications = await GetPendingNotifications1_0Async(take, after, ct);
+                    }
                 }
 
-                var currentSeen = await GetSeenNotificationsAsync();
-                var currentTime = DateTimeOffset.UtcNow;
-
-                // Only take the recent notifications into account (default: 3 days).
-                bool IsRecent(DateTimeOffset date)
+                if (notifications.Count == 0)
                 {
-                    return (currentTime - date.UtcDateTime) <= maxAge;
+                    return Enumerable.Empty<UserNotificationDto>();
                 }
 
-                var pendingNotifications = notificationPending.Items
-                    .Where(n => !n.IsSeen)
-                    .Where(n => !currentSeen.Contains(n.Id))
-                    .Where(n => IsRecent(n.Created))
-                    .OrderBy(x => x.Created)
-                    .ToArray();
+                var notificationsSeen = await GetSeenNotificationsAsync();
+                var notificationsPending = notifications.Where(n => !notificationsSeen.Contains(n.Id)).OrderBy(x => x.Created).ToArray();
 
-                Log.Debug(Strings.PendingNotificationsCount, pendingNotifications.Length);
+                Log.Debug(Strings.PendingNotificationsCount, notificationsPending.Length);
 
-                return pendingNotifications;
+                return notificationsPending;
             }
             catch (Exception ex)
             {
@@ -115,6 +122,22 @@ bool IsRecent(DateTimeOffset date)
             return Array.Empty<UserNotificationDto>();
         }
 
+        private async Task<List<UserNotificationDto>> GetPendingNotifications1_0Async(int take, DateTime after,
+            CancellationToken ct)
+        {
+            var result = await Notifications.GetMyNotificationsAsync(take: take, cancellationToken: ct);
+
+            return result.Items.Where(x => x.Created >= after).ToList();
+        }
+
+        private async Task<List<UserNotificationDto>> GetPendingNotifications1_4Async(int take, DateTime after,
+            CancellationToken ct)
+        {
+            var result = await Notifications.GetMyDeviceNotificationsAsync(token, after, true, take * 2, ct);
+
+            return result.Items;
+        }
+
         private void OnReceived(NotificationEventArgs eventArgs)
         {
             OnNotificationReceived?.Invoke(this, eventArgs);
@@ -209,7 +232,7 @@ private async Task<UNMutableNotificationContent> EnrichNotificationContentAsync(
 
                 UNUserNotificationCenter.Current.SetNotificationCategories(new NSSet<UNNotificationCategory>(categories.ToArray()));
 
-                // Without this call action buttons will not be added or updated
+                // Without this call action buttons will not be added or updated.
                 _ = await UNUserNotificationCenter.Current.GetNotificationCategoriesAsync();
 
                 content.CategoryIdentifier = categoryId;
diff --git a/sdk/Notifo.SDK/NotifoMobilePush/NotifoMobilePushImplementation.shared.cs b/sdk/Notifo.SDK/NotifoMobilePush/NotifoMobilePushImplementation.shared.cs
@@ -30,6 +30,9 @@ internal partial class NotifoMobilePushImplementation : INotifoMobilePush
         /// <inheritdoc/>
         public event EventHandler<NotificationErrorEventArgs> OnError;
 
+        /// <inheritdoc/>
+        public ApiVersion ApiVersion { get; private set; }
+
         /// <inheritdoc/>
         public IAppsClient Apps => clientProvider.Client.Apps;
 
@@ -78,7 +81,8 @@ internal partial class NotifoMobilePushImplementation : INotifoMobilePush
         /// <inheritdoc/>
         public IUserClient User => clientProvider.Client.User;
 
-        public NotifoMobilePushImplementation(Func<HttpClient> httpClientFactory, ISeenNotificationsStore seenNotificationsStore, ICommandQueue commandQueue)
+        public NotifoMobilePushImplementation(Func<HttpClient> httpClientFactory,
+            ISeenNotificationsStore seenNotificationsStore, ICommandQueue commandQueue)
         {
             this.seenNotificationsStore = seenNotificationsStore;
             this.commandQueue = commandQueue;
@@ -109,6 +113,13 @@ public INotifoMobilePush SetBaseUrl(string baseUrl)
             return this;
         }
 
+        /// <inheritdoc/>
+        public INotifoMobilePush SetApiVersion(ApiVersion apiVersion)
+        {
+            ApiVersion = apiVersion;
+            return this;
+        }
+
         /// <inheritdoc/>
         public INotifoMobilePush SetPushEventsProvider(IPushEventsProvider pushEventsProvider)
         {
diff --git a/sdk/Notifo.SDK/NotifoMobilePush/TokenRegisterCommand.cs b/sdk/Notifo.SDK/NotifoMobilePush/TokenRegisterCommand.cs
diff --git a/sdk/Notifo.SDK/NotifoMobilePush/TrackSeenCommand.cs b/sdk/Notifo.SDK/NotifoMobilePush/TrackSeenCommand.cs
diff --git a/tests/Notifo.SDK.UnitTests/NotificationDtoExtensionsTests.cs b/tests/Notifo.SDK.UnitTests/NotificationDtoExtensionsTests.cs

Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,8 @@ internal static class Constants`
`47`	`47`
`48`	`48`	`public const string SubjectKey = "subject";`
`49`	`49`
`50`		`- public const string TrackingUrlKey = "trackingUrl";`
	`50`	`+ public const string TrackingTokenKey = "trackingToken";`
	`51`	`+`
	`52`	`+ public const string TrackSeenUrlKey = "trackingUrl";`
`51`	`53`	`}`
`52`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -63,9 +63,14 @@ public static Dictionary<string, string> ToDictionary(this UserNotificationDto n`
`63`	`63`
`64`	`64`	`data[Constants.SilentKey] = notification.Silent.ToString();`
`65`	`65`
	`66`	`+ if (!string.IsNullOrWhiteSpace(notification.TrackingToken))`
	`67`	`+ {`
	`68`	`+ data[Constants.TrackingTokenKey] = notification.TrackingToken;`
	`69`	`+ }`
	`70`	`+`
`66`	`71`	`if (!string.IsNullOrWhiteSpace(notification.TrackSeenUrl))`
`67`	`72`	`{`
`68`		`- data[Constants.TrackingUrlKey] = notification.TrackSeenUrl;`
	`73`	`+ data[Constants.TrackSeenUrlKey] = notification.TrackSeenUrl;`
`69`	`74`	`}`
`70`	`75`
`71`	`76`	`if (!string.IsNullOrWhiteSpace(notification.Data))`
`@@ -141,7 +146,12 @@ public static UserNotificationDto FromDictionary(this UserNotificationDto notifi`
`141`	`146`	`notification.Silent = Convert.ToBoolean(silent.ToString());`
`142`	`147`	`}`
`143`	`148`
`144`		`- if (data.TryGetValue(Constants.TrackingUrlKey, out var trackingUrl))`
	`149`	`+ if (data.TryGetValue(Constants.TrackingTokenKey, out var trackingToken))`
	`150`	`+ {`
	`151`	`+ notification.TrackingToken = trackingToken.ToString();`
	`152`	`+ }`
	`153`	`+`
	`154`	`+ if (data.TryGetValue(Constants.TrackSeenUrlKey, out var trackingUrl))`
`145`	`155`	`{`
`146`	`156`	`notification.TrackSeenUrl = trackingUrl.ToString();`
`147`	`157`	`}`