#1314 #1869 #2072 Default timeout enhancements

src/Ocelot.Provider.Polly/PollyQoSResiliencePipelineProvider.cs

@@ -1,4 +1,6 @@
+using Microsoft.Extensions.Options;
 using Ocelot.Configuration;
+using Ocelot.Configuration.File;
 using Ocelot.Logging;
 using Ocelot.Provider.Polly.Interfaces;
 using Polly.CircuitBreaker;
@@ -15,13 +17,16 @@ public class PollyQoSResiliencePipelineProvider : IPollyQoSResiliencePipelinePro
 {
     private readonly ResiliencePipelineRegistry<OcelotResiliencePipelineKey> _registry;
     private readonly IOcelotLogger _logger;
-
+    private readonly FileGlobalConfiguration _global;
+
     public PollyQoSResiliencePipelineProvider(
         IOcelotLoggerFactory loggerFactory,
-        ResiliencePipelineRegistry<OcelotResiliencePipelineKey> registry)
+        ResiliencePipelineRegistry<OcelotResiliencePipelineKey> registry,
+        IOptions<FileGlobalConfiguration> global)
     {
         _logger = loggerFactory.CreateLogger<PollyQoSResiliencePipelineProvider>();
         _registry = registry;
+        _global = global.Value;
     }
 
     protected static readonly HashSet<HttpStatusCode> DefaultServerErrorCodes = new()
@@ -74,14 +79,21 @@ protected virtual ResiliencePipelineBuilder<HttpResponseMessage> ConfigureCircui
 
         var options = route.QosOptions;
         var info = $"Circuit Breaker for the route: {GetRouteName(route)}: ";
+
+        // Polly constraints
+        int minimumThroughput = options.ExceptionsAllowedBeforeBreaking >= QoSOptions.LowMinimumThroughput
+            ? options.ExceptionsAllowedBeforeBreaking
+            : QoSOptions.DefaultMinimumThroughput;
+        int breakDurationMs = options.DurationOfBreak > QoSOptions.LowBreakDuration
+            ? options.DurationOfBreak
+            : QoSOptions.DefaultBreakDuration;
+
         var strategyOptions = new CircuitBreakerStrategyOptions<HttpResponseMessage>
         {
             FailureRatio = 0.8,
             SamplingDuration = TimeSpan.FromSeconds(10),
-            MinimumThroughput = options.ExceptionsAllowedBeforeBreaking,
-            BreakDuration = options.DurationOfBreak > QoSOptions.LowBreakDuration
-                ? TimeSpan.FromMilliseconds(options.DurationOfBreak)
-                : TimeSpan.FromMilliseconds(QoSOptions.DefaultBreakDuration),
+            MinimumThroughput = minimumThroughput,
+            BreakDuration = TimeSpan.FromMilliseconds(breakDurationMs),
             ShouldHandle = new PredicateBuilder<HttpResponseMessage>()
                 .HandleResult(message => ServerErrorCodes.Contains(message.StatusCode))
                 .Handle<TimeoutRejectedException>()
@@ -108,18 +120,24 @@ protected virtual ResiliencePipelineBuilder<HttpResponseMessage> ConfigureCircui
 
     protected virtual ResiliencePipelineBuilder<HttpResponseMessage> ConfigureTimeout(ResiliencePipelineBuilder<HttpResponseMessage> builder, DownstreamRoute route)
     {
-        var options = route.QosOptions;
+        int? timeoutMs = route?.QosOptions?.TimeoutValue
+            ?? _global?.QoSOptions?.TimeoutValue
+            ?? QoSOptions.DefaultTimeout;
 
-        // Add Timeout strategy if TimeoutValue is not int.MaxValue and greater than 0
-        // TimeoutValue must be defined in QosOptions!
-        if (options.TimeoutValue == int.MaxValue || options.TimeoutValue <= 0)
+        // 0 means No option!
+        if (!timeoutMs.HasValue || timeoutMs.Value <= 0)
         {
             return builder;
         }
 
+        // Polly constraints
+        timeoutMs = timeoutMs.Value > QoSOptions.LowTimeout && timeoutMs.Value < QoSOptions.HighTimeout
+            ? timeoutMs.Value
+            : QoSOptions.DefaultTimeout;
+
         var strategyOptions = new TimeoutStrategyOptions
         {
-            Timeout = TimeSpan.FromMilliseconds(options.TimeoutValue),
+            Timeout = TimeSpan.FromMilliseconds(timeoutMs.Value),
             OnTimeout = _ =>
             {
                 _logger.LogInformation(() => $"Timeout for the route: {GetRouteName(route)}");

src/Ocelot/Configuration/Builder/DownstreamRouteBuilder.cs

@@ -43,6 +43,7 @@ public class DownstreamRouteBuilder
     private HttpVersionPolicy _downstreamHttpVersionPolicy;
     private Dictionary<string, UpstreamHeaderTemplate> _upstreamHeaders;
     private MetadataOptions _metadataOptions;
+    private int? _timeout;
 
     public DownstreamRouteBuilder()
     {
@@ -282,6 +283,12 @@ public DownstreamRouteBuilder WithMetadata(MetadataOptions metadataOptions)
         return this;
     }
 
+    public DownstreamRouteBuilder WithTimeout(int? timeout)
+    {
+        _timeout = timeout;
+        return this;
+    }
+
     public DownstreamRoute Build()
     {
         return new DownstreamRoute(
@@ -321,6 +328,7 @@ public DownstreamRoute Build()
             _downstreamHttpVersion,
             _downstreamHttpVersionPolicy,
             _upstreamHeaders,
-            _metadataOptions);
+            _metadataOptions,
+            _timeout);
     }
 }

src/Ocelot/Configuration/Builder/QoSOptionsBuilder.cs

@@ -6,7 +6,7 @@ public class QoSOptionsBuilder
 
         private int _durationOfBreak;
 
-        private int _timeoutValue;
+        private int? _timeoutValue;
 
         private string _key;
 
@@ -22,7 +22,7 @@ public QoSOptionsBuilder WithDurationOfBreak(int durationOfBreak)
             return this;
         }
 
-        public QoSOptionsBuilder WithTimeoutValue(int timeoutValue)
+        public QoSOptionsBuilder WithTimeoutValue(int? timeoutValue)
         {
             _timeoutValue = timeoutValue;
             return this;

src/Ocelot/Configuration/Creator/DynamicsCreator.cs

@@ -29,22 +29,26 @@ public List<Route> Create(FileConfiguration fileConfiguration)
                 .ToList();
         }
 
-        private Route SetUpDynamicRoute(FileDynamicRoute fileDynamicRoute, FileGlobalConfiguration globalConfiguration)
+        public int CreateTimeout(FileDynamicRoute route, FileGlobalConfiguration global)
+            => route.Timeout ?? global.Timeout ?? DownstreamRoute.DefaultTimeoutSeconds;
+
+        private Route SetUpDynamicRoute(FileDynamicRoute dynamicRoute, FileGlobalConfiguration globalConfiguration)
         {
             var rateLimitOption = _rateLimitOptionsCreator
-                .Create(fileDynamicRoute.RateLimitRule, globalConfiguration);
+                .Create(dynamicRoute.RateLimitRule, globalConfiguration);
 
-            var version = _versionCreator.Create(fileDynamicRoute.DownstreamHttpVersion);
-            var versionPolicy = _versionPolicyCreator.Create(fileDynamicRoute.DownstreamHttpVersionPolicy);
-            var metadata = _metadataCreator.Create(fileDynamicRoute.Metadata, globalConfiguration);
+            var version = _versionCreator.Create(dynamicRoute.DownstreamHttpVersion);
+            var versionPolicy = _versionPolicyCreator.Create(dynamicRoute.DownstreamHttpVersionPolicy);
+            var metadata = _metadataCreator.Create(dynamicRoute.Metadata, globalConfiguration);
 
             var downstreamRoute = new DownstreamRouteBuilder()
                 .WithEnableRateLimiting(rateLimitOption.EnableRateLimiting)
                 .WithRateLimitOptions(rateLimitOption)
-                .WithServiceName(fileDynamicRoute.ServiceName)
+                .WithServiceName(dynamicRoute.ServiceName)
                 .WithDownstreamHttpVersion(version)
                 .WithDownstreamHttpVersionPolicy(versionPolicy)
-                .WithMetadata(metadata)
+                .WithMetadata(metadata)
+                .WithTimeout(CreateTimeout(dynamicRoute, globalConfiguration))
                 .Build();
 
             var route = new RouteBuilder()

src/Ocelot/Configuration/Creator/IDynamicsCreator.cs

@@ -5,5 +5,13 @@ namespace Ocelot.Configuration.Creator
     public interface IDynamicsCreator
     {
         List<Route> Create(FileConfiguration fileConfiguration);
+
+        /// <summary>
+        /// Creates a timeout value for a given file route based on the global configuration.
+        /// </summary>
+        /// <param name="route">The file route for which to create the timeout.</param>
+        /// <param name="global">The global configuration to use for creating the timeout.</param>
+        /// <returns>The timeout value in seconds.</returns>
+        int CreateTimeout(FileDynamicRoute route, FileGlobalConfiguration global);
     }
 }

src/Ocelot/Configuration/Creator/IRoutesCreator.cs

@@ -5,4 +5,12 @@ namespace Ocelot.Configuration.Creator;
 public interface IRoutesCreator
 {
     List<Route> Create(FileConfiguration fileConfiguration);
+
+    /// <summary>
+    /// Creates a timeout value for a given file route based on the global configuration.
+    /// </summary>
+    /// <param name="route">The file route for which to create the timeout.</param>
+    /// <param name="global">The global configuration to use for creating the timeout.</param>
+    /// <returns>The timeout value in seconds.</returns>
+    int CreateTimeout(FileRoute route, FileGlobalConfiguration global);
 }

src/Ocelot/Configuration/Creator/QoSOptionsCreator.cs

@@ -28,7 +28,7 @@ public QoSOptions Create(QoSOptions options, string pathTemplate, List<string> h
             return Map(key, options.TimeoutValue, options.DurationOfBreak, options.ExceptionsAllowedBeforeBreaking);
         }
 
-        private static QoSOptions Map(string key, int timeoutValue, int durationOfBreak, int exceptionsAllowedBeforeBreaking)
+        private static QoSOptions Map(string key, int? timeoutValue, int durationOfBreak, int exceptionsAllowedBeforeBreaking)
         {
             return new QoSOptionsBuilder()
                 .WithExceptionsAllowedBeforeBreaking(exceptionsAllowedBeforeBreaking)

src/Ocelot/Configuration/Creator/RoutesCreator.cs

@@ -67,15 +67,16 @@ public RoutesCreator(
 
         public List<Route> Create(FileConfiguration fileConfiguration)
         {
+            Route CreateRoute(FileRoute route)
+                => SetUpRoute(route, SetUpDownstreamRoute(route, fileConfiguration.GlobalConfiguration));
             return fileConfiguration.Routes
-                .Select(route =>
-                {
-                    var downstreamRoute = SetUpDownstreamRoute(route, fileConfiguration.GlobalConfiguration);
-                    return SetUpRoute(route, downstreamRoute);
-                })
+                .Select(CreateRoute)
                 .ToList();
         }
 
+        public int CreateTimeout(FileRoute route, FileGlobalConfiguration global)
+            => route.Timeout ?? global.Timeout ?? DownstreamRoute.DefaultTimeoutSeconds;
+
         private DownstreamRoute SetUpDownstreamRoute(FileRoute fileRoute, FileGlobalConfiguration globalConfiguration)
         {
             var fileRouteOptions = _fileRouteOptionsCreator.Create(fileRoute);
@@ -156,8 +157,8 @@ private DownstreamRoute SetUpDownstreamRoute(FileRoute fileRoute, FileGlobalConf
                 .WithDownstreamHttpVersionPolicy(downstreamHttpVersionPolicy)
                 .WithDownStreamHttpMethod(fileRoute.DownstreamHttpMethod)
                 .WithMetadata(metadata)
+                .WithTimeout(CreateTimeout(fileRoute, globalConfiguration))
                 .Build();
-
             return route;
         }
 
@@ -173,7 +174,6 @@ private Route SetUpRoute(FileRoute fileRoute, DownstreamRoute downstreamRoutes)
                 .WithUpstreamHost(fileRoute.UpstreamHost)
                 .WithUpstreamHeaders(upstreamHeaderTemplates)
                 .Build();
-
             return route;
         }
     }

src/Ocelot/Configuration/DownstreamRoute.cs

@@ -42,7 +42,8 @@ public DownstreamRoute(
             Version downstreamHttpVersion,
             HttpVersionPolicy downstreamHttpVersionPolicy,
             Dictionary<string, UpstreamHeaderTemplate> upstreamHeaders,
-            MetadataOptions metadataOptions)
+            MetadataOptions metadataOptions,
+            int? timeout)
         {
             DangerousAcceptAnyServerCertificateValidator = dangerousAcceptAnyServerCertificateValidator;
             AddHeadersToDownstream = addHeadersToDownstream;
@@ -81,6 +82,7 @@ public DownstreamRoute(
             DownstreamHttpVersionPolicy = downstreamHttpVersionPolicy;
             UpstreamHeaders = upstreamHeaders ?? new();
             MetadataOptions = metadataOptions;
+            Timeout = timeout;
         }
 
         public string Key { get; }
@@ -137,5 +139,22 @@ public DownstreamRoute(
         public string Name() => string.IsNullOrEmpty(ServiceName) && !UseServiceDiscovery
             ? UpstreamPathTemplate?.Template ?? DownstreamPathTemplate?.Value ?? "?"
             : string.Join(':', ServiceNamespace, ServiceName, UpstreamPathTemplate?.Template);
+
+        /// <summary>The timeout duration for the downstream request in seconds.</summary>
+        /// <value>A <see cref="Nullable{T}"/> (T is <see cref="int"/>) value, in seconds.</value>
+        public int? Timeout { get; }
+
+        /// <summary>Defines the default timeout in seconds for all routes, applicable at both the Route-level and globally.</summary>
+        /// <remarks>By default, initialized to 90 seconds.</remarks>
+        /// <value>An <see cref="int"/> value.</value>
+        public static int DefaultTimeoutSeconds { get; set; } = 90;
+
+        /// <summary>
+        /// Calculates timeout in milliseconds based on QoS options with applying default timeout values.
+        /// </summary>
+        /// <returns>An <see cref="int"/> value, in milliseconds.</returns>
+        public int TimeoutMilliseconds() => QosOptions.UseQos
+            ? QosOptions.TimeoutValue ?? QoSOptions.DefaultTimeout
+            : 1000 * (Timeout ?? DefaultTimeoutSeconds);
     }
 }

src/Ocelot/Configuration/File/FileDynamicRoute.cs

@@ -2,6 +2,9 @@
 
 namespace Ocelot.Configuration.File
 {
+    /// <summary>
+    /// TODO: Make it as a base Route File-model.
+    /// </summary>
     public class FileDynamicRoute
     {
         public string ServiceName { get; set; }
@@ -20,5 +23,9 @@ public class FileDynamicRoute
         /// </remarks>
         public string DownstreamHttpVersionPolicy { get; set; }
         public IDictionary<string, string> Metadata { get; set; }
+
+        /// <summary>The timeout in seconds for requests.</summary>
+        /// <value>A <see cref="Nullable{T}"/> where T is <see cref="int"/> value in seconds.</value>
+        public int? Timeout { get; set; }
     }
 }

src/Ocelot/Configuration/File/FileGlobalConfiguration.cs

@@ -17,6 +17,10 @@ public FileGlobalConfiguration()
 
         public string RequestIdKey { get; set; }
 
+        /// <summary>The timeout in seconds for requests.</summary>
+        /// <value>A <see cref="Nullable{T}"/> (T is <see cref="int"/>) value in seconds.</value>
+        public int? Timeout { get; set; }
+
         public FileServiceDiscoveryProvider ServiceDiscoveryProvider { get; set; }
 
         public FileRateLimitOptions RateLimitOptions { get; set; }

src/Ocelot/Configuration/File/FileQoSOptions.cs

@@ -13,7 +13,7 @@ public FileQoSOptions()
         {
             DurationOfBreak = 1;
             ExceptionsAllowedBeforeBreaking = 0;
-            TimeoutValue = 0;
+            TimeoutValue = null; // default value will be assigned in consumer services: see DownstreamRoute.
         }
 
         public FileQoSOptions(FileQoSOptions from)
@@ -32,6 +32,17 @@ public FileQoSOptions(QoSOptions from)
 
         public int DurationOfBreak { get; set; }
         public int ExceptionsAllowedBeforeBreaking { get; set; }
-        public int TimeoutValue { get; set; }
+
+        /// <summary>Explicit timeout value which overrides default one.</summary>
+        /// <remarks>Reused in, or ignored in favor of implicit default value:
+        /// <list type="bullet">
+        ///   <item><see cref="QoSOptions.TimeoutValue"/></item>
+        ///   <item><see cref="DownstreamRoute.Timeout"/></item>
+        ///   <item><see cref="DownstreamRoute.TimeoutMilliseconds"/></item>
+        ///   <item><see cref="DownstreamRoute.DefaultTimeoutSeconds"/></item>
+        /// </list>
+        /// </remarks>
+        /// <value>A <see cref="Nullable{T}"/> (T is <see cref="int"/>) value in milliseconds.</value>
+        public int? TimeoutValue { get; set; }
     }
 }

