-
Notifications
You must be signed in to change notification settings - Fork 462
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
EdgeAgent: Change twin refresh timer logic to loop (#799)
* EA Loop * Use periodic task * Add tests * Cleanup * Clean up * Cleanup * Remove unnecessary test because of change in behavior. * Cleanup * Add logic around RefreshTwin
- Loading branch information
1 parent
408f70d
commit cb7af40
Showing
4 changed files
with
222 additions
and
108 deletions.
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
108 changes: 108 additions & 0 deletions
108
edge-util/src/Microsoft.Azure.Devices.Edge.Util/PeriodicTask.cs
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,108 @@ | ||
| // Copyright (c) Microsoft. All rights reserved. | ||
| namespace Microsoft.Azure.Devices.Edge.Util | ||
| { | ||
| using System; | ||
| using System.Threading; | ||
| using System.Threading.Tasks; | ||
| using Microsoft.Extensions.Logging; | ||
|
|
||
| public class PeriodicTask : IDisposable | ||
| { | ||
| readonly Func<CancellationToken, Task> work; | ||
| readonly TimeSpan frequency; | ||
| readonly TimeSpan startAfter; | ||
| readonly object stateLock = new object(); | ||
| readonly ILogger logger; | ||
| readonly string operationName; | ||
| readonly Timer checkTimer; | ||
| readonly CancellationTokenSource cts = new CancellationTokenSource(); | ||
|
|
||
| Task currentTask; | ||
|
|
||
| public PeriodicTask( | ||
| Func<CancellationToken, Task> work, | ||
| TimeSpan frequency, | ||
| TimeSpan startAfter, | ||
| ILogger logger, | ||
| string operationName) | ||
| { | ||
| Preconditions.CheckArgument(frequency > TimeSpan.Zero, "Frequency should be > 0"); | ||
| Preconditions.CheckArgument(startAfter >= TimeSpan.Zero, "startAfter should be >= 0"); | ||
|
|
||
| this.work = Preconditions.CheckNotNull(work, nameof(work)); | ||
| this.frequency = frequency; | ||
| this.startAfter = startAfter; | ||
| this.logger = Preconditions.CheckNotNull(logger, nameof(logger)); | ||
| this.operationName = Preconditions.CheckNonWhiteSpace(operationName, nameof(operationName)); | ||
| this.currentTask = this.DoWork(); | ||
| this.checkTimer = new Timer(this.EnsureWork, null, startAfter, frequency); | ||
| this.logger.LogInformation($"Started operation {this.operationName}"); | ||
| } | ||
|
|
||
| public PeriodicTask( | ||
| Func<Task> work, | ||
| TimeSpan frequency, | ||
| TimeSpan startAfter, | ||
| ILogger logger, | ||
| string operationName) | ||
| : this(_ => Preconditions.CheckNotNull(work, nameof(work))(), frequency, startAfter, logger, operationName) | ||
| { | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Do not dispose the task here in case it hasn't completed. | ||
| /// </summary> | ||
| public void Dispose() | ||
| { | ||
| this.checkTimer?.Dispose(); | ||
| this.cts?.Cancel(); | ||
| this.cts?.Dispose(); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// The current task should never complete, but in case it does, this makes sure it is started again. | ||
| /// </summary> | ||
| void EnsureWork(object state) | ||
| { | ||
| lock (this.stateLock) | ||
| { | ||
| if (this.currentTask == null || this.currentTask.IsCompleted) | ||
| { | ||
| this.logger.LogInformation($"Periodic operation {this.operationName}, is not running. Attempting to start again..."); | ||
| this.currentTask = this.DoWork(); | ||
| this.logger.LogInformation($"Started operation {this.operationName}"); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| async Task DoWork() | ||
| { | ||
| try | ||
| { | ||
| CancellationToken cancellationToken = this.cts.Token; | ||
| await Task.Delay(this.startAfter, cancellationToken); | ||
| while (!cancellationToken.IsCancellationRequested) | ||
| { | ||
| try | ||
| { | ||
| this.logger.LogInformation($"Starting periodic operation {this.operationName}..."); | ||
| await this.work(cancellationToken); | ||
| this.logger.LogInformation($"Successfully completed periodic operation {this.operationName}"); | ||
| } | ||
| catch (Exception e) | ||
| { | ||
| this.logger.LogWarning(e, $"Error in periodic operation {this.operationName}"); | ||
| } | ||
|
|
||
| await Task.Delay(this.frequency, cancellationToken); | ||
| } | ||
|
|
||
| this.logger.LogDebug($"Periodic operation {this.operationName} cancelled"); | ||
| } | ||
| catch (Exception ex) | ||
| { | ||
| this.logger.LogError(ex, $"Unexpected error in periodic operation {this.operationName}"); | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.