Use ktor and kotlinx serialization #126
+664
−303
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| package com.fernandocejas.sample | ||
|
|
||
| import com.fernandocejas.sample.core.navigation.navigationFeature | ||
| import com.fernandocejas.sample.core.network.networkFeature | ||
| import com.fernandocejas.sample.features.auth.authFeature | ||
| import com.fernandocejas.sample.features.login.loginFeature | ||
| import com.fernandocejas.sample.features.movies.di.moviesFeature | ||
|
|
||
| fun allFeatures() = listOf( | ||
| networkFeature(), | ||
|
There was a problem hiding this comment. I would not make network and navigation a feature. Unless we have a good reason for it. Think of features as user features. Networking and Navigation belong to core, which is the module shared across features. Happy to read your thoughts :) There was a problem hiding this comment. I totally agree about the semantics here. My idea was to break core into independent functionalities like network, etc. If it's too much too early, we can keep core as is and see how it develops? |
||
| authFeature(), | ||
| loginFeature(), | ||
| moviesFeature(), | ||
| navigationFeature(), | ||
| ) | ||
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
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,56 @@ | ||
| package com.fernandocejas.sample.core.network | ||
|
|
||
| import com.fernandocejas.sample.core.functional.Either | ||
| import com.fernandocejas.sample.core.functional.toLeft | ||
| import com.fernandocejas.sample.core.functional.toRight | ||
|
|
||
| sealed class ApiResponse<out T, out E> { | ||
| /** | ||
| * Represents successful network responses (2xx). | ||
| */ | ||
| data class Success<T>(val body: T) : ApiResponse<T, Nothing>() | ||
|
|
||
| sealed class Error<E> : ApiResponse<Nothing, E>() { | ||
| /** | ||
| * Represents server (50x) and client (40x) errors. | ||
| */ | ||
| data class HttpError<E>(val code: Int, val errorBody: E?) : Error<E>() | ||
|
|
||
| /** | ||
| * Represent IOExceptions and connectivity issues. | ||
| */ | ||
| data object NetworkError : Error<Nothing>() | ||
|
|
||
| /** | ||
| * Represent SerializationExceptions. | ||
| */ | ||
| data object SerializationError : Error<Nothing>() | ||
| } | ||
| } | ||
|
|
||
| // Side Effect helpers | ||
| inline fun <T, E> ApiResponse<T, E>.onSuccess(block: (T) -> Unit): ApiResponse<T, E> { | ||
| if (this is ApiResponse.Success) { | ||
| block(body) | ||
| } | ||
| return this | ||
| } | ||
|
|
||
| fun <T, E> ApiResponse<T, E>.toEither(): Either<E?, T> { | ||
| return when (this) { | ||
| is ApiResponse.Success -> body.toRight() | ||
| is ApiResponse.Error.HttpError -> errorBody.toLeft() | ||
| is ApiResponse.Error.NetworkError -> null.toLeft() | ||
| is ApiResponse.Error.SerializationError -> null.toLeft() | ||
| } | ||
| } | ||
|
|
||
| fun <T, E, F, D> ApiResponse<T, E>.toEither( | ||
| successTransform: (T) -> D, | ||
| errorTransform: (ApiResponse.Error<E>) -> F, | ||
| ): Either<F, D> { | ||
| return when (this) { | ||
| is ApiResponse.Success -> successTransform(body).toRight() | ||
| is ApiResponse.Error -> errorTransform(this).toLeft() | ||
| } | ||
| } |
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,34 @@ | ||
| package com.fernandocejas.sample.core.network | ||
|
|
||
| import io.ktor.client.HttpClient | ||
| import io.ktor.client.call.body | ||
| import io.ktor.client.plugins.ClientRequestException | ||
| import io.ktor.client.plugins.ResponseException | ||
| import io.ktor.client.plugins.ServerResponseException | ||
| import io.ktor.client.request.HttpRequestBuilder | ||
| import io.ktor.client.request.request | ||
| import io.ktor.serialization.JsonConvertException | ||
| import kotlinx.io.IOException | ||
|
|
||
| suspend inline fun <reified T, reified E> HttpClient.safeRequest( | ||
| block: HttpRequestBuilder.() -> Unit, | ||
| ): ApiResponse<T, E> = | ||
| try { | ||
| val response = request { block() } | ||
| ApiResponse.Success(response.body()) | ||
| } catch (e: ClientRequestException) { | ||
| ApiResponse.Error.HttpError(e.response.status.value, e.errorBody()) | ||
| } catch (e: ServerResponseException) { | ||
| ApiResponse.Error.HttpError(e.response.status.value, e.errorBody()) | ||
| } catch (e: IOException) { | ||
| ApiResponse.Error.NetworkError | ||
| } catch (e: JsonConvertException) { | ||
| ApiResponse.Error.SerializationError | ||
| } | ||
|
|
||
| suspend inline fun <reified E> ResponseException.errorBody(): E? = | ||
| try { | ||
| response.body() | ||
| } catch (e: JsonConvertException) { | ||
| null | ||
| } |
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 |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| package com.fernandocejas.sample.core.network | ||
|
|
||
| import co.touchlab.kermit.Logger | ||
| import com.fernandocejas.sample.core.di.Feature | ||
| import io.ktor.client.HttpClient | ||
| import io.ktor.client.engine.okhttp.OkHttp | ||
| import io.ktor.client.plugins.HttpTimeout | ||
| import io.ktor.client.plugins.cache.HttpCache | ||
| import io.ktor.client.plugins.contentnegotiation.ContentNegotiation | ||
| import io.ktor.client.plugins.logging.LogLevel | ||
| import io.ktor.client.plugins.logging.Logging | ||
| import io.ktor.http.ContentType | ||
| import io.ktor.serialization.kotlinx.json.json | ||
| import kotlinx.serialization.json.Json | ||
| import org.koin.core.module.dsl.singleOf | ||
| import org.koin.dsl.module | ||
| import io.ktor.client.plugins.logging.Logger as KtorLogger | ||
|
|
||
| fun networkFeature() = object : Feature { | ||
|
There was a problem hiding this comment. Since this might not become a feature, the DI part should be rethought then. If do not see any issues to continue having a DI core module that includes all the cross cutting dependencies. |
||
| override fun name() = "network" | ||
| override fun diModule() = networkModule | ||
| } | ||
|
|
||
| private val networkModule = module { | ||
| singleOf(::NetworkHandler) | ||
| single { json } | ||
| single { client } | ||
| } | ||
|
|
||
| private val json = Json { | ||
| ignoreUnknownKeys = true | ||
| explicitNulls = false | ||
| } | ||
|
|
||
| private val client = HttpClient(OkHttp) { | ||
| engine { | ||
| config { | ||
| followRedirects(true) | ||
| } | ||
| } | ||
| install(HttpCache) | ||
| install(HttpTimeout) | ||
| install(ContentNegotiation) { | ||
| json(json, ContentType.Text.Plain) | ||
| } | ||
| install(Logging) { | ||
| logger = object : KtorLogger { | ||
| override fun log(message: String) { | ||
| Logger.withTag("HTTP").d { "\uD83C\uDF10 $message" } | ||
| } | ||
| } | ||
| level = LogLevel.HEADERS | ||
| } | ||
| } | ||
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
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
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 |
|---|---|---|
| @@ -0,0 +1,177 @@ | ||
| package com.fernandocejas.sample.core.network | ||
|
|
||
| import io.kotest.matchers.equals.shouldBeEqual | ||
| import io.ktor.client.HttpClient | ||
| import io.ktor.client.engine.mock.MockEngine | ||
| import io.ktor.client.engine.mock.respond | ||
| import io.ktor.client.plugins.contentnegotiation.ContentNegotiation | ||
| import io.ktor.client.request.url | ||
| import io.ktor.http.ContentType | ||
| import io.ktor.http.HttpHeaders | ||
| import io.ktor.http.HttpStatusCode | ||
| import io.ktor.http.contentType | ||
| import io.ktor.http.headersOf | ||
| import io.ktor.serialization.kotlinx.json.json | ||
| import kotlinx.coroutines.test.runTest | ||
| import kotlinx.io.IOException | ||
| import kotlinx.serialization.Serializable | ||
| import kotlinx.serialization.json.Json | ||
| import org.junit.Test | ||
|
|
||
| class HttpClientXTest { | ||
|
|
||
| @Test | ||
| fun `map to ApiResponse Success when client returns OK`() = runTest { | ||
| val tested = FakeApi(httpClient(okEngine)) | ||
|
|
||
| val expected = ApiResponse.Success(FakeApi.FakeData()) | ||
| val actual = tested.endpoint() | ||
|
|
||
| actual shouldBeEqual expected | ||
| } | ||
|
|
||
| @Test | ||
| fun `map to ApiResponse HttpError with code when client returns 40x`() = runTest { | ||
| val tested = FakeApi(httpClient(badRequestEngine)) | ||
|
|
||
| val expected = ApiResponse.Error.HttpError(400, FakeApi.FakeError("bad request")) | ||
| val actual = tested.endpoint() | ||
|
|
||
| actual shouldBeEqual expected | ||
| } | ||
|
|
||
| @Test | ||
| fun `map to ApiResponse HttpError with code and body when client returns 50x`() = runTest { | ||
| val tested = FakeApi(httpClient(serverErrorEngine)) | ||
|
|
||
| val expected = ApiResponse.Error.HttpError(500, FakeApi.FakeError("internal server error")) | ||
| val actual = tested.endpoint() | ||
|
|
||
| actual shouldBeEqual expected | ||
| } | ||
|
|
||
| @Test | ||
| fun `map to ApiResponse HttpError with code and null body when client returns 50x and error doesn't match contract`() = | ||
| runTest { | ||
| val tested = FakeApi(httpClient(malformedServerErrorEngine)) | ||
|
|
||
| val expected = ApiResponse.Error.HttpError(500, null) | ||
| val actual = tested.endpoint() | ||
|
|
||
| actual shouldBeEqual expected | ||
| } | ||
|
|
||
| @Test | ||
| fun `map to ApiResponse NetworkError when there is no internet`() = runTest { | ||
| val tested = FakeApi(httpClient(networkErrorEngine)) | ||
|
|
||
| val expected = ApiResponse.Error.NetworkError | ||
| val actual = tested.endpoint() | ||
|
|
||
| actual shouldBeEqual expected | ||
| } | ||
|
|
||
| @Test | ||
| fun `map to ApiResponse SerialisationError when data format doesn't match`() = runTest { | ||
| val tested = FakeApi(httpClient(serialisationErrorEngine)) | ||
|
|
||
| val expected = ApiResponse.Error.SerializationError | ||
| val actual = tested.endpoint() | ||
|
|
||
| actual shouldBeEqual expected | ||
| } | ||
|
|
||
| private fun httpClient(engine: MockEngine) = HttpClient(engine) { | ||
| expectSuccess = true | ||
| install(ContentNegotiation) { | ||
| json( | ||
| Json { | ||
| ignoreUnknownKeys = true | ||
| } | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| private class FakeApi( | ||
| private val client: HttpClient, | ||
| ) { | ||
|
|
||
| suspend fun endpoint(): ApiResponse<FakeData, FakeError> = | ||
| client.safeRequest { | ||
| url("https://movies.com/api") | ||
| contentType(ContentType.Application.Json) | ||
| } | ||
|
|
||
| @Serializable | ||
| data class FakeData( | ||
| val id: Int = 1, | ||
| val name: String = "Movie", | ||
| ) | ||
|
|
||
| @Serializable | ||
| data class FakeError( | ||
| val message: String | ||
| ) | ||
| } | ||
|
|
||
| private val headers = headersOf(HttpHeaders.ContentType, "application/json") | ||
|
|
||
| private val serialisationErrorEngine = MockEngine { | ||
| respond( | ||
| content = "just a string", | ||
| status = HttpStatusCode.OK, | ||
| headers = headers, | ||
| ) | ||
| } | ||
|
|
||
| private val badRequestEngine = MockEngine { | ||
| respond( | ||
| content = """ | ||
| { | ||
| "message": "bad request" | ||
| } | ||
| """.trimIndent(), | ||
| status = HttpStatusCode.BadRequest, | ||
| headers = headers, | ||
| ) | ||
| } | ||
|
|
||
| private val serverErrorEngine = MockEngine { | ||
| respond( | ||
| content = """ | ||
| { | ||
| "message": "internal server error" | ||
| } | ||
| """.trimIndent(), | ||
| status = HttpStatusCode.InternalServerError, | ||
| headers = headers, | ||
| ) | ||
| } | ||
|
|
||
| private val malformedServerErrorEngine = MockEngine { | ||
| respond( | ||
| content = """ | ||
| { | ||
| "incorrect_field_name": "error" | ||
| } | ||
| """.trimIndent(), | ||
| status = HttpStatusCode.InternalServerError, | ||
| headers = headers, | ||
| ) | ||
| } | ||
|
|
||
| private val networkErrorEngine = MockEngine { throw IOException("No internet") } | ||
|
|
||
| private val okEngine = MockEngine { | ||
| respond( | ||
| content = """ | ||
| { | ||
| "id": 1, | ||
| "name": "Movie" | ||
| } | ||
| """.trimIndent(), | ||
| status = HttpStatusCode.OK, | ||
| headers = headers, | ||
| ) | ||
| } | ||
| } |
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
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
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.
Love this! For a long time wanted to get rid of gson :)