Implement analytics plan #4734
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Analytics: send more Events |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -65,7 +65,9 @@ import im.vector.app.core.extensions.toMvRxBundle | |
| import im.vector.app.core.utils.toast | ||
| import im.vector.app.features.MainActivity | ||
| import im.vector.app.features.MainActivityArgs | ||
| import im.vector.app.features.analytics.AnalyticsTracker | ||
| import im.vector.app.features.analytics.plan.Screen | ||
| import im.vector.app.features.analytics.screen.ScreenEvent | ||
| import im.vector.app.features.configuration.VectorConfiguration | ||
| import im.vector.app.features.consent.ConsentNotGivenHelper | ||
| import im.vector.app.features.navigation.Navigator | ||
|
|
@@ -90,6 +92,15 @@ import timber.log.Timber | |
| import javax.inject.Inject | ||
|
|
||
| abstract class VectorBaseActivity<VB : ViewBinding> : AppCompatActivity(), MavericksView { | ||
| /* ========================================================================================== | ||
| * Analytics | ||
| * ========================================================================================== */ | ||
|
|
||
| protected var analyticsScreenName: Screen.ScreenName? = null | ||
| private var screenEvent: ScreenEvent? = null | ||
|
|
||
| protected lateinit var analyticsTracker: AnalyticsTracker | ||
|
|
||
| /* ========================================================================================== | ||
| * View | ||
| * ========================================================================================== */ | ||
|
|
@@ -133,7 +144,6 @@ abstract class VectorBaseActivity<VB : ViewBinding> : AppCompatActivity(), Maver | |
| private lateinit var sessionListener: SessionListener | ||
| protected lateinit var bugReporter: BugReporter | ||
| private lateinit var pinLocker: PinLocker | ||
|
|
||
| @Inject | ||
| lateinit var rageShake: RageShake | ||
|
|
@@ -189,7 +199,7 @@ abstract class VectorBaseActivity<VB : ViewBinding> : AppCompatActivity(), Maver | |
| configurationViewModel = viewModelProvider.get(ConfigurationViewModel::class.java) | ||
| bugReporter = singletonEntryPoint.bugReporter() | ||
| pinLocker = singletonEntryPoint.pinLocker() | ||
| analyticsTracker = singletonEntryPoint.analyticsTracker() | ||
| navigator = singletonEntryPoint.navigator() | ||
| activeSessionHolder = singletonEntryPoint.activeSessionHolder() | ||
| vectorPreferences = singletonEntryPoint.vectorPreferences() | ||
|
|
@@ -324,7 +334,7 @@ abstract class VectorBaseActivity<VB : ViewBinding> : AppCompatActivity(), Maver | |
| override fun onResume() { | ||
| super.onResume() | ||
| Timber.i("onResume Activity ${javaClass.simpleName}") | ||
| screenEvent = analyticsScreenName?.let { ScreenEvent(it) } | ||
|
There was a problem hiding this comment. out of interest, how come we track on exit rather than entry? I'm not sure if this has already been defined but it might be helpful to write up what counts as a screen view event across the different platforms There was a problem hiding this comment. We track on exit because we want to report the duration, and this is managed by There was a problem hiding this comment. makes sense, thanks for explaining! |
||
| configurationViewModel.onActivityResumed() | ||
|
|
||
| if (this !is BugReportActivity && vectorPreferences.useRageshake()) { | ||
|
|
@@ -363,6 +373,7 @@ abstract class VectorBaseActivity<VB : ViewBinding> : AppCompatActivity(), Maver | |
|
|
||
| override fun onPause() { | ||
| super.onPause() | ||
| screenEvent?.send(analyticsTracker, analyticsScreenName) | ||
|
There was a problem hiding this comment. do we need to be able to override the screen name in the if not we could use a // or non null and abstract to force all screens to supply a name
protected open val name: ScreenName? = null
screenEvent = screenName?.let { ScreenEvent(it) }
...
screenEvent?.send(analyticsTracker)There was a problem hiding this comment. Yes, the screen name can change during the screen life. I made this for this particular case - LoginActivity |
||
| Timber.i("onPause Activity ${javaClass.simpleName}") | ||
|
|
||
| rageShake.stop() | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| /* | ||
| * Copyright (c) 2021 New Vector Ltd | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package im.vector.app.features.analytics | ||
|
|
||
| import im.vector.app.features.analytics.itf.VectorAnalyticsEvent | ||
| import im.vector.app.features.analytics.itf.VectorAnalyticsScreen | ||
|
|
||
| interface AnalyticsTracker { | ||
| /** | ||
| * Capture an Event | ||
| */ | ||
| fun capture(event: VectorAnalyticsEvent) | ||
|
|
||
| /** | ||
| * Track a displayed screen | ||
| */ | ||
| fun screen(screen: VectorAnalyticsScreen) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| /* | ||
| * Copyright (c) 2021 New Vector Ltd | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package im.vector.app.features.analytics.extensions | ||
|
|
||
| import im.vector.app.features.analytics.plan.JoinedRoom | ||
| import org.matrix.android.sdk.api.extensions.orFalse | ||
| import org.matrix.android.sdk.api.session.room.model.RoomSummary | ||
| import org.matrix.android.sdk.api.session.room.model.roomdirectory.PublicRoom | ||
|
|
||
| fun Int?.toAnalyticsRoomSize(): JoinedRoom.RoomSize { | ||
| return when (this) { | ||
| null, | ||
| 2 -> JoinedRoom.RoomSize.Two | ||
| in 3..10 -> JoinedRoom.RoomSize.ThreeToTen | ||
| in 11..100 -> JoinedRoom.RoomSize.ElevenToOneHundred | ||
| in 101..1000 -> JoinedRoom.RoomSize.OneHundredAndOneToAThousand | ||
| else -> JoinedRoom.RoomSize.MoreThanAThousand | ||
| } | ||
| } | ||
|
|
||
| fun RoomSummary?.toAnalyticsJoinedRoom(): JoinedRoom { | ||
| return JoinedRoom( | ||
| isDM = this?.isDirect.orFalse(), | ||
| roomSize = this?.joinedMembersCount?.toAnalyticsRoomSize() ?: JoinedRoom.RoomSize.Two | ||
| ) | ||
| } | ||
|
|
||
| fun PublicRoom.toAnalyticsJoinedRoom(): JoinedRoom { | ||
| return JoinedRoom( | ||
| isDM = false, | ||
| roomSize = numJoinedMembers.toAnalyticsRoomSize() | ||
| ) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