Pending requests

[kirillNay]

• Создал новый модуль - network
• Создал реализацию блокирующих и отложенных retrofit-запросов. Основные сущности:
  PendingRequestsManager - менеджер отложенных запросов. Занимается предоставлением доступа к буферу неотправленных запросов и хранит в себе флаг, отвечающий за необходимость складировать запросы в буфер.
  BlockingRequest - аннотация для метода Retrofit-сервиса. Этой аннотацией будет помечаться метод, который будет блокировать отправку остальных. Параметр cancelRequestsOnFail показывает необходимость останавливать выполнение отложенных запросов при фейле блокирующего.
  BlockingCall - кастомная реализация Call от Retrofit с определением и обработкой блокирующих запросов в методе enqueue
BlockingRequestCallAdapter - CallAdapter, который занимается кастом Call в BlockingCall для дальнейшей обработки блокирующих запросов

PendingRequestsManager хранит в себе список запросов. Изменение этого списка потокобезопасно и контролируется pendingRequestsLock. В кейсах PendingRequestsManagerTest как раз и тестируется потокобезопасность менеджера

Зачем это нужно
Пример блокирующего запроса - обновление сессионного токена в приложении. Пока этот запрос не выполнится успехом другие запросы не должны отправляться.

Какие могут быть доработки
PendingRequestsManager может использоваться для различных необходимостей сохранения запросов. Например возможно откладывать запросы при отсутствии интернета и вызывать их, когда интернет появится. Для этого надо будет добавить реализацию изменения isPending флага с различных источников, чтобы не было конфликтов.

Как использовать
В билдере Retrofit instance:

Retrofit.Builder()
            ...
            .addCallAdapterFactory(BlockingRequestCallAdapter.create())
            .build()

Для запросов:

interface TokenRetrofitApi {
  @BlockingRequest(cancelRequestsOnFail = true)
  @POST("/api/v3/mobile/auth/tokens/renew/")
  suspend fun renewTokenRequest(@Body body: RefreshTokenBody): RenewTokenResponse
}

Будет добавлено в README в следующем ПР

[rybakovi]

testImplementation ?

[rybakovi]

testImplementation ?

[rybakovi]

up?

[rybakovi]

testImplementation ?

[rybakovi]

а если добавили 1 блокирующий, а потом еще один блокирующий добавили до того, как отработают onResponse или onFailure. тогда второй блокирующий добавится в pendingRequests?
и вообще есть ли реальные кейсы, когда может быть несколько блокирующих запросов?

[rybakovi]

мб чуть переделать extension, чтобы он возвращал boolean? кажется, более очевидно из названия и легче понимать в коде, что происходит

[rybakovi]

я прост изначально думал, что getAnnotation() вернет boolean, а не аннотацию