Skip to content

Latest commit

 

History

History
84 lines (64 loc) · 10.3 KB

ReleaseNotes.md

File metadata and controls

84 lines (64 loc) · 10.3 KB
Raw

Spring 2024 (version {0}) aka Twilight Texas release

Codenamed: Twilight Texas Read the Docs: Ocelot 23.3

What's new?

  • Service Discovery: Introducing a new feature for "Customization of services creation" in two primary service discovery providers: Consul and Kubernetes, developed by @raman-m. The customization for both Consul and Kube providers in service creation is achieved through the overriding of virtual methods in default implementations. The recommendation was to separate the provider's logic and introduce public virtual and protected virtual methods in concrete classes, enabling:

    • The use of public virtual methods as dictated by interface definitions.
    • The application of protected virtual methods to allow developers to customize atomic operations through inheritance from existing concrete classes.
    • The injection of new interface objects into the provider's constructor.
    • The overriding of the default behavior of classes.

    Ultimately, customization relies on the virtual methods within the default implementation classes, providing developers the flexibility to override them as necessary for highly tailored Consul/K8s configurations in their specific environments. For further details, refer to the respective pull requests for both providers:

    • Kube → PR #2052
    • Consul → PR #2067

  • Routing: Introducing the new "Routing based on Request Header" feature by @jlukawska. In addition to routing via UpstreamPathTemplate, you can now define an UpstreamHeaderTemplates options dictionary. For a route to match, all headers specified in this section are required to be present in the request headers. For more details, see PR #1312.

  • Configuration: Introducing the "Custom Default Version Policy" feature by @ibnuda. The configurable HttpRequestMessage.VersionPolicy helps avoid HTTP protocol connection errors and stabilizes connections to downstream services, especially when you're not developing those services, documentation is scarce, or the deployed HTTP protocol version is uncertain. For developers of downstream services, it's possible to ConfigureKestrel server and its endpoints with new protocol settings. However, attention to version policy is also required, and this feature provides precise version settings for HTTP connections. Essentially, this feature promotes the use of HTTP protocols beyond 1.0/1.1, such as HTTP/2 or even HTTP/3. For additional details, refer to PR #1673.

  • Configuration: Introducing the new "Route Metadata" feature by @vantm. Undoubtedly, this is the standout feature of the release! ⭐ Route metadata enables Ocelot developers to incorporate custom functions that address specific needs or to create their own plugins/extensions. In versions of Ocelot prior to {0}, the configuration was limited to predefined values that Ocelot used internally. This was sufficient for official extensions, but posed challenges for third-party developers who needed to implement configurations not included in the standard FileConfiguration. Applying an option to a specific route required knowledge of the array index and other details that might not be readily accessible using the standard IConfiguration or IOptions<FileConfiguration> models from ASP.NET. Now, metadata can be directly accessed in the DownstreamRoute object. Furthermore, metadata can also be retrieved from the global JSON section via the FileConfiguration.GlobalConfiguration property. For more information, see the details in PR #1843 on this remarkable feature.

Focus On

Updates of the features: Configuration, Service Discovery, Routing and Quality of Service
Ocelot extra packages

  • Ocelot.Provider.Polly

    • Our team has resolved to eliminate the Polly V7 policies logic and the corresponding Ocelot AddPollyV7 extensions entirely (refer to the "Polly v7 vs v8" documentation). In the previous 23.2 release, named Lunar Eclipse, we included these to maintain the legacy Polly behavior, allowing development teams to transition or retain the old Polly V7 functionality. We are now confident that it is time to progress alongside Polly, shifting our focus to the new Polly V8 resilience pipelines. For more details, see PR #2079.

    • Additionally, we have implemented Polly v8 Circuit Breaker as the primary strategy. Our Quality of Service (QoS) relies on two main strategies: Circuit Breaker and Timeout. If both Circuit Breaker and Timeout are configured with their respective properties in the QoSOptions of the route JSON, then the Circuit Breaker strategy will take precedence in the constructed resilience pipeline. For more details, refer to PR #2086.

Stabilization aka bug fixing
  • Fixed #2034 in PR #2045 by @raman-m
  • Fixed #2039 in PR #2050 by @PaulARoy
  • Fixed #1590 in PR #1592 by @sergio-str
  • Fixed #2054 #2059 in PR #2058 by @thiagoloureiro
  • Fixed #954 #957 #1026 in PR #2067 by @raman-m
  • Fixed #2002 in PR #2003 by @bbenameur
  • Fixed #2085 in PR #2086 by @RaynaldM
  • See all bugs of the Spring'24 milestone
Documentation for version {0}