Shared add notification id to notification context (#665)

^ALTAPPS-984
hyperskill · Sep 20, 2023 · 4d25700 · 4d25700
1 parent f58e2b8
commit 4d25700
Show file tree

Hide file tree

Showing 8 changed files with 35 additions and 17 deletions.
diff --git a/...yperskillApp/iosHyperskillApp/Sources/Frameworks/Notifications/NotificationsService.swift b/...yperskillApp/iosHyperskillApp/Sources/Frameworks/Notifications/NotificationsService.swift
@@ -139,6 +139,7 @@ extension NotificationsService {
         case pushNotificationData
         case image
         case fcmOptions = "fcm_options"
+        case notificationID = "notification_id"
     }
 }
 
@@ -177,6 +178,9 @@ extension NotificationsService {
         }
 
         // Set necessary keys to aps dict (see shared PushNotificationData.kt)
+        if let notificationID = userInfo[PayloadKey.notificationID.rawValue] {
+            apsDict[PayloadKey.notificationID.rawValue] = notificationID
+        }
         if let badgeID = userInfo[PayloadKey.badge.rawValue] {
             apsDict[PayloadKey.badge.rawValue] = badgeID
         }

diff --git a/...app/notification/remote/domain/analytic/PushNotificationClickedHyperskillAnalyticEvent.kt b/...app/notification/remote/domain/analytic/PushNotificationClickedHyperskillAnalyticEvent.kt
@@ -20,7 +20,9 @@ import org.hyperskill.app.notification.remote.domain.model.PushNotificationData
  *     "context":
  *     {
  *         "type": "STREAK_THREE" || "SELECT_FIRST_TRACK" || ...,
- *         "group": "Routine learning" || "Re-engagement" || ...
+ *         "category": "Routine learning" || "Re-engagement" || ...,
+ *         "image": "https://hyperskill.org/image.png",
+ *         "notification_id": "12345"
  *     }
  * }
  * ```
@@ -36,10 +38,6 @@ class PushNotificationClickedHyperskillAnalyticEvent(
 ) {
     override val params: Map<String, Any>
         get() = super.params + mapOf(
-            PARAM_CONTEXT to mapOf(
-                PushNotificationHyperskillAnalyticParams.PARAM_TYPE to pushNotificationData.typeString,
-                PushNotificationHyperskillAnalyticParams.PARAM_CATEGORY to pushNotificationData.categoryString,
-                PushNotificationHyperskillAnalyticParams.PARAM_IMAGE to pushNotificationData.image
-            )
+            PARAM_CONTEXT to PushNotificationDataAnalyticContextMapper.map(pushNotificationData)
         )
 }
diff --git a/...kill/app/notification/remote/domain/analytic/PushNotificationDataAnalyticContextMapper.kt b/...kill/app/notification/remote/domain/analytic/PushNotificationDataAnalyticContextMapper.kt
@@ -0,0 +1,14 @@
+package org.hyperskill.app.notification.remote.domain.analytic
+
+import org.hyperskill.app.notification.remote.domain.model.PushNotificationData
+import ru.nobird.app.core.model.mapOfNotNull
+
+internal object PushNotificationDataAnalyticContextMapper {
+    fun map(pushNotificationData: PushNotificationData): Map<String, Any> =
+        mapOfNotNull(
+            PushNotificationHyperskillAnalyticParams.PARAM_TYPE to pushNotificationData.typeString,
+            PushNotificationHyperskillAnalyticParams.PARAM_CATEGORY to pushNotificationData.categoryString,
+            PushNotificationHyperskillAnalyticParams.PARAM_IMAGE to pushNotificationData.image,
+            PushNotificationHyperskillAnalyticParams.PARAM_NOTIFICATION_ID to pushNotificationData.notificationId
+        )
+}
diff --git a/...skill/app/notification/remote/domain/analytic/PushNotificationHyperskillAnalyticParams.kt b/...skill/app/notification/remote/domain/analytic/PushNotificationHyperskillAnalyticParams.kt
@@ -4,4 +4,5 @@ internal object PushNotificationHyperskillAnalyticParams {
     const val PARAM_TYPE = "type"
     const val PARAM_CATEGORY = "category"
     const val PARAM_IMAGE = "image"
+    const val PARAM_NOTIFICATION_ID = "notification_id"
 }
diff --git a/...l/app/notification/remote/domain/analytic/PushNotificationShownHyperskillAnalyticEvent.kt b/...l/app/notification/remote/domain/analytic/PushNotificationShownHyperskillAnalyticEvent.kt
@@ -20,7 +20,9 @@ import org.hyperskill.app.notification.remote.domain.model.PushNotificationData
  *     "context":
  *     {
  *         "type": "STREAK_THREE" || "SELECT_FIRST_TRACK" || ...,
- *         "group": "Routine learning" || "Re-engagement" || ...
+ *         "category": "Routine learning" || "Re-engagement" || ...,
+ *         "image": "https://hyperskill.org/image.png",
+ *         "notification_id": "12345"
  *     }
  * }
  * ```
