Require accepting terms and privacy policy

LaurentTreguier · LaurentTreguier · commit d8112bbd484e · 2024-10-04T17:19:07.000+02:00
diff --git a/app/src/main/kotlin/app/fyreplace/fyreplace/fakes/api/FakeUsersEndpointApi.kt b/app/src/main/kotlin/app/fyreplace/fyreplace/fakes/api/FakeUsersEndpointApi.kt
@@ -75,9 +75,9 @@ class FakeUsersEndpointApi : UsersEndpointApi {
         const val PASSWORD_USERNAME = "password-username"
         const val GOOD_USERNAME = "good-username"
 
-        const val BAD_EMAIL = "bad-email"
-        const val USED_EMAIL = "used-email"
-        const val GOOD_EMAIL = "good-email"
+        const val BAD_EMAIL = "bad@email"
+        const val USED_EMAIL = "used@email"
+        const val GOOD_EMAIL = "good@email"
 
         val NOT_IMAGE_FILE = File("text.txt")
         val LARGE_IMAGE_FILE = File("large.png")
diff --git a/app/src/main/kotlin/app/fyreplace/fyreplace/ui/screens/LoginScreen.kt b/app/src/main/kotlin/app/fyreplace/fyreplace/ui/screens/LoginScreen.kt
@@ -76,7 +76,7 @@ fun SharedTransitionScope.LoginScreen(
         modifier = Modifier
             .verticalScroll(rememberScrollState())
             .fillMaxWidth()
-            .padding(horizontal = dimensionResource(R.dimen.spacing_medium))
+            .padding(horizontal = dimensionResource(R.dimen.spacing_large))
             .imePadding()
     ) {
         Logo(
@@ -101,11 +101,12 @@ fun SharedTransitionScope.LoginScreen(
             )
         }
 
-        val textFieldModifier = Modifier
+        val fieldModifier = Modifier
             .widthIn(
                 dimensionResource(R.dimen.form_min_width),
                 dimensionResource(R.dimen.form_max_width)
             )
+            .fillMaxWidth()
             .padding(bottom = dimensionResource(R.dimen.spacing_large))
 
         OutlinedTextField(
@@ -127,7 +128,7 @@ fun SharedTransitionScope.LoginScreen(
                 }
             }),
             onValueChange = viewModel::updateIdentifier,
-            modifier = textFieldModifier
+            modifier = fieldModifier
                 .focusRequester(identifierFocus)
                 .sharedElement(
                     rememberSharedContentState(key = "first-field"),
@@ -139,7 +140,7 @@ fun SharedTransitionScope.LoginScreen(
             RandomCodeInput(
                 randomCode = randomCode,
                 onValueChange = viewModel::updateRandomCode,
-                modifier = textFieldModifier
+                modifier = fieldModifier
             )
         }
 
diff --git a/app/src/main/kotlin/app/fyreplace/fyreplace/ui/screens/RegisterScreen.kt b/app/src/main/kotlin/app/fyreplace/fyreplace/ui/screens/RegisterScreen.kt
@@ -8,6 +8,7 @@ import androidx.compose.animation.SharedTransitionScope
 import androidx.compose.foundation.layout.Arrangement
 import androidx.compose.foundation.layout.Box
 import androidx.compose.foundation.layout.Column
+import androidx.compose.foundation.layout.Row
 import androidx.compose.foundation.layout.fillMaxWidth
 import androidx.compose.foundation.layout.imePadding
 import androidx.compose.foundation.layout.padding
@@ -16,8 +17,10 @@ import androidx.compose.foundation.rememberScrollState
 import androidx.compose.foundation.text.KeyboardActions
 import androidx.compose.foundation.text.KeyboardOptions
 import androidx.compose.foundation.verticalScroll
+import androidx.compose.material3.Checkbox
 import androidx.compose.material3.OutlinedTextField
 import androidx.compose.material3.Text
+import androidx.compose.material3.TextButton
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.runtime.getValue
@@ -29,11 +32,15 @@ import androidx.compose.ui.focus.focusProperties
 import androidx.compose.ui.focus.focusRequester
 import androidx.compose.ui.platform.LocalContext
 import androidx.compose.ui.platform.LocalSoftwareKeyboardController
+import androidx.compose.ui.platform.LocalUriHandler
 import androidx.compose.ui.res.dimensionResource
 import androidx.compose.ui.res.stringResource
+import androidx.compose.ui.text.LinkAnnotation
+import androidx.compose.ui.text.buildAnnotatedString
 import androidx.compose.ui.text.input.ImeAction
 import androidx.compose.ui.text.input.KeyboardCapitalization
 import androidx.compose.ui.text.input.KeyboardType
+import androidx.compose.ui.text.withLink
 import androidx.compose.ui.tooling.preview.Preview
 import androidx.hilt.navigation.compose.hiltViewModel
 import androidx.lifecycle.SavedStateHandle
@@ -66,6 +73,7 @@ fun SharedTransitionScope.RegisterScreen(
     val environment by environmentViewModel.environment.collectAsStateWithLifecycle()
     val username by viewModel.username.collectAsStateWithLifecycle()
     val email by viewModel.email.collectAsStateWithLifecycle()
+    val hasAcceptedTerms by viewModel.hasAcceptedTerms.collectAsStateWithLifecycle()
     val randomCode by viewModel.randomCode.collectAsStateWithLifecycle()
     val isWaitingForRandomCode by viewModel.isWaitingForRandomCode.collectAsStateWithLifecycle()
     val canSubmit by viewModel.canSubmit.collectAsStateWithLifecycle()
@@ -80,7 +88,7 @@ fun SharedTransitionScope.RegisterScreen(
         modifier = Modifier
             .verticalScroll(rememberScrollState())
             .fillMaxWidth()
-            .padding(horizontal = dimensionResource(R.dimen.spacing_medium))
+            .padding(horizontal = dimensionResource(R.dimen.spacing_large))
             .imePadding()
     ) {
         Logo(
@@ -105,11 +113,12 @@ fun SharedTransitionScope.RegisterScreen(
             )
         }
 
-        val textFieldModifier = Modifier
+        val fieldModifier = Modifier
             .widthIn(
                 dimensionResource(R.dimen.form_min_width),
                 dimensionResource(R.dimen.form_max_width)
             )
+            .fillMaxWidth()
             .padding(bottom = dimensionResource(R.dimen.spacing_large))
 
         OutlinedTextField(
@@ -124,7 +133,7 @@ fun SharedTransitionScope.RegisterScreen(
                 imeAction = ImeAction.Next
             ),
             onValueChange = viewModel::updateUsername,
-            modifier = textFieldModifier
+            modifier = fieldModifier
                 .focusRequester(usernameFocus)
                 .focusProperties { next = emailFocus }
                 .sharedElement(
@@ -153,17 +162,59 @@ fun SharedTransitionScope.RegisterScreen(
                 }
             }),
             onValueChange = viewModel::updateEmail,
-            modifier = textFieldModifier.focusRequester(emailFocus)
+            modifier = fieldModifier.focusRequester(emailFocus)
         )
 
         AnimatedVisibility(isWaitingForRandomCode) {
             RandomCodeInput(
                 randomCode = randomCode,
                 onValueChange = viewModel::updateRandomCode,
-                modifier = textFieldModifier
+                modifier = fieldModifier
+            )
+        }
+
+        Row(
+            verticalAlignment = Alignment.CenterVertically,
+            modifier = fieldModifier
+        ) {
+            Checkbox(
+                checked = hasAcceptedTerms,
+                enabled = !isWaitingForRandomCode,
+                onCheckedChange = viewModel::updateHasAcceptedTerms
+            )
+
+            Text(
+                text = buildAnnotatedString {
+                    withLink(LinkAnnotation.Clickable("terms") {
+                        viewModel.updateHasAcceptedTerms(!hasAcceptedTerms)
+                    }) {
+                        append(stringResource(R.string.register_terms_acceptance))
+                    }
+                },
+                modifier = Modifier.focusProperties { canFocus = false }
             )
         }
 
+        Row(
+            horizontalArrangement = Arrangement.spacedBy(
+                space = dimensionResource(R.dimen.spacing_small),
+                alignment = Alignment.CenterHorizontally
+            ),
+            modifier = fieldModifier
+        ) {
+            val uriHandler = LocalUriHandler.current
+            val termsUri = stringResource(R.string.info_url_terms_of_service)
+            val privacyUri = stringResource(R.string.info_url_privacy_policy)
+
+            TextButton(onClick = { uriHandler.openUri(termsUri) }) {
+                Text(stringResource(R.string.register_terms_of_service))
+            }
+
+            TextButton(onClick = { uriHandler.openUri(privacyUri) }) {
+                Text(stringResource(R.string.register_privacy_policy))
+            }
+        }
+
         SubmitOrCancel(
             submitLabel = stringResource(R.string.register_submit),
             canSubmit = canSubmit,
diff --git a/app/src/main/kotlin/app/fyreplace/fyreplace/ui/views/account/EnvironmentSelector.kt b/app/src/main/kotlin/app/fyreplace/fyreplace/ui/views/account/EnvironmentSelector.kt
@@ -87,7 +87,7 @@ private fun SelectorDialog(
                             onClick = onClick
                         )
                         Text(
-                            buildAnnotatedString {
+                            text = buildAnnotatedString {
                                 withLink(LinkAnnotation.Clickable("name") { onClick() }) {
                                     append(name(env))
 
diff --git a/app/src/main/kotlin/app/fyreplace/fyreplace/viewmodels/screens/LoginViewModel.kt b/app/src/main/kotlin/app/fyreplace/fyreplace/viewmodels/screens/LoginViewModel.kt
@@ -16,6 +16,7 @@ import dagger.hilt.android.lifecycle.HiltViewModel
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.first
 import kotlinx.coroutines.flow.map
+import kotlinx.coroutines.flow.onStart
 import kotlinx.coroutines.launch
 import javax.inject.Inject
 import kotlin.math.min
@@ -32,16 +33,12 @@ class LoginViewModel @Inject constructor(
 ) : AccountViewModelBase(state, eventBus, storeResolver, resourceResolver, secretsHandler) {
     val identifier: StateFlow<String> =
         state.getStateFlow(::identifier.name, "")
+            .onStart { updateIdentifier(storeResolver.accountStore.data.first().identifier) }
+            .asState("")
 
     override val isFirstStepValid = identifier
         .map { it.isNotBlank() && it.length >= resourceResolver.getInteger(R.integer.username_min_length) }
 
-    init {
-        viewModelScope.launch {
-            updateIdentifier(storeResolver.accountStore.data.map { it.identifier }.first())
-        }
-    }
-
     fun updateIdentifier(value: String) {
         val maxLength = resourceResolver.getInteger(R.integer.email_max_length)
         val newValue = value.substring(0, min(maxLength, value.length))
diff --git a/app/src/main/kotlin/app/fyreplace/fyreplace/viewmodels/screens/RegisterViewModel.kt b/app/src/main/kotlin/app/fyreplace/fyreplace/viewmodels/screens/RegisterViewModel.kt
@@ -17,6 +17,7 @@ import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.combine
 import kotlinx.coroutines.flow.distinctUntilChanged
 import kotlinx.coroutines.flow.first
+import kotlinx.coroutines.flow.onStart
 import kotlinx.coroutines.launch
 import javax.inject.Inject
 import kotlin.math.min
@@ -32,16 +33,18 @@ class RegisterViewModel @Inject constructor(
 ) : AccountViewModelBase(state, eventBus, storeResolver, resourceResolver, secretsHandler) {
     val username: StateFlow<String> =
         state.getStateFlow(::username.name, "")
+            .onStart { updateUsername(storeResolver.accountStore.data.first().username) }
+            .asState("")
     val email: StateFlow<String> =
         state.getStateFlow(::email.name, "")
-
-    init {
-        viewModelScope.launch {
-            val account = storeResolver.accountStore.data.first()
-            updateUsername(account.username)
-            updateEmail(account.email)
-        }
-    }
+            .onStart { updateEmail(storeResolver.accountStore.data.first().email) }
+            .asState("")
+    val hasAcceptedTerms: StateFlow<Boolean> =
+        state.getStateFlow(::hasAcceptedTerms.name, false)
+            .combine(isWaitingForRandomCode) { hasAcceptedTerms, isWaitingForRandomCode ->
+                hasAcceptedTerms || isWaitingForRandomCode
+            }
+            .asState(false)
 
     override val isFirstStepValid = username
         .combine(email) { username, email ->
@@ -53,6 +56,7 @@ class RegisterViewModel @Inject constructor(
                     && email.length >= emailMinLength
                     && email.contains('@'))
         }
+        .combine(hasAcceptedTerms) { isDataValid, hasAcceptedTerms -> isDataValid && hasAcceptedTerms }
         .distinctUntilChanged()
         .asState(false)
 
@@ -70,6 +74,10 @@ class RegisterViewModel @Inject constructor(
         viewModelScope.launch { storeResolver.accountStore.update { setEmail(newValue) } }
     }
 
+    fun updateHasAcceptedTerms(value: Boolean) {
+        state[::hasAcceptedTerms.name] = value
+    }
+
     override fun sendEmail() = callWhileLoading(apiResolver::users) {
         val input = UserCreation(email = email.value, username = username.value)
         createUser(input).failWith {
diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml
@@ -49,6 +49,9 @@
     <string name="register_username_placeholder">Only letters, numbers and dashes</string>
     <string name="register_email">Email</string>
     <string name="register_email_placeholder" translatable="false">email@example.org</string>
+    <string name="register_terms_acceptance">I accept the terms of service and the privacy policy</string>
+    <string name="register_terms_of_service">Terms of service</string>
+    <string name="register_privacy_policy">Privacy policy</string>
     <string name="register_submit">@string/main_destination_register</string>
     <string name="register_error_create_user_400_username_title">Invalid username</string>
     <string name="register_error_create_user_400_username_message">This username is not valid.</string>
diff --git a/app/src/main/res/values/urls.xml b/app/src/main/res/values/urls.xml
@@ -3,6 +3,9 @@
     <string name="api_url_main" translatable="false">https://rest.api.fyreplace.app</string>
     <string name="api_url_dev" translatable="false">https://dev.rest.api.fyreplace.app</string>
     <string name="api_url_local" translatable="false" />
+    <string name="info_url_website" translatable="false">https://fyreplace.net</string>
+    <string name="info_url_terms_of_service" translatable="false">https://fyreplace.net/terms-of-service</string>
+    <string name="info_url_privacy_policy" translatable="false">https://fyreplace.net/privacy-policy</string>
     <string name="deep_link_host_main" translatable="false">fyreplace.app</string>
     <string name="deep_link_host_dev" translatable="false">dev.fyreplace.app</string>
     <string name="deep_link_path_login" translatable="false">/login</string>
diff --git a/app/src/test/kotlin/app/fyreplace/fyreplace/test/screens/RegisterViewModelTests.kt b/app/src/test/kotlin/app/fyreplace/fyreplace/test/screens/RegisterViewModelTests.kt
@@ -29,7 +29,8 @@ class RegisterViewModelTests : TestsBase() {
     @Test
     fun `Username must have correct length`() = runTest {
         val (minLength, maxLength, viewModel) = makeViewModel(FakeEventBus())
-        viewModel.updateEmail("email@example")
+        viewModel.updateEmail(FakeUsersEndpointApi.GOOD_EMAIL)
+        viewModel.updateHasAcceptedTerms(true)
         backgroundScope.launch { viewModel.canSubmit.collect() }
 
         for (i in 0..<minLength) {
@@ -53,7 +54,8 @@ class RegisterViewModelTests : TestsBase() {
     @Test
     fun `Email must have correct length`() = runTest {
         val (minLength, maxLength, viewModel) = makeViewModel(FakeEventBus())
-        viewModel.updateUsername("Example")
+        viewModel.updateUsername(FakeUsersEndpointApi.GOOD_USERNAME)
+        viewModel.updateHasAcceptedTerms(true)
         backgroundScope.launch { viewModel.canSubmit.collect() }
 
         for (i in 0..<minLength) {
@@ -77,7 +79,8 @@ class RegisterViewModelTests : TestsBase() {
     @Test
     fun `Email must have @`() = runTest {
         val (_, _, viewModel) = makeViewModel(FakeEventBus())
-        viewModel.updateUsername("Example")
+        viewModel.updateUsername(FakeUsersEndpointApi.GOOD_USERNAME)
+        viewModel.updateHasAcceptedTerms(true)
         backgroundScope.launch { viewModel.canSubmit.collect() }
 
         viewModel.updateEmail("email")

Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ private fun SelectorDialog(`
`87`	`87`	`onClick = onClick`
`88`	`88`	`)`
`89`	`89`	`Text(`
`90`		`- buildAnnotatedString {`
	`90`	`+ text = buildAnnotatedString {`
`91`	`91`	`withLink(LinkAnnotation.Clickable("name") { onClick() }) {`
`92`	`92`	`append(name(env))`
`93`	`93`