Change name of "success" param to "action_success".

appunite · Mar 12, 2024 · 37c83f5 · 37c83f5
1 parent 0ec85eb
commit 37c83f5
Show file tree

Hide file tree

Showing 10 changed files with 65 additions and 65 deletions.
diff --git a/app-shared-tests/src/main/java/com/appunite/loudius/AbsPullRequestsScreenTest.kt b/app-shared-tests/src/main/java/com/appunite/loudius/AbsPullRequestsScreenTest.kt
@@ -65,7 +65,7 @@ abstract class AbsPullRequestsScreenTest {
             expectThat(analyticsRule.analytics.log).containsExactly(
                 AnalyticsLog("action_start", mapOf("item_name" to "fetch_pull_requests_data", "screen_name" to "pull_requests_screen")),
                 AnalyticsLog("screen_opened", mapOf("screen_name" to "pull_requests_screen")),
-                AnalyticsLog("action_finished", mapOf("item_name" to "fetch_pull_requests_data", "success" to true, "screen_name" to "pull_requests_screen"))
+                AnalyticsLog("action_finished", mapOf("item_name" to "fetch_pull_requests_data", "action_success" to true, "screen_name" to "pull_requests_screen"))
             )
         }
     }

diff --git a/app-shared-tests/src/main/java/com/appunite/loudius/AbsReviewersScreenTest.kt b/app-shared-tests/src/main/java/com/appunite/loudius/AbsReviewersScreenTest.kt
@@ -68,7 +68,7 @@ abstract class AbsReviewersScreenTest {
             expectThat(analyticsRule.analytics.log).containsExactly(
                 AnalyticsLog("action_start", mapOf("item_name" to "fetch_reviewers_data", "screen_name" to "reviewers_screen")),
                 AnalyticsLog("screen_opened", mapOf("screen_name" to "reviewers_screen")),
-                AnalyticsLog("action_finished", mapOf("item_name" to "fetch_reviewers_data", "success" to true, "screen_name" to "reviewers_screen"))
+                AnalyticsLog("action_finished", mapOf("item_name" to "fetch_reviewers_data", "action_success" to true, "screen_name" to "reviewers_screen"))
             )
         }
     }
@@ -100,10 +100,10 @@ abstract class AbsReviewersScreenTest {
             expectThat(analyticsRule.analytics.log).containsExactly(
                 AnalyticsLog("action_start", mapOf("item_name" to "fetch_reviewers_data", "screen_name" to "reviewers_screen")),
                 AnalyticsLog("screen_opened", mapOf("screen_name" to "reviewers_screen")),
-                AnalyticsLog("action_finished", mapOf("item_name" to "fetch_reviewers_data", "success" to true, "screen_name" to "reviewers_screen")),
+                AnalyticsLog("action_finished", mapOf("item_name" to "fetch_reviewers_data", "action_success" to true, "screen_name" to "reviewers_screen")),
                 AnalyticsLog("button_click", mapOf("item_name" to "notify", "screen_name" to "reviewers_screen")),
                 AnalyticsLog("action_start", mapOf("item_name" to "notify", "screen_name" to "reviewers_screen")),
-                AnalyticsLog("action_finished", mapOf("item_name" to "notify", "success" to true, "screen_name" to "reviewers_screen"))
+                AnalyticsLog("action_finished", mapOf("item_name" to "notify", "action_success" to true, "screen_name" to "reviewers_screen"))
             )
         }
     }
@@ -132,10 +132,10 @@ abstract class AbsReviewersScreenTest {
             expectThat(analyticsRule.analytics.log).containsExactly(
                 AnalyticsLog("action_start", mapOf("item_name" to "fetch_reviewers_data", "screen_name" to "reviewers_screen")),
                 AnalyticsLog("screen_opened", mapOf("screen_name" to "reviewers_screen")),
-                AnalyticsLog("action_finished", mapOf("item_name" to "fetch_reviewers_data", "success" to true, "screen_name" to "reviewers_screen")),
+                AnalyticsLog("action_finished", mapOf("item_name" to "fetch_reviewers_data", "action_success" to true, "screen_name" to "reviewers_screen")),
                 AnalyticsLog("button_click", mapOf("item_name" to "notify", "screen_name" to "reviewers_screen")),
                 AnalyticsLog("action_start", mapOf("item_name" to "notify", "screen_name" to "reviewers_screen")),
-                AnalyticsLog("action_finished", mapOf("item_name" to "notify", "success" to false, "screen_name" to "reviewers_screen", "error_message" to "Client request(POST https://api.github.com/repos/exampleOwner/exampleRepo/issues/1/comments) invalid: 404 Client Error. Text: \"\""))
+                AnalyticsLog("action_finished", mapOf("item_name" to "notify", "action_success" to false, "screen_name" to "reviewers_screen", "error_message" to "Client request(POST https://api.github.com/repos/exampleOwner/exampleRepo/issues/1/comments) invalid: 404 Client Error. Text: \"\""))
             )
         }
     }

