Add challengeId to analytic events

hyperskill · Nov 18, 2023 · 3979c98 · 3979c98
1 parent 8587b68
commit 3979c98
Show file tree

Hide file tree

Showing 5 changed files with 60 additions and 15 deletions.
diff --git a/...lin/org/hyperskill/app/challenges/widget/domain/analytic/ChallengeWidgetAnalyticParams.kt b/...lin/org/hyperskill/app/challenges/widget/domain/analytic/ChallengeWidgetAnalyticParams.kt
@@ -0,0 +1,6 @@
+package org.hyperskill.app.challenges.widget.domain.analytic
+
+internal object ChallengeWidgetAnalyticParams {
+    const val PARAM_URL = "url"
+    const val PARAM_CHALLENGE_ID = "challenge_id"
+}
diff --git a/...nges/widget/domain/analytic/ChallengeWidgetClickedCollectRewardHyperskillAnalyticEvent.kt b/...nges/widget/domain/analytic/ChallengeWidgetClickedCollectRewardHyperskillAnalyticEvent.kt
@@ -5,6 +5,7 @@ import org.hyperskill.app.analytic.domain.model.hyperskill.HyperskillAnalyticEve
 import org.hyperskill.app.analytic.domain.model.hyperskill.HyperskillAnalyticPart
 import org.hyperskill.app.analytic.domain.model.hyperskill.HyperskillAnalyticRoute
 import org.hyperskill.app.analytic.domain.model.hyperskill.HyperskillAnalyticTarget
+import ru.nobird.app.core.model.mapOfNotNull
 
 /**
  * Represents a click analytic event on the "Collect Reward" button.
@@ -15,15 +16,26 @@ import org.hyperskill.app.analytic.domain.model.hyperskill.HyperskillAnalyticTar
  *     "route": "/home",
  *     "action": "click",
  *     "part": "challenge_card",
- *     "target": "collect_reward"
+ *     "target": "collect_reward",
+ *     "context":
+ *     {
+ *         "challenge_id": 1
+ *     }
  * }
  * ```
  *
  * @see HyperskillAnalyticEvent
  */
-object ChallengeWidgetClickedCollectRewardHyperskillAnalyticEvent : HyperskillAnalyticEvent(
+class ChallengeWidgetClickedCollectRewardHyperskillAnalyticEvent(
+    val challengeId: Long?
+) : HyperskillAnalyticEvent(
     HyperskillAnalyticRoute.Home(),
     HyperskillAnalyticAction.CLICK,
     HyperskillAnalyticPart.CHALLENGE_CARD,
     HyperskillAnalyticTarget.COLLECT_REWARD
-)
+) {
+    override val params: Map<String, Any>
+        get() = super.params + mapOf(
+            PARAM_CONTEXT to mapOfNotNull(ChallengeWidgetAnalyticParams.PARAM_CHALLENGE_ID to challengeId)
+        )
+}
diff --git a/...ges/widget/domain/analytic/ChallengeWidgetClickedDeadlineReloadHyperskillAnalyticEvent.kt b/...ges/widget/domain/analytic/ChallengeWidgetClickedDeadlineReloadHyperskillAnalyticEvent.kt
@@ -5,6 +5,7 @@ import org.hyperskill.app.analytic.domain.model.hyperskill.HyperskillAnalyticEve
 import org.hyperskill.app.analytic.domain.model.hyperskill.HyperskillAnalyticPart
 import org.hyperskill.app.analytic.domain.model.hyperskill.HyperskillAnalyticRoute
 import org.hyperskill.app.analytic.domain.model.hyperskill.HyperskillAnalyticTarget
+import ru.nobird.app.core.model.mapOfNotNull
 
 /**
  * Represents a click analytic event on the "Reload" button.
@@ -15,15 +16,26 @@ import org.hyperskill.app.analytic.domain.model.hyperskill.HyperskillAnalyticTar
  *     "route": "/home",
  *     "action": "click",
  *     "part": "challenge_card",
- *     "target": "deadline_reload"
+ *     "target": "deadline_reload",
+ *     "context":
+ *     {
+ *         "challenge_id": 1
+ *     }
  * }
  * ```
  *
  * @see HyperskillAnalyticEvent
  */
