Allow overriding the default cache policy, Close #286

VahidN · VahidN · commit 7ab3736af3df · 2025-02-24T14:52:50.000+03:30
diff --git a/README.md b/README.md
diff --git a/src/EFCoreSecondLevelCacheInterceptor.CacheManager.Core/EFCoreSecondLevelCacheInterceptor.CacheManager.Core.csproj b/src/EFCoreSecondLevelCacheInterceptor.CacheManager.Core/EFCoreSecondLevelCacheInterceptor.CacheManager.Core.csproj
@@ -1,7 +1,7 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
     <PropertyGroup>
         <Description>Entity Framework Core Second Level Caching Library.</Description>
-        <VersionPrefix>5.1.1</VersionPrefix>
+        <VersionPrefix>5.2.0</VersionPrefix>
         <Authors>Vahid Nasiri</Authors>
         <TargetFrameworks>net9.0;net8.0;net7.0;net6.0;net5.0;netstandard2.1;netstandard2.0;net462;netcoreapp3.1;</TargetFrameworks>
         <GenerateDocumentationFile>true</GenerateDocumentationFile>
diff --git a/src/EFCoreSecondLevelCacheInterceptor.EasyCaching.Core/EFCoreSecondLevelCacheInterceptor.EasyCaching.Core.csproj b/src/EFCoreSecondLevelCacheInterceptor.EasyCaching.Core/EFCoreSecondLevelCacheInterceptor.EasyCaching.Core.csproj
@@ -1,7 +1,7 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
     <PropertyGroup>
         <Description>Entity Framework Core Second Level Caching Library.</Description>
-        <VersionPrefix>5.1.1</VersionPrefix>
+        <VersionPrefix>5.2.0</VersionPrefix>
         <Authors>Vahid Nasiri</Authors>
         <TargetFrameworks>net9.0;net8.0;net7.0;net6.0;net5.0;netstandard2.1;netstandard2.0;net462;netcoreapp3.1;</TargetFrameworks>
         <GenerateDocumentationFile>true</GenerateDocumentationFile>
diff --git a/src/EFCoreSecondLevelCacheInterceptor.FusionCache/EFCoreSecondLevelCacheInterceptor.FusionCache.csproj b/src/EFCoreSecondLevelCacheInterceptor.FusionCache/EFCoreSecondLevelCacheInterceptor.FusionCache.csproj
@@ -1,7 +1,7 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
     <PropertyGroup>
         <Description>Entity Framework Core Second Level Caching Library.</Description>
-        <VersionPrefix>5.1.1</VersionPrefix>
+        <VersionPrefix>5.2.0</VersionPrefix>
         <Authors>Vahid Nasiri</Authors>
         <TargetFrameworks>net9.0;net8.0;</TargetFrameworks>
         <GenerateDocumentationFile>true</GenerateDocumentationFile>
diff --git a/src/EFCoreSecondLevelCacheInterceptor.HybridCache/EFCoreSecondLevelCacheInterceptor.HybridCache.csproj b/src/EFCoreSecondLevelCacheInterceptor.HybridCache/EFCoreSecondLevelCacheInterceptor.HybridCache.csproj
@@ -1,7 +1,7 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
     <PropertyGroup>
         <Description>Entity Framework Core Second Level Caching Library.</Description>
-        <VersionPrefix>5.1.1</VersionPrefix>
+        <VersionPrefix>5.2.0</VersionPrefix>
         <Authors>Vahid Nasiri</Authors>
         <TargetFrameworks>net9.0;net8.0;</TargetFrameworks>
         <GenerateDocumentationFile>true</GenerateDocumentationFile>
diff --git a/src/EFCoreSecondLevelCacheInterceptor.MemoryCache/EFCoreSecondLevelCacheInterceptor.MemoryCache.csproj b/src/EFCoreSecondLevelCacheInterceptor.MemoryCache/EFCoreSecondLevelCacheInterceptor.MemoryCache.csproj
@@ -1,7 +1,7 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
     <PropertyGroup>
         <Description>Entity Framework Core Second Level Caching Library.</Description>