diff --git a/app-shared-tests/src/main/java/com/appunite/loudius/UniversalWalkThroughAppTest.kt b/app-shared-tests/src/main/java/com/appunite/loudius/UniversalWalkThroughAppTest.kt
@@ -68,18 +68,18 @@ abstract class UniversalWalkThroughAppTest {
             AnalyticsLog("action_start", mapOf("item_name" to "authentication", "screen_name" to "authenticating_screen")),
             AnalyticsLog("action_start", mapOf("item_name" to "get_access_token", "screen_name" to "authenticating_screen")),
             AnalyticsLog("screen_opened", mapOf("screen_name" to "authenticating_screen")),
-            AnalyticsLog("action_finished", mapOf("item_name" to "get_access_token", "success" to true, "screen_name" to "authenticating_screen")),
-            AnalyticsLog("action_finished", mapOf("item_name" to "authentication", "success" to true, "screen_name" to "authenticating_screen")),
+            AnalyticsLog("action_finished", mapOf("item_name" to "get_access_token", "action_success" to true, "screen_name" to "authenticating_screen")),
+            AnalyticsLog("action_finished", mapOf("item_name" to "authentication", "action_success" to true, "screen_name" to "authenticating_screen")),
             AnalyticsLog("action_start", mapOf("item_name" to "fetch_pull_requests_data", "screen_name" to "pull_requests_screen")),
             AnalyticsLog("screen_opened", mapOf("screen_name" to "pull_requests_screen")),
-            AnalyticsLog("action_finished", mapOf("item_name" to "fetch_pull_requests_data", "success" to true, "screen_name" to "pull_requests_screen")),
+            AnalyticsLog("action_finished", mapOf("item_name" to "fetch_pull_requests_data", "action_success" to true, "screen_name" to "pull_requests_screen")),
             AnalyticsLog("item_click", mapOf("item_name" to "pull_request", "screen_name" to "pull_requests_screen")),
             AnalyticsLog("action_start", mapOf("item_name" to "fetch_reviewers_data", "screen_name" to "reviewers_screen")),
             AnalyticsLog("screen_opened", mapOf("screen_name" to "reviewers_screen")),
-            AnalyticsLog("action_finished", mapOf("item_name" to "fetch_reviewers_data", "success" to true, "screen_name" to "reviewers_screen")),
+            AnalyticsLog("action_finished", mapOf("item_name" to "fetch_reviewers_data", "action_success" to true, "screen_name" to "reviewers_screen")),
             AnalyticsLog("button_click", mapOf("item_name" to "notify", "screen_name" to "reviewers_screen")),
             AnalyticsLog("action_start", mapOf("item_name" to "notify", "screen_name" to "reviewers_screen")),
-            AnalyticsLog("action_finished", mapOf("item_name" to "notify", "success" to true, "screen_name" to "reviewers_screen")),
+            AnalyticsLog("action_finished", mapOf("item_name" to "notify", "action_success" to true, "screen_name" to "reviewers_screen")),
             AnalyticsLog("screen_opened", mapOf("screen_name" to "pull_requests_screen"))
         )
     }

diff --git a/app/src/main/java/com/appunite/loudius/analytics/events/AuthenticatingEvents.kt b/app/src/main/java/com/appunite/loudius/analytics/events/AuthenticatingEvents.kt
@@ -41,7 +41,7 @@ object AuthenticatingEvents {
         override val name: String = "action_finished"
         override val parameters: List<EventParameter> = listOf(
             EventParameter.String("item_name", "authentication"),
-            EventParameter.Boolean("success", true),
+            EventParameter.Boolean("action_success", true),
             EventParameter.String("screen_name", "authenticating_screen")
         )
     }
