Putting tiered cache settings behind feature flag

Signed-off-by: Sagar Upadhyaya <[email protected]>
opensearch-project · Apr 25, 2024 · a9fc92e · a9fc92e
1 parent 6133ff0
commit a9fc92e
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 11 deletions.
diff --git a/...che-common/src/main/java/org/opensearch/cache/common/tier/TieredSpilloverCachePlugin.java b/...che-common/src/main/java/org/opensearch/cache/common/tier/TieredSpilloverCachePlugin.java
@@ -11,6 +11,8 @@
 import org.opensearch.common.cache.CacheType;
 import org.opensearch.common.cache.ICache;
 import org.opensearch.common.settings.Setting;
+import org.opensearch.common.settings.Settings;
+import org.opensearch.common.util.FeatureFlags;
 import org.opensearch.plugins.CachePlugin;
 import org.opensearch.plugins.Plugin;
 
@@ -31,10 +33,15 @@ public class TieredSpilloverCachePlugin extends Plugin implements CachePlugin {
      */
     public static final String TIERED_CACHE_SPILLOVER_PLUGIN_NAME = "tieredSpilloverCachePlugin";
 
+    private final Settings settings;
+
     /**
      * Default constructor
+     * @param settings settings
      */
-    public TieredSpilloverCachePlugin() {}
+    public TieredSpilloverCachePlugin(Settings settings) {
+        this.settings = settings;
+    }
 
     @Override
     public Map<String, ICache.Factory> getCacheFactoryMap() {
@@ -47,15 +54,21 @@ public Map<String, ICache.Factory> getCacheFactoryMap() {
     @Override
     public List<Setting<?>> getSettings() {
         List<Setting<?>> settingList = new ArrayList<>();
-        for (CacheType cacheType : CacheType.values()) {
-            settingList.add(
-                TieredSpilloverCacheSettings.TIERED_SPILLOVER_ONHEAP_STORE_NAME.getConcreteSettingForNamespace(cacheType.getSettingPrefix())
-            );
-            settingList.add(
-                TieredSpilloverCacheSettings.TIERED_SPILLOVER_DISK_STORE_NAME.getConcreteSettingForNamespace(cacheType.getSettingPrefix())
-            );
-            settingList.add(TOOK_TIME_POLICY_CONCRETE_SETTINGS_MAP.get(cacheType));
-            settingList.add(DISK_CACHE_ENABLED_SETTING_MAP.get(cacheType));
+        if (FeatureFlags.PLUGGABLE_CACHE_SETTING.get(settings)) {
+            for (CacheType cacheType : CacheType.values()) {
+                settingList.add(
+                    TieredSpilloverCacheSettings.TIERED_SPILLOVER_ONHEAP_STORE_NAME.getConcreteSettingForNamespace(
+                        cacheType.getSettingPrefix()
+                    )
+                );
+                settingList.add(
+                    TieredSpilloverCacheSettings.TIERED_SPILLOVER_DISK_STORE_NAME.getConcreteSettingForNamespace(
+                        cacheType.getSettingPrefix()
+                    )
+                );
+                settingList.add(TOOK_TIME_POLICY_CONCRETE_SETTINGS_MAP.get(cacheType));
+                settingList.add(DISK_CACHE_ENABLED_SETTING_MAP.get(cacheType));
+            }
         }
         return settingList;
     }

diff --git a/...ommon/src/test/java/org/opensearch/cache/common/tier/TieredSpilloverCachePluginTests.java b/...ommon/src/test/java/org/opensearch/cache/common/tier/TieredSpilloverCachePluginTests.java
@@ -9,16 +9,25 @@
 package org.opensearch.cache.common.tier;
 
 import org.opensearch.common.cache.ICache;
+import org.opensearch.common.settings.Settings;
+import org.opensearch.common.util.FeatureFlags;
 import org.opensearch.test.OpenSearchTestCase;
 
 import java.util.Map;
 
 public class TieredSpilloverCachePluginTests extends OpenSearchTestCase {
 
     public void testGetCacheFactoryMap() {
-        TieredSpilloverCachePlugin tieredSpilloverCachePlugin = new TieredSpilloverCachePlugin();
+        TieredSpilloverCachePlugin tieredSpilloverCachePlugin = new TieredSpilloverCachePlugin(Settings.EMPTY);
         Map<String, ICache.Factory> map = tieredSpilloverCachePlugin.getCacheFactoryMap();
         assertNotNull(map.get(TieredSpilloverCache.TieredSpilloverCacheFactory.TIERED_SPILLOVER_CACHE_NAME));
         assertEquals(TieredSpilloverCachePlugin.TIERED_CACHE_SPILLOVER_PLUGIN_NAME, tieredSpilloverCachePlugin.getName());
     }
+
+    public void testGetSettingsWithFeatureFlagOn() {
+        TieredSpilloverCachePlugin tieredSpilloverCachePlugin = new TieredSpilloverCachePlugin(
+            Settings.builder().put(FeatureFlags.PLUGGABLE_CACHE_SETTING.getKey(), true).build()
+        );
+        assertFalse(tieredSpilloverCachePlugin.getSettings().isEmpty());
+    }
 }