[FSSDK-11177] Cache with remove interface addition

junaed-optimizely · junaed-optimizely · commit 252ba9ecc391 · 2025-10-31T15:05:18.000+06:00
diff --git a/OptimizelySDK.NetStandard20/OptimizelySDK.NetStandard20.csproj b/OptimizelySDK.NetStandard20/OptimizelySDK.NetStandard20.csproj
@@ -375,6 +375,9 @@
     <Compile Include="..\OptimizelySDK\Utils\Validator.cs">
       <Link>Utils\Validator.cs</Link>
     </Compile>
+    <Compile Include="..\OptimizelySDK\Utils\ICacheWithRemove.cs">
+      <Link>Utils\ICacheWithRemove.cs</Link>
+    </Compile>
     <Compile Include="..\OptimizelySDK\Event\BatchEventProcessor.cs">
       <Link>Event\BatchEventProcessor.cs</Link>
     </Compile>
diff --git a/OptimizelySDK.Tests/CmabTests/DefaultCmabServiceTest.cs b/OptimizelySDK.Tests/CmabTests/DefaultCmabServiceTest.cs
@@ -26,6 +26,7 @@
 using OptimizelySDK.Odp;
 using OptimizelySDK.OptimizelyDecisions;
 using OptimizelySDK.Tests.Utils;
+using OptimizelySDK.Utils;
 using AttributeEntity = OptimizelySDK.Entity.Attribute;
 
 namespace OptimizelySDK.Tests.CmabTests
@@ -461,7 +462,7 @@ public void ConstructorAcceptsAnyICacheImplementation()
 
             Assert.IsNotNull(cache);
             Assert.AreSame(fakeCache, cache);
-            Assert.IsInstanceOf<ICache<CmabCacheEntry>>(cache);
+            Assert.IsInstanceOf<ICacheWithRemove<CmabCacheEntry>>(cache);
         }
 
         [Test]
@@ -586,9 +587,9 @@ public void LockStripingDistribution()
                 "Different user/rule combinations should generally use different locks");
         }
 
-        private static ICache<CmabCacheEntry> GetInternalCache(DefaultCmabService service)
+        private static ICacheWithRemove<CmabCacheEntry> GetInternalCache(DefaultCmabService service)
         {
-            return Reflection.GetFieldValue<ICache<CmabCacheEntry>, DefaultCmabService>(service,
+            return Reflection.GetFieldValue<ICacheWithRemove<CmabCacheEntry>, DefaultCmabService>(service,
                 "_cmabCache");
         }
 
@@ -598,7 +599,7 @@ private static ICmabClient GetInternalClient(DefaultCmabService service)
                 "_cmabClient");
         }
 
