v5: Sealed interfaces, Raw Retrofit Responses, Kotest Migration, Kotlin 1.6.0

[haroldadmin]

This PR accomplishes some milestones aimed at the next major release of the library (#34)

Sealed Interfaces

The NetworkResponse class is now based on sealed interfaces. This allows for more concise when expressions when you don't care about the specific type of the error:

when (networkResponse) {
  is NetworkResponse.Success -> ...
  is NetworkResponse.Error -> ...
}

Raw Retrofit Responses

NetworkResponse.Success and NetworkResponse.ServerError now bundle the raw retrofit Response<S> object to allow for greater access to the response of the network request.

when (networkResponse) {
  is NetworkResponse.Success -> {
    val statusCode = networkResponse.response.code()
  }
}

We still supply code and headers properties as before to retain familiarity with the existing API design.

Handling Empty Response Bodies

In the current version of the library you have to use the Unit response type if you expected your server to respond without a body. This is fine when the API never returns a body, but causes problems if it sometimes returns a body and sometimes doesn't (200 vs 204 status code).

The bundled raw Retrofit responses provide a better way to handle this situation.

interface PostsService {
  @GET("/")
  suspend fun getPost(): NetworkResponse<Unit, ErrorResponse>
}

when (val postResponse  = service.getPost()) {
  is NetworkResponse.Success -> {
    if (postResponse.code != 204) {
      val rawBody = postResponse.response.rawBody()
      // Manually parse the raw body to access the response
    }
  }
  is NetworkResponse.Error -> { ... }
}

Tests Overhaul & Migration to Kotest

This PR gets refactors the library's test suite to get rid of redundant and obscure tests, and replaces them with a streamlined test suite focused on publicly exposed functionality.

We've also finally moved away from the deprecated kotlintest artifacts to the new kotest libraries.

Remove Deprecated Classes

We've removed deprecated ways to instantiate adapter factory. The existing classes had been marked as deprecated for a long period, and I hope everyone has moved away from them.

Kotlin 1.6.0

Updated the language level to 1.6.0

Sample App

Add a module showing sample usage of the library using the kotlinx.serialization library.

[gilgoldzweig]

I think there should be a NetworkResponse.Complete and there can be a discussion on if we should include
public val response: Response<*> or not

we can also add a typealias of CompletableResponse

typealias CompletableResponse<E> = NetworkResponse<Unit, E>

[haroldadmin]

I've included the raw Response as an escape hatch when you want more control over the response than what this library provides. I see no harm in adding it, but a loss of control for consumers in removing it. Unless there's a strong argument against not including it, it's better to leave it in there IMO.

Great idea on the CompletableResponse, I'll add it as a nice utility.

[gilgoldzweig]

Great!

On Wed, Dec 8, 2021 at 3:13 PM Leandro ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In src/main/kotlin/com/haroldadmin/cnradapter/NetworkResponse.kt <#50 (comment)> : > */ - data class NetworkError(override val error: IOException) : - NetworkResponse<Nothing, Nothing>(), Error + public sealed interface Error<S, E> : NetworkResponse<S, E> { Should the errors be nested? and if they are nested can they be renamed to not include the "Error" keyword? NetworkResponse.ServerError or NetworkResponse.Error.Server instead of NetworkResponse.Error.ServerError` Sorry, that was how I originally implemented it. I had not realised @haroldadmin <https://github.com/haroldadmin> had *nested* the classes already. I would agree with your last comment: we should neither nest nor rename the classes in this release. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#50 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AD563XCKXRTMAX5TIPKWF63UP7J7BANCNFSM5JMDNPRA> .

-- Best regards, *Gil Goldzweig Goldbaum* T: +972 50-839-2942 E: ***@***.***

[haroldadmin]

Appreciate the thorough review, @gilgoldzweig and @argenkiwi, the feedback is really useful. I'll update the PR with the requested changes.

[haroldadmin]

I've updated the pull request with your feedback. Would appreciate another round of review, @gilgoldzweig @argenkiwi.

[gilgoldzweig]

Looks fantastic, awesome job!!!

[argenkiwi]

Thanks for the good work @haroldadmin and apologies for the late reply. Looking forward to the next release. :D