-        <VersionPrefix>5.1.1</VersionPrefix>
+        <VersionPrefix>5.2.0</VersionPrefix>
         <Authors>Vahid Nasiri</Authors>
         <TargetFrameworks>net9.0;net8.0;net7.0;net6.0;net5.0;netstandard2.1;netstandard2.0;net462;netcoreapp3.1;</TargetFrameworks>
         <GenerateDocumentationFile>true</GenerateDocumentationFile>
diff --git a/src/EFCoreSecondLevelCacheInterceptor.StackExchange.Redis/EFCoreSecondLevelCacheInterceptor.StackExchange.Redis.csproj b/src/EFCoreSecondLevelCacheInterceptor.StackExchange.Redis/EFCoreSecondLevelCacheInterceptor.StackExchange.Redis.csproj
@@ -1,7 +1,7 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
     <PropertyGroup>
         <Description>Entity Framework Core Second Level Caching Library.</Description>
-        <VersionPrefix>5.1.1</VersionPrefix>
+        <VersionPrefix>5.2.0</VersionPrefix>
         <Authors>Vahid Nasiri</Authors>
         <TargetFrameworks>net9.0;net8.0;net7.0;net6.0;net5.0;netstandard2.1;netstandard2.0;net462;netcoreapp3.1;</TargetFrameworks>
         <GenerateDocumentationFile>true</GenerateDocumentationFile>
diff --git a/src/EFCoreSecondLevelCacheInterceptor/EFCachePolicyContext.cs b/src/EFCoreSecondLevelCacheInterceptor/EFCachePolicyContext.cs
@@ -0,0 +1,36 @@
+using System;
+using System.Collections.Generic;
+
+namespace EFCoreSecondLevelCacheInterceptor;
+
+/// <summary>
+///     Provides information about the currently executing query
+/// </summary>
+public class EFCachePolicyContext
+{
+    /// <summary>
+    ///     The currently executing query
+    /// </summary>
+    public string CommandText { set; get; } = null!;
+
+    /// <summary>
+    ///     The associated currently executing query's table names.
+    /// </summary>
+    public ISet<string> CommandTableNames { set; get; } = new SortedSet<string>(StringComparer.OrdinalIgnoreCase);
+
+    /// <summary>
+    ///     The associated currently executing query's entity types.
+    /// </summary>
+    public IList<Type> CommandEntityTypes { set; get; } = [];
+
+    /// <summary>
+    ///     Is `insert`, `update` or `delete`?
+    /// </summary>
+    public bool IsCrudCommand { set; get; }
+
+    /// <summary>
+    ///     The currently executing query's EFCachePolicy value, before being possibly altered by calling
+    ///     `OverrideCachePolicy()` method.
+    /// </summary>
+    public EFCachePolicy? CommandCachePolicy { set; get; }
+}
diff --git a/src/EFCoreSecondLevelCacheInterceptor/EFCachePolicyParser.cs b/src/EFCoreSecondLevelCacheInterceptor/EFCachePolicyParser.cs
@@ -127,6 +127,8 @@ public string RemoveEFCachePolicyTag(string commandText)
         var efCachePolicy = GetParsedPolicy(commandText) ?? GetSpecificGlobalPolicy(commandText, allEntityTypes) ??
             GetSkippedGlobalPolicy(commandText, allEntityTypes) ?? GetGlobalPolicy(commandText);
 
+        efCachePolicy = TryOverrideCachePolicy(efCachePolicy, commandText, allEntityTypes);
+
         if (efCachePolicy != null && _logger.IsLoggerEnabled)
         {
             var message = $"Using EFCachePolicy: {efCachePolicy}.";
@@ -139,6 +141,32 @@ public string RemoveEFCachePolicyTag(string commandText)
         return efCachePolicy;
     }
 
