A new stable release for your favourite Retrofit call adapter. v5 is a culmination of a lot of community contributions and an overhaul of the internals of the library.
Upgrade Guide
https://haroldadmin.github.io/NetworkResponseAdapter/upgrade-guides/v5/
Breaking Changes:
- The constructors for
NetworkResponsesubclasses have changed (#59)
NetworkResponse.Success, NetworkResponse.ServerError and NetworkResponse.UnknownError no longer accept status code, headers or body as constructor parameters. Instead, you must supply a correctly configured instance of a Retrofit Response.
Here's an example with Mockito:
In v4:
whenever(apiService.signOut(any()))
.thenReturn(NetworkResponse.Success(code = 200, body = Unit))In v5:
// NetworkResponse.Success
whenever(apiService.signOut(any()))
.thenReturn(NetworkResponse.Success(response = Response.success(200), body = Unit))
// NetworkResponse.Error
val errorResponse = Response.error<String>(
500,
"{\"error\": \"boom\"}"
.toResponseBody("application/json")
.toMediaTypeOrNull(),
)
whenever(apiService.signOut(any()))
.thenReturn(NetworkResponse.ServerError(response = errorResponse, body = ErrorResponse("boom")))New Features
- 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, NetworkResponse.ServerError and NetworkResponse.UnknownError 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()
}
}- 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.
Huge thanks to @argenkiwi and @gilgoldzweig for their contributions to this release.
This release brings the v5 beta for NetworkResponseAdapter!
Changes
NetworkResponse.UnknownErrornow bundles the raw Retrofit response when available- Updated documentation site for changes in the v5 release
- Added upgrade guide to v5 to the docs
- Added a projects and endorsements page
The next version of NetworkResponseAdapter is here! Here's a list of all the changes:
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.
New
- Gracefully handle the case when a service interface method's return type can not be handled by
NetworkResponseAdapterFactory
Misc
- Upgrade to Kotlin 1.5.20 and Gradle 7.1
- Migrate to Maven publish plugin
Fixes the Jitpack build issue that plagued v4.2.0.
This version is not available for download due to Jitpack build issues. Use v4.2.1 instead
- Build issues on Jitpack mean that JAR files for v4.2.0 are not available for download yet.
- Please continue using v4.1.0, or wait for the next release that fixes this problem.**
New:
- Introduce a new generic
Errorinterface for when you don't about the specific type of error in aNetworkResponse(thanks @gilgoldzweig!) - Update Kotlin to v1.4.31 and Dokka to v1.4.32
- Migrate to Pipenv for the documentation website
- Add nullable status code and headers fields to
NetworkResponse.UnknownError - Update to Kotlin 1.4.21, Coroutines 1.4.2, OkHttp 4.9.0
- Make kotlin, coroutines, retrofit and okhttp as
apidependencies
This release adds a couple of new features:
- A special case of successful responses with empty bodies can now be handled by declaring the success type to be Unit
- NetworkResponse.Success class now contains a field representing the response code
Fixes:
- This release fixes a bug in
NetworkResponseCallclass, which caused Retrofit's suspending functions to always receivenullas the ErrorType.
This release adds a big new feature to this library: Support for suspending functions in Retrofit's service interfaces!
New:
- Support for suspending functions
- Kotlin 1.3.50
- Coroutines 1.3 stable
Changes:
- Deprecate
CoroutinesNetworkResponseAdapterandCoroutinesNetworkResponseAdapterFactoryclasses. Replaced withNetworkResponseAdapterandNetworkResponseAdapterFactory. Quickfix suggestion should be available within the IDE.
Huge thanks to @JavierSegoviaCordoba for helping out with this release.
- Upgrade Kotlin to 1.3.41
- Upgrade Coroutines to 1.3.0-RC
- Upgrade to OkHTTP 4 and Retrofit 2.6.0
- Null response codes in HttpExceptions are now returned as code 520
- Fixes:
- Fix null headers when server response body is empty.
- New features: - Added overloaded invoke operator function the
NetworkResponseclass.
This release adds support for response headers in the NetworkResponse class. A new executeWithRetry method has also been added which automatically retries the network requests in case they result in NetworkResponse.NetworkError. You can customize the number of retries, and exponential delay parameters too.
-
New Features:
- Headers support
- ExecuteWithRetry utility function
-
Fixes
- Fixed retrofit executor used in tests
- First public release of the library