feat:

* Added LTRSettings * Added tests for settings * Added LTRSettings.isLTRPluginEnabled check to all Query.createWeight and all BaseRestHandler.prepareRequest implementations Signed-off-by: Johannes Peter <[email protected]>
opensearch-project · Nov 29, 2024 · 8b3b148 · 8b3b148
1 parent 45e743f
commit 8b3b148
Show file tree

Hide file tree

Showing 18 changed files with 593 additions and 0 deletions.
diff --git a/src/main/java/com/o19s/es/explore/ExplorerQuery.java b/src/main/java/com/o19s/es/explore/ExplorerQuery.java
@@ -35,6 +35,7 @@
 
 import org.apache.lucene.search.DocIdSetIterator;
 import org.apache.lucene.search.similarities.ClassicSimilarity;
+import org.opensearch.ltr.settings.LTRSettings;
 
 import java.io.IOException;
 import java.util.HashSet;
@@ -91,6 +92,10 @@ public int hashCode() {
     @Override
     public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)
             throws IOException {
+        if (!LTRSettings.isLTRPluginEnabled()) {
+            throw new IllegalStateException("LTR plugin is disabled. To enable update ltr.plugin.enabled to true");
+        }
+
         if (!scoreMode.needsScores()) {
             return searcher.createWeight(query, scoreMode, boost);
         }

diff --git a/src/main/java/com/o19s/es/explore/PostingsExplorerQuery.java b/src/main/java/com/o19s/es/explore/PostingsExplorerQuery.java
@@ -33,6 +33,7 @@
 import org.apache.lucene.search.Scorer;
 import org.apache.lucene.search.Explanation;
 import org.apache.lucene.search.DocIdSetIterator;
+import org.opensearch.ltr.settings.LTRSettings;
 
 import java.io.IOException;
 import java.util.ArrayList;
@@ -78,6 +79,10 @@ public int hashCode() {
     @Override
     public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)
             throws IOException {
+        if (!LTRSettings.isLTRPluginEnabled()) {
+            throw new IllegalStateException("LTR plugin is disabled. To enable update ltr.plugin.enabled to true");
+        }
+
         assert scoreMode.needsScores() : "Should not be used in filtering mode";
         return new PostingsExplorerWeight(this, this.term, TermStates.build(searcher, this.term,
                 scoreMode.needsScores()),

diff --git a/src/main/java/com/o19s/es/ltr/feature/PrebuiltFeature.java b/src/main/java/com/o19s/es/ltr/feature/PrebuiltFeature.java
@@ -25,6 +25,7 @@
 import org.apache.lucene.search.IndexSearcher;
 import org.apache.lucene.search.ScoreMode;
 import org.opensearch.common.Nullable;
+import org.opensearch.ltr.settings.LTRSettings;
 
 import java.io.IOException;
 import java.util.Map;
@@ -79,6 +80,10 @@ public String toString(String field) {
 
     @Override
     public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws IOException {
+        if (!LTRSettings.isLTRPluginEnabled()) {
+            throw new IllegalStateException("LTR plugin is disabled. To enable update ltr.plugin.enabled to true");
+        }
+
         return query.createWeight(searcher, scoreMode, boost);
     }
 

diff --git a/src/main/java/com/o19s/es/ltr/feature/store/ScriptFeature.java b/src/main/java/com/o19s/es/ltr/feature/store/ScriptFeature.java
@@ -48,6 +48,7 @@
 import org.opensearch.core.xcontent.XContentParser;
 import org.opensearch.common.xcontent.XContentType;
 import org.opensearch.index.mapper.MappedFieldType;
+import org.opensearch.ltr.settings.LTRSettings;
 import org.opensearch.script.ScoreScript;
 import org.opensearch.script.Script;
 
@@ -287,6 +288,10 @@ public String toString(String field) {
 
         @Override
         public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws IOException {
+            if (!LTRSettings.isLTRPluginEnabled()) {
+                throw new IllegalStateException("LTR plugin is disabled. To enable update ltr.plugin.enabled to true");
+            }
+
             if (!scoreMode.needsScores()) {
                 return new MatchAllDocsQuery().createWeight(searcher, scoreMode, 1F);
             }

diff --git a/src/main/java/com/o19s/es/ltr/query/DerivedExpressionQuery.java b/src/main/java/com/o19s/es/ltr/query/DerivedExpressionQuery.java
@@ -38,6 +38,7 @@
 import org.apache.lucene.search.ConstantScoreWeight;
 import org.apache.lucene.search.ConstantScoreWeight;
 import org.apache.lucene.search.ConstantScoreWeight;
+import org.opensearch.ltr.settings.LTRSettings;
 
 
 import java.io.IOException;
@@ -102,6 +103,10 @@ public String toString(String field) {
 
         @Override
         public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws IOException {
+            if (!LTRSettings.isLTRPluginEnabled()) {
+                throw new IllegalStateException("LTR plugin is disabled. To enable update ltr.plugin.enabled to true");
+            }
+
             if (!scoreMode.needsScores()) {
                 // If scores are not needed simply return a constant score on all docs
                 return new ConstantScoreWeight(this.query, boost) {

diff --git a/src/main/java/com/o19s/es/ltr/query/RankerQuery.java b/src/main/java/com/o19s/es/ltr/query/RankerQuery.java
@@ -16,6 +16,7 @@
 
 package com.o19s.es.ltr.query;
 
+import org.opensearch.ltr.settings.LTRSettings;
 import com.o19s.es.ltr.LtrQueryContext;
 import com.o19s.es.ltr.feature.Feature;
 import com.o19s.es.ltr.feature.FeatureSet;
@@ -201,6 +202,10 @@ public FeatureSet featureSet() {
 
     @Override
     public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws IOException {
+        if (!LTRSettings.isLTRPluginEnabled()) {
+            throw new IllegalStateException("LTR plugin is disabled. To enable update ltr.plugin.enabled to true");
+        }
+
         if (!scoreMode.needsScores()) {
             // If scores are not needed simply return a constant score on all docs
             return new ConstantScoreWeight(this, boost) {

diff --git a/src/main/java/com/o19s/es/ltr/rest/RestAddFeatureToSet.java b/src/main/java/com/o19s/es/ltr/rest/RestAddFeatureToSet.java
@@ -16,6 +16,7 @@
 
 package com.o19s.es.ltr.rest;
 
+import org.opensearch.ltr.settings.LTRSettings;
 import com.o19s.es.ltr.action.AddFeaturesToSetAction.AddFeaturesToSetRequestBuilder;
 import com.o19s.es.ltr.feature.FeatureValidation;
 import com.o19s.es.ltr.feature.store.StoredFeature;
@@ -51,6 +52,10 @@ public List<Route> routes() {
 
     @Override
     protected RestChannelConsumer prepareRequest(RestRequest request, NodeClient client) throws IOException {
+        if (!LTRSettings.isLTRPluginEnabled()) {
+            throw new IllegalStateException("LTR plugin is disabled. To enable update ltr.plugin.enabled to true");
+        }
+
         String store = indexName(request);
 
         String setName = request.param("name");

diff --git a/src/main/java/com/o19s/es/ltr/rest/RestCreateModelFromSet.java b/src/main/java/com/o19s/es/ltr/rest/RestCreateModelFromSet.java
@@ -16,6 +16,7 @@
 
 package com.o19s.es.ltr.rest;
 
+import org.opensearch.ltr.settings.LTRSettings;
 import com.o19s.es.ltr.action.CreateModelFromSetAction;
 import com.o19s.es.ltr.action.CreateModelFromSetAction.CreateModelFromSetRequestBuilder;
 import com.o19s.es.ltr.feature.FeatureValidation;
@@ -55,6 +56,10 @@ public List<Route> routes() {
 
     @Override
     protected RestChannelConsumer prepareRequest(RestRequest request, NodeClient client) throws IOException {
+        if (!LTRSettings.isLTRPluginEnabled()) {
+            throw new IllegalStateException("LTR plugin is disabled. To enable update ltr.plugin.enabled to true");
+        }
+
         String store = indexName(request);
         Long expectedVersion = null;
         if (request.hasParam("version")) {

diff --git a/src/main/java/com/o19s/es/ltr/rest/RestFeatureManager.java b/src/main/java/com/o19s/es/ltr/rest/RestFeatureManager.java
@@ -26,6 +26,7 @@
 import org.opensearch.action.delete.DeleteResponse;
 import org.opensearch.action.get.GetResponse;
 import org.opensearch.client.node.NodeClient;
+import org.opensearch.ltr.settings.LTRSettings;
 import org.opensearch.rest.BytesRestResponse;
 import org.opensearch.rest.RestRequest;
 import org.opensearch.core.rest.RestStatus;
@@ -73,6 +74,10 @@ public List<Route> routes() {
 
     @Override
     protected RestChannelConsumer prepareRequest(RestRequest request, NodeClient client) throws IOException {
+        if (!LTRSettings.isLTRPluginEnabled()) {
+            throw new IllegalStateException("LTR plugin is disabled. To enable update ltr.plugin.enabled to true");
+        }
+
         String indexName = indexName(request);
         if (request.method() == RestRequest.Method.DELETE) {
             return delete(client, type, indexName, request);

diff --git a/src/main/java/com/o19s/es/ltr/rest/RestFeatureStoreCaches.java b/src/main/java/com/o19s/es/ltr/rest/RestFeatureStoreCaches.java
@@ -16,6 +16,7 @@
 
 package com.o19s.es.ltr.rest;
 
+import org.opensearch.ltr.settings.LTRSettings;
 import com.o19s.es.ltr.action.CachesStatsAction;
 import com.o19s.es.ltr.action.ClearCachesAction;
 import com.o19s.es.ltr.action.ClearCachesAction.ClearCachesNodesResponse;
@@ -61,6 +62,10 @@ public List<Route> routes() {
 
     @Override
     protected RestChannelConsumer prepareRequest(RestRequest request, NodeClient client) {
+        if (!LTRSettings.isLTRPluginEnabled()) {
+            throw new IllegalStateException("LTR plugin is disabled. To enable update ltr.plugin.enabled to true");
+        }
+
         if (request.method() == RestRequest.Method.POST) {
             return clearCache(request, client);
         } else {

diff --git a/src/main/java/com/o19s/es/ltr/rest/RestLTRStats.java b/src/main/java/com/o19s/es/ltr/rest/RestLTRStats.java
@@ -20,6 +20,7 @@
 import com.o19s.es.ltr.action.LTRStatsAction.LTRStatsNodesRequest;
 import com.o19s.es.ltr.stats.StatName;
 import org.opensearch.client.node.NodeClient;
+import org.opensearch.ltr.settings.LTRSettings;
 import org.opensearch.rest.BaseRestHandler;
 import org.opensearch.rest.RestRequest;
 import org.opensearch.rest.action.RestActions;
@@ -62,6 +63,10 @@ public List<Route> routes() {
     @Override
     protected RestChannelConsumer prepareRequest(RestRequest request, NodeClient client)
             throws IOException {
+        if (!LTRSettings.isLTRPluginEnabled()) {
+            throw new IllegalStateException("LTR plugin is disabled. To enable update ltr.plugin.enabled to true");
+        }
+
         LTRStatsNodesRequest ltrStatsRequest = getRequest(request);
         return (channel) -> client.execute(LTRStatsAction.INSTANCE,
                 ltrStatsRequest,

diff --git a/src/main/java/com/o19s/es/ltr/rest/RestSearchStoreElements.java b/src/main/java/com/o19s/es/ltr/rest/RestSearchStoreElements.java
@@ -18,6 +18,7 @@
 import com.o19s.es.ltr.feature.store.index.IndexFeatureStore;
 import org.opensearch.client.node.NodeClient;
 import org.opensearch.index.query.BoolQueryBuilder;
+import org.opensearch.ltr.settings.LTRSettings;
 import org.opensearch.rest.RestRequest;
 import org.opensearch.rest.action.RestStatusToXContentListener;
 
@@ -51,6 +52,10 @@ public List<Route> routes() {
 
     @Override
     protected RestChannelConsumer prepareRequest(RestRequest request, NodeClient client) {
+        if (!LTRSettings.isLTRPluginEnabled()) {
+            throw new IllegalStateException("LTR plugin is disabled. To enable update ltr.plugin.enabled to true");
+        }
+
         return search(client, type, indexName(request), request);
     }
 

diff --git a/src/main/java/com/o19s/es/ltr/rest/RestStoreManager.java b/src/main/java/com/o19s/es/ltr/rest/RestStoreManager.java
@@ -21,6 +21,7 @@
 import org.opensearch.action.admin.indices.exists.indices.IndicesExistsResponse;
 import org.opensearch.client.node.NodeClient;
 import org.opensearch.core.xcontent.XContentBuilder;
+import org.opensearch.ltr.settings.LTRSettings;
 import org.opensearch.rest.BytesRestResponse;
 import org.opensearch.rest.RestRequest;
 import org.opensearch.rest.RestResponse;
@@ -69,6 +70,10 @@ public List<Route> routes() {
      */
     @Override
     protected RestChannelConsumer prepareRequest(RestRequest request, NodeClient client) throws IOException {
+        if (!LTRSettings.isLTRPluginEnabled()) {
+            throw new IllegalStateException("LTR plugin is disabled. To enable update ltr.plugin.enabled to true");
+        }
+
         String indexName = indexName(request);
 
         if (request.method() == RestRequest.Method.PUT) {

diff --git a/src/main/java/com/o19s/es/termstat/TermStatQuery.java b/src/main/java/com/o19s/es/termstat/TermStatQuery.java
@@ -31,6 +31,7 @@
 import org.apache.lucene.search.Weight;
 import org.apache.lucene.search.Explanation;
 import org.apache.lucene.search.Scorer;
+import org.opensearch.ltr.settings.LTRSettings;
 
 import java.io.IOException;
 import java.util.HashMap;
@@ -89,6 +90,10 @@ public String toString(String field) {
     @Override
     public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)
             throws IOException {
+        if (!LTRSettings.isLTRPluginEnabled()) {
+            throw new IllegalStateException("LTR plugin is disabled. To enable update ltr.plugin.enabled to true");
+        }
+
         assert scoreMode.needsScores() : "Should not be used in filtering mode";
 
         return new TermStatWeight(searcher, this, terms, scoreMode, aggr, posAggr);

diff --git a/src/main/java/org/opensearch/ltr/breaker/LTRCircuitBreakerService.java b/src/main/java/org/opensearch/ltr/breaker/LTRCircuitBreakerService.java
@@ -17,6 +17,7 @@
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.opensearch.ltr.settings.LTRSettings;
 import org.opensearch.monitor.jvm.JvmService;
 
 import java.util.concurrent.ConcurrentHashMap;
@@ -79,6 +80,10 @@ public LTRCircuitBreakerService init() {
     }
 
     public Boolean isOpen() {
+        if (!LTRSettings.isLTRBreakerEnabled()) {
+            return false;
+        }
+
         for (CircuitBreaker breaker : breakers.values()) {
             if (breaker.isOpen()) {
                 return true;