Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add analytics initial events (WPB-10589) #3428

Merged
merged 13 commits into from
Sep 12, 2024
Merged

feat: add analytics initial events (WPB-10589) #3428

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
efb9854
feat: add calling initiated, calling joined, backup export and restor…
alexandreferris Aug 30, 2024
16aaddf
feat: add usage for calling initiated and joined events
alexandreferris Aug 30, 2024
ad7f903
feat: add usage for backup export and restore events
alexandreferris Aug 30, 2024
ae98e22
feat: add contributed event base, message action and location
yamilmedina Sep 2, 2024
e9ceb61
feat: skeleton for rest of contribution messages
yamilmedina Sep 2, 2024
3c00f3d
feat: call send location contribution
yamilmedina Sep 9, 2024
b41eb9f
feat: call send non asset contribution
yamilmedina Sep 9, 2024
8848510
feat: call send assets contribution
yamilmedina Sep 10, 2024
82e8646
feat: call send assets contribution
yamilmedina Sep 10, 2024
8b01c8e
feat: test coverage and wrap logic
yamilmedina Sep 10, 2024
beac9bc
feat: test coverage and wrap logic
yamilmedina Sep 10, 2024
75b1cda
feat: fix detekt
yamilmedina Sep 10, 2024
9d6b2b3
Merge branch 'release/candidate' into feat/add_analytics_initial_events
yamilmedina Sep 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions app/src/main/kotlin/com/wire/android/di/AppModule.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ import android.media.AudioAttributes
import android.media.MediaPlayer
import androidx.core.app.NotificationManagerCompat
import com.wire.android.BuildConfig
import com.wire.android.feature.analytics.AnonymousAnalyticsManager
import com.wire.android.feature.analytics.AnonymousAnalyticsManagerImpl
import com.wire.android.mapper.MessageResourceProvider
import com.wire.android.ui.analytics.AnalyticsConfiguration
import com.wire.android.ui.home.appLock.CurrentTimestampProvider
Expand Down Expand Up @@ -95,4 +97,7 @@ object AppModule {
@Provides
fun provideAnalyticsConfiguration() =
if (BuildConfig.ANALYTICS_ENABLED) AnalyticsConfiguration.Enabled else AnalyticsConfiguration.Disabled

@Provides
fun provideAnonymousAnalyticsManager(): AnonymousAnalyticsManager = AnonymousAnalyticsManagerImpl
Comment on lines +100 to +102
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: this is mostly to be injected in a VM so the manager can be used in tests

}
40 changes: 25 additions & 15 deletions app/src/main/kotlin/com/wire/android/ui/home/conversations/ConversationScreen.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,8 @@ import com.ramcosta.composedestinations.result.ResultBackNavigator
import com.ramcosta.composedestinations.result.ResultRecipient
import com.wire.android.R
import com.wire.android.appLogger
import com.wire.android.feature.analytics.AnonymousAnalyticsManagerImpl
import com.wire.android.feature.analytics.model.AnalyticsEvent
import com.wire.android.mapper.MessageDateTimeGroup
import com.wire.android.media.audiomessage.AudioState
import com.wire.android.model.Clickable
Expand Down Expand Up @@ -277,6 +279,7 @@ fun ConversationScreen(
getOngoingCallIntent(activity, it.toString()).run {
activity.startActivity(this)
}
AnonymousAnalyticsManagerImpl.sendEvent(event = AnalyticsEvent.CallJoined())
}
}
)
Expand All @@ -290,6 +293,7 @@ fun ConversationScreen(
getOutgoingCallIntent(activity, conversationListCallViewModel.conversationId.toString()).run {
activity.startActivity(this)
}
AnonymousAnalyticsManagerImpl.sendEvent(event = AnalyticsEvent.CallJoined())
}
showDialog.value = ConversationScreenDialogType.NONE
}, onDialogDismiss = {
Expand All @@ -316,12 +320,13 @@ fun ConversationScreen(
getOutgoingCallIntent(activity, it.toString()).run {
activity.startActivity(this)
}
},
onOpenOngoingCallScreen = {
getOngoingCallIntent(activity, it.toString()).run {
activity.startActivity(this)
}
}
) {
getOngoingCallIntent(activity, it.toString()).run {
activity.startActivity(this)
}
}
)
},
onDialogDismiss = {
showDialog.value = ConversationScreenDialogType.NONE
Expand All @@ -348,12 +353,13 @@ fun ConversationScreen(
getOutgoingCallIntent(activity, it.toString()).run {
activity.startActivity(this)
}
},
onOpenOngoingCallScreen = {
getOngoingCallIntent(activity, it.toString()).run {
activity.startActivity(this)
}
}
) {
getOngoingCallIntent(activity, it.toString()).run {
activity.startActivity(this)
}
}
)
},
onDialogDismiss = { showDialog.value = ConversationScreenDialogType.NONE }
)
Expand Down Expand Up @@ -423,15 +429,17 @@ fun ConversationScreen(
getOutgoingCallIntent(activity, it.toString()).run {
activity.startActivity(this)
}
},
onOpenOngoingCallScreen = {
getOngoingCallIntent(activity, it.toString()).run {
activity.startActivity(this)
}
}
) {
getOngoingCallIntent(activity, it.toString()).run {
activity.startActivity(this)
}
}
)
},
onJoinCall = {
conversationListCallViewModel.joinOngoingCall {
AnonymousAnalyticsManagerImpl.sendEvent(event = AnalyticsEvent.CallJoined())
getOngoingCallIntent(activity, it.toString()).run {
activity.startActivity(this)
}
Expand Down Expand Up @@ -664,13 +672,15 @@ private fun startCallIfPossible(
} else {
conversationListCallViewModel.endEstablishedCallIfAny {
onOpenOutgoingCallScreen(conversationListCallViewModel.conversationId)
AnonymousAnalyticsManagerImpl.sendEvent(event = AnalyticsEvent.CallInitiated())
}
ConversationScreenDialogType.NONE
}
}

ConferenceCallingResult.Disabled.Established -> {
onOpenOngoingCallScreen(conversationListCallViewModel.conversationId)
AnonymousAnalyticsManagerImpl.sendEvent(event = AnalyticsEvent.CallJoined())
ConversationScreenDialogType.NONE
}

Expand Down
42 changes: 42 additions & 0 deletions ...rc/main/kotlin/com/wire/android/ui/home/conversations/sendmessage/SendMessageViewModel.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ import androidx.lifecycle.SavedStateHandle
import androidx.lifecycle.viewModelScope
import com.wire.android.R
import com.wire.android.appLogger
import com.wire.android.feature.analytics.AnonymousAnalyticsManager
import com.wire.android.feature.analytics.model.AnalyticsEvent
import com.wire.android.media.PingRinger
import com.wire.android.model.SnackBarMessage
import com.wire.android.navigation.SavedStateViewModel
Expand Down Expand Up @@ -65,6 +67,7 @@ import com.wire.kalium.logic.feature.message.SendTextMessageUseCase
import com.wire.kalium.logic.feature.message.draft.RemoveMessageDraftUseCase
import com.wire.kalium.logic.functional.Either
import com.wire.kalium.logic.functional.onFailure
import com.wire.kalium.logic.functional.onSuccess
import dagger.hilt.android.lifecycle.HiltViewModel
import kotlinx.coroutines.Job
import kotlinx.coroutines.flow.MutableSharedFlow
Expand Down Expand Up @@ -96,6 +99,7 @@ class SendMessageViewModel @Inject constructor(
private val observeConversationUnderLegalHoldNotified: ObserveConversationUnderLegalHoldNotifiedUseCase,
private val sendLocation: SendLocationUseCase,
private val removeMessageDraft: RemoveMessageDraftUseCase,
private val analyticsManager: AnonymousAnalyticsManager
) : SavedStateViewModel(savedStateHandle) {

private val conversationNavArgs: ConversationNavArgs = savedStateHandle.navArgs()
Expand Down Expand Up @@ -199,6 +203,7 @@ class SendMessageViewModel @Inject constructor(
mentions = newMentions.map { it.intoMessageMention() },
)
.handleLegalHoldFailureAfterSendingMessage(conversationId)
.handleNonAssetContributionEvent(messageBundle)
}
}

