Skip to content

Commit da71abb

Browse files
committed
Fix migration note wording for the removed OAuth timeout
The auth-flow's own HTTP requests are not bounded either, so don't claim the redirect/callback handlers are the only open-ended waits. No-Verification-Needed: doc-only wording change
1 parent 7af30f9 commit da71abb

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

docs/migration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1956,7 +1956,7 @@ Forward the `iss` query parameter from the redirect so the validation can run: o
19561956

19571957
### `timeout` parameter removed from `OAuthClientProvider`
19581958

1959-
`OAuthClientProvider` (and the deprecated `RFC7523OAuthClientProvider`) no longer accept a `timeout` argument, and `OAuthContext.timeout` is gone. The value was stored but never read, so it never bounded anything — the only open-ended waits in the flow are your own `redirect_handler` and `callback_handler`.
1959+
`OAuthClientProvider` (and the deprecated `RFC7523OAuthClientProvider`) no longer accept a `timeout` argument, and `OAuthContext.timeout` is gone. The value was stored but never read, so it never bounded anything — removing it changes no behavior.
19601960

19611961
**Before (v1):**
19621962

@@ -1970,7 +1970,7 @@ provider = OAuthClientProvider(server_url, client_metadata, storage, timeout=120
19701970
provider = OAuthClientProvider(server_url, client_metadata, storage)
19711971
```
19721972

1973-
If you need to bound how long the flow waits for the user to complete authorization, apply the timeout inside your `callback_handler`, e.g. `with anyio.fail_after(120): ...`.
1973+
If you passed `timeout` to bound how long you wait for the user to complete authorization, apply that bound where you actually wait — inside your `redirect_handler`/`callback_handler`, e.g. `with anyio.fail_after(120): ...`.
19741974

19751975
### Client rejects authorization server metadata with a mismatched `issuer`
19761976

0 commit comments

Comments
 (0)