Change-Id: I7b019a186e6fa69f81f053e2bd9379d906a72dfddt/clean-arch
Don Turner
8 months ago
parent
0c9f0dd48c
commit
80be5c8c59
@ -1,132 +0,0 @@
|
||||
/*
|
||||
* Copyright 2022 The Android Open Source Project
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package com.google.samples.apps.nowinandroid.core.data
|
||||
|
||||
import android.util.Log
|
||||
import com.google.samples.apps.nowinandroid.core.datastore.ChangeListVersions
|
||||
import com.google.samples.apps.nowinandroid.core.network.model.NetworkChangeList
|
||||
import kotlinx.coroutines.flow.Flow
|
||||
import kotlinx.coroutines.flow.combine
|
||||
import kotlin.coroutines.cancellation.CancellationException
|
||||
|
||||
/**
|
||||
* Interface marker for a class that manages synchronization between local data and a remote
|
||||
* source for a [Syncable].
|
||||
*/
|
||||
interface Synchronizer {
|
||||
suspend fun getChangeListVersions(): ChangeListVersions
|
||||
|
||||
suspend fun updateChangeListVersions(update: ChangeListVersions.() -> ChangeListVersions)
|
||||
|
||||
/**
|
||||
* Syntactic sugar to call [Syncable.syncWith] while omitting the synchronizer argument
|
||||
*/
|
||||
suspend fun Syncable.sync() = this@sync.syncWith(this@Synchronizer)
|
||||
}
|
||||
|
||||
/**
|
||||
* Interface marker for a class that is synchronized with a remote source. Syncing must not be
|
||||
* performed concurrently and it is the [Synchronizer]'s responsibility to ensure this.
|
||||
*/
|
||||
interface Syncable {
|
||||
/**
|
||||
* Synchronizes the local database backing the repository with the network.
|
||||
* Returns if the sync was successful or not.
|
||||
*/
|
||||
suspend fun syncWith(synchronizer: Synchronizer): Boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* Attempts [block], returning a successful [Result] if it succeeds, otherwise a [Result.Failure]
|
||||
* taking care not to break structured concurrency
|
||||
*/
|
||||
private suspend fun <T> suspendRunCatching(block: suspend () -> T): Result<T> = try {
|
||||
Result.success(block())
|
||||
} catch (cancellationException: CancellationException) {
|
||||
throw cancellationException
|
||||
} catch (exception: Exception) {
|
||||
Log.i(
|
||||
"suspendRunCatching",
|
||||
"Failed to evaluate a suspendRunCatchingBlock. Returning failure Result",
|
||||
exception,
|
||||
)
|
||||
Result.failure(exception)
|
||||
}
|
||||
|
||||
/**
|
||||
* Utility function for syncing a repository with the network.
|
||||
* [versionReader] Reads the current version of the model that needs to be synced
|
||||
* [changeListFetcher] Fetches the change list for the model
|
||||
* [versionUpdater] Updates the [ChangeListVersions] after a successful sync
|
||||
* [modelDeleter] Deletes models by consuming the ids of the models that have been deleted.
|
||||
* [modelUpdater] Updates models by consuming the ids of the models that have changed.
|
||||
*
|
||||
* Note that the blocks defined above are never run concurrently, and the [Synchronizer]
|
||||
* implementation must guarantee this.
|
||||
*/
|
||||
suspend fun Synchronizer.changeListSync(
|
||||
versionReader: (ChangeListVersions) -> Int,
|
||||
changeListFetcher: suspend (Int) -> List<NetworkChangeList>,
|
||||
versionUpdater: ChangeListVersions.(Int) -> ChangeListVersions,
|
||||
modelDeleter: suspend (List<String>) -> Unit,
|
||||
modelUpdater: suspend (List<String>) -> Unit,
|
||||
) = suspendRunCatching {
|
||||
// Fetch the change list since last sync (akin to a git fetch)
|
||||
val currentVersion = versionReader(getChangeListVersions())
|
||||
val changeList = changeListFetcher(currentVersion)
|
||||
if (changeList.isEmpty()) return@suspendRunCatching true
|
||||
|
||||
val (deleted, updated) = changeList.partition(NetworkChangeList::isDelete)
|
||||
|
||||
// Delete models that have been deleted server-side
|
||||
modelDeleter(deleted.map(NetworkChangeList::id))
|
||||
|
||||
// Using the change list, pull down and save the changes (akin to a git pull)
|
||||
modelUpdater(updated.map(NetworkChangeList::id))
|
||||
|
||||
// Update the last synced version (akin to updating local git HEAD)
|
||||
val latestVersion = changeList.last().changeListVersion
|
||||
updateChangeListVersions {
|
||||
versionUpdater(latestVersion)
|
||||
}
|
||||
}.isSuccess
|
||||
|
||||
/**
|
||||
* Returns a [Flow] whose values are generated by [transform] function that process the most
|
||||
* recently emitted values by each flow.
|
||||
*/
|
||||
fun <T1, T2, T3, T4, T5, T6, R> combine(
|
||||
flow: Flow<T1>,
|
||||
flow2: Flow<T2>,
|
||||
flow3: Flow<T3>,
|
||||
flow4: Flow<T4>,
|
||||
flow5: Flow<T5>,
|
||||
flow6: Flow<T6>,
|
||||
transform: suspend (T1, T2, T3, T4, T5, T6) -> R,
|
||||
): Flow<R> = combine(
|
||||
combine(flow, flow2, flow3, ::Triple),
|
||||
combine(flow4, flow5, flow6, ::Triple),
|
||||
) { t1, t2 ->
|
||||
transform(
|
||||
t1.first,
|
||||
t1.second,
|
||||
t1.third,
|
||||
t2.first,
|
||||
t2.second,
|
||||
t2.third,
|
||||
)
|
||||
}
|
||||
@ -0,0 +1,25 @@
|
||||
/*
|
||||
* Copyright 2024 The Android Open Source Project
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package com.google.samples.apps.nowinandroid.core.domain.model
|
||||
|
||||
import kotlinx.datetime.Clock
|
||||
import kotlinx.datetime.Instant
|
||||
|
||||
data class RecentSearchQuery(
|
||||
val query: String,
|
||||
val queriedDate: Instant = Clock.System.now(),
|
||||
)
|
||||
@ -0,0 +1,74 @@
|
||||
/*
|
||||
* Copyright 2024 The Android Open Source Project
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* https://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package com.google.samples.apps.nowinandroid.core.domain.utils
|
||||
|
||||
import com.google.samples.apps.nowinandroid.core.domain.model.ChangeListVersions
|
||||
import kotlinx.coroutines.flow.Flow
|
||||
import kotlinx.coroutines.flow.combine
|
||||
|
||||
/**
|
||||
* Interface marker for a class that manages synchronization between local data and a remote
|
||||
* source for a [Syncable].
|
||||
*/
|
||||
interface Synchronizer {
|
||||
suspend fun getChangeListVersions(): ChangeListVersions
|
||||
|
||||
suspend fun updateChangeListVersions(update: ChangeListVersions.() -> ChangeListVersions)
|
||||
|
||||
/**
|
||||
* Syntactic sugar to call [Syncable.syncWith] while omitting the synchronizer argument
|
||||
*/
|
||||
suspend fun Syncable.sync() = this@sync.syncWith(this@Synchronizer)
|
||||
}
|
||||
|
||||
/**
|
||||
* Interface marker for a class that is synchronized with a remote source. Syncing must not be
|
||||
* performed concurrently and it is the [Synchronizer]'s responsibility to ensure this.
|
||||
*/
|
||||
interface Syncable {
|
||||
/**
|
||||
* Synchronizes the local database backing the repository with the network.
|
||||
* Returns if the sync was successful or not.
|
||||
*/
|
||||
suspend fun syncWith(synchronizer: Synchronizer): Boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a [Flow] whose values are generated by [transform] function that process the most
|
||||
* recently emitted values by each flow.
|
||||
*/
|
||||
fun <T1, T2, T3, T4, T5, T6, R> combine(
|
||||
flow: Flow<T1>,
|
||||
flow2: Flow<T2>,
|
||||
flow3: Flow<T3>,
|
||||
flow4: Flow<T4>,
|
||||
flow5: Flow<T5>,
|
||||
flow6: Flow<T6>,
|
||||
transform: suspend (T1, T2, T3, T4, T5, T6) -> R,
|
||||
): Flow<R> = combine(
|
||||
combine(flow, flow2, flow3, ::Triple),
|
||||
combine(flow4, flow5, flow6, ::Triple),
|
||||
) { t1, t2 ->
|
||||
transform(
|
||||
t1.first,
|
||||
t1.second,
|
||||
t1.third,
|
||||
t2.first,
|
||||
t2.second,
|
||||
t2.third,
|
||||
)
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue