KTOR-7644 Make re-auth status codes configurable #4420
Conversation
wkornewald
force-pushed
the
reauth-status-codes
branch
from
90a256c
to
d6e7166
Compare
wkornewald
changed the title
osipxd
force-pushed
the
3.1.0-eap
branch
2 times, most recently
from
a65ff10
to
9ae3d49
Compare
wkornewald
force-pushed
the
reauth-status-codes
branch
from
d6e7166
to
2034352
Compare
Some services use 403 instead of 401. Changing them might be impossible. With this change Ktor can flexibly work with any broken service.
wkornewald
force-pushed
the
reauth-status-codes
branch
from
2034352
to
5f0ca66
Compare
| if (origin.request.attributes.contains(AuthCircuitBreaker)) return@on origin | ||
|
|
||
| var call = origin | ||
|
|
||
| val candidateProviders = HashSet(providers) | ||
|
|
||
| while (call.response.status == HttpStatusCode.Unauthorized) { | ||
| while (call.response.status in pluginConfig.reAuthStatusCodes) { |
There was a problem hiding this comment.
Speaking of broken services, I've seen some APIs returning 200 OK with actual status code in a body. We could provide a lambda instead of a list of statuses:
var isUnauthorized: (HttpResponse) -> Boolean = { it.status == HttpStatusCode.Unauthorized }@e5l, @bjhham, @marychatte, what do you think?
There was a problem hiding this comment.
This sounds much better than the list. I've pushed that change.
There was a problem hiding this comment.
@osipxd
I like the idea with lambda!
returning 200 OK with actual status code in a body
Do you mean it could be used like this?
isUnauthorized = { it.bodyAsText() == "401" }
If yes, then isUnauthorized function should be suspend
ktor-client/ktor-client-plugins/ktor-client-auth/common/src/io/ktor/client/plugins/auth/Auth.kt
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
LGTM. Thank you!
@bjhham, @marychatte, could you also take a look?
| * [providers] - list of auth providers to use. | ||
| * [isUnauthorized] - lambda function to control whether a response is unauthorized and should trigger a re-auth. |
There was a problem hiding this comment.
Something else: this refers to variables that are actually defined on AuthConfig. Shouldn't the docstring be defined there instead or at least refer to the full path [AuthConfig.providers]? I just copied the existing code, but maybe this should be fixed, too.
|
Thanks for the PR! Can we also please add tests for it? |
Sure, added one and switched to a suspend lambda. |
Some services use 403 instead of 401. Changing them might be impossible. With this change Ktor can flexibly work with any broken service.