#585 #2319 Load Balancer global configuration

.github/workflows/develop.yml

@@ -68,15 +68,15 @@ jobs:
   build-cake:
     needs: build
     runs-on: ubuntu-latest
-    environment: build.cake
+    # environment: build.cake
     env:
       # https://github.com/actions/setup-dotnet/blob/main/README.md#environment-variables
       # NUGET_PACKAGES: ${{ github.workspace }}/.nuget/packages
       DOTNET_INSTALL_DIR: "/usr/share/dotnet" # don't override by /usr/lib/dotnet
-      COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
-      GITHUB_SHA: ${{ github.sha }}
-      GITHUB_REF: ${{ github.ref }}
-      GITHUB_REF_NAME: ${{ github.ref_name }}
+      # COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+      # GITHUB_SHA: ${{ github.sha }}
+      # GITHUB_REF: ${{ github.ref }}
+      # GITHUB_REF_NAME: ${{ github.ref_name }}
     steps:
     - name: .NET Info
       run: |
@@ -144,9 +144,12 @@ jobs:
         target: Build
     - name: Prepare Coveralls
       run: |
-        echo "GITHUB_REF is ${{ env.GITHUB_REF }}"
-        echo "GITHUB_REF_NAME is ${{ env.GITHUB_REF_NAME }}"
-        echo "GITHUB_SHA is ${{ env.GITHUB_SHA }}"
+        # echo "GITHUB_REF is ${{ env.GITHUB_REF }}"
+        # echo "GITHUB_REF_NAME is ${{ env.GITHUB_REF_NAME }}"
+        # echo "GITHUB_SHA is ${{ env.GITHUB_SHA }}"
+        echo "Listing environment variables:"
+        env | sort
+        echo ------------ Detect coverage file ------------ 
         coverage_1st_folder=$(ls -d /home/runner/work/Ocelot/Ocelot/artifacts/UnitTests/*/ | head -1)
         echo "Detected first folder : $coverage_1st_folder"
         coverage_file="${coverage_1st_folder%/}/coverage.cobertura.xml"

.github/workflows/pr.yml

@@ -82,12 +82,12 @@ jobs:
   build-cake:
     needs: build
     runs-on: ubuntu-latest
-    environment: build.cake
-    env:
-      COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
-      GITHUB_SHA: ${{ github.sha }}
-      GITHUB_REF: ${{ github.ref }}
-      GITHUB_REF_NAME: ${{ github.ref_name }}
+    # environment: Pull-Request
+    # env:
+    #   COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+    #   GITHUB_SHA: ${{ github.sha }}
+    #   GITHUB_REF: ${{ github.ref }}
+    #   GITHUB_REF_NAME: ${{ github.ref_name }}
     steps:
     - name: .NET Info
       run: |

docs/features/caching.rst

@@ -31,10 +31,17 @@ The second step is to add the following to your `Program`_:
 Configuration
 -------------
 
-Finally, in order to use caching on a route in your route configuration add this setting:
+Finally, in order to use caching on a route in your route configuration add these sections:
 
 .. code-block:: json
 
+    "CacheOptions": {
+      "TtlSeconds": 1, // nullable integer
+      "Region": "",
+      "Header": "",
+      "EnableContentHashing": false // nullable boolean
+    },
+    // Warning! FileCacheOptions section is deprecated! -> use CacheOptions
     "FileCacheOptions": {
       "TtlSeconds": 15,
       "Region": "europe-central",
@@ -48,6 +55,15 @@ Finally, in order to use caching on a route in your route configuration add this
 * If a header name is defined in the ``Header`` property, that header value is looked up by the key (header name) in the ``HttpRequest`` headers, and if the header is found, its value will be included in caching key.
   This causes the cache to become invalid due to the header value changing.
 
+.. _24.1: https://github.com/ThreeMammals/Ocelot/releases/tag/24.1.0
+.. _25.0: https://github.com/ThreeMammals/Ocelot/milestone/12
+.. warning::
+  Static route ``FileCacheOptions`` section is deprecated!
+
+  The `old schema <https://github.com/ThreeMammals/Ocelot/blob/24.0.0/src/Ocelot/Configuration/File/FileRoute.cs#L75>`_ ``FileCacheOptions`` section is deprecated in version `24.1`_!
+  Use ``CacheOptions`` instead of ``FileCacheOptions``! Note that ``FileCacheOptions`` will be removed in version `25.0`_!
+  For backward compatibility in version `24.1`_, the ``FileCacheOptions`` section takes precedence over the ``CacheOptions`` section.
+
 .. _caching-enablecontenthashing-option:
 
 ``EnableContentHashing`` option

docs/features/configuration.rst

@@ -79,7 +79,8 @@ You do not need to set all of these things, but this is everything that is avail
       "DownstreamHttpVersionPolicy": "",
       "DownstreamPathTemplate": "",
       "DownstreamScheme": "",
-      "FileCacheOptions": {}, // object
+      "CacheOptions": {}, // object
+      "FileCacheOptions": {}, // deprecated! -> use CacheOptions
       "HttpHandlerOptions": {}, // object
       "Key": "",
       "LoadBalancerOptions": {}, // object
@@ -103,6 +104,10 @@ You do not need to set all of these things, but this is everything that is avail
 
 The actual route schema with all the properties can be found in the C# `FileRoute`_ class.
 
+  **Note**: The `old schema <https://github.com/ThreeMammals/Ocelot/blob/24.0.0/src/Ocelot/Configuration/File/FileRoute.cs#L75>`__ ``FileCacheOptions`` section is deprecated in version `24.1`_!
+  Use ``CacheOptions`` instead of ``FileCacheOptions``! Note that ``FileCacheOptions`` will be removed in version `25.0`_!
+  For backward compatibility in version `24.1`_, the ``FileCacheOptions`` section takes precedence over the ``CacheOptions`` section.
+
 .. _config-dynamic-route-schema:
 
 Dynamic Route Schema

src/Ocelot.Provider.Kubernetes/KubeServiceCreator.cs

@@ -40,7 +40,7 @@ protected virtual string GetServiceName(KubeRegistryConfiguration configuration,
     protected virtual ServiceHostAndPort GetServiceHostAndPort(KubeRegistryConfiguration configuration, EndpointsV1 endpoint, EndpointSubsetV1 subset, EndpointAddressV1 address)
     {
         var ports = subset.Ports;
-        bool portNameToScheme(EndpointPortV1 p) => string.Equals(p.Name, configuration.Scheme, StringComparison.InvariantCultureIgnoreCase);
+        bool portNameToScheme(EndpointPortV1 p) => string.Equals(p.Name, configuration.Scheme, StringComparison.OrdinalIgnoreCase);
         var portV1 = string.IsNullOrEmpty(configuration.Scheme) || !ports.Any(portNameToScheme)
             ? ports.FirstOrDefault()
             : ports.FirstOrDefault(portNameToScheme);

src/Ocelot.Provider.Polly/PollyQoSResiliencePipelineProvider.cs

@@ -56,7 +56,7 @@ public ResiliencePipeline<HttpResponseMessage> GetResiliencePipeline(DownstreamR
         }
 
         return _registry.GetOrAddPipeline<HttpResponseMessage>(
-            key: new OcelotResiliencePipelineKey(GetRouteName(route)),
+            key: new OcelotResiliencePipelineKey(route.LoadBalancerKey),
             configure: (builder) => ConfigureStrategies(builder, route));
     }
 

src/Ocelot/Configuration/Builder/DownstreamRouteBuilder.cs

@@ -1,4 +1,5 @@
 using Ocelot.Configuration.Creator;
+using Ocelot.Infrastructure.Extensions;
 using Ocelot.Values;
 
 namespace Ocelot.Configuration.Builder;
@@ -9,7 +10,7 @@ public class DownstreamRouteBuilder
     private string _loadBalancerKey;
     private string _downstreamPathTemplate;
     private UpstreamPathTemplate _upstreamTemplatePattern;
-    private List<HttpMethod> _upstreamHttpMethod;
+    private HashSet<HttpMethod> _upstreamHttpMethod;
     private bool _isAuthenticated;
     private List<ClaimToThing> _claimsToHeaders;
     private List<ClaimToThing> _claimToClaims;
@@ -88,11 +89,9 @@ public DownstreamRouteBuilder WithUpstreamPathTemplate(UpstreamPathTemplate inpu
         return this;
     }
 
-    public DownstreamRouteBuilder WithUpstreamHttpMethod(List<string> input)
+    public DownstreamRouteBuilder WithUpstreamHttpMethod(IEnumerable<string> methods)
     {
-        _upstreamHttpMethod = input.Count > 0
-            ? input.Select(x => new HttpMethod(x.Trim())).ToList()
-            : new();
+        _upstreamHttpMethod = methods.ToHttpMethods();
         return this;
     }
 

src/Ocelot/Configuration/Builder/QoSOptionsBuilder.cs

@@ -20,12 +20,6 @@ public QoSOptionsBuilder WithTimeoutValue(int? value)
         return this;
     }
 
-    public QoSOptionsBuilder WithKey(string value)
-    {
-        Key = value;
-        return this;
-    }
-
     public QoSOptionsBuilder WithFailureRatio(double? value)
     {
         FailureRatio = value;

src/Ocelot/Configuration/Creator/AggregatesCreator.cs

@@ -1,5 +1,5 @@
-using Ocelot.Configuration.Builder;
 using Ocelot.Configuration.File;
+using Ocelot.Infrastructure.Extensions;
 
 namespace Ocelot.Configuration.Creator;
 
@@ -39,16 +39,16 @@ private Route SetUpAggregateRoute(IEnumerable<Route> routes, FileAggregateRoute
 
         var upstreamTemplatePattern = _creator.Create(aggregateRoute);
         var upstreamHeaderTemplates = _headerCreator.Create(aggregateRoute);
-        var upstreamHttpMethod = (aggregateRoute.UpstreamHttpMethod.Count == 0) ? new List<HttpMethod>()
-            : aggregateRoute.UpstreamHttpMethod.Select(x => new HttpMethod(x.Trim())).ToList();
-
-        return new Route(
-            applicableRoutes,
-            aggregateRoute.RouteKeysConfig,
-            upstreamHttpMethod,
-            upstreamTemplatePattern,
-            aggregateRoute.UpstreamHost,
-            aggregateRoute.Aggregator,
-            upstreamHeaderTemplates);
+        var upstreamHttpMethod = aggregateRoute.UpstreamHttpMethod.ToHttpMethods();
+        return new Route()
+        {
+            Aggregator = aggregateRoute.Aggregator,
+            DownstreamRoute = applicableRoutes,
+            DownstreamRouteConfig = aggregateRoute.RouteKeysConfig,
+            UpstreamHeaderTemplates = upstreamHeaderTemplates,
+            UpstreamHost = aggregateRoute.UpstreamHost,
+            UpstreamHttpMethod = upstreamHttpMethod,
+            UpstreamTemplatePattern = upstreamTemplatePattern,
+        };
     }
 }

src/Ocelot/Configuration/Creator/CacheOptionsCreator.cs

@@ -1,20 +1,23 @@
 using Ocelot.Configuration.File;
+using Ocelot.Infrastructure.Extensions;
 
 namespace Ocelot.Configuration.Creator;
 
 public class CacheOptionsCreator : ICacheOptionsCreator
 {
-    public CacheOptions Create(FileCacheOptions options, FileGlobalConfiguration global, string upstreamPathTemplate, IList<string> upstreamHttpMethods)
+    public CacheOptions Create(FileCacheOptions options, FileGlobalConfiguration globalConfiguration, string upstreamPathTemplate, IReadOnlyCollection<string> upstreamHttpMethods)
     {
-        var region = GetRegion(options.Region ?? global?.CacheOptions.Region, upstreamPathTemplate, upstreamHttpMethods);
-        var header = options.Header ?? global?.CacheOptions.Header;
-        var ttlSeconds = options.TtlSeconds ?? global?.CacheOptions.TtlSeconds;
-        var enableContentHashing = options.EnableContentHashing ?? global?.CacheOptions.EnableContentHashing;
+        options ??= new();
+        var global = globalConfiguration?.CacheOptions ?? new();
+        var region = GetRegion(options.Region.IfEmpty(global.Region), upstreamPathTemplate, upstreamHttpMethods);
+        var header = options.Header.IfEmpty(global.Header);
+        var ttlSeconds = options.TtlSeconds ?? global.TtlSeconds;
+        var enableHashing = options.EnableContentHashing ?? global.EnableContentHashing;
 
-        return new CacheOptions(ttlSeconds, region, header, enableContentHashing);
+        return new CacheOptions(ttlSeconds, region, header, enableHashing);
     }
 
-    protected virtual string GetRegion(string region, string upstreamPathTemplate, IList<string> upstreamHttpMethod)
+    protected virtual string GetRegion(string region, string upstreamPathTemplate, IReadOnlyCollection<string> upstreamHttpMethod)
     {
         if (!string.IsNullOrEmpty(region))
         {

src/Ocelot/Configuration/Creator/ConfigurationCreator.cs

@@ -13,6 +13,8 @@ public class ConfigurationCreator : IConfigurationCreator
     private readonly ILoadBalancerOptionsCreator _loadBalancerOptionsCreator;
     private readonly IVersionCreator _versionCreator;
     private readonly IVersionPolicyCreator _versionPolicyCreator;
+    private readonly IMetadataCreator _metadataCreator;
+    private readonly IRateLimitOptionsCreator _rateLimitOptionsCreator;
 
     public ConfigurationCreator(
         IServiceProviderConfigurationCreator serviceProviderConfigCreator,
@@ -21,44 +23,46 @@ public ConfigurationCreator(
         IServiceProvider serviceProvider,
         ILoadBalancerOptionsCreator loadBalancerOptionsCreator,
         IVersionCreator versionCreator,
-        IVersionPolicyCreator versionPolicyCreator
-        )
+        IVersionPolicyCreator versionPolicyCreator,
+        IMetadataCreator metadataCreator,
+        IRateLimitOptionsCreator rateLimitOptionsCreator)
     {
         _adminPath = serviceProvider.GetService<IAdministrationPath>();
         _loadBalancerOptionsCreator = loadBalancerOptionsCreator;
         _serviceProviderConfigCreator = serviceProviderConfigCreator;
         _qosOptionsCreator = qosOptionsCreator;
         _httpHandlerOptionsCreator = httpHandlerOptionsCreator;
         _versionCreator = versionCreator;
-        _versionPolicyCreator = versionPolicyCreator;
+        _versionPolicyCreator = versionPolicyCreator;
+        _metadataCreator = metadataCreator;
+        _rateLimitOptionsCreator = rateLimitOptionsCreator;
     }
 
-    public InternalConfiguration Create(FileConfiguration fileConfiguration, List<Route> routes)
+    public InternalConfiguration Create(FileConfiguration configuration, List<Route> routes)
     {
-        var serviceProviderConfiguration = _serviceProviderConfigCreator.Create(fileConfiguration.GlobalConfiguration);
-
-        var lbOptions = _loadBalancerOptionsCreator.Create(fileConfiguration.GlobalConfiguration.LoadBalancerOptions);
-
-        var qosOptions = _qosOptionsCreator.Create(fileConfiguration.GlobalConfiguration.QoSOptions);
-
-        var httpHandlerOptions = _httpHandlerOptionsCreator.Create(fileConfiguration.GlobalConfiguration.HttpHandlerOptions);
-
         var adminPath = _adminPath?.Path;
-
-        var version = _versionCreator.Create(fileConfiguration.GlobalConfiguration.DownstreamHttpVersion);
-
-        var versionPolicy = _versionPolicyCreator.Create(fileConfiguration.GlobalConfiguration.DownstreamHttpVersionPolicy);
+        var globalConfiguration = configuration.GlobalConfiguration ?? new();
+        var serviceProviderConfiguration = _serviceProviderConfigCreator.Create(globalConfiguration);
+        var lbOptions = _loadBalancerOptionsCreator.Create(globalConfiguration.LoadBalancerOptions);
+        var qosOptions = _qosOptionsCreator.Create(globalConfiguration.QoSOptions);
+        var httpHandlerOptions = _httpHandlerOptionsCreator.Create(globalConfiguration.HttpHandlerOptions);
+        var version = _versionCreator.Create(globalConfiguration.DownstreamHttpVersion);
+        var versionPolicy = _versionPolicyCreator.Create(globalConfiguration.DownstreamHttpVersionPolicy);
+        var metadataOptions = _metadataCreator.Create(null, globalConfiguration);
+        var rateLimitOptions = _rateLimitOptionsCreator.Create(globalConfiguration);
 
         return new InternalConfiguration(routes,
             adminPath,
             serviceProviderConfiguration,
-            fileConfiguration.GlobalConfiguration.RequestIdKey,
+            globalConfiguration.RequestIdKey,
             lbOptions,
-            fileConfiguration.GlobalConfiguration.DownstreamScheme,
+            globalConfiguration.DownstreamScheme,
             qosOptions,
             httpHandlerOptions,
             version,
-            versionPolicy
-            );
+            versionPolicy,
+            metadataOptions,
+            rateLimitOptions,
+            globalConfiguration.Timeout);
     }
 }