-
Notifications
You must be signed in to change notification settings - Fork 2.9k
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.
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
[AppConfig] Add lock to SyncTokenPolicy #19395
Merged
Merged
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
94 changes: 94 additions & 0 deletions
94
sdk/appconfiguration/azure-appconfiguration/azure/appconfiguration/aio/_sync_token_async.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
# -------------------------------------------------------------------------- | ||
# | ||
# Copyright (c) Microsoft Corporation. All rights reserved. | ||
# | ||
# The MIT License (MIT) | ||
# | ||
# Permission is hereby granted, free of charge, to any person obtaining a copy | ||
# of this software and associated documentation files (the ""Software""), to | ||
# deal in the Software without restriction, including without limitation the | ||
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or | ||
# sell copies of the Software, and to permit persons to whom the Software is | ||
# furnished to do so, subject to the following conditions: | ||
# | ||
# The above copyright notice and this permission notice shall be included in | ||
# all copies or substantial portions of the Software. | ||
# | ||
# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | ||
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS | ||
# IN THE SOFTWARE. | ||
# | ||
# -------------------------------------------------------------------------- | ||
from typing import Any, Dict | ||
from asyncio import Lock | ||
from azure.core.pipeline import PipelineRequest, PipelineResponse | ||
from azure.core.pipeline.policies import SansIOHTTPPolicy | ||
|
||
from .._sync_token import SyncToken | ||
|
||
|
||
class AsyncSyncTokenPolicy(SansIOHTTPPolicy): | ||
"""A simple policy that enable the given callback | ||
with the response. | ||
:keyword callback raw_response_hook: Callback function. Will be invoked on response. | ||
""" | ||
|
||
def __init__(self, **kwargs): # pylint: disable=unused-argument | ||
# type: (**Any) -> None | ||
self._sync_token_header = "Sync-Token" | ||
self._sync_tokens = {} # type: Dict[str, Any] | ||
self._lock = Lock() | ||
|
||
async def on_request(self, request): # type: ignore # pylint: disable=arguments-differ, invalid-overrident-method | ||
# type: (PipelineRequest) -> None | ||
"""This is executed before sending the request to the next policy. | ||
:param request: The PipelineRequest object. | ||
:type request: ~azure.core.pipeline.PipelineRequest | ||
""" | ||
async with self._lock: | ||
sync_token_header = ",".join(str(x) for x in self._sync_tokens.values()) | ||
if sync_token_header: | ||
request.http_request.headers.update( | ||
{self._sync_token_header: sync_token_header} | ||
) | ||
|
||
async def on_response(self, request, response): # type: ignore # pylint: disable=arguments-differ, invalid-overrident-method | ||
# type: (PipelineRequest, PipelineResponse) -> None | ||
"""This is executed after the request comes back from the policy. | ||
:param request: The PipelineRequest object. | ||
:type request: ~azure.core.pipeline.PipelineRequest | ||
:param response: The PipelineResponse object. | ||
:type response: ~azure.core.pipeline.PipelineResponse | ||
""" | ||
sync_token_header = response.http_response.headers.get(self._sync_token_header) | ||
if not sync_token_header: | ||
return | ||
sync_token_strings = sync_token_header.split(",") | ||
if not sync_token_strings: | ||
return | ||
for sync_token_string in sync_token_strings: | ||
sync_token = SyncToken.from_sync_token_string(sync_token_string) | ||
await self._update_sync_token(sync_token) | ||
|
||
async def add_token(self, full_raw_tokens): | ||
# type: (str) -> None | ||
raw_tokens = full_raw_tokens.split(",") | ||
for raw_token in raw_tokens: | ||
sync_token = SyncToken.from_sync_token_string(raw_token) | ||
await self._update_sync_token(sync_token) | ||
|
||
async def _update_sync_token(self, sync_token): | ||
# type: (SyncToken) -> None | ||
if not sync_token: | ||
return | ||
async with self._lock: | ||
existing_token = self._sync_tokens.get(sync_token.token_id, None) | ||
if not existing_token: | ||
self._sync_tokens[sync_token.token_id] = sync_token | ||
return | ||
if existing_token.sequence_number < sync_token.sequence_number: | ||
self._sync_tokens[sync_token.token_id] = sync_token |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where is "add_token"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add_token is
update_sync_token