Finish descriptor screen

ooni · Sep 9, 2024 · 6ff8eb1 · 6ff8eb1
1 parent 2db15ee
commit 6ff8eb1
Show file tree

Hide file tree

Showing 19 changed files with 536 additions and 39 deletions.
diff --git a/composeApp/src/commonMain/composeResources/values/strings-common.xml b/composeApp/src/commonMain/composeResources/values/strings-common.xml
@@ -1,6 +1,9 @@
 <resources>
     <string name="Dashboard_Tab_Label">Dashboard</string>
-    <string name="Dashboard_Overview_LatestTest">Last test: %1$s</string>
+    <string name="Dashboard_Overview_LatestTest">Last test:</string>
+    <string name="Dashboard_Overview_Estimated">Estimated:</string>
+    <string name="Dashboard_Overview_LastRun_Never">N/A</string>
+
     <string name="Dashboard_Running_Running">Running:</string>
     <string name="Dashboard_Running_EstimatedTimeLeft">Estimated time left:</string>
     <string name="Dashboard_Running_Stopping_Title">Stopping test…</string>
@@ -46,6 +49,7 @@
     <string name="Modal_EnableNotifications_Paragraph">Interested in running OONI Probe tests during emergent censorship events? Enable notifications to receive a message when we hear of internet censorship near you.</string>
 
     <string name="Settings_TestOptions_Label">Test options</string>
+    <string name="Settings_TestOptions_LongRunningTest">Long running test</string>
 
     <string name="Settings_AutomatedTesting_RunAutomatically">Run tests automatically</string>
     <string name="Settings_AutomatedTesting_RunAutomatically_Number">Number of automated tests: %1$s.</string>
@@ -161,6 +165,9 @@
 
     <string name="Modal_Error_CantDownloadURLs">Unable to download URL list. Please try again.</string>
 
+    <string name="AddDescriptor_Settings">Test Settings</string>
+    <string name="AddDescriptor_AutoRun">Run tests automatically</string>
+
     <!-- New Strings -->
     <string name="back">Back</string>
     <string name="refresh">refresh</string>

