Migrate TagReaderActivity to use BottomSheet and add confirmation buttons #6814
+1,277
−120
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,87 +1,48 @@ | ||
| package io.homeassistant.companion.android.nfc | ||
|
|
||
| import android.content.Intent | ||
| import android.nfc.NfcAdapter | ||
| import android.os.Bundle | ||
| import androidx.activity.compose.setContent | ||
| import androidx.activity.viewModels | ||
| import androidx.compose.runtime.getValue | ||
| import androidx.lifecycle.compose.collectAsStateWithLifecycle | ||
| import dagger.hilt.android.AndroidEntryPoint | ||
| import io.homeassistant.companion.android.BaseActivity | ||
| import io.homeassistant.companion.android.common.compose.theme.HATheme | ||
| import io.homeassistant.companion.android.nfc.views.TagReaderScreen | ||
|
|
||
| @AndroidEntryPoint | ||
| class TagReaderActivity : BaseActivity() { | ||
|
|
||
| private val viewModel: TagReaderViewModel by viewModels() | ||
|
|
||
| override fun onCreate(savedInstanceState: Bundle?) { | ||
| super.onCreate(savedInstanceState) | ||
|
|
||
| val isNfcTag = intent.action == NfcAdapter.ACTION_NDEF_DISCOVERED | ||
| val isQrTag = intent.action == Intent.ACTION_VIEW | ||
|
|
||
| setContent { | ||
| HATheme { | ||
| val state by viewModel.uiState.collectAsStateWithLifecycle() | ||
|
|
||
| TagReaderScreen( | ||
| state = state, | ||
| onAllowOnce = viewModel::onAllowOnce, | ||
| onAllowAlways = viewModel::onAllowAlways, | ||
| onDismissed = viewModel::onDismissed, | ||
| onErrorAcknowledged = viewModel::onErrorAcknowledged, | ||
| onFinished = ::finish, | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| if (isNfcTag || isQrTag) { | ||
| val url = if (isNfcTag) NFCUtil.extractUrlFromNFCIntent(intent) else intent.data | ||
| viewModel.onIntentReceived(url = url, isNfcTag = isNfcTag) | ||
| } else { | ||
| finish() | ||
| } | ||
|
Comment on lines
20
to
46
Member
Author
There was a problem hiding this comment. I'm not sure we need that, I didn't have any issue during my tests testing multiples. |
||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| package io.homeassistant.companion.android.nfc | ||
|
|
||
| import androidx.annotation.StringRes | ||
|
|
||
| /** | ||
| * UI states surfaced by [TagReaderViewModel] and consumed by the tag reader screen. | ||
| */ | ||
| sealed interface TagReaderUiState { | ||
| /** Initial state. No UI is rendered. */ | ||
| data object Initial : TagReaderUiState | ||
|
|
||
| /** | ||
| * The scanned tag id need approving from the user before any | ||
| * server action is taken. | ||
| */ | ||
| data class ApprovingTag(val tagId: String) : TagReaderUiState | ||
|
|
||
| /** | ||
| * The tag is being scanned to all registered servers. | ||
| */ | ||
| data object Scanning : TagReaderUiState | ||
|
|
||
| /** | ||
| * A user-facing error occurred. | ||
| */ | ||
| data class Error(@StringRes val messageRes: Int) : TagReaderUiState | ||
|
|
||
| /** Terminal state: the activity should call `finish()`. */ | ||
| data object Done : TagReaderUiState | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| package io.homeassistant.companion.android.nfc | ||
|
|
||
| import android.net.Uri | ||
| import androidx.annotation.VisibleForTesting | ||
| import androidx.lifecycle.ViewModel | ||
| import androidx.lifecycle.viewModelScope | ||
| import dagger.hilt.android.lifecycle.HiltViewModel | ||
| import io.homeassistant.companion.android.common.R as commonR | ||
| import io.homeassistant.companion.android.common.data.prefs.PrefsRepository | ||
| import io.homeassistant.companion.android.common.data.servers.ServerManager | ||
| import io.homeassistant.companion.android.util.UrlUtil | ||
| import javax.inject.Inject | ||
| import kotlin.coroutines.cancellation.CancellationException | ||
| import kotlin.time.Duration.Companion.seconds | ||
| import kotlinx.coroutines.async | ||
| import kotlinx.coroutines.awaitAll | ||
| import kotlinx.coroutines.coroutineScope | ||
| import kotlinx.coroutines.delay | ||
| import kotlinx.coroutines.flow.MutableStateFlow | ||
| import kotlinx.coroutines.flow.StateFlow | ||
| import kotlinx.coroutines.flow.asStateFlow | ||
| import kotlinx.coroutines.launch | ||
| import timber.log.Timber | ||
|
|
||
| /** | ||
| * Lower bound on how long the [TagReaderUiState.Scanning] state stays visible. Servers may | ||
| * answer faster than the user can perceive the loading sheet, so we keep it on screen for | ||
| * at least this long before transitioning to [TagReaderUiState.Done]. | ||
| */ | ||
| @VisibleForTesting | ||
| internal val MIN_SCANNING_DURATION = 1.5.seconds | ||
|
|
||
| /** | ||
| * Drives the NFC / QR tag reader flow. | ||
| * | ||
| * Reads the tag id from the incoming URL, decides whether it can be auto-scanned | ||
| * based on whether it is already present in the allowed tags preference, or requires | ||
| * manual user approval when it is not yet allowed, and exposes the result as [uiState]. | ||
| */ | ||
| @HiltViewModel | ||
| class TagReaderViewModel @Inject constructor( | ||
| private val serverManager: ServerManager, | ||
| private val prefsRepository: PrefsRepository, | ||
| ) : ViewModel() { | ||
|
|
||
| private val _uiState = MutableStateFlow<TagReaderUiState>(TagReaderUiState.Initial) | ||
| val uiState: StateFlow<TagReaderUiState> = _uiState.asStateFlow() | ||
|
|
||
| /** | ||
| * Called by the activity once the launching intent has been parsed. Drives | ||
| * a single tag-handling cycle and updates [uiState] accordingly. | ||
| */ | ||
| fun onIntentReceived(url: Uri?, isNfcTag: Boolean) { | ||
| viewModelScope.launch { | ||
| val tagId = UrlUtil.splitNfcTagId(url) | ||
| if (tagId == null) { | ||
| Timber.w("Tag intent had no tag id, isNfcTag=$isNfcTag") | ||
| _uiState.value = TagReaderUiState.Error(errorMessageRes(isNfcTag)) | ||
| return@launch | ||
| } | ||
| if (!serverManager.isRegistered()) { | ||
| Timber.w("Tag scanned but no server is registered") | ||
| _uiState.value = TagReaderUiState.Error(errorMessageRes(isNfcTag)) | ||
| return@launch | ||
| } | ||
| if (prefsRepository.allowedTags().contains(tagId)) { | ||
| scanAndFinish(tagId) | ||
| } else { | ||
| _uiState.value = TagReaderUiState.ApprovingTag(tagId) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Called when the user taps "Allow Once" in the approval bottom sheet. Transitions | ||
| * the sheet into its scanning state and dispatches the tag to all registered servers. | ||
| * | ||
| * Has no effect unless the current state is [TagReaderUiState.ApprovingTag]. | ||
| */ | ||
| fun onAllowOnce() { | ||
| val current = _uiState.value as? TagReaderUiState.ApprovingTag ?: return | ||
| viewModelScope.launch { | ||
| scanAndFinish(current.tagId) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Called when the user taps "Allow always" in the approval bottom sheet. Persists | ||
| * the tag id so future scans of the same tag skip the | ||
| * approval step, then proceeds with the scan in the same way as [onAllowOnce]. | ||
| * | ||
| * Has no effect unless the current state is [TagReaderUiState.ApprovingTag]. | ||
| */ | ||
| fun onAllowAlways() { | ||
| val current = _uiState.value as? TagReaderUiState.ApprovingTag ?: return | ||
| viewModelScope.launch { | ||
| prefsRepository.addAllowedTag(current.tagId) | ||
| scanAndFinish(current.tagId) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Called once the user-facing error has been dismissed. Transitions to [TagReaderUiState.Done] | ||
| * so the activity can finish. | ||
| */ | ||
| fun onErrorAcknowledged() { | ||
| if (_uiState.value is TagReaderUiState.Error) { | ||
| _uiState.value = TagReaderUiState.Done | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Called when the user dismisses the approval. | ||
| * Transitions to [TagReaderUiState.Done] so the activity can finish. | ||
| */ | ||
| fun onDismissed() { | ||
| _uiState.value = TagReaderUiState.Done | ||
| } | ||
|
|
||
| private suspend fun scanAndFinish(tagId: String) { | ||
| _uiState.value = TagReaderUiState.Scanning | ||
| coroutineScope { | ||
| launch { delay(MIN_SCANNING_DURATION) } | ||
| launch { scanTag(tagId) } | ||
| } | ||
| _uiState.value = TagReaderUiState.Done | ||
| } | ||
|
|
||
| private suspend fun scanTag(tagId: String) { | ||
| coroutineScope { | ||
| serverManager.servers().map { server -> | ||
| async { | ||
| try { | ||
| serverManager.integrationRepository(server.id) | ||
| .scanTag(mapOf("tag_id" to tagId)) | ||
| Timber.d("Tag scanned to HA serverId=${server.id}") | ||
| } catch (e: CancellationException) { | ||
| throw e | ||
| } catch (e: Exception) { | ||
| Timber.e(e, "Tag not scanned to HA serverId=${server.id}") | ||
| } | ||
| } | ||
| }.awaitAll() | ||
| } | ||
| } | ||
|
|
||
| private fun errorMessageRes(isNfcTag: Boolean): Int = if (isNfcTag) { | ||
| commonR.string.nfc_processing_tag_error | ||
| } else { | ||
| commonR.string.qrcode_processing_tag_error | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.