[Backport 3.0] moving ML-Commons Settings from plugin module to common module

common/src/main/java/org/opensearch/ml/common/conversation/ConversationalIndexConstants.java

@@ -17,7 +17,8 @@
  */
 package org.opensearch.ml.common.conversation;
 
-import org.opensearch.common.settings.Setting;
+import static org.opensearch.ml.common.settings.MLCommonsSettings.ML_COMMONS_MEMORY_FEATURE_ENABLED;
+
 import org.opensearch.ml.common.MLIndex;
 
 /**
@@ -66,10 +67,6 @@ public class ConversationalIndexConstants {
     /** Mappings for the interactions index */
     public final static String INTERACTIONS_MAPPINGS = MLIndex.MEMORY_MESSAGE.getMapping();
 
-    /** Feature Flag setting for conversational memory */
-    public static final Setting<Boolean> ML_COMMONS_MEMORY_FEATURE_ENABLED = Setting
-        .boolSetting("plugins.ml_commons.memory_feature_enabled", true, Setting.Property.NodeScope, Setting.Property.Dynamic);
-
     public static final String ML_COMMONS_MEMORY_FEATURE_DISABLED_MESSAGE =
         "The Conversation Memory feature is not enabled. To enable, please update the setting "
             + ML_COMMONS_MEMORY_FEATURE_ENABLED.getKey();

plugin/src/main/java/org/opensearch/ml/settings/MLCommonsSettings.java → common/src/main/java/org/opensearch/ml/common/settings/MLCommonsSettings.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package org.opensearch.ml.settings;
+package org.opensearch.ml.common.settings;
 
 import static org.opensearch.remote.metadata.common.CommonValue.REMOTE_METADATA_ENDPOINT_KEY;
 import static org.opensearch.remote.metadata.common.CommonValue.REMOTE_METADATA_REGION_KEY;
@@ -17,8 +17,6 @@
 import org.opensearch.core.common.unit.ByteSizeUnit;
 import org.opensearch.core.common.unit.ByteSizeValue;
 import org.opensearch.ml.common.CommonValue;
-import org.opensearch.ml.common.conversation.ConversationalIndexConstants;
-import org.opensearch.searchpipelines.questionanswering.generative.GenerativeQAProcessorConstants;
 
 import com.google.common.collect.ImmutableList;
 
@@ -215,13 +213,15 @@ private MLCommonsSettings() {}
             Setting.Property.Dynamic
         );
 
-    public static final Setting<Boolean> ML_COMMONS_MEMORY_FEATURE_ENABLED = ConversationalIndexConstants.ML_COMMONS_MEMORY_FEATURE_ENABLED;
+    /** Feature Flag setting for conversational memory */
+    public static final Setting<Boolean> ML_COMMONS_MEMORY_FEATURE_ENABLED = Setting
+        .boolSetting("plugins.ml_commons.memory_feature_enabled", true, Setting.Property.NodeScope, Setting.Property.Dynamic);
 
     public static final Setting<Boolean> ML_COMMONS_MCP_FEATURE_ENABLED = CommonValue.ML_COMMONS_MCP_FEATURE_ENABLED;
 
     // Feature flag for enabling search processors for Retrieval Augmented Generation using OpenSearch and Remote Inference.
-    public static final Setting<Boolean> ML_COMMONS_RAG_PIPELINE_FEATURE_ENABLED =
-        GenerativeQAProcessorConstants.RAG_PIPELINE_FEATURE_ENABLED;
+    public static final Setting<Boolean> ML_COMMONS_RAG_PIPELINE_FEATURE_ENABLED = Setting
+        .boolSetting("plugins.ml_commons.rag_pipeline_feature_enabled", true, Setting.Property.NodeScope, Setting.Property.Dynamic);
 
     // This setting is to enable/disable agent related API register/execute/delete/get/search agent.
     public static final Setting<Boolean> ML_COMMONS_AGENT_FRAMEWORK_ENABLED = Setting