Expand Down Expand Up @@ -231,20 +236,23 @@ class SendMessageViewModel @Inject constructor(
quotedMessageId = quotedMessageId
)
.handleLegalHoldFailureAfterSendingMessage(conversationId)
.handleNonAssetContributionEvent(messageBundle)
}
}

is ComposableMessageBundle.LocationBundle -> {
with(messageBundle) {
sendLocation(conversationId, location.latitude.toFloat(), location.longitude.toFloat(), locationName, zoom)
.handleLegalHoldFailureAfterSendingMessage(conversationId)
.handleNonAssetContributionEvent(messageBundle)
}
}

is Ping -> {
pingRinger.ping(R.raw.ping_from_me, isReceivingPing = false)
sendKnockUseCase(conversationId = messageBundle.conversationId, hotKnock = false)
.handleLegalHoldFailureAfterSendingMessage(messageBundle.conversationId)
.handleNonAssetContributionEvent(messageBundle)
}
}
}
Expand Down Expand Up @@ -297,6 +305,7 @@ class SendMessageViewModel @Inject constructor(
audioLengthInMs = 0L
)
.handleLegalHoldFailureAfterSendingMessage(conversationId)
.handleAssetContributionEvent(assetType)
}

AttachmentType.VIDEO,
Expand All @@ -317,6 +326,7 @@ class SendMessageViewModel @Inject constructor(
)
)
.handleLegalHoldFailureAfterSendingMessage(conversationId)
.handleAssetContributionEvent(assetType)
} catch (e: OutOfMemoryError) {
appLogger.e("There was an OutOfMemory error while uploading the asset")
onSnackbarMessage(ConversationSnackbarMessages.ErrorSendingAsset)
Expand All @@ -328,6 +338,37 @@ class SendMessageViewModel @Inject constructor(
}
}