+    private EFCachePolicy? TryOverrideCachePolicy(EFCachePolicy? efCachePolicy,
+        string commandText,
+        IList<TableEntityInfo> allEntityTypes)
+    {
+        if (_cacheSettings.OverrideCachePolicy is null)
+        {
+            return efCachePolicy;
+        }
+
+        var newCachePolicy = _cacheSettings.OverrideCachePolicy(new EFCachePolicyContext
+        {
+            CommandText = commandText,
+            CommandTableNames = _sqlCommandsProcessor.GetSqlCommandTableNames(commandText),
+            CommandEntityTypes = _sqlCommandsProcessor.GetSqlCommandEntityTypes(commandText, allEntityTypes),
+            IsCrudCommand = _sqlCommandsProcessor.IsCrudCommand(commandText),
+            CommandCachePolicy = efCachePolicy
+        });
+
+        if (newCachePolicy is not null)
+        {
+            efCachePolicy = newCachePolicy;
+        }
+
+        return efCachePolicy;
+    }
+
     private bool ShouldSkipCachingCommands(string commandText)
     {
         var result = _cacheSettings.SkipCachingCommands != null && _cacheSettings.SkipCachingCommands(commandText);
diff --git a/src/EFCoreSecondLevelCacheInterceptor/EFCoreSecondLevelCacheInterceptor.csproj b/src/EFCoreSecondLevelCacheInterceptor/EFCoreSecondLevelCacheInterceptor.csproj
@@ -1,7 +1,7 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
     <PropertyGroup>
         <Description>Entity Framework Core Second Level Caching Library.</Description>
-        <VersionPrefix>5.1.1</VersionPrefix>
+        <VersionPrefix>5.2.0</VersionPrefix>
         <Authors>Vahid Nasiri</Authors>
         <TargetFrameworks>net9.0;net8.0;net7.0;net6.0;net5.0;netstandard2.1;netstandard2.0;net462;netcoreapp3.1;</TargetFrameworks>
         <GenerateDocumentationFile>true</GenerateDocumentationFile>
diff --git a/src/EFCoreSecondLevelCacheInterceptor/EFCoreSecondLevelCacheOptions.cs b/src/EFCoreSecondLevelCacheInterceptor/EFCoreSecondLevelCacheOptions.cs
@@ -338,4 +338,15 @@ public EFCoreSecondLevelCacheOptions CacheAllQueriesExceptContainingTypes(CacheE
 
         return this;
     }
+
+    /// <summary>
+    ///     Here you can override the default/calculated cache-policy of the current query.
+    ///     Return null, if you want to use the default/calculated settings.
+    /// </summary>
+    public EFCoreSecondLevelCacheOptions OverrideCachePolicy(Func<EFCachePolicyContext, EFCachePolicy?> cachePolicy)
+    {
+        Settings.OverrideCachePolicy = cachePolicy ?? throw new ArgumentNullException(nameof(cachePolicy));
+
+        return this;
+    }
 }
diff --git a/src/EFCoreSecondLevelCacheInterceptor/EFCoreSecondLevelCacheSettings.cs b/src/EFCoreSecondLevelCacheInterceptor/EFCoreSecondLevelCacheSettings.cs
@@ -120,6 +120,12 @@ public class EFCoreSecondLevelCacheSettings
     /// </summary>
     public Predicate<string>? SkipCacheInvalidationCommands { set; get; }
 
+    /// <summary>
+    ///     Here you can override the default cache-policy of the current query.
+    ///     Return null, if you want to use the default settings.
+    /// </summary>
+    public Func<EFCachePolicyContext, EFCachePolicy?>? OverrideCachePolicy { set; get; }
+
     /// <summary>
     ///     Queries containing these types will not be cached.
     /// </summary>
diff --git a/src/Tests/EFCoreSecondLevelCacheInterceptor.AspNetCoreSample/Startup.cs b/src/Tests/EFCoreSecondLevelCacheInterceptor.AspNetCoreSample/Startup.cs
@@ -92,7 +92,21 @@ public void ConfigureServices(IServiceCollection services)
                 .SkipCacheInvalidationCommands(commandText =>
 
                     // How to skip invalidating the related cache entries of this query
-                    commandText.Contains(value: "NEWID()", StringComparison.InvariantCultureIgnoreCase));
+                    commandText.Contains(value: "NEWID()", StringComparison.InvariantCultureIgnoreCase))
+                .OverrideCachePolicy(context =>
+                {
+                    if (context.IsCrudCommand)
+                    {
+                        return null;
+                    }
+
+                    if (context.CommandTableNames.Contains(item: "posts"))
+                    {
+                        return new EFCachePolicy().ExpirationMode(CacheExpirationMode.NeverRemove);
+                    }
+
+                    return null; // Use the default/calculated EFCachePolicy 
+                });
         });
 
         var connectionString = Configuration[key: "ConnectionStrings:ApplicationDbContextConnection"];