plugin/src/main/java/org/opensearch/ml/settings/MLFeatureEnabledSetting.java → common/src/main/java/org/opensearch/ml/common/settings/MLFeatureEnabledSetting.java

@@ -5,24 +5,23 @@
  *
  */
 
-package org.opensearch.ml.settings;
+package org.opensearch.ml.common.settings;
 
-import static org.opensearch.ml.settings.MLCommonsSettings.ML_COMMONS_AGENT_FRAMEWORK_ENABLED;
-import static org.opensearch.ml.settings.MLCommonsSettings.ML_COMMONS_CONNECTOR_PRIVATE_IP_ENABLED;
-import static org.opensearch.ml.settings.MLCommonsSettings.ML_COMMONS_CONTROLLER_ENABLED;
-import static org.opensearch.ml.settings.MLCommonsSettings.ML_COMMONS_LOCAL_MODEL_ENABLED;
-import static org.opensearch.ml.settings.MLCommonsSettings.ML_COMMONS_MULTI_TENANCY_ENABLED;
-import static org.opensearch.ml.settings.MLCommonsSettings.ML_COMMONS_OFFLINE_BATCH_INFERENCE_ENABLED;
-import static org.opensearch.ml.settings.MLCommonsSettings.ML_COMMONS_OFFLINE_BATCH_INGESTION_ENABLED;
-import static org.opensearch.ml.settings.MLCommonsSettings.ML_COMMONS_REMOTE_INFERENCE_ENABLED;
+import static org.opensearch.ml.common.settings.MLCommonsSettings.ML_COMMONS_AGENT_FRAMEWORK_ENABLED;
+import static org.opensearch.ml.common.settings.MLCommonsSettings.ML_COMMONS_CONNECTOR_PRIVATE_IP_ENABLED;
+import static org.opensearch.ml.common.settings.MLCommonsSettings.ML_COMMONS_CONTROLLER_ENABLED;
+import static org.opensearch.ml.common.settings.MLCommonsSettings.ML_COMMONS_LOCAL_MODEL_ENABLED;
+import static org.opensearch.ml.common.settings.MLCommonsSettings.ML_COMMONS_MULTI_TENANCY_ENABLED;
+import static org.opensearch.ml.common.settings.MLCommonsSettings.ML_COMMONS_OFFLINE_BATCH_INFERENCE_ENABLED;
+import static org.opensearch.ml.common.settings.MLCommonsSettings.ML_COMMONS_OFFLINE_BATCH_INGESTION_ENABLED;
+import static org.opensearch.ml.common.settings.MLCommonsSettings.ML_COMMONS_REMOTE_INFERENCE_ENABLED;
 
 import java.util.ArrayList;
 import java.util.List;
 import java.util.concurrent.atomic.AtomicBoolean;
 
 import org.opensearch.cluster.service.ClusterService;
 import org.opensearch.common.settings.Settings;
-import org.opensearch.ml.common.settings.SettingsChangeListener;
 
 import com.google.common.annotations.VisibleForTesting;
 
@@ -137,7 +136,7 @@ public void addListener(SettingsChangeListener listener) {
     }
 
     @VisibleForTesting