private fun Either<CoreFailure?, Unit>.handleAssetContributionEvent(
assetType: AttachmentType
) = also {
onSuccess {
val event = when (assetType) {
AttachmentType.IMAGE -> AnalyticsEvent.Contributed.Photo()
AttachmentType.VIDEO -> AnalyticsEvent.Contributed.Video()
AttachmentType.GENERIC_FILE -> AnalyticsEvent.Contributed.File()
AttachmentType.AUDIO -> AnalyticsEvent.Contributed.Audio()
}
analyticsManager.sendEvent(event)
}
}

private fun Either<CoreFailure, Unit>.handleNonAssetContributionEvent(messageBundle: MessageBundle) = also {
onSuccess {
val event = when (messageBundle) {
// assets are not handled here, as they need extra processing
is ComposableMessageBundle.UriPickedBundle,
is ComposableMessageBundle.AudioMessageBundle,
is ComposableMessageBundle.AttachmentPickedBundle -> return@also

is ComposableMessageBundle.LocationBundle -> AnalyticsEvent.Contributed.Location()
is Ping -> AnalyticsEvent.Contributed.Ping()
is ComposableMessageBundle.EditMessageBundle,
is ComposableMessageBundle.SendTextMessageBundle -> AnalyticsEvent.Contributed.Text()
}
analyticsManager.sendEvent(event)
}
}

private fun CoreFailure.handleLegalHoldFailureAfterSendingMessage(conversationId: ConversationId) = also {
if (this is LegalHoldEnabledForConversationFailure) {
sureAboutMessagingDialogState = when (val currentState = sureAboutMessagingDialogState) {
Expand Down Expand Up @@ -419,6 +460,7 @@ class SendMessageViewModel @Inject constructor(
}
sureAboutMessagingDialogState = SureAboutMessagingDialogState.Hidden
}

private companion object {
const val MAX_LIMIT_MESSAGE_SEND = 20
}
Expand Down
3 changes: 3 additions & 0 deletions app/src/main/kotlin/com/wire/android/ui/home/conversationslist/ConversationRouter.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ import androidx.compose.runtime.rememberCoroutineScope
import androidx.compose.runtime.setValue
import androidx.hilt.navigation.compose.hiltViewModel
import com.wire.android.R
import com.wire.android.feature.analytics.AnonymousAnalyticsManagerImpl
import com.wire.android.feature.analytics.model.AnalyticsEvent
import com.wire.android.navigation.NavigationCommand
import com.wire.android.navigation.Navigator
import com.wire.android.ui.LocalActivity
Expand Down Expand Up @@ -174,6 +176,7 @@ fun ConversationRouterHomeBridge(
}
val onJoinedCall: (ConversationId) -> Unit = remember(navigator) {
{
AnonymousAnalyticsManagerImpl.sendEvent(event = AnalyticsEvent.CallJoined())
getOngoingCallIntent(activity, it.toString()).run {
activity.startActivity(this)
}
Expand Down
11 changes: 11 additions & 0 deletions app/src/main/kotlin/com/wire/android/ui/home/settings/backup/BackupAndRestoreViewModel.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ import androidx.lifecycle.viewModelScope
import com.wire.android.BuildConfig
import com.wire.android.appLogger
import com.wire.android.datastore.UserDataStore
import com.wire.android.feature.analytics.AnonymousAnalyticsManagerImpl
import com.wire.android.feature.analytics.model.AnalyticsEvent
import com.wire.android.ui.common.textfield.textAsFlow
import com.wire.android.util.FileManager
import com.wire.android.util.dispatchers.DispatcherProvider
Expand Down Expand Up @@ -124,6 +126,7 @@ class BackupAndRestoreViewModel
is CreateBackupResult.Failure -> {
state = state.copy(backupCreationProgress = BackupCreationProgress.Failed)
appLogger.e("Failed to create backup: ${result.coreFailure}")
AnonymousAnalyticsManagerImpl.sendEvent(event = AnalyticsEvent.BackupExportFailed())
}
}
}
Expand Down Expand Up @@ -185,6 +188,7 @@ class BackupAndRestoreViewModel
importDatabase(importedBackupPath)
} else {
state = state.copy(restoreFileValidation = RestoreFileValidation.IncompatibleBackup)
AnonymousAnalyticsManagerImpl.sendEvent(event = AnalyticsEvent.BackupRestoreFailed())
}
}
}
Expand All @@ -196,6 +200,8 @@ class BackupAndRestoreViewModel
is VerifyBackupResult.Failure.Generic -> result.error.toString()
VerifyBackupResult.Failure.InvalidBackupFile -> "No valid files found in the backup"
}