diff --git a/composeApp/src/commonMain/kotlin/org/ooni/engine/models/TestType.kt b/composeApp/src/commonMain/kotlin/org/ooni/engine/models/TestType.kt
@@ -134,7 +134,7 @@ sealed class TestType {
         override val iconRes: DrawableResource = Res.drawable.test_websites
         override val url: String = "https://ooni.org/nettest/web-connectivity"
 
-        override fun runtime(inputs: List<String>?) = 5.seconds * (inputs?.size ?: 1)
+        override fun runtime(inputs: List<String>?) = 5.seconds * (inputs?.ifEmpty { null }?.size ?: 30)
     }
 
     data object Whatsapp : TestType() {

diff --git a/composeApp/src/commonMain/kotlin/org/ooni/probe/data/models/Descriptor.kt b/composeApp/src/commonMain/kotlin/org/ooni/probe/data/models/Descriptor.kt
@@ -5,6 +5,7 @@ import androidx.compose.ui.graphics.Color
 import kotlinx.datetime.LocalDateTime
 import org.jetbrains.compose.resources.DrawableResource
 import org.ooni.probe.shared.now
+import kotlin.time.Duration.Companion.seconds
 
 data class Descriptor(
     val name: String,
@@ -35,4 +36,9 @@ data class Descriptor(
         }
 
     val allTests get() = netTests + longRunningTests
+
+    val estimatedDuration
+        get() = allTests
+            .sumOf { it.test.runtime(it.inputs).inWholeSeconds }
+            .seconds
 }
diff --git a/composeApp/src/commonMain/kotlin/org/ooni/probe/data/repositories/ResultRepository.kt b/composeApp/src/commonMain/kotlin/org/ooni/probe/data/repositories/ResultRepository.kt
@@ -52,6 +52,13 @@ class ResultRepository(
             .mapToOneOrNull(backgroundDispatcher)
             .map { it?.toModel() }
 
+    fun getLatestByDescriptor(descriptorKey: String): Flow<ResultModel?> =
+        database.resultQueries
+            .selectLatestByDescriptor(descriptorKey)
+            .asFlow()
+            .mapToOneOrNull(backgroundDispatcher)
+            .map { it?.toModel() }
+
     suspend fun createOrUpdate(model: ResultModel): ResultModel.Id =
         withContext(backgroundDispatcher) {
             database.transactionWithResult {

diff --git a/composeApp/src/commonMain/kotlin/org/ooni/probe/di/Dependencies.kt b/composeApp/src/commonMain/kotlin/org/ooni/probe/di/Dependencies.kt
@@ -55,6 +55,7 @@ import org.ooni.probe.domain.TestRunStateManager
 import org.ooni.probe.domain.UploadMissingMeasurements
 import org.ooni.probe.shared.PlatformInfo
 import org.ooni.probe.ui.dashboard.DashboardViewModel
+import org.ooni.probe.ui.descriptor.DescriptorViewModel
 import org.ooni.probe.ui.result.ResultViewModel
 import org.ooni.probe.ui.results.ResultsViewModel
 import org.ooni.probe.ui.run.RunViewModel
@@ -236,15 +237,29 @@ class Dependencies(
         goToResults: () -> Unit,
         goToRunningTest: () -> Unit,
         goToRunTests: () -> Unit,
+        goToDescriptor: (String) -> Unit,
     ) = DashboardViewModel(
         goToResults = goToResults,
         goToRunningTest = goToRunningTest,
         goToRunTests = goToRunTests,
+        goToDescriptor = goToDescriptor,
         getTestDescriptors = getTestDescriptors::invoke,
         observeTestRunState = testStateManager.observeState(),
         observeTestRunErrors = testStateManager.observeError(),
     )
 
+    fun descriptorViewModel(
+        descriptorKey: String,
+        onBack: () -> Unit,
+    ) = DescriptorViewModel(
+        descriptorKey = descriptorKey,
+        onBack = onBack,
+        getTestDescriptors = getTestDescriptors::invoke,
+        getDescriptorLastResult = resultRepository::getLatestByDescriptor,
+        preferenceRepository = preferenceRepository,
+        launchUrl = { launchUrl(it, null) },
+    )
+
     fun proxyViewModel(onBack: () -> Unit) = ProxyViewModel(onBack, preferenceRepository)
 
     fun resultsViewModel(

diff --git a/composeApp/src/commonMain/kotlin/org/ooni/probe/domain/GetTestDescriptors.kt b/composeApp/src/commonMain/kotlin/org/ooni/probe/domain/GetTestDescriptors.kt
@@ -1,9 +1,12 @@
 package org.ooni.probe.domain
 
+import androidx.compose.runtime.Composable
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.asFlow
 import kotlinx.coroutines.flow.flatMapLatest
 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.probe.data.models.DefaultTestDescriptor
 import org.ooni.probe.data.models.Descriptor
@@ -33,7 +36,13 @@ class GetTestDescriptors(
             name = label,
             title = { stringResource(title) },
             shortDescription = { stringResource(shortDescription) },
-            description = { stringResource(description) },
+            description = {
+                if (label == "experimental") {
+                    stringResource(description, experimentalLinks())
+                } else {
+                    stringResource(description)
+                }
+            },
             icon = icon,
             color = color,
             animation = animation,
@@ -58,4 +67,17 @@ class GetTestDescriptors(
             netTests = netTests.orEmpty(),
             source = Descriptor.Source.Installed(this),
         )
+
+    @Composable
+    private fun experimentalLinks() =
+        """
+        * [STUN Reachability](https://github.com/ooni/spec/blob/master/nettests/ts-025-stun-reachability.md)
+        * [DNS Check](https://github.com/ooni/spec/blob/master/nettests/ts-028-dnscheck.md)
+        * [RiseupVPN](https://ooni.org/nettest/riseupvpn/)
+        * [ECH Check](https://github.com/ooni/spec/blob/master/nettests/ts-039-echcheck.md)
+        * [Tor Snowflake](https://ooni.org/nettest/tor-snowflake/) (${stringResource(Res.string.Settings_TestOptions_LongRunningTest)})
+        * [Vanilla Tor](https://github.com/ooni/spec/blob/master/nettests/ts-016-vanilla-tor.md) (${stringResource(
+            Res.string.Settings_TestOptions_LongRunningTest,
+        )})
+        """.trimIndent()
 }
diff --git a/composeApp/src/commonMain/kotlin/org/ooni/probe/domain/RunDescriptors.kt b/composeApp/src/commonMain/kotlin/org/ooni/probe/domain/RunDescriptors.kt
@@ -21,7 +21,6 @@ import org.ooni.probe.data.models.TestRunState
 import org.ooni.probe.data.models.UrlModel
 import org.ooni.probe.shared.now
 import kotlin.time.Duration
-import kotlin.time.Duration.Companion.seconds
 
 class RunDescriptors(
     private val getTestDescriptorsBySpec: suspend (RunSpecification) -> List<Descriptor>,
@@ -115,10 +114,7 @@ class RunDescriptors(
     private suspend fun List<Descriptor>.getEstimatedRuntime(): List<Duration> {
         val maxRuntime = getEnginePreferences().maxRuntime
         return map { descriptor ->
-            descriptor.netTests
-                .sumOf { it.test.runtime(it.inputs).inWholeSeconds }
-                .seconds
-                .coerceAtMost(maxRuntime ?: Duration.INFINITE)
+            descriptor.estimatedDuration.coerceAtMost(maxRuntime ?: Duration.INFINITE)
         }
     }
 

diff --git a/composeApp/src/commonMain/kotlin/org/ooni/probe/ui/dashboard/DashboardScreen.kt b/composeApp/src/commonMain/kotlin/org/ooni/probe/ui/dashboard/DashboardScreen.kt
@@ -3,6 +3,7 @@ package org.ooni.probe.ui.dashboard
 import androidx.compose.foundation.Image
 import androidx.compose.foundation.clickable
 import androidx.compose.foundation.layout.Column
+import androidx.compose.foundation.layout.PaddingValues
 import androidx.compose.foundation.layout.Row
 import androidx.compose.foundation.layout.WindowInsets
 import androidx.compose.foundation.layout.asPaddingValues
@@ -69,16 +70,22 @@ fun DashboardScreen(
 
         LazyColumn(
             modifier = Modifier.padding(top = 24.dp),
+            contentPadding = PaddingValues(bottom = 16.dp),
         ) {
-            val allSectionsHaveValues = state.tests.entries.all { it.value.any() }
-            state.tests.forEach { (type, tests) ->
-                if (allSectionsHaveValues && tests.isNotEmpty()) {
+            val allSectionsHaveValues = state.descriptors.entries.all { it.value.any() }
+            state.descriptors.forEach { (type, items) ->
+                if (allSectionsHaveValues && items.isNotEmpty()) {
                     item(type) {
                         TestDescriptorSection(type)
                     }
                 }
-                items(tests, key = { it.key }) { test ->
-                    TestDescriptorItem(test)
+                items(items, key = { it.key }) { descriptor ->
+                    TestDescriptorItem(
+                        descriptor = descriptor,
+                        onClick = {
+                            onEvent(DashboardViewModel.Event.DescriptorClicked(descriptor))
+                        },
+                    )
                 }
             }
         }
@@ -113,10 +120,8 @@ private fun TestRunStateSection(
             }
             state.lastTestAt?.let { lastTestAt ->
                 Text(
-                    text = stringResource(
-                        Res.string.Dashboard_Overview_LatestTest,
-                        lastTestAt.relativeDateTime(),
-                    ),
+                    text = stringResource(Res.string.Dashboard_Overview_LatestTest) +
+                        " " + lastTestAt.relativeDateTime(),
                     style = MaterialTheme.typography.labelLarge,
                     modifier = Modifier.padding(top = 4.dp),
                 )

diff --git a/composeApp/src/commonMain/kotlin/org/ooni/probe/ui/dashboard/DashboardViewModel.kt b/composeApp/src/commonMain/kotlin/org/ooni/probe/ui/dashboard/DashboardViewModel.kt
@@ -19,6 +19,7 @@ class DashboardViewModel(
     goToResults: () -> Unit,
     goToRunningTest: () -> Unit,
     goToRunTests: () -> Unit,
+    goToDescriptor: (String) -> Unit,
     getTestDescriptors: () -> Flow<List<Descriptor>>,
     observeTestRunState: Flow<TestRunState>,
     observeTestRunErrors: Flow<TestRunError>,
@@ -31,7 +32,7 @@ class DashboardViewModel(
     init {
         getTestDescriptors()
             .onEach { tests ->
-                _state.update { it.copy(tests = tests.groupByType()) }
+                _state.update { it.copy(descriptors = tests.groupByType()) }
             }
             .launchIn(viewModelScope)
 
@@ -68,6 +69,11 @@ class DashboardViewModel(
                 _state.update { it.copy(testRunErrors = it.testRunErrors - event.error) }
             }
             .launchIn(viewModelScope)
+
+        events
+            .filterIsInstance<Event.DescriptorClicked>()
+            .onEach { goToDescriptor(it.descriptor.key) }
+            .launchIn(viewModelScope)
     }
 
     fun onEvent(event: Event) {
@@ -81,7 +87,7 @@ class DashboardViewModel(
         )
 
     data class State(
-        val tests: Map<DescriptorType, List<Descriptor>> = emptyMap(),
+        val descriptors: Map<DescriptorType, List<Descriptor>> = emptyMap(),
         val testRunState: TestRunState = TestRunState.Idle(),
         val testRunErrors: List<TestRunError> = emptyList(),
     )
@@ -94,5 +100,7 @@ class DashboardViewModel(
         data object SeeResultsClick : Event
 
         data class ErrorDisplayed(val error: TestRunError) : Event
+
+        data class DescriptorClicked(val descriptor: Descriptor) : Event
     }
 }
diff --git a/composeApp/src/commonMain/kotlin/org/ooni/probe/ui/dashboard/TestDescriptorItem.kt b/composeApp/src/commonMain/kotlin/org/ooni/probe/ui/dashboard/TestDescriptorItem.kt
@@ -1,5 +1,6 @@
 package org.ooni.probe.ui.dashboard
 
+import androidx.compose.foundation.clickable
 import androidx.compose.foundation.layout.Column
 import androidx.compose.foundation.layout.Row
 import androidx.compose.foundation.layout.fillMaxWidth
@@ -17,10 +18,14 @@ import org.jetbrains.compose.resources.painterResource
 import org.ooni.probe.data.models.Descriptor
 
 @Composable
-fun TestDescriptorItem(descriptor: Descriptor) {
+fun TestDescriptorItem(
+    descriptor: Descriptor,
+    onClick: () -> Unit,
+) {
     Card(
         Modifier
-            .padding(horizontal = 16.dp, vertical = 4.dp),
+            .padding(horizontal = 16.dp, vertical = 4.dp)
+            .clickable { onClick() },
     ) {
         Row(
             verticalAlignment = Alignment.CenterVertically,