@@ -36,9 +38,6 @@ class PushNotificationShownHyperskillAnalyticEvent(
 ) {
     override val params: Map<String, Any>
         get() = super.params + mapOf(
-            PARAM_CONTEXT to mapOf(
-                PushNotificationHyperskillAnalyticParams.PARAM_TYPE to pushNotificationData.typeString,
-                PushNotificationHyperskillAnalyticParams.PARAM_CATEGORY to pushNotificationData.categoryString
-            )
+            PARAM_CONTEXT to PushNotificationDataAnalyticContextMapper.map(pushNotificationData)
         )
 }
diff --git a/...onMain/kotlin/org/hyperskill/app/notification/remote/domain/model/PushNotificationData.kt b/...onMain/kotlin/org/hyperskill/app/notification/remote/domain/model/PushNotificationData.kt
@@ -5,6 +5,8 @@ import kotlinx.serialization.Serializable
 
 @Serializable
 data class PushNotificationData(
+    @SerialName("notification_id")
+    val notificationId: String? = null,
     @SerialName("category")
     val typeString: String,
     @SerialName("thread-id")

diff --git a/shared/src/commonTest/kotlin/org/hyperskill/main/AppFeatureTest.kt b/shared/src/commonTest/kotlin/org/hyperskill/main/AppFeatureTest.kt
@@ -54,8 +54,8 @@ class AppFeatureTest {
             AppFeature.Message.UserAccountStatus(
                 Profile.stub(isGuest = true, trackId = 1),
                 PushNotificationData(
-                    PushNotificationType.STREAK_NEW.name,
-                    PushNotificationCategory.CONTINUE_LEARNING.backendName!!
+                    typeString = PushNotificationType.STREAK_NEW.name,
+                    categoryString = PushNotificationCategory.CONTINUE_LEARNING.backendName!!
                 )
             )
         )

diff --git a/...src/commonTest/kotlin/org/hyperskill/notification/NotificationClickHandlingFeatureTest.kt b/...src/commonTest/kotlin/org/hyperskill/notification/NotificationClickHandlingFeatureTest.kt
@@ -18,8 +18,8 @@ class NotificationClickHandlingFeatureTest {
             NotificationClickHandlingFeature.State,
             NotificationClickHandlingFeature.Message.NotificationClicked(
                 PushNotificationData(
-                    PushNotificationType.STREAK_NEW.name,
-                    PushNotificationCategory.CONTINUE_LEARNING.backendName!!
+                    typeString = PushNotificationType.STREAK_NEW.name,
+                    categoryString = PushNotificationCategory.CONTINUE_LEARNING.backendName!!
                 ),
                 isUserAuthorized = false,
                 notificationLaunchedApp = true
@@ -38,8 +38,8 @@ class NotificationClickHandlingFeatureTest {
             NotificationClickHandlingFeature.State,
             NotificationClickHandlingFeature.Message.NotificationClicked(
                 PushNotificationData(
-                    PushNotificationType.STREAK_NEW.name,
-                    PushNotificationCategory.CONTINUE_LEARNING.backendName!!
+                    typeString = PushNotificationType.STREAK_NEW.name,
+                    categoryString = PushNotificationCategory.CONTINUE_LEARNING.backendName!!
                 ),
                 isUserAuthorized = true,
                 notificationLaunchedApp = true