#585 #2330 Caching global configuration

[raman-m]

Closes #2330

• Dynamic routing global configuration #585
• #585 Caching global configuration #2330

Proposed Changes

• Reviewed CacheManager and shared my concerns in the comment. In my opinion, this project should be deprecated since Ocelot already has a built-in DefaultMemoryCache<T> that performs the same function as the legacy CacheManager. We should strictly use Microsoft's IMemoryCache and IDistributedCache interfaces moving forward →
  1. Cache in-memory in ASP.NET Core
  2. Distributed caching in ASP.NET Core
• Streamlined the DefaultCacheKeyGenerator by reducing code and tidying up the workflow.
• Reviewed DefaultMemoryCache
• Checked the OutputCacheMiddleware, but it looks like the Logger.LogDebug() calls were still not removed, @RaynaldM 😄
• Created a new version of CacheOptionsCreator with the added global options feature. ⚠️ This is the feat ❗
• Added support for creating CacheOptions in DynamicRoutesCreator. ⚠️ This is the feat ❗
• Removed the IsCached property from DownstreamRoute and introduced a simple UseCache helper in CacheOptions. This refactoring eliminated a significant amount of unnecessary code.
• A few File-models were added and updated, including FileGlobalCacheOptions, FileGlobalConfiguration, FileGlobalDynamicRouting, and FileRoute. However, FileDynamicRoute was left unchanged in favor of updating FileGlobalDynamicRouting.
• The CacheOptions property has been added to InternalConfiguration and its interface.
• The DiscoveryDownstreamRouteFinder passes CacheOptions into the context of DownstreamRoute business model. ⚠️ This is the feat ❗
• Added acceptance tests to DynamicRoutingTests
• Unit testing has been completed in the following classes: CacheOptionsCreatorTests, CachedResponseTests, FileCacheOptionsTests, FileGlobalCacheOptionsTests and OutputCacheMiddlewareTests. And, OcelotCacheManagerCacheTests were updated, but we are going to deprecate the project.
• Targeted full coverage in the Ocelot/Cache namespace, boosting total coverage by +0.3%. Take a look at the latest Coveralls build or Coveralls message for more details.
• Updated documentation for the Caching feature. Check it out rst vs html after merging.

[coveralls]

coverage: 91.759% (+0.3%) from 91.479%
when pulling 3cd09ae on feat-2330
into f758ba7 on develop.

[raman-m]

This feels outdated despite the recent 2.0.0 release on March 6, 2025, which added support for the net8.0 TFM in the CacheManager.Core package. These pack dependencies were upgraded in release 24.0. Active development stopped back in 2018, seven years ago, and since then, only a single upgrade release was made on March 6 to accommodate .NET 8.

This library definitely needs a review of its capabilities. Considering a complete switch to Microsoft Cache libraries makes sense since the CacheManager GH-project is abandoned. Ocelot ranks first in the "Top Used By" list for CacheManager.Core and CacheManager.Microsoft.Extensions.Configuration, highlighting the lack of popularity and abandonment of the library.
Finally, it's better to rely on native Microsoft caching libraries and evolving ASP.NET Core approaches.

[raman-m]

The roadmap definitely needs a rewrite and update. A lot has happened in the ASP.NET industry over the last five years, making it a subject worth reviewing. However, it's not a pressing issue at the moment. Rewriting it would make more sense after the release of 24.1, during the development of version 25.0.

[ggnaegi]

@raman-m i will review this tomorrow or saturday.

From: Raman

Reviewing tomorrow works fine and fits the timeline. The PR will be more refined and solid by then.

[raman-m]

Development Complete ✅

[raman-m]

Ready for delivery ✅

• Code reviews ✔️ ✔️
• Unit testing ✔️
• Acceptance testing ✔️
• Updated documentation ✔️ ✔️

[raman-m]

TODO tasks

• Phase out the Ocelot.Cache.CacheManager project along with its associated Ocelot extension package. Reason: here
• look at the output caching story as MS have some stuff Ocelot could just use #1196