-object ChallengeWidgetClickedDeadlineReloadHyperskillAnalyticEvent : HyperskillAnalyticEvent(
+class ChallengeWidgetClickedDeadlineReloadHyperskillAnalyticEvent(
+    val challengeId: Long?
+) : HyperskillAnalyticEvent(
     HyperskillAnalyticRoute.Home(),
     HyperskillAnalyticAction.CLICK,
     HyperskillAnalyticPart.CHALLENGE_CARD,
     HyperskillAnalyticTarget.DEADLINE_RELOAD
-)
+) {
+    override val params: Map<String, Any>
+        get() = super.params + mapOf(
+            PARAM_CONTEXT to mapOfNotNull(ChallengeWidgetAnalyticParams.PARAM_CHALLENGE_ID to challengeId)
+        )
+}
diff --git a/...dget/domain/analytic/ChallengeWidgetClickedLinkInTheDescriptionHyperskillAnalyticEvent.kt b/...dget/domain/analytic/ChallengeWidgetClickedLinkInTheDescriptionHyperskillAnalyticEvent.kt
@@ -5,6 +5,7 @@ import org.hyperskill.app.analytic.domain.model.hyperskill.HyperskillAnalyticEve
 import org.hyperskill.app.analytic.domain.model.hyperskill.HyperskillAnalyticPart
 import org.hyperskill.app.analytic.domain.model.hyperskill.HyperskillAnalyticRoute
 import org.hyperskill.app.analytic.domain.model.hyperskill.HyperskillAnalyticTarget
+import ru.nobird.app.core.model.mapOfNotNull
 
 /**
  * Represents a click analytic event on a link in the description block.
@@ -18,27 +19,28 @@ import org.hyperskill.app.analytic.domain.model.hyperskill.HyperskillAnalyticTar
  *     "target": "link"
  *     "context":
  *     {
- *         "url": "https://sample.com/"
+ *         "url": "https://sample.com/",
+ *         "challenge_id": 1
  *     }
  * }
  * ```
  *
  * @see HyperskillAnalyticEvent
  */
 class ChallengeWidgetClickedLinkInTheDescriptionHyperskillAnalyticEvent(
+    val challengeId: Long?,
     val url: String
 ) : HyperskillAnalyticEvent(
     HyperskillAnalyticRoute.Home(),
     HyperskillAnalyticAction.CLICK,
     HyperskillAnalyticPart.CHALLENGE_CARD,
     HyperskillAnalyticTarget.LINK
 ) {
-    companion object {
-        private const val PARAM_URL = "url"
-    }
-
     override val params: Map<String, Any>
         get() = super.params + mapOf(
-            PARAM_CONTEXT to mapOf(PARAM_URL to url)
+            PARAM_CONTEXT to mapOfNotNull(
+                ChallengeWidgetAnalyticParams.PARAM_CHALLENGE_ID to challengeId,
+                ChallengeWidgetAnalyticParams.PARAM_URL to url
+            )
         )
 }
diff --git a/...onMain/kotlin/org/hyperskill/app/challenges/widget/presentation/ChallengeWidgetReducer.kt b/...onMain/kotlin/org/hyperskill/app/challenges/widget/presentation/ChallengeWidgetReducer.kt
@@ -101,7 +101,10 @@ class ChallengeWidgetReducer : StateReducer<State, Message, Action> {
             state to setOf(
                 Action.ViewAction.OpenUrl(url = message.url, shouldOpenInApp = true),
                 InternalAction.LogAnalyticEvent(
-                    ChallengeWidgetClickedLinkInTheDescriptionHyperskillAnalyticEvent(url = message.url)
+                    ChallengeWidgetClickedLinkInTheDescriptionHyperskillAnalyticEvent(
+                        challengeId = state.getCurrentChallenge()?.id,
+                        url = message.url
+                    )
                 )
             )
         } else {
@@ -117,7 +120,11 @@ class ChallengeWidgetReducer : StateReducer<State, Message, Action> {
             }
 
             newState to setOf(
-                InternalAction.LogAnalyticEvent(ChallengeWidgetClickedDeadlineReloadHyperskillAnalyticEvent)
+                InternalAction.LogAnalyticEvent(
+                    ChallengeWidgetClickedDeadlineReloadHyperskillAnalyticEvent(
+                        challengeId = state.getCurrentChallenge()?.id
+                    )
+                )
             )
         } else {
             null
@@ -128,7 +135,13 @@ class ChallengeWidgetReducer : StateReducer<State, Message, Action> {
             state.getCurrentChallenge()?.rewardLink?.let {
                 add(InternalAction.CreateMagicLink(nextUrl = it))
             }
-            add(InternalAction.LogAnalyticEvent(ChallengeWidgetClickedCollectRewardHyperskillAnalyticEvent))
+            add(
+                InternalAction.LogAnalyticEvent(
+                    ChallengeWidgetClickedCollectRewardHyperskillAnalyticEvent(
+                        challengeId = state.getCurrentChallenge()?.id
+                    )
+                )
+            )
         }
 
     private fun handleCreateMagicLinkFailureMessage(state: State): ChallengeWidgetReducerResult? =