#585 #2338 Quality of Service global configuration

[raman-m]

Closes #2338

• Dynamic routing global configuration #585
• #585 Quality of Service global configuration #2338

Ocelot now fully supports global QoS options for both static and dynamic routing, with the ability to override options at the route level when needed. In the past, only route-level QoS options were available for static routing, while global QoS was limited to dynamic routing. The current challenge is to unify everything into a single QoSOptions model as part of the DownstreamRoute business object.

Proposed Changes

• The Ocelot.Provider.Polly project code has been updated to reflect changes in the QoSOptions business model schema. Notably, this breaking change requires users to recompile their solutions when upgrading to the current version, if a custom PollyQoSResiliencePipelineProvider was developed.
• Removed QoSOptionsBuilder from the codebase to eliminate unnecessary clutter, opting instead for native QoSOptions constructors to fully leverage Object initializers during construction. As the result, the new micro-constructors cover 90% of user cases. This nice C# feat, Object initializers were added in C# 3.0 with the .NET Framework 3.5 SDK in 2007! There's no need to build objects using the outdated Builder anti-pattern.
• ❗Feature: QoSOptionsCreator 👈
• Both FileRoute and FileDynamicRoute inherit from FileRouteBase abstract class
• The FileGlobalConfiguration doesn't inherit from anything, allowing the flexibility to add more complex models as properties. Finally, the new qualifier was removed, which previously hid base properties from the old inherited FileGlobalDynamicRouting class, to address issues with polymorphic JSON (de)serialization of the FileGlobalConfiguration properties which types inherit the IRouteGroup interface, so called FileGlobal* classes.
• ❗Feature: FileGlobalQoSOptions
• ❗Feature: The deprecated FileQoSOptions properties include DurationOfBreak (now BreakDuration), ExceptionsAllowedBeforeBreaking (now MinimumThroughput), and TimeoutValue (now Timeout). The original names were suggested by a Chinese developer in PR Circuit breaker pattern #27. So, now the QoS models align with the Polly schema.
• The QoSOptions business model now aligns with the Polly schema. Note: this IBC requires users to recompile their solutions when upgrading to the current version.
• Created a new QualityOfService folder to house the QoS feature in its own dedicated code area. Previously, the QoS functionality was scattered across various folders within the main project.
• Unit testing. Created a new QualityOfService folder to organize all QoS feature unit tests under a single Ocelot.UnitTests.QualityOfService namespace.
• Unit testing. The main unit tests covering the feature code are written in the QoSOptionsCreatorTests class, while the remaining unit tests are located in the QualityOfService namespace.
• Acceptance testing. PollyQoSTests and DynamicRoutingTests which writing was a real challenge.
• Documentation. Added commit 69944b8 → qualityofservice.rst → html docs in develop → Quality of Service

[coveralls]

coverage: 93.442% (+0.05%) from 93.391%
when pulling 69944b8 on feature/2338-qos-opts
into 4730613 on develop.

[raman-m]

@RaynaldM Are you interested in quality of this PR? This is Polly provider which is used by your dev team.

[ggnaegi]

I'm going to have a look at this tomorrow, cheers!

[raman-m]

Development Complete ✅

@ggnaegi commented on December 3

You might be late, as I am currently writing the docs and the status is "Dev Complete".
Once I push a commit with the updated docs, I'll proceed to merge.

[raman-m]

Ready for delivery ✅

• Code review ✔️
• Unit testing ✔️
• Acceptance testing ✔️ ✔️
• Updated docs ✔️ ✔️ → html docs in develop → Quality of Service