Clean up files

Signed-off-by: Andy Qin <[email protected]>

Author: q-andy

src/main/java/org/opensearch/neuralsearch/rest/RestNeuralStatsAction.java

@@ -81,8 +81,13 @@ public class RestNeuralStatsAction extends BaseRestHandler {
 
     private static final Set<String> RESPONSE_PARAMS = ImmutableSet.of("nodeId", "stat", INCLUDE_METADATA_PARAM, FLATTEN_PARAM);
 
-    public static boolean isValidParamString(String name) {
-        return name.matches(PARAM_REGEX) && name.length() < MAX_PARAM_LENGTH;
+    /**
+     * Validates a param string if its under the max length and matches simple string pattern
+     * @param param the string to validate
+     * @return whether it's valid
+     */
+    public static boolean isValidParamString(String param) {
+        return param.matches(PARAM_REGEX) && param.length() < MAX_PARAM_LENGTH;
     }
 
     private NeuralSearchSettingsAccessor settingsAccessor;
@@ -134,7 +139,7 @@ private NeuralStatsRequest createNeuralStatsRequest(RestRequest request) {
         return neuralStatsRequest;
     }
 
-    NeuralStatsInput createNeuralStatsInputFromRequestParams(RestRequest request) {
+    private NeuralStatsInput createNeuralStatsInputFromRequestParams(RestRequest request) {
         NeuralStatsInput neuralStatsInput = new NeuralStatsInput();
 
         // Parse specified nodes

src/main/java/org/opensearch/neuralsearch/stats/events/EventStatName.java

@@ -18,7 +18,7 @@
  */
 @Getter
 public enum EventStatName implements StatName {
-    TEXT_EMBEDDING_PROCESSOR_EXECUTIONS("text_embedding_executions", "processors.ingest", EventStatType.TIMESTAMPED_COUNTER);
+    TEXT_EMBEDDING_PROCESSOR_EXECUTIONS("text_embedding_executions", "processors.ingest", EventStatType.TIMESTAMPED_EVENT_COUNTER);
 
     private final String nameString;
     private final String path;
@@ -43,7 +43,7 @@ public enum EventStatName implements StatName {
         this.statType = statType;
 
         switch (statType) {
-            case EventStatType.TIMESTAMPED_COUNTER:
+            case EventStatType.TIMESTAMPED_EVENT_COUNTER:
                 eventStat = new TimestampedEventStat(this);
                 break;
         }

src/main/java/org/opensearch/neuralsearch/stats/events/EventStatType.java

@@ -12,7 +12,7 @@
  * Enum for different kinds of event stat types to track
  */
 public enum EventStatType implements StatType {
-    TIMESTAMPED_COUNTER;
+    TIMESTAMPED_EVENT_COUNTER;
 
     /**
      * Gets the name of the stat type, the enum name in lowercase

src/main/java/org/opensearch/neuralsearch/stats/events/EventStatsManager.java

@@ -72,7 +72,7 @@ public Map<EventStatName, TimestampedEventStatSnapshot> getTimestampedEventStatS
         // Filter stats based on passed in collection
         Map<EventStatName, TimestampedEventStatSnapshot> eventStatsDataMap = new HashMap<>();
         for (EventStatName statName : statsToRetrieve) {
-            if (statName.getStatType() == EventStatType.TIMESTAMPED_COUNTER) {
+            if (statName.getStatType() == EventStatType.TIMESTAMPED_EVENT_COUNTER) {
                 StatSnapshot<?> snapshot = statName.getEventStat().getStatSnapshot();
                 if (snapshot instanceof TimestampedEventStatSnapshot) {
                     // Get event data snapshot

src/main/java/org/opensearch/neuralsearch/stats/info/InfoStatName.java

@@ -19,8 +19,8 @@
 @Getter
 public enum InfoStatName implements StatName {
     // Cluster info
-    CLUSTER_VERSION("cluster_version", "", InfoStatType.SETTABLE_STRING),
-    TEXT_EMBEDDING_PROCESSORS("text_embedding_processors_in_pipelines", "processors.ingest", InfoStatType.INFO_COUNTABLE);
+    CLUSTER_VERSION("cluster_version", "", InfoStatType.INFO_STRING),
+    TEXT_EMBEDDING_PROCESSORS("text_embedding_processors_in_pipelines", "processors.ingest", InfoStatType.INFO_COUNTER);
 
     private final String nameString;
     private final String path;

src/main/java/org/opensearch/neuralsearch/stats/info/InfoStatType.java

@@ -12,9 +12,9 @@
  * Enum for different kinds of info stat types to track
  */
 public enum InfoStatType implements StatType {
-    INFO_COUNTABLE,
-    SETTABLE_STRING,
-    SETTABLE_BOOLEAN;
+    INFO_COUNTER,
+    INFO_STRING,
+    INFO_BOOLEAN;
 
     /**
      * Gets the name of the stat type, the enum name in lowercase

src/main/java/org/opensearch/neuralsearch/stats/info/InfoStatsManager.java

@@ -72,7 +72,7 @@ private Map<InfoStatName, CountableInfoStatSnapshot> getCountableStats() {
         // Initialize empty map with keys so stat names are visible in JSON even if the value is not counted
         Map<InfoStatName, CountableInfoStatSnapshot> countableInfoStats = new HashMap<>();
         for (InfoStatName stat : EnumSet.allOf(InfoStatName.class)) {
-            if (stat.getStatType() == InfoStatType.INFO_COUNTABLE) {
+            if (stat.getStatType() == InfoStatType.INFO_COUNTER) {
                 countableInfoStats.put(stat, new CountableInfoStatSnapshot(stat));
             }
         }
@@ -92,8 +92,8 @@ private Map<InfoStatName, SettableInfoStatSnapshot<?>> getSettableStats() {
         Map<InfoStatName, SettableInfoStatSnapshot<?>> settableInfoStats = new HashMap<>();
         for (InfoStatName statName : EnumSet.allOf(InfoStatName.class)) {
             switch (statName.getStatType()) {
-                case InfoStatType.SETTABLE_BOOLEAN -> settableInfoStats.put(statName, new SettableInfoStatSnapshot<Boolean>(statName));
-                case InfoStatType.SETTABLE_STRING -> settableInfoStats.put(statName, new SettableInfoStatSnapshot<String>(statName));
+                case InfoStatType.INFO_BOOLEAN -> settableInfoStats.put(statName, new SettableInfoStatSnapshot<Boolean>(statName));
+                case InfoStatType.INFO_STRING -> settableInfoStats.put(statName, new SettableInfoStatSnapshot<String>(statName));
             }
         }
 

src/test/java/org/opensearch/neuralsearch/rest/RestNeuralStatsActionIT.java

@@ -7,7 +7,12 @@
 import lombok.extern.log4j.Log4j2;
 import org.junit.After;
 import org.junit.Before;
+import org.opensearch.client.Request;
+import org.opensearch.client.Response;
+import org.opensearch.client.ResponseException;
+import org.opensearch.core.rest.RestStatus;
 import org.opensearch.neuralsearch.BaseNeuralSearchIT;
+import org.opensearch.neuralsearch.plugin.NeuralSearch;
 import org.opensearch.neuralsearch.settings.NeuralSearchSettings;
 import org.opensearch.neuralsearch.stats.common.StatSnapshot;
 import org.opensearch.neuralsearch.stats.info.InfoStatName;
@@ -57,6 +62,14 @@ public void tearDown() throws Exception {
         updateClusterSettings(NeuralSearchSettings.NEURAL_STATS_ENABLED.getKey(), false);
     }
 
+    public void test_statsDisabledIsForbidden() throws Exception {
+        updateClusterSettings("plugins.neural_search.stats_enabled", false);
+        Request request = new Request("GET", NeuralSearch.NEURAL_BASE_URI + "/stats");
+
+        ResponseException response = expectThrows(ResponseException.class, () -> client().performRequest(request));
+        assertEquals(RestStatus.FORBIDDEN, RestStatus.fromCode(response.getResponse().getStatusLine().getStatusCode()));
+    }
+
     public void test_textEmbedding() throws Exception {
         // Setup processors
         String modelId = uploadTextEmbeddingModel();
@@ -138,7 +151,7 @@ public void test_includeMetadata() throws Exception {
         String valueWithMetadata = ((Map<String, String>) clusterVersionStatMetadata).get(StatSnapshot.VALUE_FIELD);
 
         // Stat type metadata should match
-        assertEquals(InfoStatType.SETTABLE_STRING.getTypeString(), statType);
+        assertEquals(InfoStatType.INFO_STRING.getTypeString(), statType);
 
         // Fetch Without metadata
         params.put(RestNeuralStatsAction.INCLUDE_METADATA_PARAM, "false");