@@ -50,7 +50,7 @@ object AuthenticatingEvents {
         override val name: String = "action_finished"
         override val parameters: List<EventParameter> = listOf(
             EventParameter.String("item_name", "authentication"),
-            EventParameter.Boolean("success", false),
+            EventParameter.Boolean("action_success", false),
             EventParameter.String("screen_name", "authenticating_screen"),
             EventParameter.String("error_message", errorMessage)
         )
@@ -68,7 +68,7 @@ object AuthenticatingEvents {
         override val name: String = "action_finished"
         override val parameters: List<EventParameter> = listOf(
             EventParameter.String("item_name", "get_access_token"),
-            EventParameter.Boolean("success", true),
+            EventParameter.Boolean("action_success", true),
             EventParameter.String("screen_name", "authenticating_screen")
         )
     }
@@ -77,7 +77,7 @@ object AuthenticatingEvents {
         override val name: String = "action_finished"
         override val parameters: List<EventParameter> = listOf(
             EventParameter.String("item_name", "get_access_token"),
-            EventParameter.Boolean("success", false),
+            EventParameter.Boolean("action_success", false),
             EventParameter.String("screen_name", "authenticating_screen"),
             EventParameter.String("error_message", errorMessage)
         )

diff --git a/app/src/main/java/com/appunite/loudius/analytics/events/PullRequestsEvents.kt b/app/src/main/java/com/appunite/loudius/analytics/events/PullRequestsEvents.kt
@@ -42,7 +42,7 @@ object PullRequestsEvents {
         override val name: String = "action_finished"
         override val parameters: List<EventParameter> = listOf(
             EventParameter.String("item_name", "refresh_pull_requests_data"),
-            EventParameter.Boolean("success", true),
+            EventParameter.Boolean("action_success", true),
             EventParameter.String("screen_name", "pull_requests_screen")
         )
     }
@@ -51,7 +51,7 @@ object PullRequestsEvents {
         override val name: String = "action_finished"
         override val parameters: List<EventParameter> = listOf(
             EventParameter.String("item_name", "refresh_pull_requests_data"),
-            EventParameter.Boolean("success", false),
+            EventParameter.Boolean("action_success", false),
             EventParameter.String("screen_name", "pull_requests_screen"),
             EventParameter.String("error_message", errorMessage)
         )
@@ -69,7 +69,7 @@ object PullRequestsEvents {
         override val name: String = "action_finished"
         override val parameters: List<EventParameter> = listOf(
             EventParameter.String("item_name", "fetch_pull_requests_data"),
-            EventParameter.Boolean("success", true),
+            EventParameter.Boolean("action_success", true),
             EventParameter.String("screen_name", "pull_requests_screen")
         )
     }
@@ -78,7 +78,7 @@ object PullRequestsEvents {
         override val name: String = "action_finished"
         override val parameters: List<EventParameter> = listOf(
             EventParameter.String("item_name", "fetch_pull_requests_data"),
-            EventParameter.Boolean("success", false),
+            EventParameter.Boolean("action_success", false),
             EventParameter.String("screen_name", "pull_requests_screen"),
             EventParameter.String("error_message", errorMessage)
         )

diff --git a/app/src/main/java/com/appunite/loudius/analytics/events/ReviewersEvents.kt b/app/src/main/java/com/appunite/loudius/analytics/events/ReviewersEvents.kt
@@ -50,7 +50,7 @@ object ReviewersEvents {
         override val name: String = "action_finished"
         override val parameters: List<EventParameter> = listOf(
             EventParameter.String("item_name", "notify"),
-            EventParameter.Boolean("success", true),
+            EventParameter.Boolean("action_success", true),
             EventParameter.String("screen_name", "reviewers_screen")
         )
     }
@@ -59,7 +59,7 @@ object ReviewersEvents {
         override val name: String = "action_finished"
         override val parameters: List<EventParameter> = listOf(
             EventParameter.String("item_name", "notify"),
-            EventParameter.Boolean("success", false),
+            EventParameter.Boolean("action_success", false),
             EventParameter.String("screen_name", "reviewers_screen"),
             EventParameter.String("error_message", errorMessage)
         )
@@ -77,7 +77,7 @@ object ReviewersEvents {
         override val name: String = "action_finished"
         override val parameters: List<EventParameter> = listOf(
             EventParameter.String("item_name", "refresh_reviewers_data"),
-            EventParameter.Boolean("success", true),
+            EventParameter.Boolean("action_success", true),
             EventParameter.String("screen_name", "reviewers_screen")
         )
     }
@@ -86,7 +86,7 @@ object ReviewersEvents {
         override val name: String = "action_finished"
         override val parameters: List<EventParameter> = listOf(
             EventParameter.String("item_name", "refresh_reviewers_data"),
-            EventParameter.Boolean("success", false),
+            EventParameter.Boolean("action_success", false),
             EventParameter.String("screen_name", "reviewers_screen"),
             EventParameter.String("error_message", errorMessage)
         )
@@ -104,7 +104,7 @@ object ReviewersEvents {
         override val name: String = "action_finished"
         override val parameters: List<EventParameter> = listOf(
             EventParameter.String("item_name", "fetch_reviewers_data"),
-            EventParameter.Boolean("success", true),
+            EventParameter.Boolean("action_success", true),
             EventParameter.String("screen_name", "reviewers_screen")
         )
     }
@@ -113,7 +113,7 @@ object ReviewersEvents {
         override val name: String = "action_finished"
         override val parameters: List<EventParameter> = listOf(
             EventParameter.String("item_name", "fetch_reviewers_data"),
-            EventParameter.Boolean("success", false),
+            EventParameter.Boolean("action_success", false),
             EventParameter.String("screen_name", "reviewers_screen"),
             EventParameter.String("error_message", errorMessage)
         )

diff --git a/docs/event_details/action_finished.md b/docs/event_details/action_finished.md
@@ -18,7 +18,7 @@ Called when the [action_start](action_start.md) is finished.
 {
   "event_name": "action_finished",
   "item_name": "Downloading User Profile",
-  "success": true,
+  "action_success": true,
   "screen_name": "reviewers_screen"
 }
 ```
@@ -29,7 +29,7 @@ or
 {
   "event_name": "action_finished",
   "item_name": "Downloading User Profile",
-  "success": false,
+  "action_success": false,
   "screen_name": "reviewers_screen",
   "error_message": "Some error message."
 }

diff --git a/docs/screens/authenticating.md b/docs/screens/authenticating.md
@@ -11,17 +11,17 @@
 | After user clicks log in, authentication started. | <pre>{<br />   "name": "action_start"<br />   "item_name": "authentication"<br />   "screen_name": "authenticating_screen"<br />}<pre/> |
 |:-------------------------------------------------:|-----------------------------------------------------------------------------------------------------------------------------------------|
 
-| When application gets access token and authentication finished with success. | <pre>{<br />   "name": "action_finished"<br />   "item_name": "authentication"<br />   "success": true<br />   "screen_name": "authenticating_screen"<br />}<pre/> |
-|:----------------------------------------------------------------------------:|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| When application gets access token and authentication finished with success. | <pre>{<br />   "name": "action_finished"<br />   "item_name": "authentication"<br />   "action_success": true<br />   "screen_name": "authenticating_screen"<br />}<pre/> |
+|:----------------------------------------------------------------------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 
-| When application doesn't get access token and  When authentication finished with failure. | <pre>{<br />   "name": "action_finished"<br />   "item_name": "authentication"<br />   "success": false<br />   "screen_name": "authenticating_screen"<br />   "error_message": "Some error message."<br />}<pre/> |
-|:-----------------------------------------------------------------------------------------:|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| When application doesn't get access token and  When authentication finished with failure. | <pre>{<br />   "name": "action_finished"<br />   "item_name": "authentication"<br />   "action_success": false<br />   "screen_name": "authenticating_screen"<br />   "error_message": "Some error message."<br />}<pre/> |
+|:-----------------------------------------------------------------------------------------:|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 
 | When get access token started. | <pre>{<br />   "name": "action_start"<br />   "item_name": "get_access_token"<br />   "screen_name": "authenticating_screen"<br />}<pre/> |
 |:------------------------------:|-------------------------------------------------------------------------------------------------------------------------------------------|
 
-| When get access token finished with success. | <pre>{<br />   "name": "action_finished"<br />   "item_name": "get_access_token"<br />   "success": true<br />   "screen_name": "authenticating_screen"<br />}<pre/> |
-|:--------------------------------------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| When get access token finished with success. | <pre>{<br />   "name": "action_finished"<br />   "item_name": "get_access_token"<br />   "action_success": true<br />   "screen_name": "authenticating_screen"<br />}<pre/> |
+|:--------------------------------------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 
-| When get access token finished with failure. | <pre>{<br />   "name": "action_finished"<br />   "item_name": "get_access_token"<br />   "success": false<br />   "screen_name": "authenticating_screen"<br />   "error_message": "Some error message."<br />}}<pre/> |
-|:--------------------------------------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| When get access token finished with failure. | <pre>{<br />   "name": "action_finished"<br />   "item_name": "get_access_token"<br />   "action_success": false<br />   "screen_name": "authenticating_screen"<br />   "error_message": "Some error message."<br />}}<pre/> |
+|:--------------------------------------------:|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|