Core auth flows #40084
Core auth flows #40084
Conversation
|
API change check API changes are not detected in this pull request. |
xiangyan99
requested review from
lmazuel,
annatisch,
johanste,
iscai-msft,
kashifkhan and
pvaneck
as code owners
There was a problem hiding this comment.
Pull Request Overview
This PR introduces support for the auth_flows keyword in bearer token authentication flows across synchronous and asynchronous pipelines.
- Updated tests to pass the new auth_flows parameter to request-handling methods.
- Modified the _authentication and _authentication_async policies to incorporate auth_flows when obtaining tokens.
- Updated CHANGELOG and added a type-ignore comment for OpenTelemetry context detachment.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| sdk/core/corehttp/tests/async_tests/test_authentication_async.py | Updated test cases to pass auth_flows and modified the token credential method. |
| sdk/core/corehttp/tests/test_authentication.py | Updated assertions and token request options for auth_flows. |
| sdk/core/corehttp/corehttp/runtime/policies/_authentication.py | Changed on_request signature and added auth_flows support in token acquisition. |
| sdk/core/corehttp/corehttp/runtime/policies/_authentication_async.py | Updated asynchronous on_request to support auth_flows. |
| sdk/core/azure-core/azure/core/tracing/opentelemetry.py | Added "# type: ignore" for a detachment call. |
| sdk/core/azure-core/CHANGELOG.md | Documented the addition of auth_flows support in BearerTokenCredentialPolicy. |
Comments suppressed due to low confidence (1)
sdk/core/corehttp/tests/async_tests/test_authentication_async.py:278
- Avoid using mutable default arguments. Change the default value of options to None and initialize it to {} within the function.
async def get_token_info(self, *scopes, options={):
| """ | ||
| self._enforce_https(request) | ||
|
|
||
| if self._token is None or self._need_new_token: | ||
| self._token = self._credential.get_token_info(*self._scopes) | ||
| options: TokenRequestOptions = {"auth_flows": auth_flows} if auth_flows else {} # type: ignore |
There was a problem hiding this comment.
Add auth_flows to the TypedDict TokenRequestOptions class?
There was a problem hiding this comment.
It is optional. I would hold until the GA at least. :)
| :raises: :class:`~corehttp.exceptions.ServiceRequestError` | ||
| """ | ||
|
|
||
| def on_request(self, request: PipelineRequest[HTTPRequestType]) -> None: | ||
| def on_request( | ||
| self, request: PipelineRequest[HTTPRequestType], *, auth_flows: Optional[list[dict[str, str]]] = None |
There was a problem hiding this comment.
Do we need to take in auth_flows as a parameter here? Or can we just access it in this method via self._auth_flows?
There was a problem hiding this comment.
I have the parameter because we will support per-operation auth_flow. :)
No description provided.