-    void notifyMultiTenancyListeners(boolean isEnabled) {
+    public void notifyMultiTenancyListeners(boolean isEnabled) {
         for (SettingsChangeListener listener : listeners) {
             listener.onMultiTenancyEnabledChanged(isEnabled);
         }

common/src/test/java/org/opensearch/ml/common/settings/MLCommonsSettingsTests.java

@@ -0,0 +1,73 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package org.opensearch.ml.common.settings;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+import java.util.List;
+
+import org.junit.Test;
+import org.opensearch.core.common.unit.ByteSizeUnit;
+import org.opensearch.core.common.unit.ByteSizeValue;
+
+public class MLCommonsSettingsTests {
+
+    @Test
+    public void testMaxModelsPerNodeDefaultValue() {
+        assertEquals(10, MLCommonsSettings.ML_COMMONS_MAX_MODELS_PER_NODE.getDefault(null).intValue());
+    }
+
+    @Test
+    public void testOnlyRunOnMLNodeDefaultValue() {
+        assertTrue(MLCommonsSettings.ML_COMMONS_ONLY_RUN_ON_ML_NODE.getDefault(null));
+    }
+
+    @Test
+    public void testInHousePythonModelDisabledByDefault() {
+        assertFalse(MLCommonsSettings.ML_COMMONS_ENABLE_INHOUSE_PYTHON_MODEL.getDefault(null));
+    }
+
+    @Test
+    public void testDiskFreeSpaceThresholdDefault() {
+        ByteSizeValue expected = new ByteSizeValue(5L, ByteSizeUnit.GB);
+        assertEquals(expected, MLCommonsSettings.ML_COMMONS_DISK_FREE_SPACE_THRESHOLD.getDefault(null));
+    }
+
+    @Test
+    public void testTrustedUrlRegexDefault() {
+        String expectedRegex = "^(https?|ftp|file)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]";
+        assertEquals(expectedRegex, MLCommonsSettings.ML_COMMONS_TRUSTED_URL_REGEX.getDefault(null));
+    }
+
+    @Test
+    public void testRemoteModelEligibleNodeRolesDefault() {
+        List<String> expected = List.of("data", "ml");
+        assertEquals(expected, MLCommonsSettings.ML_COMMONS_REMOTE_MODEL_ELIGIBLE_NODE_ROLES.getDefault(null));
+    }
+
+    @Test
+    public void testLocalModelEligibleNodeRolesDefault() {
+        List<String> expected = List.of("data", "ml");
+        assertEquals(expected, MLCommonsSettings.ML_COMMONS_LOCAL_MODEL_ELIGIBLE_NODE_ROLES.getDefault(null));
+    }
+
+    @Test
+    public void testMultiTenancyDisabledByDefault() {
+        assertFalse(MLCommonsSettings.ML_COMMONS_MULTI_TENANCY_ENABLED.getDefault(null));
+    }
+
+    @Test
+    public void testRemoteInferenceEnabledByDefault() {
+        assertTrue(MLCommonsSettings.ML_COMMONS_REMOTE_INFERENCE_ENABLED.getDefault(null));
+    }
+
+    @Test
+    public void testAllowModelUrlDisabledByDefault() {
+        assertFalse(MLCommonsSettings.ML_COMMONS_ALLOW_MODEL_URL.getDefault(null));
+    }
+}

common/src/test/java/org/opensearch/ml/common/settings/MLFeatureEnabledSettingTests.java

@@ -0,0 +1,112 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package org.opensearch.ml.common.settings;
+
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+import java.util.Set;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.opensearch.cluster.service.ClusterService;
+import org.opensearch.common.settings.ClusterSettings;
+import org.opensearch.common.settings.Settings;
+
+public class MLFeatureEnabledSettingTests {
+
+    private ClusterService mockClusterService;
+    private ClusterSettings mockClusterSettings;
+
+    @Before
+    public void setUp() {
+        mockClusterService = mock(ClusterService.class);
+        // Create a real ClusterSettings instance with an empty set of registered settings
+        mockClusterSettings = new ClusterSettings(
+            Settings.EMPTY,
+            Set
+                .of(
+                    MLCommonsSettings.ML_COMMONS_REMOTE_INFERENCE_ENABLED,
+                    MLCommonsSettings.ML_COMMONS_AGENT_FRAMEWORK_ENABLED,
+                    MLCommonsSettings.ML_COMMONS_LOCAL_MODEL_ENABLED,
+                    MLCommonsSettings.ML_COMMONS_CONNECTOR_PRIVATE_IP_ENABLED,
+                    MLCommonsSettings.ML_COMMONS_CONTROLLER_ENABLED,
+                    MLCommonsSettings.ML_COMMONS_OFFLINE_BATCH_INGESTION_ENABLED,
+                    MLCommonsSettings.ML_COMMONS_OFFLINE_BATCH_INFERENCE_ENABLED,
+                    MLCommonsSettings.ML_COMMONS_MULTI_TENANCY_ENABLED
+                )
+        );
+        when(mockClusterService.getClusterSettings()).thenReturn(mockClusterSettings);
+    }
+
+    @Test
+    public void testDefaults_allFeaturesEnabled() {
+        Settings settings = Settings
+            .builder()
+            .put("plugins.ml_commons.remote_inference.enabled", true)
+            .put("plugins.ml_commons.agent_framework_enabled", true)
+            .put("plugins.ml_commons.local_model.enabled", true)
+            .put("plugins.ml_commons.connector.private_ip_enabled", true)
+            .put("plugins.ml_commons.controller_enabled", true)
+            .put("plugins.ml_commons.offline_batch_ingestion_enabled", true)
+            .put("plugins.ml_commons.offline_batch_inference_enabled", true)
+            .put("plugins.ml_commons.multi_tenancy_enabled", true)
+            .build();
+
+        MLFeatureEnabledSetting setting = new MLFeatureEnabledSetting(mockClusterService, settings);
+
+        assertTrue(setting.isRemoteInferenceEnabled());
+        assertTrue(setting.isAgentFrameworkEnabled());
+        assertTrue(setting.isLocalModelEnabled());
+        assertTrue(setting.isConnectorPrivateIpEnabled().get());
+        assertTrue(setting.isControllerEnabled());
+        assertTrue(setting.isOfflineBatchIngestionEnabled());
+        assertTrue(setting.isOfflineBatchInferenceEnabled());
+        assertTrue(setting.isMultiTenancyEnabled());
+    }
+
+    @Test
+    public void testDefaults_someFeaturesDisabled() {
+        Settings settings = Settings
+            .builder()
+            .put("plugins.ml_commons.remote_inference.enabled", false)
+            .put("plugins.ml_commons.agent_framework_enabled", false)
+            .put("plugins.ml_commons.local_model.enabled", false)
+            .put("plugins.ml_commons.connector.private_ip_enabled", false)
+            .put("plugins.ml_commons.controller_enabled", false)
+            .put("plugins.ml_commons.offline_batch_ingestion_enabled", false)
+            .put("plugins.ml_commons.offline_batch_inference_enabled", false)
+            .put("plugins.ml_commons.multi_tenancy_enabled", false)
+            .build();
+
+        MLFeatureEnabledSetting setting = new MLFeatureEnabledSetting(mockClusterService, settings);
+
+        assertFalse(setting.isRemoteInferenceEnabled());
+        assertFalse(setting.isAgentFrameworkEnabled());
+        assertFalse(setting.isLocalModelEnabled());
+        assertFalse(setting.isConnectorPrivateIpEnabled().get());
+        assertFalse(setting.isControllerEnabled());
+        assertFalse(setting.isOfflineBatchIngestionEnabled());
+        assertFalse(setting.isOfflineBatchInferenceEnabled());
+        assertFalse(setting.isMultiTenancyEnabled());
+    }
+
+    @Test
+    public void testMultiTenancyChangeNotifiesListeners() {
+        Settings settings = Settings.builder().put("plugins.ml_commons.multi_tenancy_enabled", false).build();
+
+        MLFeatureEnabledSetting setting = new MLFeatureEnabledSetting(mockClusterService, settings);
+
+        SettingsChangeListener mockListener = mock(SettingsChangeListener.class);
+        setting.addListener(mockListener);
+
+        setting.notifyMultiTenancyListeners(true);
+        verify(mockListener).onMultiTenancyEnabledChanged(true);
+    }
+}

memory/src/main/java/org/opensearch/ml/memory/action/conversation/CreateConversationTransportAction.java

@@ -28,7 +28,7 @@
 import org.opensearch.common.inject.Inject;
 import org.opensearch.common.util.concurrent.ThreadContext;
 import org.opensearch.core.action.ActionListener;
-import org.opensearch.ml.common.conversation.ConversationalIndexConstants;
+import org.opensearch.ml.common.settings.MLCommonsSettings;
 import org.opensearch.ml.memory.ConversationalMemoryHandler;
 import org.opensearch.ml.memory.index.OpenSearchConversationalMemoryHandler;
 import org.opensearch.tasks.Task;
@@ -67,10 +67,10 @@ public CreateConversationTransportAction(
         super(CreateConversationAction.NAME, transportService, actionFilters, CreateConversationRequest::new);
         this.cmHandler = cmHandler;
         this.client = client;
-        this.featureIsEnabled = ConversationalIndexConstants.ML_COMMONS_MEMORY_FEATURE_ENABLED.get(clusterService.getSettings());
+        this.featureIsEnabled = MLCommonsSettings.ML_COMMONS_MEMORY_FEATURE_ENABLED.get(clusterService.getSettings());
         clusterService
             .getClusterSettings()
-            .addSettingsUpdateConsumer(ConversationalIndexConstants.ML_COMMONS_MEMORY_FEATURE_ENABLED, it -> featureIsEnabled = it);
+            .addSettingsUpdateConsumer(MLCommonsSettings.ML_COMMONS_MEMORY_FEATURE_ENABLED, it -> featureIsEnabled = it);
     }
 
     @Override

memory/src/main/java/org/opensearch/ml/memory/action/conversation/CreateInteractionTransportAction.java

@@ -31,7 +31,7 @@
 import org.opensearch.common.inject.Inject;
 import org.opensearch.common.util.concurrent.ThreadContext;
 import org.opensearch.core.action.ActionListener;
-import org.opensearch.ml.common.conversation.ConversationalIndexConstants;
+import org.opensearch.ml.common.settings.MLCommonsSettings;
 import org.opensearch.ml.memory.ConversationalMemoryHandler;
 import org.opensearch.ml.memory.index.OpenSearchConversationalMemoryHandler;
 import org.opensearch.tasks.Task;
@@ -70,10 +70,10 @@ public CreateInteractionTransportAction(
         super(CreateInteractionAction.NAME, transportService, actionFilters, CreateInteractionRequest::new);
         this.client = client;
         this.cmHandler = cmHandler;
-        this.featureIsEnabled = ConversationalIndexConstants.ML_COMMONS_MEMORY_FEATURE_ENABLED.get(clusterService.getSettings());
+        this.featureIsEnabled = MLCommonsSettings.ML_COMMONS_MEMORY_FEATURE_ENABLED.get(clusterService.getSettings());
         clusterService
             .getClusterSettings()
-            .addSettingsUpdateConsumer(ConversationalIndexConstants.ML_COMMONS_MEMORY_FEATURE_ENABLED, it -> featureIsEnabled = it);
+            .addSettingsUpdateConsumer(MLCommonsSettings.ML_COMMONS_MEMORY_FEATURE_ENABLED, it -> featureIsEnabled = it);
     }
 
     @Override

memory/src/main/java/org/opensearch/ml/memory/action/conversation/DeleteConversationTransportAction.java

@@ -26,7 +26,7 @@
 import org.opensearch.common.inject.Inject;
 import org.opensearch.common.util.concurrent.ThreadContext;
 import org.opensearch.core.action.ActionListener;
-import org.opensearch.ml.common.conversation.ConversationalIndexConstants;
+import org.opensearch.ml.common.settings.MLCommonsSettings;
 import org.opensearch.ml.memory.ConversationalMemoryHandler;
 import org.opensearch.ml.memory.index.OpenSearchConversationalMemoryHandler;
 import org.opensearch.tasks.Task;
@@ -65,10 +65,10 @@ public DeleteConversationTransportAction(
         super(DeleteConversationAction.NAME, transportService, actionFilters, DeleteConversationRequest::new);
         this.client = client;
         this.cmHandler = cmHandler;
-        this.featureIsEnabled = ConversationalIndexConstants.ML_COMMONS_MEMORY_FEATURE_ENABLED.get(clusterService.getSettings());
+        this.featureIsEnabled = MLCommonsSettings.ML_COMMONS_MEMORY_FEATURE_ENABLED.get(clusterService.getSettings());
         clusterService
             .getClusterSettings()
-            .addSettingsUpdateConsumer(ConversationalIndexConstants.ML_COMMONS_MEMORY_FEATURE_ENABLED, it -> featureIsEnabled = it);
+            .addSettingsUpdateConsumer(MLCommonsSettings.ML_COMMONS_MEMORY_FEATURE_ENABLED, it -> featureIsEnabled = it);
     }
 
     @Override

memory/src/main/java/org/opensearch/ml/memory/action/conversation/GetConversationTransportAction.java

@@ -27,7 +27,7 @@
 import org.opensearch.common.util.concurrent.ThreadContext;
 import org.opensearch.core.action.ActionListener;
 import org.opensearch.ml.common.conversation.ConversationMeta;
-import org.opensearch.ml.common.conversation.ConversationalIndexConstants;
+import org.opensearch.ml.common.settings.MLCommonsSettings;
 import org.opensearch.ml.memory.ConversationalMemoryHandler;
 import org.opensearch.ml.memory.index.OpenSearchConversationalMemoryHandler;
 import org.opensearch.tasks.Task;
@@ -65,10 +65,10 @@ public GetConversationTransportAction(
         super(GetConversationAction.NAME, transportService, actionFilters, GetConversationRequest::new);
         this.client = client;
         this.cmHandler = cmHandler;
-        this.featureIsEnabled = ConversationalIndexConstants.ML_COMMONS_MEMORY_FEATURE_ENABLED.get(clusterService.getSettings());
+        this.featureIsEnabled = MLCommonsSettings.ML_COMMONS_MEMORY_FEATURE_ENABLED.get(clusterService.getSettings());
         clusterService
             .getClusterSettings()
-            .addSettingsUpdateConsumer(ConversationalIndexConstants.ML_COMMONS_MEMORY_FEATURE_ENABLED, it -> featureIsEnabled = it);
+            .addSettingsUpdateConsumer(MLCommonsSettings.ML_COMMONS_MEMORY_FEATURE_ENABLED, it -> featureIsEnabled = it);
     }
 
     @Override

memory/src/main/java/org/opensearch/ml/memory/action/conversation/GetConversationsTransportAction.java

@@ -29,7 +29,7 @@
 import org.opensearch.common.util.concurrent.ThreadContext;
 import org.opensearch.core.action.ActionListener;
 import org.opensearch.ml.common.conversation.ConversationMeta;
-import org.opensearch.ml.common.conversation.ConversationalIndexConstants;
+import org.opensearch.ml.common.settings.MLCommonsSettings;
 import org.opensearch.ml.memory.ConversationalMemoryHandler;
 import org.opensearch.ml.memory.index.OpenSearchConversationalMemoryHandler;
 import org.opensearch.tasks.Task;
@@ -68,10 +68,10 @@ public GetConversationsTransportAction(
         super(GetConversationsAction.NAME, transportService, actionFilters, GetConversationsRequest::new);
         this.client = client;
         this.cmHandler = cmHandler;
-        this.featureIsEnabled = ConversationalIndexConstants.ML_COMMONS_MEMORY_FEATURE_ENABLED.get(clusterService.getSettings());
+        this.featureIsEnabled = MLCommonsSettings.ML_COMMONS_MEMORY_FEATURE_ENABLED.get(clusterService.getSettings());
         clusterService
             .getClusterSettings()
-            .addSettingsUpdateConsumer(ConversationalIndexConstants.ML_COMMONS_MEMORY_FEATURE_ENABLED, it -> featureIsEnabled = it);
+            .addSettingsUpdateConsumer(MLCommonsSettings.ML_COMMONS_MEMORY_FEATURE_ENABLED, it -> featureIsEnabled = it);
     }
 
     @Override