41 lines
2.1 KiB
Markdown
41 lines
2.1 KiB
Markdown
# core:common
|
|
|
|
Pure Kotlin utilities shared by all modules. This is the lowest layer -- no other `:core:*` module is a dependency.
|
|
|
|
## What This Module Provides
|
|
|
|
- **Result sealed class** (`result/Result.kt`): `Success<T>`, `Error(exception, message)`, `Loading`. Used by repositories and ViewModels to propagate outcomes.
|
|
- **Dispatcher DI** (`di/DispatcherModule.kt`): `@Dispatcher(IO)`, `@Dispatcher(Default)`, `@Dispatcher(Main)` qualifiers for Hilt injection. Always inject dispatchers -- never hardcode `Dispatchers.IO`.
|
|
- **CoroutineScope DI** (`di/CoroutineScopeModule.kt`): `@ApplicationScope` for work that outlives ViewModels.
|
|
- **Extensions** (`extensions/`): `StringExt`, `DateExt`, `FlowExt` (includes `retryWithBackoff`, `throttleFirst`).
|
|
- **ConnectivityObserver**: Wraps Android `ConnectivityManager.NetworkCallback` to detect network changes. Used by SSE reconnection logic.
|
|
|
|
## safeApiCall Pattern
|
|
|
|
All repository implementations use this to wrap network calls:
|
|
|
|
```kotlin
|
|
suspend fun <T> safeApiCall(block: suspend () -> T): Result<T> =
|
|
try {
|
|
Result.Success(block())
|
|
} catch (e: ClientRequestException) { // 4xx
|
|
Result.Error(e, parseErrorMessage(e.response.bodyAsText()))
|
|
} catch (e: ServerResponseException) { // 5xx
|
|
Result.Error(e, "Server error. Please try again.")
|
|
} catch (e: HttpRequestTimeoutException) {
|
|
Result.Error(e, "Request timed out.")
|
|
} catch (e: IOException) {
|
|
Result.Error(e, "Network unavailable. Check your connection.")
|
|
} catch (e: SerializationException) {
|
|
Result.Error(e, "Unexpected response format.")
|
|
}
|
|
```
|
|
|
|
This lives here (not in `:core:network`) because repositories in `:core:data` call it.
|
|
|
|
## Rules
|
|
|
|
- **Pure Kotlin preferred.** Minimal Android dependencies (only what ConnectivityObserver and Hilt require).
|
|
- **No network or data dependencies.** This module must not depend on `:core:network`, `:core:data`, or `:core:model`.
|
|
- Dependencies: `coroutines-core`, `coroutines-android`, Hilt.
|
|
- Convention plugin: `librechat.android.library` + `librechat.android.hilt`.
|