src/Ocelot/Configuration/File/FileRoute.cs

@@ -2,7 +2,7 @@
 
 namespace Ocelot.Configuration.File
 {
-    public class FileRoute : IRoute, ICloneable
+    public class FileRoute : IRoute, ICloneable // TODO: Inherit from FileDynamicRoute (FileRouteBase) or an interface with FileDynamicRoute props
     {
         public FileRoute()
         {
@@ -72,8 +72,19 @@ public FileRoute(FileRoute from)
         public FileSecurityOptions SecurityOptions { get; set; }
         public string ServiceName { get; set; }
         public string ServiceNamespace { get; set; }
-        public int Timeout { get; set; }
-        public Dictionary<string, string> UpstreamHeaderTransform { get; set; }
+
+        /// <summary>Explicit timeout value which overrides default one.</summary>
+        /// <remarks>Reused in, or ignored in favor of implicit default value:
+        /// <list type="bullet">
+        ///   <item><see cref="DownstreamRoute.Timeout"/></item>
+        ///   <item><see cref="DownstreamRoute.TimeoutMilliseconds"/></item>
+        ///   <item><see cref="DownstreamRoute.DefaultTimeoutSeconds"/></item>
+        /// </list>
+        /// </remarks>
+        /// <value>A <see cref="Nullable{T}"/> (T is <see cref="int"/>) value, in seconds.</value>
+        public int? Timeout { get; set; }
+
+        public IDictionary<string, string> UpstreamHeaderTransform { get; set; }
         public string UpstreamHost { get; set; }
         public List<string> UpstreamHttpMethod { get; set; }
         public string UpstreamPathTemplate { get; set; }
@@ -122,7 +133,7 @@ public static void DeepCopy(FileRoute from, FileRoute to)
             to.ServiceNamespace = from.ServiceNamespace;
             to.Timeout = from.Timeout;
             to.UpstreamHeaderTemplates = new Dictionary<string, string>(from.UpstreamHeaderTemplates);
-            to.UpstreamHeaderTransform = new(from.UpstreamHeaderTransform);
+            to.UpstreamHeaderTransform = new Dictionary<string, string>(from.UpstreamHeaderTransform);
             to.UpstreamHost = from.UpstreamHost;
             to.UpstreamHttpMethod = new(from.UpstreamHttpMethod);
             to.UpstreamPathTemplate = from.UpstreamPathTemplate;