AnonymousAnalyticsManagerImpl.sendEvent(event = AnalyticsEvent.BackupRestoreFailed())
appLogger.e("Failed to extract backup files: $errorMessage")
}
}
Expand All @@ -211,6 +217,7 @@ class BackupAndRestoreViewModel
updateCreationProgress(PROGRESS_75)
delay(SMALL_DELAY)
state = state.copy(backupRestoreProgress = BackupRestoreProgress.Finished)
AnonymousAnalyticsManagerImpl.sendEvent(event = AnalyticsEvent.BackupRestoreSucceeded())
}

is RestoreBackupResult.Failure -> {
Expand All @@ -222,6 +229,7 @@ class BackupAndRestoreViewModel
restoreFileValidation = RestoreFileValidation.IncompatibleBackup,
backupRestoreProgress = BackupRestoreProgress.Failed
)
AnonymousAnalyticsManagerImpl.sendEvent(event = AnalyticsEvent.BackupRestoreFailed())
}
}
}
Expand All @@ -242,14 +250,17 @@ class BackupAndRestoreViewModel
restorePasswordValidation = PasswordValidation.Valid
)
restoreBackupPasswordState.clearText()
AnonymousAnalyticsManagerImpl.sendEvent(event = AnalyticsEvent.BackupRestoreSucceeded())
}

is RestoreBackupResult.Failure -> {
mapBackupRestoreFailure(result.failure)
AnonymousAnalyticsManagerImpl.sendEvent(event = AnalyticsEvent.BackupRestoreFailed())
}
}
} else {
state = state.copy(backupRestoreProgress = BackupRestoreProgress.Failed)
AnonymousAnalyticsManagerImpl.sendEvent(event = AnalyticsEvent.BackupRestoreFailed())
}
}

Expand Down
7 changes: 6 additions & 1 deletion ...lin/com/wire/android/ui/home/conversations/sendmessage/SendMessageViewModelArrangement.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ package com.wire.android.ui.home.conversations.sendmessage
import androidx.lifecycle.SavedStateHandle
import com.wire.android.config.TestDispatcherProvider
import com.wire.android.config.mockUri
import com.wire.android.feature.analytics.AnonymousAnalyticsManager
import com.wire.android.framework.FakeKaliumFileSystem
import com.wire.android.media.PingRinger
import com.wire.android.ui.home.conversations.ConversationNavArgs
Expand Down Expand Up @@ -139,6 +140,9 @@ internal class SendMessageViewModelArrangement {

private val fakeKaliumFileSystem = FakeKaliumFileSystem()

@MockK
lateinit var analyticsManager: AnonymousAnalyticsManager

private val viewModel by lazy {
SendMessageViewModel(
sendTextMessage = sendTextMessage,
Expand All @@ -158,7 +162,8 @@ internal class SendMessageViewModelArrangement {
observeConversationUnderLegalHoldNotified = observeConversationUnderLegalHoldNotified,
sendLocation = sendLocation,
removeMessageDraft = removeMessageDraftUseCase,
savedStateHandle = savedStateHandle
savedStateHandle = savedStateHandle,
analyticsManager = analyticsManager
)
}

Expand Down
Loading
Loading