// Copyright (C) 2024, The Duplicati Team // https://duplicati.com, hello@duplicati.com // // 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. using Duplicati.Library.Logging; using Duplicati.Library.Utility; using System; using System.Collections.Generic; using System.Linq; using System.Net.Http.Headers; using System.Text; using System.Threading; using System.Threading.Tasks; namespace Duplicati.Library { public class RetryAfterHelper { private static readonly string LOGTAG = Log.LogTagFromType(); // Whenever a response includes a Retry-After header, we'll update this timestamp with when we can next // send a request. And before sending any requests, we'll make sure to wait until at least this time. // Since this may be read and written by multiple threads, it is stored as a long and updated using Interlocked.Exchange. private long retryAfter = DateTimeOffset.MinValue.UtcTicks; public void SetRetryAfter(RetryConditionHeaderValue retryAfter) { if (retryAfter != null) { DateTimeOffset? delayUntil = null; if (retryAfter.Delta.HasValue) { delayUntil = DateTimeOffset.UtcNow + retryAfter.Delta.Value; } else if (retryAfter.Date.HasValue) { delayUntil = retryAfter.Date.Value; } if (delayUntil.HasValue) { // Set the retry timestamp to the UTC version of the timestamp. long newRetryAfter = delayUntil.Value.UtcTicks; // Update the persisted retry after timestamp long replacedRetryAfter; long currentRetryAfter; do { currentRetryAfter = Interlocked.Read(ref this.retryAfter); if (newRetryAfter < currentRetryAfter) { // If the current retry after is already past the new value, then no need to update it again. break; } else { replacedRetryAfter = Interlocked.CompareExchange(ref this.retryAfter, newRetryAfter, currentRetryAfter); } } while (replacedRetryAfter != currentRetryAfter); } } } public void WaitForRetryAfter() { this.WaitForRetryAfterAsync(CancellationToken.None).Await(); } public async Task WaitForRetryAfterAsync(CancellationToken cancelToken) { TimeSpan delay = this.GetDelayTime(); if (delay > TimeSpan.Zero) { Log.WriteProfilingMessage( LOGTAG, "RetryAfterWait", "Waiting for {0} to respect Retry-After header", delay); await Task.Delay(delay).ConfigureAwait(false); } } private TimeSpan GetDelayTime() { // Make sure this is thread safe in case multiple calls are made concurrently to this backend // This is done by reading the value into a local value which is then parsed and operated on locally. long retryAfterTicks = Interlocked.Read(ref this.retryAfter); DateTimeOffset delayUntil = new DateTimeOffset(retryAfterTicks, TimeSpan.Zero); TimeSpan delay; DateTimeOffset now = DateTimeOffset.UtcNow; // Make sure delayUntil is in the future and delay until then if so if (delayUntil >= now) { delay = delayUntil - now; } else { // If the date given was in the past then don't wait at all delay = TimeSpan.Zero; } return delay; } } }