-        private sealed class FakeCache : ICache<CmabCacheEntry>
+        private sealed class FakeCache : ICacheWithRemove<CmabCacheEntry>
         {
             public void Save(string key, CmabCacheEntry value) { }
 
diff --git a/OptimizelySDK.Tests/OptimizelyFactoryTest.cs b/OptimizelySDK.Tests/OptimizelyFactoryTest.cs
@@ -29,6 +29,7 @@
 using OptimizelySDK.Notifications;
 using OptimizelySDK.Odp;
 using OptimizelySDK.Tests.ConfigTest;
+using OptimizelySDK.Utils;
 using OptimizelySDK.Tests.EventTest;
 using OptimizelySDK.Tests.Utils;
 
@@ -308,7 +309,7 @@ public void NewDefaultInstanceUsesConfiguredCmabCache()
             var cmabService = Reflection.GetFieldValue<ICmabService, DecisionService>(decisionService, "CmabService");
             Assert.IsInstanceOf<DefaultCmabService>(cmabService);
 
-            var cache = Reflection.GetFieldValue<ICache<CmabCacheEntry>, DefaultCmabService>((DefaultCmabService)cmabService, "_cmabCache") as LruCache<CmabCacheEntry>;
+            var cache = Reflection.GetFieldValue<ICacheWithRemove<CmabCacheEntry>, DefaultCmabService>((DefaultCmabService)cmabService, "_cmabCache") as LruCache<CmabCacheEntry>;
             Assert.IsNotNull(cache);
             Assert.AreEqual(cacheSize, cache.MaxSizeForTesting);
             Assert.AreEqual(cacheTtl, cache.TimeoutForTesting);
diff --git a/OptimizelySDK/Cmab/CmabConfig.cs b/OptimizelySDK/Cmab/CmabConfig.cs
@@ -15,7 +15,7 @@
  */
 
 using System;
-using OptimizelySDK.Odp;
+using OptimizelySDK.Utils;
 
 namespace OptimizelySDK.Cmab
 {
@@ -40,7 +40,7 @@ public CmabConfig(int? cacheSize = null, TimeSpan? cacheTtl = null)
         ///     Initializes a new instance of the CmabConfig class with a custom cache implementation.
         /// </summary>
         /// <param name="customCache">Custom cache implementation for CMAB decisions.</param>
-        public CmabConfig(ICache<CmabCacheEntry> customCache)
+        public CmabConfig(ICacheWithRemove<CmabCacheEntry> customCache)
         {
             CustomCache = customCache ?? throw new ArgumentNullException(nameof(customCache));
             CacheSize = null;
@@ -63,6 +63,6 @@ public CmabConfig(ICache<CmabCacheEntry> customCache)
         ///     Gets the custom cache implementation for CMAB decisions.
         ///     If provided, CacheSize and CacheTtl will be ignored.
         /// </summary>
-        public ICache<CmabCacheEntry> CustomCache { get; }
+        public ICacheWithRemove<CmabCacheEntry> CustomCache { get; }
     }
 }
diff --git a/OptimizelySDK/Cmab/DefaultCmabService.cs b/OptimizelySDK/Cmab/DefaultCmabService.cs
@@ -23,8 +23,8 @@
 using OptimizelySDK;
 using OptimizelySDK.Entity;
 using OptimizelySDK.Logger;
-using OptimizelySDK.Odp;
 using OptimizelySDK.OptimizelyDecisions;
+using OptimizelySDK.Utils;
 using AttributeEntity = OptimizelySDK.Entity.Attribute;
 
 namespace OptimizelySDK.Cmab
@@ -89,7 +89,7 @@ public class DefaultCmabService : ICmabService
         /// </summary>
         private const int NUM_LOCK_STRIPES = 1000;
 
-        private readonly ICache<CmabCacheEntry> _cmabCache;
+        private readonly ICacheWithRemove<CmabCacheEntry> _cmabCache;
         private readonly ICmabClient _cmabClient;
         private readonly ILogger _logger;
         private readonly object[] _locks;
@@ -100,7 +100,7 @@ public class DefaultCmabService : ICmabService
         /// <param name="cmabCache">Cache for storing CMAB decisions.</param>
         /// <param name="cmabClient">Client for fetching decisions from the CMAB prediction service.</param>
         /// <param name="logger">Logger for recording service operations.</param>
-        public DefaultCmabService(ICache<CmabCacheEntry> cmabCache,
+        public DefaultCmabService(ICacheWithRemove<CmabCacheEntry> cmabCache,
             ICmabClient cmabClient,
             ILogger logger)
         {
diff --git a/OptimizelySDK/Odp/ICache.cs b/OptimizelySDK/Odp/ICache.cs
@@ -22,6 +22,5 @@ public interface ICache<T>
         void Save(string key, T value);
         T Lookup(string key);
         void Reset();
-        void Remove(string key);
     }
 }
diff --git a/OptimizelySDK/Odp/LruCache.cs b/OptimizelySDK/Odp/LruCache.cs
@@ -22,7 +22,7 @@
 
 namespace OptimizelySDK.Odp
 {
-    public class LruCache<T> : ICache<T> where T : class
+    public class LruCache<T> : ICacheWithRemove<T> where T : class
     {
         /// <summary>
         /// The maximum number of elements that should be stored
diff --git a/OptimizelySDK/Optimizely.cs b/OptimizelySDK/Optimizely.cs
@@ -289,7 +289,7 @@ private void InitializeComponents(IEventDispatcher eventDispatcher = null,
             if (cmabService == null)
             {
                 var config = cmabConfig ?? new CmabConfig();
-                ICache<CmabCacheEntry> cache;
+                ICacheWithRemove<CmabCacheEntry> cache;
 
                 if (config.CustomCache != null)
                 {
diff --git a/OptimizelySDK/OptimizelyFactory.cs b/OptimizelySDK/OptimizelyFactory.cs
@@ -41,6 +41,7 @@
 
 #if USE_CMAB
 using OptimizelySDK.Cmab;
+using OptimizelySDK.Utils;
 #endif
 
 
@@ -102,7 +103,7 @@ public static void SetCmabCacheConfig(int cacheSize, TimeSpan cacheTtl)
         /// Sets a custom cache implementation for CMAB.
         /// </summary>
         /// <param name="customCache">Custom cache implementation.</param>
-        public static void SetCmabCustomCache(ICache<CmabCacheEntry> customCache)
+        public static void SetCmabCustomCache(ICacheWithRemove<CmabCacheEntry> customCache)
         {
             CmabConfiguration = new CmabConfig(customCache);
         }
diff --git a/OptimizelySDK/OptimizelySDK.csproj b/OptimizelySDK/OptimizelySDK.csproj
@@ -183,6 +183,7 @@
     <Compile Include="Properties\AssemblyInfo.cs"/>
     <Compile Include="Utils\ConfigParser.cs"/>
     <Compile Include="Utils\Schema.cs"/>
+    <Compile Include="Utils\ICacheWithRemove.cs"/>
     <Compile Include="Bucketing\UserProfileService.cs"/>
     <Compile Include="Bucketing\DecisionService.cs"/>
     <Compile Include="ProjectConfig.cs"/>
diff --git a/OptimizelySDK/Utils/ICacheWithRemove.cs b/OptimizelySDK/Utils/ICacheWithRemove.cs
@@ -0,0 +1,36 @@
+﻿/*
+ * Copyright 2025, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+using OptimizelySDK.Odp;
+
+namespace OptimizelySDK.Utils
+{
+    /// <summary>
+    ///     Extended cache interface that adds the ability to remove individual entries.
+    ///     This interface extends ICache with additional removal functionality needed for
+    ///     certain use cases like CMAB decision caching.
+    /// </summary>
+    /// <typeparam name="T">The type of values stored in the cache</typeparam>
+    public interface ICacheWithRemove<T> : ICache<T>
+        where T : class
+    {
+        /// <summary>
+        ///     Remove the element associated with the provided key from the cache
+        /// </summary>
+        /// <param name="key">Key of element to remove from the cache</param>
+        void Remove(string key);
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@`
`26`	`26`	`using OptimizelySDK.Odp;`
`27`	`27`	`using OptimizelySDK.OptimizelyDecisions;`
`28`	`28`	`using OptimizelySDK.Tests.Utils;`
	`29`	`+using OptimizelySDK.Utils;`
`29`	`30`	`using AttributeEntity = OptimizelySDK.Entity.Attribute;`
`30`	`31`
`31`	`32`	`namespace OptimizelySDK.Tests.CmabTests`
`@@ -461,7 +462,7 @@ public void ConstructorAcceptsAnyICacheImplementation()`
`461`	`462`
`462`	`463`	`Assert.IsNotNull(cache);`
`463`	`464`	`Assert.AreSame(fakeCache, cache);`
`464`		`- Assert.IsInstanceOf<ICache<CmabCacheEntry>>(cache);`
	`465`	`+ Assert.IsInstanceOf<ICacheWithRemove<CmabCacheEntry>>(cache);`
`465`	`466`	`}`
`466`	`467`
`467`	`468`	`[Test]`
`@@ -586,9 +587,9 @@ public void LockStripingDistribution()`
`586`	`587`	`"Different user/rule combinations should generally use different locks");`
`587`	`588`	`}`
`588`	`589`
`589`		`- private static ICache<CmabCacheEntry> GetInternalCache(DefaultCmabService service)`
	`590`	`+ private static ICacheWithRemove<CmabCacheEntry> GetInternalCache(DefaultCmabService service)`
`590`	`591`	`{`
`591`		`- return Reflection.GetFieldValue<ICache<CmabCacheEntry>, DefaultCmabService>(service,`
	`592`	`+ return Reflection.GetFieldValue<ICacheWithRemove<CmabCacheEntry>, DefaultCmabService>(service,`
`592`	`593`	`"_cmabCache");`
`593`	`594`	`}`
`594`	`595`
`@@ -598,7 +599,7 @@ private static ICmabClient GetInternalClient(DefaultCmabService service)`
`598`	`599`	`"_cmabClient");`
`599`	`600`	`}`
`600`	`601`
`601`		`- private sealed class FakeCache : ICache<CmabCacheEntry>`
	`602`	`+ private sealed class FakeCache : ICacheWithRemove<CmabCacheEntry>`
`602`	`603`	`{`
`603`	`604`	`public void Save(string key, CmabCacheEntry value) { }`
`604`	`605`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`*/`
`16`	`16`
`17`	`17`	`using System;`
`18`		`-using OptimizelySDK.Odp;`
	`18`	`+using OptimizelySDK.Utils;`
`19`	`19`
`20`	`20`	`namespace OptimizelySDK.Cmab`
`21`	`21`	`{`
`@@ -40,7 +40,7 @@ public CmabConfig(int? cacheSize = null, TimeSpan? cacheTtl = null)`
`40`	`40`	`/// Initializes a new instance of the CmabConfig class with a custom cache implementation.`
`41`	`41`	`/// </summary>`
`42`	`42`	`/// <param name="customCache">Custom cache implementation for CMAB decisions.</param>`
`43`		`- public CmabConfig(ICache<CmabCacheEntry> customCache)`
	`43`	`+ public CmabConfig(ICacheWithRemove<CmabCacheEntry> customCache)`
`44`	`44`	`{`
`45`	`45`	`CustomCache = customCache ?? throw new ArgumentNullException(nameof(customCache));`
`46`	`46`	`CacheSize = null;`
`@@ -63,6 +63,6 @@ public CmabConfig(ICache<CmabCacheEntry> customCache)`
`63`	`63`	`/// Gets the custom cache implementation for CMAB decisions.`
`64`	`64`	`/// If provided, CacheSize and CacheTtl will be ignored.`
`65`	`65`	`/// </summary>`
`66`		`- public ICache<CmabCacheEntry> CustomCache { get; }`
	`66`	`+ public ICacheWithRemove<CmabCacheEntry> CustomCache { get; }`
`67`	`67`	`}`
`68`	`68`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,5 @@ public interface ICache<T>`
`22`	`22`	`void Save(string key, T value);`
`23`	`23`	`T Lookup(string key);`
`24`	`24`	`void Reset();`
`25`		`- void Remove(string key);`
`26`	`25`	`}`
`27`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`
`23`	`23`	`namespace OptimizelySDK.Odp`
`24`	`24`	`{`
`25`		`- public class LruCache<T> : ICache<T> where T : class`
	`25`	`+ public class LruCache<T> : ICacheWithRemove<T> where T : class`
`26`	`26`	`{`
`27`	`27`	`/// <summary>`
`28`	`28`	`/// The maximum number of elements that should be stored`
Original file line number	Diff line number	Diff line change
`@@ -289,7 +289,7 @@ private void InitializeComponents(IEventDispatcher eventDispatcher = null,`
`289`	`289`	`if (cmabService == null)`
`290`	`290`	`{`
`291`	`291`	`var config = cmabConfig ?? new CmabConfig();`
`292`		`- ICache<CmabCacheEntry> cache;`
	`292`	`+ ICacheWithRemove<CmabCacheEntry> cache;`
`293`	`293`
`294`	`294`	`if (config.CustomCache != null)`
`295`	`295`	`{`
Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,7 @@`
`41`	`41`
`42`	`42`	`#if USE_CMAB`
`43`	`43`	`using OptimizelySDK.Cmab;`
	`44`	`+using OptimizelySDK.Utils;`
`44`	`45`	`#endif`
`45`	`46`
`46`	`47`
`@@ -102,7 +103,7 @@ public static void SetCmabCacheConfig(int cacheSize, TimeSpan cacheTtl)`
`102`	`103`	`/// Sets a custom cache implementation for CMAB.`
`103`	`104`	`/// </summary>`
`104`	`105`	`/// <param name="customCache">Custom cache implementation.</param>`
`105`		`- public static void SetCmabCustomCache(ICache<CmabCacheEntry> customCache)`
	`106`	`+ public static void SetCmabCustomCache(ICacheWithRemove<CmabCacheEntry> customCache)`
`106`	`107`	`{`
`107`	`108`	`CmabConfiguration = new CmabConfig(customCache);`
`108`	`109`	`}`