Merge pull request #7 from DevelopersBreach/shreyas/integrate-arrow-core

yesshreyes · web-flow · commit 94b0fc8ebdf2 · 2025-05-30T22:02:25.000+05:30
Integrate Arrow Core for exception handling
diff --git a/composeApp/build.gradle.kts b/composeApp/build.gradle.kts
@@ -99,6 +99,8 @@ kotlin {
             implementation(libs.koin.compose)
             implementation(libs.koin.compose.viewmodel)
             implementation(libs.kermit)
+            implementation(libs.arrow.core)
+            implementation(libs.arrow.fx.coroutines)
         }
         desktopMain.dependencies {
             implementation(compose.desktop.currentOs)
diff --git a/composeApp/src/commonMain/composeResources/values/string.xml b/composeApp/src/commonMain/composeResources/values/string.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<resources>
+    <string name="error_occurred">Error occurred</string>
+    <string name="ok">OK</string>
+    <string name="error_info_unavailable">Error information not available</string>
+</resources>
diff --git a/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/core/ApiKey.kt b/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/core/ApiKey.kt
diff --git a/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/core/network/ApiKey.kt b/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/core/network/ApiKey.kt
@@ -0,0 +1,3 @@
+package com.developersbreach.kotlindictionarymultiplatform.core.network
+
+const val API_KEY = ""
diff --git a/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/core/network/KtorHttpClient.kt b/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/core/network/KtorHttpClient.kt
@@ -1,11 +1,11 @@
-package com.developersbreach.kotlindictionarymultiplatform.core
+package com.developersbreach.kotlindictionarymultiplatform.core.network
 
 import com.developersbreach.kotlindictionarymultiplatform.Log
-import com.developersbreach.kotlindictionarymultiplatform.data.detail.ChatCompletionRequest
-import com.developersbreach.kotlindictionarymultiplatform.data.detail.ChatCompletionResponse
-import com.developersbreach.kotlindictionarymultiplatform.data.detail.ChatMessage
-import com.developersbreach.kotlindictionarymultiplatform.data.detail.FunctionDefinition
-import com.developersbreach.kotlindictionarymultiplatform.data.detail.KotlinTopicDetails
+import com.developersbreach.kotlindictionarymultiplatform.data.detail.model.ChatCompletionRequest
+import com.developersbreach.kotlindictionarymultiplatform.data.detail.model.ChatCompletionResponse
+import com.developersbreach.kotlindictionarymultiplatform.data.detail.model.ChatMessage
+import com.developersbreach.kotlindictionarymultiplatform.data.detail.model.FunctionDefinition
+import com.developersbreach.kotlindictionarymultiplatform.data.detail.model.KotlinTopicDetails
 import io.ktor.client.HttpClient
 import io.ktor.client.plugins.contentnegotiation.ContentNegotiation
 import io.ktor.client.request.header
diff --git a/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/data/detail/model/KotlinTopicDetails.kt b/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/data/detail/model/KotlinTopicDetails.kt
@@ -1,4 +1,4 @@
-package com.developersbreach.kotlindictionarymultiplatform.data.detail
+package com.developersbreach.kotlindictionarymultiplatform.data.detail.model
 
 import kotlinx.serialization.Serializable
 import kotlinx.serialization.SerialName
diff --git a/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/data/detail/repository/DetailRepository.kt b/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/data/detail/repository/DetailRepository.kt
@@ -0,0 +1,14 @@
+package com.developersbreach.kotlindictionarymultiplatform.data.detail.repository
+
+import arrow.core.Either
+import com.developersbreach.kotlindictionarymultiplatform.core.network.API_KEY
+import com.developersbreach.kotlindictionarymultiplatform.core.network.KtorHttpClient
+import com.developersbreach.kotlindictionarymultiplatform.data.detail.model.KotlinTopicDetails
+
+class DetailRepository {
+
+    suspend fun fetchTopic(topicId: String): Either<Throwable, KotlinTopicDetails> =
+        Either.catch {
+            KtorHttpClient.generateTopicDetails(topicId, API_KEY)
+        }
+}
diff --git a/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/data/topic/repository/TopicRepository.kt b/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/data/topic/repository/TopicRepository.kt
@@ -1,23 +1,26 @@
 package com.developersbreach.kotlindictionarymultiplatform.data.topic.repository
 
+import arrow.core.Either
 import com.developersbreach.kotlindictionarymultiplatform.data.topic.model.Topic
 
 object TopicRepository {
-    fun getTopics(): List<Topic> = listOf(
-        Topic("Variables"),
-        Topic("Strings"),
-        Topic("Functions"),
-        Topic("Coroutines"),
-        Topic("Classes"),
-        Topic("Interfaces"),
-        Topic("Objects"),
-        Topic("Collections"),
-        Topic("Null Safety"),
-        Topic("Lambdas"),
-        Topic("Higher-Order Functions"),
-        Topic("Delegation"),
-        Topic("Sealed Classes"),
-        Topic("Generics"),
-        Topic("Annotations"),
-    )
+    fun getTopics(): Either<Throwable, List<Topic>> = Either.catch {
+        listOf(
+            Topic("Variables"),
+            Topic("Strings"),
+            Topic("Functions"),
+            Topic("Coroutines"),
+            Topic("Classes"),
+            Topic("Interfaces"),
+            Topic("Objects"),
+            Topic("Collections"),
+            Topic("Null Safety"),
+            Topic("Lambdas"),
+            Topic("Higher-Order Functions"),
+            Topic("Delegation"),
+            Topic("Sealed Classes"),
+            Topic("Generics"),
+            Topic("Annotations"),
+        )
+    }
 }
diff --git a/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/di/AppModule.kt b/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/di/AppModule.kt
@@ -1,15 +1,22 @@
 package com.developersbreach.kotlindictionarymultiplatform.di
 
+import com.developersbreach.kotlindictionarymultiplatform.data.detail.repository.DetailRepository
 import org.koin.dsl.module
 import com.developersbreach.kotlindictionarymultiplatform.ui.screens.detail.DetailViewModel
 import com.developersbreach.kotlindictionarymultiplatform.ui.screens.topic.TopicViewModel
 import org.koin.core.module.dsl.viewModel
+import androidx.lifecycle.SavedStateHandle
+import com.developersbreach.kotlindictionarymultiplatform.data.topic.repository.TopicRepository
 
 val appModule = module {
-    viewModel {
-        DetailViewModel(get())
+    single { DetailRepository() }
+    single { TopicRepository }
+
+    viewModel { (handle: SavedStateHandle) ->
+        DetailViewModel(handle, get())
     }
+
     viewModel {
-        TopicViewModel()
+        TopicViewModel(get())
     }
 }
diff --git a/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/ui/components/ShowAlertDialog.kt b/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/ui/components/ShowAlertDialog.kt
@@ -0,0 +1,30 @@
+package com.developersbreach.kotlindictionarymultiplatform.ui.components
+
+import androidx.compose.material.AlertDialog
+import androidx.compose.material.Text
+import androidx.compose.material.TextButton
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Modifier
+import kotlindictionarymultiplatform.composeapp.generated.resources.Res
+import kotlindictionarymultiplatform.composeapp.generated.resources.ok
+import org.jetbrains.compose.resources.stringResource
+
+@Composable
+fun ShowAlertDialog(
+    onButtonClick: () -> Unit,
+    modifier: Modifier = Modifier,
+    title: String,
+    description: String,
+) {
+    AlertDialog(
+        onDismissRequest = onButtonClick,
+        title = { Text(title) },
+        text = { Text(description) },
+        confirmButton = {
+            TextButton(onClick = onButtonClick) {
+                Text(text = stringResource(Res.string.ok))
+            }
+        },
+        modifier = modifier,
+    )
+}
diff --git a/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/ui/components/UiState.kt b/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/ui/components/UiState.kt
@@ -0,0 +1,9 @@
+package com.developersbreach.kotlindictionarymultiplatform.ui.components
+
+sealed class UiState<out T> {
+    data object Loading : UiState<Nothing>()
+
+    data class Success<out T>(val data: T) : UiState<T>()
+
+    data class Error(val throwable: Throwable) : UiState<Nothing>()
+}
diff --git a/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/ui/components/UiStateHandler.kt b/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/ui/components/UiStateHandler.kt
@@ -0,0 +1,61 @@
+package com.developersbreach.kotlindictionarymultiplatform.ui.components
+
+import androidx.compose.foundation.layout.Box
+import androidx.compose.foundation.layout.fillMaxSize
+import androidx.compose.material.CircularProgressIndicator
+import androidx.compose.material.MaterialTheme
+import androidx.compose.runtime.mutableStateOf
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.LaunchedEffect
+import androidx.compose.ui.Alignment
+import androidx.compose.ui.Modifier
+import androidx.compose.runtime.saveable.rememberSaveable
+import kotlindictionarymultiplatform.composeapp.generated.resources.Res
+import kotlindictionarymultiplatform.composeapp.generated.resources.error_info_unavailable
+import kotlindictionarymultiplatform.composeapp.generated.resources.error_occurred
+import org.jetbrains.compose.resources.stringResource
+
+@Composable
+fun <T> UiStateHandler(
+    uiState: UiState<T>,
+    isLoading: Boolean = false,
+    content: @Composable (T) -> Unit,
+) {
+    val shouldDismissErrorDialog = rememberSaveable { mutableStateOf(false) }
+
+    LaunchedEffect(Unit) {
+        shouldDismissErrorDialog.value = false
+    }
+
+    Box(modifier = Modifier.fillMaxSize()) {
+        when (uiState) {
+            is UiState.Loading -> {
+                CircularProgressIndicator(
+                    modifier = Modifier.align(Alignment.Center),
+                    color = MaterialTheme.colors.onBackground,
+                )
+            }
+
+            is UiState.Error -> {
+                if (!shouldDismissErrorDialog.value) {
+                    val errorDetails = uiState.throwable
+                    ShowAlertDialog(
+                        onButtonClick = { shouldDismissErrorDialog.value = true },
+                        modifier = Modifier,
+                        title = stringResource(Res.string.error_occurred),
+                        description = errorDetails.message ?: stringResource(Res.string.error_info_unavailable),
+                    )
+                }
+            }
+
+            is UiState.Success -> content(uiState.data)
+        }
+
+        if (isLoading) {
+            CircularProgressIndicator(
+                modifier = Modifier.align(Alignment.Center),
+                color = MaterialTheme.colors.onBackground,
+            )
+        }
+    }
+}
diff --git a/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/ui/screens/detail/DetailScreen.kt b/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/ui/screens/detail/DetailScreen.kt
@@ -1,35 +1,35 @@
 package com.developersbreach.kotlindictionarymultiplatform.ui.screens.detail
 
-import androidx.compose.foundation.layout.Box
 import androidx.compose.foundation.layout.Spacer
-import androidx.compose.foundation.layout.fillMaxSize
 import androidx.compose.foundation.layout.height
 import androidx.compose.foundation.layout.padding
 import androidx.compose.foundation.lazy.LazyColumn
-import androidx.compose.material.CircularProgressIndicator
 import androidx.compose.material.MaterialTheme
 import androidx.compose.material.Text
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.collectAsState
 import androidx.compose.runtime.getValue
-import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.unit.dp
 import androidx.compose.foundation.lazy.items
+import com.developersbreach.kotlindictionarymultiplatform.ui.components.UiStateHandler
 
 @Composable
 fun DetailScreen(viewModel: DetailViewModel) {
-    val topicState by viewModel.state.collectAsState()
+    val uiState by viewModel.state.collectAsState()
 
-    topicState?.let { topic ->
+    UiStateHandler(uiState = uiState) { topic ->
         LazyColumn(modifier = Modifier.padding(16.dp)) {
             item {
                 Text(text = topic.topicName, style = MaterialTheme.typography.h5)
                 Spacer(modifier = Modifier.height(8.dp))
                 Text(text = topic.intro)
                 Spacer(modifier = Modifier.height(16.dp))
 
-                Text(text = "Signature: ${topic.syntax.signature}", style = MaterialTheme.typography.subtitle1)
+                Text(
+                    text = "Signature: ${topic.syntax.signature}",
+                    style = MaterialTheme.typography.subtitle1,
+                )
                 topic.syntax.notes?.let {
                     Text(text = "Notes: $it")
                 }
@@ -64,9 +64,5 @@ fun DetailScreen(viewModel: DetailViewModel) {
                 }
             }
         }
-    } ?: run {
-        Box(modifier = Modifier.fillMaxSize(), contentAlignment = Alignment.Center) {
-            CircularProgressIndicator()
-        }
     }
 }
diff --git a/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/ui/screens/detail/DetailViewModel.kt b/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/ui/screens/detail/DetailViewModel.kt
@@ -5,37 +5,39 @@ import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
 import androidx.navigation.toRoute
 import com.developersbreach.kotlindictionarymultiplatform.Log
-import com.developersbreach.kotlindictionarymultiplatform.data.detail.KotlinTopicDetails
-import com.developersbreach.kotlindictionarymultiplatform.core.KtorHttpClient
+import com.developersbreach.kotlindictionarymultiplatform.data.detail.model.KotlinTopicDetails
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.launch
-import com.developersbreach.kotlindictionarymultiplatform.core.API_KEY
+import com.developersbreach.kotlindictionarymultiplatform.data.detail.repository.DetailRepository
+import com.developersbreach.kotlindictionarymultiplatform.ui.components.UiState
 import com.developersbreach.kotlindictionarymultiplatform.ui.navigation.AppDestinations
+import kotlinx.io.IOException
 
 class DetailViewModel(
-    savedStateHandle: SavedStateHandle,
+    private val savedStateHandle: SavedStateHandle,
+    private val repository: DetailRepository,
 ) : ViewModel() {
 
     private val topicId = savedStateHandle.toRoute<AppDestinations.Detail>().topicId
 
-    private val _state = MutableStateFlow<KotlinTopicDetails?>(null)
-    val state: StateFlow<KotlinTopicDetails?> = _state
+    private val _state = MutableStateFlow<UiState<KotlinTopicDetails>>(UiState.Loading)
+    val state: StateFlow<UiState<KotlinTopicDetails>> = _state
 
     init {
-        fetchTopic(topicId)
-    }
-
-    private fun fetchTopic(topicId: String) {
         viewModelScope.launch {
             try {
-                val topic = KtorHttpClient.generateTopicDetails(topicId, API_KEY)
-                Log.i("DetailViewModel", "Fetched details: $topic")
-                _state.value = topic
-                Log.i("DetailViewModel", "State updated with topic: $topic")
-            } catch (e: Exception) {
+                fetchTopic()
+            } catch (e: IOException) {
                 Log.e("DetailViewModel", "Error fetching topic: ${e.message}", e)
             }
         }
     }
+
+    private suspend fun fetchTopic() {
+        _state.value = repository.fetchTopic(topicId).fold(
+            ifLeft = { UiState.Error(it) },
+            ifRight = { UiState.Success(it) },
+        )
+    }
 }
diff --git a/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/ui/screens/topic/TopicScreen.kt b/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/ui/screens/topic/TopicScreen.kt
@@ -16,24 +16,27 @@ import androidx.compose.ui.Modifier
 import androidx.compose.ui.unit.dp
 import com.developersbreach.kotlindictionarymultiplatform.Log
 import com.developersbreach.kotlindictionarymultiplatform.data.topic.model.Topic
+import com.developersbreach.kotlindictionarymultiplatform.ui.components.UiStateHandler
 
 @Composable
 fun TopicScreen(
     onTopicClick: (String) -> Unit,
     viewModel: TopicViewModel,
 ) {
-    val topics by viewModel.topics.collectAsState()
+    val state by viewModel.topics.collectAsState()
 
-    LazyColumn(
-        modifier = Modifier
-            .fillMaxSize()
-            .padding(16.dp),
-    ) {
-        items(topics) { topic ->
-            TopicItem(topic = topic, onClick = {
-                Log.i("TopicScreen", "Topic clicked: ${topic.name}")
-                onTopicClick(topic.name)
-            })
+    UiStateHandler(uiState = state) { topics ->
+        LazyColumn(
+            modifier = Modifier
+                .fillMaxSize()
+                .padding(16.dp),
+        ) {
+            items(topics) { topic ->
+                TopicItem(topic = topic, onClick = {
+                    Log.i("TopicScreen", "Topic clicked: ${topic.name}")
+                    onTopicClick(topic.name)
+                })
+            }
         }
     }
 }
diff --git a/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/ui/screens/topic/TopicViewModel.kt b/composeApp/src/commonMain/kotlin/com/developersbreach/kotlindictionarymultiplatform/ui/screens/topic/TopicViewModel.kt
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml

Original file line number	Diff line number	Diff line change
`@@ -99,6 +99,8 @@ kotlin {`
`99`	`99`	`implementation(libs.koin.compose)`
`100`	`100`	`implementation(libs.koin.compose.viewmodel)`
`101`	`101`	`implementation(libs.kermit)`
	`102`	`+ implementation(libs.arrow.core)`
	`103`	`+ implementation(libs.arrow.fx.coroutines)`
`102`	`104`	`}`
`103`	`105`	`desktopMain.dependencies {`
`104`	`106`	`implementation(compose.desktop.currentOs)`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+package com.developersbreach.kotlindictionarymultiplatform.core.network`
	`2`	`+`
	`3`	`+const val API_KEY = ""`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package com.developersbreach.kotlindictionarymultiplatform.data.detail`
	`1`	`+package com.developersbreach.kotlindictionarymultiplatform.data.detail.model`
`2`	`2`
`3`	`3`	`import kotlinx.serialization.Serializable`
`4`	`4`	`import kotlinx.serialization.SerialName`