diff --git a/app/src/main/java/com/itsaky/androidide/di/TemplateModule.kt b/app/src/main/java/com/itsaky/androidide/di/TemplateModule.kt index 44c4ec3542..a4e92a0265 100644 --- a/app/src/main/java/com/itsaky/androidide/di/TemplateModule.kt +++ b/app/src/main/java/com/itsaky/androidide/di/TemplateModule.kt @@ -1,5 +1,6 @@ package com.itsaky.androidide.di +import com.itsaky.androidide.repositories.TemplateCollectionRepository import com.itsaky.androidide.repositories.TemplateRepository import com.itsaky.androidide.repositories.TemplateRepositoryImpl import com.itsaky.androidide.utils.Environment @@ -25,6 +26,7 @@ val templateModule = viewModel { TemplateManagerViewModel( templateRepository = get(), + collectionInstalls = get().installs, ) } } diff --git a/app/src/main/java/com/itsaky/androidide/repositories/TemplateCollectionRepository.kt b/app/src/main/java/com/itsaky/androidide/repositories/TemplateCollectionRepository.kt index 29cdccc75d..7ddf1203ee 100644 --- a/app/src/main/java/com/itsaky/androidide/repositories/TemplateCollectionRepository.kt +++ b/app/src/main/java/com/itsaky/androidide/repositories/TemplateCollectionRepository.kt @@ -1,5 +1,6 @@ package com.itsaky.androidide.repositories +import kotlinx.coroutines.flow.Flow import java.io.File /** @@ -10,6 +11,13 @@ interface TemplateCollectionRepository { val templateNames: List, ) + /** + * Emits once after each successful [installCollection]. The install can run in another + * activity (ExternalFileInstallActivity) while the Templates tab's list is still on screen + * underneath, so the tab collects this to reload (ADFA-6967). + */ + val installs: Flow + /** * Parse and validate a candidate .cgt archive without installing it. */ diff --git a/app/src/main/java/com/itsaky/androidide/repositories/TemplateCollectionRepositoryImpl.kt b/app/src/main/java/com/itsaky/androidide/repositories/TemplateCollectionRepositoryImpl.kt index c3900bbac7..181f9149ef 100644 --- a/app/src/main/java/com/itsaky/androidide/repositories/TemplateCollectionRepositoryImpl.kt +++ b/app/src/main/java/com/itsaky/androidide/repositories/TemplateCollectionRepositoryImpl.kt @@ -7,6 +7,10 @@ import com.itsaky.androidide.templates.impl.zip.ZipTemplateReader import com.itsaky.androidide.utils.Environment import kotlinx.coroutines.CancellationException import kotlinx.coroutines.Dispatchers +import kotlinx.coroutines.channels.BufferOverflow +import kotlinx.coroutines.flow.MutableSharedFlow +import kotlinx.coroutines.flow.SharedFlow +import kotlinx.coroutines.flow.asSharedFlow import kotlinx.coroutines.sync.Mutex import kotlinx.coroutines.sync.withLock import kotlinx.coroutines.withContext @@ -63,6 +67,11 @@ class TemplateCollectionRepositoryImpl : TemplateCollectionRepository { private fun installLock(baseName: String): Mutex = installLocks.computeIfAbsent(baseName.lowercase()) { Mutex() } } + // No replay: a list loaded after an install already includes it. DROP_OLDEST keeps + // tryEmit() from ever failing; collectors only need to know that something changed. + private val _installs = MutableSharedFlow(extraBufferCapacity = 1, onBufferOverflow = BufferOverflow.DROP_OLDEST) + override val installs: SharedFlow = _installs.asSharedFlow() + override suspend fun inspectCollection(candidateFile: File): Result = withContext(Dispatchers.IO) { runCatching { @@ -215,6 +224,7 @@ class TemplateCollectionRepositoryImpl : TemplateCollectionRepository { if (!candidateFile.delete()) { log.warn("Installed but failed to delete source temp file: {}", candidateFile.name) } + _installs.tryEmit(Unit) Unit }.onFailure { exception -> if (exception is CancellationException) throw exception diff --git a/app/src/main/java/com/itsaky/androidide/ui/compose/ManagerScreen.kt b/app/src/main/java/com/itsaky/androidide/ui/compose/ManagerScreen.kt index c5fd3ef4a7..ddb1e0478e 100644 --- a/app/src/main/java/com/itsaky/androidide/ui/compose/ManagerScreen.kt +++ b/app/src/main/java/com/itsaky/androidide/ui/compose/ManagerScreen.kt @@ -56,7 +56,6 @@ import com.itsaky.androidide.ui.compose.templates.TemplateManagerScreen import com.itsaky.androidide.ui.models.AddonFileKind import com.itsaky.androidide.ui.models.DownloadPickerUiState import com.itsaky.androidide.ui.models.PluginManagerUiEvent -import com.itsaky.androidide.ui.models.TemplateManagerUiEvent import com.itsaky.androidide.utils.UrlManager import com.itsaky.androidide.utils.flashError import com.itsaky.androidide.utils.getFileName @@ -254,7 +253,8 @@ fun ManagerScreen( // A .cgp only reaches this ViewModel via the routing above, which sends plugins down the // PickedUri path instead - so this is defensive, not a live path. onForwardPlugin = { filePath -> pluginViewModel.onPendingInstallFile(filePath) }, - onFinish = { templateViewModel.onEvent(TemplateManagerUiEvent.LoadTemplates) }, + // The Templates tab reloads from TemplateCollectionRepository.installs, so nothing to do. + onFinish = {}, ) Scaffold( diff --git a/app/src/main/java/com/itsaky/androidide/viewmodels/TemplateManagerViewModel.kt b/app/src/main/java/com/itsaky/androidide/viewmodels/TemplateManagerViewModel.kt index 999c6332ce..0e0641e366 100644 --- a/app/src/main/java/com/itsaky/androidide/viewmodels/TemplateManagerViewModel.kt +++ b/app/src/main/java/com/itsaky/androidide/viewmodels/TemplateManagerViewModel.kt @@ -10,7 +10,9 @@ import com.itsaky.androidide.templates.manager.models.displayName import com.itsaky.androidide.ui.models.TemplateManagerUiEffect import com.itsaky.androidide.ui.models.TemplateManagerUiEvent import com.itsaky.androidide.ui.models.TemplateManagerUiState +import kotlinx.coroutines.Job import kotlinx.coroutines.channels.Channel +import kotlinx.coroutines.flow.Flow import kotlinx.coroutines.flow.MutableStateFlow import kotlinx.coroutines.flow.StateFlow import kotlinx.coroutines.flow.asStateFlow @@ -23,6 +25,7 @@ import kotlinx.coroutines.launch */ class TemplateManagerViewModel( private val templateRepository: TemplateRepository, + collectionInstalls: Flow, ) : ViewModel() { private companion object { private const val TAG = "TemplateManagerViewModel" @@ -34,8 +37,14 @@ class TemplateManagerViewModel( private val _uiEffect = Channel(Channel.BUFFERED) val uiEffect = _uiEffect.receiveAsFlow() + private var loadJob: Job? = null + init { loadTemplates() + // A .cgt opened from outside the app installs in ExternalFileInstallActivity, which then + // finishes back to this screen without telling it (ADFA-6967). Reload on every install + // instead, whichever screen ran it. + viewModelScope.launch { collectionInstalls.collect { loadTemplates() } } } fun onEvent(event: TemplateManagerUiEvent) { @@ -49,26 +58,33 @@ class TemplateManagerViewModel( } } + /** + * Scans finish in any order, so a reload cancels the scan it supersedes; otherwise an earlier + * scan finishing last would overwrite the newer list (e.g. hide a collection that just + * installed). The repository rethrows cancellation, so a cancelled scan never reaches the state. + */ private fun loadTemplates() { - viewModelScope.launch { - _uiState.update { it.copy(isLoading = true) } - - templateRepository - .listTemplateFiles() - .onSuccess { items -> - Log.d(TAG, "Loaded ${items.size} template files") - _uiState.update { it.copy(isLoading = false, items = items) } - }.onFailure { exception -> - Log.e(TAG, "Failed to load template files", exception) - _uiState.update { it.copy(isLoading = false) } - _uiEffect.send( - TemplateManagerUiEffect.ShowError( - R.string.msg_template_load_failed, - listOf(exception.message ?: ""), - ), - ) - } - } + loadJob?.cancel() + loadJob = + viewModelScope.launch { + _uiState.update { it.copy(isLoading = true) } + + templateRepository + .listTemplateFiles() + .onSuccess { items -> + Log.d(TAG, "Loaded ${items.size} template files") + _uiState.update { it.copy(isLoading = false, items = items) } + }.onFailure { exception -> + Log.e(TAG, "Failed to load template files", exception) + _uiState.update { it.copy(isLoading = false) } + _uiEffect.send( + TemplateManagerUiEffect.ShowError( + R.string.msg_template_load_failed, + listOf(exception.message ?: ""), + ), + ) + } + } } private fun showInstallConfirmation(item: CgtFileItem) { diff --git a/app/src/test/java/com/itsaky/androidide/repositories/TemplateCollectionRepositoryImplTest.kt b/app/src/test/java/com/itsaky/androidide/repositories/TemplateCollectionRepositoryImplTest.kt index 555511efb1..bfaaf5ef73 100644 --- a/app/src/test/java/com/itsaky/androidide/repositories/TemplateCollectionRepositoryImplTest.kt +++ b/app/src/test/java/com/itsaky/androidide/repositories/TemplateCollectionRepositoryImplTest.kt @@ -4,6 +4,11 @@ import com.google.common.truth.Truth.assertThat import com.itsaky.androidide.plugins.templates.CgtTemplateBuilder import com.itsaky.androidide.utils.Environment import kotlinx.coroutines.ExperimentalCoroutinesApi +import kotlinx.coroutines.flow.toList +import kotlinx.coroutines.launch +import kotlinx.coroutines.test.TestScope +import kotlinx.coroutines.test.UnconfinedTestDispatcher +import kotlinx.coroutines.test.advanceUntilIdle import kotlinx.coroutines.test.runTest import org.junit.After import org.junit.Before @@ -123,6 +128,40 @@ class TemplateCollectionRepositoryImplTest { assertThat(cgt.exists()).isFalse() } + /** Collects [TemplateCollectionRepository.installs] for the rest of the test. */ + private fun TestScope.recordInstalls(): List { + val emissions = mutableListOf() + // Unconfined, so the collector is subscribed before this returns and records an + // emission as it happens, with no virtual-time timeout that could skip past it. + backgroundScope.launch(UnconfinedTestDispatcher(testScheduler)) { repository.installs.toList(emissions) } + return emissions + } + + @Test + fun `installCollection emits on installs after a successful install`() = + runTest { + val emissions = recordInstalls() + val cgt = buildCgt("Empty Activity") + + assertThat(repository.installCollection(cgt, "my-templates", overwrite = false).isSuccess).isTrue() + advanceUntilIdle() + + assertThat(emissions).hasSize(1) + } + + @Test + fun `installCollection does not emit on installs when the install fails`() = + runTest { + val emissions = recordInstalls() + File(templatesDir, "my-templates.cgt").writeText("existing") + val cgt = buildCgt("Empty Activity") + + assertThat(repository.installCollection(cgt, "my-templates", overwrite = false).isFailure).isTrue() + advanceUntilIdle() + + assertThat(emissions).isEmpty() + } + @Test fun `installCollection without overwrite fails when the destination already exists`() = runTest { diff --git a/app/src/test/java/com/itsaky/androidide/viewmodels/TemplateManagerViewModelTest.kt b/app/src/test/java/com/itsaky/androidide/viewmodels/TemplateManagerViewModelTest.kt index bdb90510b6..d5ff0975d0 100644 --- a/app/src/test/java/com/itsaky/androidide/viewmodels/TemplateManagerViewModelTest.kt +++ b/app/src/test/java/com/itsaky/androidide/viewmodels/TemplateManagerViewModelTest.kt @@ -17,7 +17,9 @@ import io.mockk.every import io.mockk.mockk import io.mockk.mockkStatic import io.mockk.unmockkStatic +import kotlinx.coroutines.CompletableDeferred import kotlinx.coroutines.ExperimentalCoroutinesApi +import kotlinx.coroutines.flow.MutableSharedFlow import kotlinx.coroutines.flow.first import kotlinx.coroutines.flow.take import kotlinx.coroutines.flow.toList @@ -38,6 +40,7 @@ class TemplateManagerViewModelTest { val mainDispatcherRule = MainDispatcherRule() private val repository = mockk() + private val collectionInstalls = MutableSharedFlow(extraBufferCapacity = 1) private val item = CgtFileItem( @@ -69,19 +72,61 @@ class TemplateManagerViewModelTest { runTest { coEvery { repository.listTemplateFiles() } returns Result.success(listOf(item)) - val viewModel = TemplateManagerViewModel(repository) + val viewModel = TemplateManagerViewModel(repository, collectionInstalls) advanceUntilIdle() assertThat(viewModel.uiState.value.isLoading).isFalse() assertThat(viewModel.uiState.value.items).containsExactly(item) } + @Test + fun collectionInstall_reloadsTemplates() = + runTest { + // ADFA-6967: a .cgt opened from outside the app installs in another activity, and this + // list must pick it up without the user leaving the screen. + coEvery { repository.listTemplateFiles() } returnsMany + listOf(Result.success(emptyList()), Result.success(listOf(installedItem))) + + val viewModel = TemplateManagerViewModel(repository, collectionInstalls) + advanceUntilIdle() + assertThat(viewModel.uiState.value.items).isEmpty() + + collectionInstalls.emit(Unit) + advanceUntilIdle() + + assertThat(viewModel.uiState.value.items).containsExactly(installedItem) + coVerify(exactly = 2) { repository.listTemplateFiles() } + } + + @Test + fun collectionInstall_duringInitialScan_keepsTheNewerResult() = + runTest { + // The initial scan is still running when an install arrives, and finishes last. Its + // stale (empty) list must not replace the post-install one. + val initialScan = CompletableDeferred>>() + var calls = 0 + coEvery { repository.listTemplateFiles() } coAnswers { + if (calls++ == 0) initialScan.await() else Result.success(listOf(installedItem)) + } + + val viewModel = TemplateManagerViewModel(repository, collectionInstalls) + advanceUntilIdle() + + collectionInstalls.emit(Unit) + advanceUntilIdle() + initialScan.complete(Result.success(emptyList())) + advanceUntilIdle() + + assertThat(viewModel.uiState.value.items).containsExactly(installedItem) + assertThat(viewModel.uiState.value.isLoading).isFalse() + } + @Test fun installTemplateEvent_onlyAsksForConfirmation() = runTest { coEvery { repository.listTemplateFiles() } returns Result.success(emptyList()) - val viewModel = TemplateManagerViewModel(repository) + val viewModel = TemplateManagerViewModel(repository, collectionInstalls) advanceUntilIdle() viewModel.onEvent(TemplateManagerUiEvent.InstallTemplate(item)) @@ -97,7 +142,7 @@ class TemplateManagerViewModelTest { coEvery { repository.listTemplateFiles() } returns Result.success(emptyList()) coEvery { repository.installTemplate(item) } returns Result.success(Unit) - val viewModel = TemplateManagerViewModel(repository) + val viewModel = TemplateManagerViewModel(repository, collectionInstalls) advanceUntilIdle() viewModel.confirmInstallTemplate(item, deleteSourceAfterInstall = false) @@ -113,7 +158,7 @@ class TemplateManagerViewModelTest { coEvery { repository.installTemplate(item) } returns Result.success(Unit) coEvery { repository.deleteDownloadFile(item) } returns Result.success(Unit) - val viewModel = TemplateManagerViewModel(repository) + val viewModel = TemplateManagerViewModel(repository, collectionInstalls) advanceUntilIdle() viewModel.confirmInstallTemplate(item, deleteSourceAfterInstall = true) @@ -132,7 +177,7 @@ class TemplateManagerViewModelTest { coEvery { repository.installTemplate(item) } returns Result.success(Unit) coEvery { repository.deleteDownloadFile(item) } returns Result.failure(java.io.IOException("ro")) - val viewModel = TemplateManagerViewModel(repository) + val viewModel = TemplateManagerViewModel(repository, collectionInstalls) advanceUntilIdle() viewModel.confirmInstallTemplate(item, deleteSourceAfterInstall = true) @@ -149,7 +194,7 @@ class TemplateManagerViewModelTest { coEvery { repository.listTemplateFiles() } returns Result.success(emptyList()) coEvery { repository.installTemplate(item) } returns Result.failure(java.io.IOException("boom")) - val viewModel = TemplateManagerViewModel(repository) + val viewModel = TemplateManagerViewModel(repository, collectionInstalls) advanceUntilIdle() viewModel.confirmInstallTemplate(item, deleteSourceAfterInstall = true) @@ -173,7 +218,7 @@ class TemplateManagerViewModelTest { coEvery { repository.listTemplateFiles() } returns Result.success(emptyList()) coEvery { repository.installTemplate(item) } returns Result.success(Unit) - val viewModel = TemplateManagerViewModel(repository) + val viewModel = TemplateManagerViewModel(repository, collectionInstalls) advanceUntilIdle() viewModel.confirmInstallTemplate(item, deleteSourceAfterInstall = false) @@ -191,7 +236,7 @@ class TemplateManagerViewModelTest { coEvery { repository.listTemplateFiles() } returns Result.success(emptyList()) coEvery { repository.installTemplate(item) } returns Result.failure(java.io.IOException("boom")) - val viewModel = TemplateManagerViewModel(repository) + val viewModel = TemplateManagerViewModel(repository, collectionInstalls) advanceUntilIdle() viewModel.confirmInstallTemplate(item, deleteSourceAfterInstall = false) @@ -210,7 +255,7 @@ class TemplateManagerViewModelTest { // assertion below, rather than throwing inside the coroutine and hanging first(). coEvery { repository.uninstallTemplate(installedItem) } returns Result.success(Unit) - val viewModel = TemplateManagerViewModel(repository) + val viewModel = TemplateManagerViewModel(repository, collectionInstalls) advanceUntilIdle() viewModel.onEvent(TemplateManagerUiEvent.UninstallTemplate(installedItem)) @@ -226,7 +271,7 @@ class TemplateManagerViewModelTest { coEvery { repository.listTemplateFiles() } returns Result.success(emptyList()) coEvery { repository.uninstallTemplate(installedItem) } returns Result.success(Unit) - val viewModel = TemplateManagerViewModel(repository) + val viewModel = TemplateManagerViewModel(repository, collectionInstalls) advanceUntilIdle() viewModel.confirmUninstallTemplate(installedItem) @@ -244,7 +289,7 @@ class TemplateManagerViewModelTest { coEvery { repository.listTemplateFiles() } returns Result.success(emptyList()) coEvery { repository.uninstallTemplate(installedItem) } returns Result.failure(java.io.IOException("boom")) - val viewModel = TemplateManagerViewModel(repository) + val viewModel = TemplateManagerViewModel(repository, collectionInstalls) advanceUntilIdle() viewModel.confirmUninstallTemplate(installedItem)