Skip to content

Commit

Permalink
feat: add more debug information (WPB-14930) 🍒 (#3729)
Browse files Browse the repository at this point in the history 
Co-authored-by: sergeibakhtiarov <[email protected]>
Co-authored-by: sergei.bakhtiarov <[email protected]>
Co-authored-by: Yamil Medina <[email protected]>
  • Loading branch information
@github-actions @sergeibakhtiarov
@sbakhtiarov @yamilmedina
4 people authored Dec 13, 2024
1 parent 375b8ca commit 0c0c629
Show file tree
Hide file tree
Showing 5 changed files with 244 additions and 1 deletion.
15 changes: 15 additions & 0 deletions app/src/main/kotlin/com/wire/android/ui/debug/DebugDataOptions.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,21 @@ fun DebugDataOptionsContent(
)
)

Column {
SettingsItem(
title = stringResource(R.string.debug_federation_enabled),
text = state.isFederationEnabled.toString(),
)
SettingsItem(
title = stringResource(R.string.debug_default_backend_protocol),
text = state.defaultProtocol,
)
SettingsItem(
title = stringResource(R.string.debug_current_api_version),
text = state.currentApiVersion,
)
}

if (BuildConfig.DEBUG) {
GetE2EICertificateSwitch(
enrollE2EI = enrollE2EICertificate
Expand Down
5 changes: 4 additions & 1 deletion app/src/main/kotlin/com/wire/android/ui/debug/DebugDataOptionsState.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,8 @@ data class DebugDataOptionsState(
val certificate: String = "null",
val showCertificate: Boolean = false,
val startGettingE2EICertificate: Boolean = false,
val analyticsTrackingId: String = "null"
val analyticsTrackingId: String = "null",
val isFederationEnabled: Boolean = false,
val currentApiVersion: String = "null",
val defaultProtocol: String = "null",
)
34 changes: 34 additions & 0 deletions app/src/main/kotlin/com/wire/android/ui/debug/DebugDataOptionsViewModel.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ import com.wire.android.util.getGitBuildId
import com.wire.android.util.ui.UIText
import com.wire.kalium.logic.CoreFailure
import com.wire.kalium.logic.E2EIFailure
import com.wire.kalium.logic.configuration.server.CommonApiVersionType
import com.wire.kalium.logic.data.user.SupportedProtocol
import com.wire.kalium.logic.data.user.UserId
import com.wire.kalium.logic.feature.analytics.GetCurrentAnalyticsTrackingIdentifierUseCase
import com.wire.kalium.logic.feature.e2ei.CheckCrlRevocationListUseCase
Expand All @@ -42,6 +44,8 @@ import com.wire.kalium.logic.feature.keypackage.MLSKeyPackageCountResult
import com.wire.kalium.logic.feature.keypackage.MLSKeyPackageCountUseCase
import com.wire.kalium.logic.feature.notificationToken.SendFCMTokenError
import com.wire.kalium.logic.feature.notificationToken.SendFCMTokenUseCase
import com.wire.kalium.logic.feature.user.GetDefaultProtocolUseCase
import com.wire.kalium.logic.feature.user.SelfServerConfigUseCase
import com.wire.kalium.logic.functional.Either
import com.wire.kalium.logic.functional.fold
import com.wire.kalium.logic.sync.periodic.UpdateApiVersionsScheduler
Expand Down Expand Up @@ -87,6 +91,8 @@ class DebugDataOptionsViewModelImpl
private val getCurrentAnalyticsTrackingIdentifier: GetCurrentAnalyticsTrackingIdentifierUseCase,
private val sendFCMToken: SendFCMTokenUseCase,
private val dispatcherProvider: DispatcherProvider,
private val selfServerConfigUseCase: SelfServerConfigUseCase,
private val getDefaultProtocolUseCase: GetDefaultProtocolUseCase,
) : ViewModel(), DebugDataOptionsViewModel {

var state by mutableStateOf(
Expand All @@ -102,6 +108,34 @@ class DebugDataOptionsViewModelImpl
checkIfCanTriggerManualMigration()
setGitHashAndDeviceId()
setAnalyticsTrackingId()
setServerConfigData()
setDefaultProtocol()
}

private fun setDefaultProtocol() {
viewModelScope.launch {
state = state.copy(
defaultProtocol = when (getDefaultProtocolUseCase()) {
SupportedProtocol.PROTEUS -> "Proteus"
SupportedProtocol.MLS -> "MLS"
}
)
}
}

private fun setServerConfigData() {
viewModelScope.launch {
val result = selfServerConfigUseCase()
if (result is SelfServerConfigUseCase.Result.Success) {
state = state.copy(
isFederationEnabled = result.serverLinks.metaData.federation,
currentApiVersion = when (result.serverLinks.metaData.commonApiVersion) {
CommonApiVersionType.Unknown -> "Unknown"
else -> result.serverLinks.metaData.commonApiVersion.version.toString()
},
)
}
}
}

private fun setAnalyticsTrackingId() {
Expand Down
5 changes: 5 additions & 0 deletions app/src/main/res/values/strings.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@
<string name="debug_analytics_tracking_identifier_title" translatable="false">
Analytics Tracking Identifier
</string>
<string name="debug_federation_enabled" translatable="false">Federation Enabled</string>
<string name="debug_default_backend_protocol" translatable="false">
Default Backend Protocol
</string>
<string name="debug_current_api_version" translatable="false">Current API Version</string>
<string name="label_new">New</string>
<string name="label_login">Login</string>
<string name="label_ok">OK</string>
Expand Down
186 changes: 186 additions & 0 deletions app/src/test/kotlin/com/wire/android/ui/settings/debug/DebugDataOptionsViewModelTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,21 +31,28 @@ import com.wire.android.ui.debug.DebugDataOptionsViewModelImpl
import com.wire.android.util.getDeviceIdString
import com.wire.android.util.getGitBuildId
import com.wire.android.util.ui.UIText
import com.wire.kalium.logic.CoreFailure
import com.wire.kalium.logic.configuration.server.CommonApiVersionType
import com.wire.kalium.logic.configuration.server.ServerConfig
import com.wire.kalium.logic.data.conversation.ClientId
import com.wire.kalium.logic.data.user.SupportedProtocol
import com.wire.kalium.logic.data.user.UserId
import com.wire.kalium.logic.feature.analytics.GetCurrentAnalyticsTrackingIdentifierUseCase
import com.wire.kalium.logic.feature.e2ei.CheckCrlRevocationListUseCase
import com.wire.kalium.logic.feature.keypackage.MLSKeyPackageCountResult
import com.wire.kalium.logic.feature.keypackage.MLSKeyPackageCountUseCase
import com.wire.kalium.logic.feature.notificationToken.SendFCMTokenError
import com.wire.kalium.logic.feature.notificationToken.SendFCMTokenUseCase
import com.wire.kalium.logic.feature.user.GetDefaultProtocolUseCase
import com.wire.kalium.logic.feature.user.SelfServerConfigUseCase
import com.wire.kalium.logic.functional.Either
import com.wire.kalium.logic.sync.periodic.UpdateApiVersionsScheduler
import com.wire.kalium.logic.sync.slow.RestartSlowSyncProcessForRecoveryUseCase
import io.mockk.MockKAnnotations
import io.mockk.coEvery
import io.mockk.every
import io.mockk.impl.annotations.MockK
import io.mockk.mockk
import io.mockk.mockkStatic
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.ExperimentalCoroutinesApi
Expand Down Expand Up @@ -128,6 +135,77 @@ class DebugDataOptionsViewModelTest {
assertEquals(UIText.DynamicString("Can't register token, error: error message"), result)
}
}

@Test
fun `given that Proteus protocol is used, view state should have Proteus protocol name`() = runTest {
// given
val (_, viewModel) = DebugDataOptionsHiltArrangement()
.withProteusProtocolSetup()
.arrange()

assertEquals("Proteus", viewModel.state.defaultProtocol)
}

@Test
fun `given that Mls protocol is used, view state should have proteus Mls name`() = runTest {
// given
val (_, viewModel) = DebugDataOptionsHiltArrangement()
.withMlsProtocolSetup()
.arrange()

assertEquals("MLS", viewModel.state.defaultProtocol)
}

@Test
fun `given that federation is disabled, view state should have federation value of false`() = runTest {
// given
val (_, viewModel) = DebugDataOptionsHiltArrangement()
.withFederationDisabled()
.arrange()

assertEquals(false, viewModel.state.isFederationEnabled)
}

@Test
fun `given that federation is enabled, view state should have federation value of true`() = runTest {
// given
val (_, viewModel) = DebugDataOptionsHiltArrangement()
.withFederationEnabled()
.arrange()

assertEquals(true, viewModel.state.isFederationEnabled)
}

@Test
fun `given that api version is unknown, view state should have api version unknown`() = runTest {
// given
val (_, viewModel) = DebugDataOptionsHiltArrangement()
.withApiVersionUnknown()
.arrange()

assertEquals("Unknown", viewModel.state.currentApiVersion)
}

@Test
fun `given that api version is set, view state should have api version set`() = runTest {
// given
val (_, viewModel) = DebugDataOptionsHiltArrangement()
.withApiVersionSet(7)
.arrange()

assertEquals("7", viewModel.state.currentApiVersion)
}

@Test
fun `given server config failure, view state should have default values`() = runTest {
// given
val (_, viewModel) = DebugDataOptionsHiltArrangement()
.withServerConfigError()
.arrange()

assertEquals("null", viewModel.state.currentApiVersion)
assertEquals(false, viewModel.state.isFederationEnabled)
}
}

internal class DebugDataOptionsHiltArrangement {
Expand Down Expand Up @@ -155,6 +233,12 @@ internal class DebugDataOptionsHiltArrangement {
@MockK
lateinit var getCurrentAnalyticsTrackingIdentifier: GetCurrentAnalyticsTrackingIdentifierUseCase

@MockK
lateinit var selfServerConfigUseCase: SelfServerConfigUseCase

@MockK
lateinit var getDefaultProtocolUseCase: GetDefaultProtocolUseCase

@MockK
lateinit var sendFCMToken: SendFCMTokenUseCase

Expand All @@ -170,6 +254,8 @@ internal class DebugDataOptionsHiltArrangement {
getCurrentAnalyticsTrackingIdentifier = getCurrentAnalyticsTrackingIdentifier,
sendFCMToken = sendFCMToken,
dispatcherProvider = TestDispatcherProvider(),
selfServerConfigUseCase = selfServerConfigUseCase,
getDefaultProtocolUseCase = getDefaultProtocolUseCase,
)
}

Expand All @@ -196,6 +282,22 @@ internal class DebugDataOptionsHiltArrangement {
coEvery {
globalDataStore.getUserMigrationStatus(TestUser.SELF_USER_ID.value)
} returns flowOf(UserMigrationStatus.NoNeed)
coEvery {
selfServerConfigUseCase()
} returns SelfServerConfigUseCase.Result.Success(
ServerConfig(
id = "id",
links = mockk(),
metaData = ServerConfig.MetaData(
federation = true,
commonApiVersion = CommonApiVersionType.Unknown,
domain = null,
)
)
)
every {
getDefaultProtocolUseCase()
} returns SupportedProtocol.PROTEUS
}

fun arrange() = this to viewModel
Expand Down Expand Up @@ -223,4 +325,88 @@ internal class DebugDataOptionsHiltArrangement {
sendFCMToken()
} returns Either.Left(SendFCMTokenError(SendFCMTokenError.Reason.CANT_REGISTER_TOKEN, "error message"))
}

fun withProteusProtocolSetup() = apply {
every {
getDefaultProtocolUseCase()
} returns SupportedProtocol.PROTEUS
}

fun withMlsProtocolSetup() = apply {
every {
getDefaultProtocolUseCase()
} returns SupportedProtocol.MLS
}

fun withFederationEnabled() = apply {
coEvery {
selfServerConfigUseCase()
} returns SelfServerConfigUseCase.Result.Success(
ServerConfig(
id = "id",
links = mockk(),
metaData = ServerConfig.MetaData(
federation = true,
commonApiVersion = CommonApiVersionType.Unknown,
domain = null,
)
)
)
}

fun withFederationDisabled() = apply {
coEvery {
selfServerConfigUseCase()
} returns SelfServerConfigUseCase.Result.Success(
ServerConfig(
id = "id",
links = mockk(),
metaData = ServerConfig.MetaData(
federation = false,
commonApiVersion = CommonApiVersionType.Unknown,
domain = null,
)
)
)
}

fun withApiVersionUnknown() = apply {
coEvery {
selfServerConfigUseCase()
} returns SelfServerConfigUseCase.Result.Success(
ServerConfig(
id = "id",
links = mockk(),
metaData = ServerConfig.MetaData(
federation = true,
commonApiVersion = CommonApiVersionType.Unknown,
domain = null,
)
)
)
}

fun withApiVersionSet(version: Int) = apply {
coEvery {
selfServerConfigUseCase()
} returns SelfServerConfigUseCase.Result.Success(
ServerConfig(
id = "id",
links = mockk(),
metaData = ServerConfig.MetaData(
federation = true,
commonApiVersion = CommonApiVersionType.Valid(version),
domain = null,
)
)
)
}

fun withServerConfigError() = apply {
coEvery {
selfServerConfigUseCase()
} returns SelfServerConfigUseCase.Result.Failure(
CoreFailure.Unknown(IllegalStateException())
)
}
}

0 comments on commit 0c0c629

Please sign in to comment.