Utilize retry policy when retrying to send SAS token in CBS auth in AMQP #3074
Conversation
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
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
schoims
force-pushed
the
choisophia/refresh-token-2
branch
from
6cd36f1 to
9144246
Compare
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
schoims
commented
Jan 19, 2023
| @@ -62,9 +62,10 @@ public abstract class IotHubBaseClient : IAsyncDisposable | |||
| DesiredPropertyUpdateCallback = OnDesiredStatePatchReceived, | |||
| ConnectionStatusChangeHandler = OnConnectionStatusChanged, | |||
| MessageEventCallback = OnMessageReceivedAsync, | |||
| RetryPolicy = _clientOptions.RetryPolicy ?? new IotHubClientNoRetry(), | |||
There was a problem hiding this comment.
Set RetryPolicy with the default exponential backoff policy unless user set it to null which is IotHubClientNoRetry()
schoims
commented
Jan 19, 2023
| if (_clientOptions.TransportSettings is IotHubClientAmqpSettings) | ||
| { | ||
| InnerHandler.SetSasTokenRefreshesOn(); | ||
| } |
There was a problem hiding this comment.
Sets SAS token refreshes on only for AMQP
schoims
commented
Jan 19, 2023
|
|
||
| if (_clientOptions.TransportSettings is IotHubClientAmqpSettings) | ||
| { | ||
| await InnerHandler.StopSasTokenLoopAsync().ConfigureAwait(false); |
There was a problem hiding this comment.
Stop SAS token refresh loop only for AMQP
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
schoims
commented
Jan 23, 2023
| [DataRow(IotHubClientErrorCode.ServerError)] | ||
| [DataRow(IotHubClientErrorCode.ServerBusy)] | ||
| [DataRow(IotHubClientErrorCode.Timeout)] | ||
| public async Task RetryDelegatingHandler_RefreshSasTokenAsync_RetriesOnTransientErrors(IotHubClientErrorCode errorCode) |
There was a problem hiding this comment.
Retries on all transient errors including network errors
schoims
commented
Jan 23, 2023
| [DataRow(IotHubClientErrorCode.Unauthorized)] | ||
| [DataRow(IotHubClientErrorCode.TlsAuthenticationError)] | ||
| [DataRow(IotHubClientErrorCode.ArgumentInvalid)] | ||
| public async Task RetryDelegatingHandler_RefreshSasTokenAsync_NoRetriesOnNonTransientErrors(IotHubClientErrorCode errorCode) |
There was a problem hiding this comment.
Does not retry on non-transient errors
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
schoims
requested review from
drwill-ms,
timtay-microsoft,
abhipsaMisra,
andyk-ms,
brycewang-microsoft,
tmahmood-microsoft,
ngastelum-ms and
patilsnr
as code owners
drwill-ms
reviewed
Jan 23, 2023
Comment on lines
536
to
540
| try | ||
| { | ||
| if (Logging.IsEnabled) | ||
| Logging.Enter(this, nameof(StopSasTokenLoopAsync)); | ||
|
|
There was a problem hiding this comment.
Suggested change
| try | |
| { | |
| if (Logging.IsEnabled) | |
| Logging.Enter(this, nameof(StopSasTokenLoopAsync)); | |
| if (Logging.IsEnabled) | |
| Logging.Enter(this, nameof(StopSasTokenLoopAsync)); | |
| try | |
| { |
drwill-ms
reviewed
Jan 23, 2023
drwill-ms
reviewed
Jan 23, 2023
drwill-ms
reviewed
Jan 23, 2023
drwill-ms
approved these changes
Jan 23, 2023
schoims
changed the title
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Refactored how retryPolicy is set in RetryDelegatingHandler. It is passed as a PipelineContext property. This change eliminates the need for setting it with a default RetryPolicy and updating it later.
AMQP implements proactive SAS token renewal support. This logic has been moved from AmqpAuthenticationRefresher to RetryDelegatingHandler to utilize retryHandler. When deviceClient calls OpenAsync(), AmqpIoTConnection creates amqpAuthenticationRefresher and amqpAuthenticationRefresher.refreshTokenAsync() sends a token to AmqpIotCbsTokenProvider for the first time and then gets a dateTime variable. This variable represents the token expiry time in UTC.