feat: add ooni test descriptors

Author: aanorbel

composeApp/src/commonMain/kotlin/org/ooni/probe/data/models/Descriptor.kt

@@ -45,7 +45,7 @@ data class Descriptor(
     val key: String
         get() = when (source) {
             is Source.Default -> name
-            is Source.Installed -> source.value.id.value
+            is Source.Installed -> source.value.key.id.value
         }
 
     val allTests get() = netTests + longRunningTests
@@ -57,6 +57,26 @@ data class Descriptor(
 
     val isWebConnectivityOnly get() =
         allTests.size == 1 && allTests.first().test == TestType.WebConnectivity
+
+    val settingsPrefix: String?
+        get() = when (isDefaultDescriptor()) {
+            true -> null
+            else -> (source as Source.Installed)
+                .value.id.value
+                .toString()
+        }
+
+    fun isDefaultDescriptor(): Boolean =
+        when (source) {
+            is Source.Default -> true
+            is Source.Installed -> source.value.isDefaultTestDescriptor
+        }
+
+    fun isInstalledNonDefaultDescriptor(): Boolean =
+        when (source) {
+            is Source.Installed -> !source.value.isDefaultTestDescriptor
+            else -> false
+        }
 }
 
 fun List<Descriptor>.notExpired() = filter { !it.isExpired }

composeApp/src/commonMain/kotlin/org/ooni/probe/data/models/InstalledTestDescriptorModel.kt

@@ -6,16 +6,20 @@ import kotlinx.datetime.format
 import kotlinx.datetime.format.MonthNames
 import kotlinx.datetime.format.char
 import kotlinx.serialization.Serializable
-import kotlinx.serialization.encodeToString
 import kotlinx.serialization.json.Json
 import ooniprobe.composeapp.generated.resources.Dashboard_Runv2_Overview_Description
 import ooniprobe.composeapp.generated.resources.Dashboard_Runv2_Overview_LastUpdated
 import ooniprobe.composeapp.generated.resources.Res
+import ooniprobe.composeapp.generated.resources.TestResults_NotAvailable
+import ooniprobe.composeapp.generated.resources.performance_datausage
+import ooniprobe.composeapp.generated.resources.small_datausage
 import ooniprobe.composeapp.generated.resources.test_circumvention
 import ooniprobe.composeapp.generated.resources.test_experimental
 import ooniprobe.composeapp.generated.resources.test_instant_messaging
 import ooniprobe.composeapp.generated.resources.test_performance
 import ooniprobe.composeapp.generated.resources.test_websites
+import ooniprobe.composeapp.generated.resources.websites_datausage
+import org.jetbrains.compose.resources.StringResource
 import org.jetbrains.compose.resources.stringResource
 import org.ooni.engine.models.SummaryType
 import org.ooni.probe.data.TestDescriptor
@@ -24,6 +28,26 @@ import org.ooni.probe.shared.hexToColor
 import org.ooni.probe.shared.stringMonthArrayResource
 import org.ooni.probe.shared.toEpoch
 
+enum class OoniTest(
+    val id: Long,
+    val key: String,
+) {
+    WEBSITES(10470L, "websites"),
+    INSTANT_MESSAGING(10471L, "instant_messaging"),
+    CIRCUMVENTION(10472L, "circumvention"),
+    PERFORMANCE(10473L, "performance"),
+    EXPERIMENTAL(10474L, "experimental"),
+    ;
+
+    companion object {
+        private val map = entries.associateBy(OoniTest::id)
+
+        fun fromId(id: Long) = map[id]
+
+        fun isValidId(id: Long): Boolean = entries.any { it.id == id }
+    }
+}
+
 @Serializable
 data class InstalledTestDescriptorModel(
     val id: Id,
@@ -56,6 +80,8 @@ data class InstalledTestDescriptorModel(
         val revision: Long,
     )
 
+    val isDefaultTestDescriptor get() = OoniTest.isValidId(id.value.toLongOrNull() ?: -1L)
+
     val key get() = Key(id, revision)
 
     val previousRevisions
@@ -85,7 +111,7 @@ fun InstalledTestDescriptorModel.toDescriptor(updateStatus: UpdateStatus = Updat
         icon = icon?.let(InstalledDescriptorIcons::getIconFromValue),
         color = color?.hexToColor(),
         animation = icon?.let { determineAnimation(it) } ?: animation?.let(Animation::fromFileName),
-        dataUsage = { null },
+        dataUsage = { if (isDefaultTestDescriptor) stringResource(getDataUsage()) else null },
         expirationDate = expirationDate,
         netTests = netTests.orEmpty(),
         source = Descriptor.Source.Installed(this),
@@ -94,6 +120,22 @@ fun InstalledTestDescriptorModel.toDescriptor(updateStatus: UpdateStatus = Updat
         summaryType = SummaryType.Anomaly,
     )
 
+fun InstalledTestDescriptorModel.getDataUsage(): StringResource =
+    when (
+        OoniTest
+            .fromId(
+                this.key.id.value
+                    .toLong(),
+            )?.key
+    ) {
+        OoniTest.WEBSITES.key -> Res.string.websites_datausage
+        OoniTest.INSTANT_MESSAGING.key -> Res.string.small_datausage
+        OoniTest.CIRCUMVENTION.key -> Res.string.small_datausage
+        OoniTest.PERFORMANCE.key -> Res.string.performance_datausage
+        OoniTest.EXPERIMENTAL.key -> Res.string.TestResults_NotAvailable
+        else -> Res.string.TestResults_NotAvailable
+    }
+
 private val iconAnimationMap = mapOf(
     Res.drawable.test_websites to Animation.Websites,
     Res.drawable.test_instant_messaging to Animation.InstantMessaging,

composeApp/src/commonMain/kotlin/org/ooni/probe/data/repositories/PreferenceRepository.kt

@@ -205,11 +205,7 @@ class PreferenceRepository(
         isAutoRun: Boolean,
     ) = getPreferenceKey(
         name = netTest.test.preferenceKey,
-        prefix = (descriptor.source as? Descriptor.Source.Installed)
-            ?.value
-            ?.id
-            ?.value
-            ?.toString(),
+        prefix = descriptor.settingsPrefix,
         autoRun = isAutoRun,
     )
 

composeApp/src/commonMain/kotlin/org/ooni/probe/di/Dependencies.kt

@@ -55,7 +55,6 @@ import org.ooni.probe.domain.FinishInProgressData
 import org.ooni.probe.domain.GetAutoRunSettings
 import org.ooni.probe.domain.GetAutoRunSpecification
 import org.ooni.probe.domain.GetBootstrapTestDescriptors
-import org.ooni.probe.domain.GetDefaultTestDescriptors
 import org.ooni.probe.domain.GetEnginePreferences
 import org.ooni.probe.domain.GetFirstRun
 import org.ooni.probe.domain.GetLastResultOfDescriptor
@@ -303,7 +302,6 @@ class Dependencies(
     private val getBootstrapTestDescriptors by lazy {
         GetBootstrapTestDescriptors(readAssetFile, json, backgroundContext)
     }
-    private val getDefaultTestDescriptors by lazy { GetDefaultTestDescriptors() }
     private val getProxySettings by lazy { GetProxySettings(preferenceRepository) }
     private val getEnginePreferences by lazy {
         GetEnginePreferences(
@@ -366,7 +364,6 @@ class Dependencies(
     @VisibleForTesting
     val getTestDescriptors by lazy {
         GetTestDescriptors(
-            getDefaultTestDescriptors = getDefaultTestDescriptors::invoke,
             listAllInstalledTestDescriptors = testDescriptorRepository::listAll,
             listLatestInstalledTestDescriptors = testDescriptorRepository::listLatest,
             observeDescriptorsUpdateState = descriptorUpdateStateManager::observe,

composeApp/src/dwMain/kotlin/org/ooni/probe/domain/GetBootstrapTestDescriptors.kt renamed to composeApp/src/commonMain/kotlin/org/ooni/probe/domain/GetBootstrapTestDescriptors.kt

@@ -16,7 +16,6 @@ class GetBootstrapTestDescriptors(
 ) {
     suspend operator fun invoke(): List<InstalledTestDescriptorModel> =
         withContext(backgroundContext) {
-
             val descriptorsJson = Res.readBytes("files/assets/descriptors.json").decodeToString()
             val descriptors =
                 try {

composeApp/src/commonMain/kotlin/org/ooni/probe/domain/GetResults.kt

@@ -38,7 +38,9 @@ fun List<Descriptor>.forResult(result: ResultModel): Descriptor? =
     result.descriptorKey
         ?.let { key ->
             firstOrNull {
-                it.source is Descriptor.Source.Installed && it.source.value.key == key
+                it.source is Descriptor.Source.Installed &&
+                    it.source.value.key
+                        .toString() == key.toString()
             }
         }
         ?: firstOrNull { it.name == result.descriptorName }

composeApp/src/commonMain/kotlin/org/ooni/probe/domain/descriptors/GetTestDescriptors.kt

@@ -3,22 +3,18 @@ package org.ooni.probe.domain.descriptors
 import androidx.compose.runtime.Composable
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.combine
-import kotlinx.coroutines.flow.flowOf
 import kotlinx.coroutines.flow.map
 import ooniprobe.composeapp.generated.resources.Res
 import ooniprobe.composeapp.generated.resources.Settings_TestOptions_LongRunningTest
 import org.jetbrains.compose.resources.stringResource
 import org.ooni.engine.models.WebConnectivityCategory
-import org.ooni.probe.data.models.DefaultTestDescriptor
 import org.ooni.probe.data.models.Descriptor
 import org.ooni.probe.data.models.DescriptorsUpdateState
 import org.ooni.probe.data.models.InstalledTestDescriptorModel
 import org.ooni.probe.data.models.SettingsKey
-import org.ooni.probe.data.models.UpdateStatus
 import org.ooni.probe.data.models.toDescriptor
 
 class GetTestDescriptors(
-    private val getDefaultTestDescriptors: () -> List<DefaultTestDescriptor>,
     private val listAllInstalledTestDescriptors: () -> Flow<List<InstalledTestDescriptorModel>>,
     private val listLatestInstalledTestDescriptors: () -> Flow<List<InstalledTestDescriptorModel>>,
     private val observeDescriptorsUpdateState: () -> Flow<DescriptorsUpdateState>,
@@ -38,14 +34,12 @@ class GetTestDescriptors(
         return combine(
             installedDescriptorFlow(),
             observeDescriptorsUpdateState(),
-            flowOf(getDefaultTestDescriptors()),
             isWebsitesDescriptorEnabled(),
-        ) { installedDescriptors, descriptorUpdates, defaultDescriptors, isWebsitesEnabled ->
+        ) { installedDescriptors, descriptorUpdates, isWebsitesEnabled ->
             val updatedDescriptors = installedDescriptors.map { item ->
                 item.toDescriptor(updateStatus = descriptorUpdates.getStatusOf(item.id))
             }
-            val allDescriptors = defaultDescriptors.map { it.toDescriptor() } + updatedDescriptors
-            return@combine allDescriptors.map {
+            return@combine updatedDescriptors.map {
                 it.copy(enabled = it.name != "websites" || isWebsitesEnabled)
             }
         }
@@ -55,30 +49,6 @@ class GetTestDescriptors(
         getPreferenceValues(WebConnectivityCategory.entries.mapNotNull { it.settingsKey })
             .map { preferences -> preferences.any { it.value == true } }
 
-    private fun DefaultTestDescriptor.toDescriptor() =
-        Descriptor(
-            name = label,
-            title = { stringResource(title) },
-            shortDescription = { stringResource(shortDescription) },
-            description = {
-                if (label == "experimental") {
-                    stringResource(description, experimentalLinks())
-                } else {
-                    stringResource(description)
-                }
-            },
-            icon = icon,
-            color = color,
-            animation = animation,
-            dataUsage = { stringResource(dataUsage) },
-            expirationDate = null,
-            netTests = netTests,
-            longRunningTests = longRunningTests,
-            source = Descriptor.Source.Default(this),
-            updateStatus = UpdateStatus.NotApplicable,
-            summaryType = summaryType,
-        )
-
     @Composable
     private fun experimentalLinks() =
         """

composeApp/src/commonMain/kotlin/org/ooni/probe/domain/descriptors/GetTestDescriptorsBySpec.kt

@@ -34,16 +34,13 @@ class GetTestDescriptorsBySpec(
     // Is this descriptor contained in the RunSpecification's list of tests
     private fun RunSpecification.Full.forDescriptor(descriptor: Descriptor) =
         tests.firstOrNull { specTest ->
-            when (descriptor.source) {
-                is Descriptor.Source.Default -> {
+            when (val source = descriptor.source) {
+                is Descriptor.Source.Default ->
                     specTest.source is RunSpecification.Test.Source.Default &&
-                        specTest.source.name == descriptor.name
-                }
-
-                is Descriptor.Source.Installed -> {
+                        specTest.source.name == source.value.label
+                is Descriptor.Source.Installed ->
                     specTest.source is RunSpecification.Test.Source.Installed &&
-                        specTest.source.id == descriptor.source.value.id
-                }
+                        specTest.source.id == source.value.id
             }
         }
 

composeApp/src/commonMain/kotlin/org/ooni/probe/ui/choosewebsites/ChooseWebsitesViewModel.kt

@@ -15,7 +15,9 @@ import kotlinx.coroutines.flow.update
 import kotlinx.coroutines.launch
 import org.ooni.engine.models.TaskOrigin
 import org.ooni.engine.models.TestType
+import org.ooni.probe.data.models.InstalledTestDescriptorModel
 import org.ooni.probe.data.models.NetTest
+import org.ooni.probe.data.models.OoniTest
 import org.ooni.probe.data.models.RunSpecification
 import org.ooni.probe.data.models.SettingsKey
 import org.ooni.probe.ui.shared.isValidUrl
@@ -133,7 +135,9 @@ class ChooseWebsitesViewModel(
                     RunSpecification.Full(
                         tests = listOf(
                             RunSpecification.Test(
-                                source = RunSpecification.Test.Source.Default("websites"),
+                                source = RunSpecification.Test.Source.Installed(
+                                    InstalledTestDescriptorModel.Id(OoniTest.WEBSITES.key),
+                                ),
                                 netTests = listOf(
                                     NetTest(
                                         test = TestType.WebConnectivity,

composeApp/src/commonMain/kotlin/org/ooni/probe/ui/dashboard/DashboardViewModel.kt

@@ -181,8 +181,8 @@ class DashboardViewModel(
 
     private fun List<Descriptor>.groupByType() =
         mapOf(
-            DescriptorType.Default to filter { it.source is Descriptor.Source.Default },
-            DescriptorType.Installed to filter { it.source is Descriptor.Source.Installed },
+            DescriptorType.Default to filter { it.isDefaultDescriptor() },
+            DescriptorType.Installed to filter { it.isInstalledNonDefaultDescriptor() },
         )
 
     data class State(