Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an API to receive partial responses if the caller wants them #2325

Merged
merged 1 commit into from
Nov 26, 2024
Merged

Add an API to receive partial responses if the caller wants them #2325

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 21 additions & 8 deletions app/apollo/apollo-core/src/main/kotlin/com/hedvig/android/apollo/ApolloCallExt.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ sealed interface ApolloOperationError {
}

suspend fun <D : Operation.Data> ApolloCall<D>.safeExecute(): Either<ApolloOperationError, D> {
return iorNel<ApolloOperationError, D> { parseResponse(execute()) }.iorToEither()
return iorNel<ApolloOperationError, D> { parseResponse(execute()) }.dropPartialResponses()
}

suspend fun <D : Operation.Data, ErrorType> ApolloCall<D>.safeExecute(
Expand All @@ -68,7 +68,15 @@ suspend fun <D : Operation.Data, ErrorType> ApolloCall<D>.safeExecute(
return safeExecute().mapLeft(mapError)
}

fun <D : Operation.Data> ApolloCall<D>.safeFlowAllowingPartialResponses(): Flow<Ior<ApolloOperationError, D>> {
return internalSafeFlow().map { it.mergeApolloErrors() }
}

fun <D : Operation.Data> ApolloCall<D>.safeFlow(): Flow<Either<ApolloOperationError, D>> {
return internalSafeFlow().map { it.dropPartialResponses() }
}

private fun <D : Operation.Data> ApolloCall<D>.internalSafeFlow(): Flow<IorNel<ApolloOperationError, D>> {
return flow<ApolloResponse<D>> {
var hasEmitted = false
var errorResponse: ApolloResponse<D>? = null
Expand All @@ -87,7 +95,7 @@ fun <D : Operation.Data> ApolloCall<D>.safeFlow(): Flow<Either<ApolloOperationEr
// Flow has terminated without a valid response, emit the error one if it exists.
emit(errorResponseValue)
}
}.map { iorNel { parseResponse(it) }.iorToEither() }
}.map { iorNel { parseResponse(it) } }
}

fun <D : Operation.Data, ErrorType> ApolloCall<D>.safeFlow(
Expand All @@ -97,7 +105,7 @@ fun <D : Operation.Data, ErrorType> ApolloCall<D>.safeFlow(
}

fun <D : Query.Data> ApolloCall<D>.safeWatch(): Flow<Either<ApolloOperationError, D>> {
return this.watch().map { iorNel { parseResponse(it) }.iorToEither() }
return this.watch().map { iorNel { parseResponse(it) }.dropPartialResponses() }
}

fun ErrorMessage(apolloOperationError: ApolloOperationError): ErrorMessage = object : ErrorMessage {
Expand Down Expand Up @@ -169,15 +177,20 @@ private fun List<Error>?.mapToOperationErrors(): Nel<ApolloOperationError>? {
}.toNonEmptyListOrNull()
}

/**
* Turn it all back into the `Either<ApolloOperationError, D>` return type as all call-sites expect it this way for now
*/
private fun <D : Operation.Data> IorNel<ApolloOperationError, D>.iorToEither(): Either<ApolloOperationError, D> {
private fun <D : Operation.Data> IorNel<ApolloOperationError, D>.mergeApolloErrors(): Ior<ApolloOperationError, D> {
return mapLeft { errors ->
ApolloOperationError.OperationError.Other(
errors.joinToString(prefix = " [", postfix = "]", separator = ", ") { it.toString() },
)
}.toEither()
}
}

/**
* Turn it all back into `Either<ApolloOperationError, D>`, which drops all information where we may have had both
* errors and data. This only is [Either.Right] if everything went well and we got no responses.
*/
private fun <D : Operation.Data> IorNel<ApolloOperationError, D>.dropPartialResponses(): Either<ApolloOperationError, D> {
return mergeApolloErrors().toEither()
}

private fun <D : Operation.Data> iorFromErrorsAndData(
Expand Down
Loading