Implemented filtering on the ISM eplain API

spi/src/main/kotlin/org.opensearch.indexmanagement.spi/indexstatemanagement/model/StateMetaData.kt

@@ -22,7 +22,8 @@ import org.opensearch.indexmanagement.spi.indexstatemanagement.model.ManagedInde
 import java.io.ByteArrayInputStream
 import java.nio.charset.StandardCharsets
 
-data class StateMetaData(
+data class
+StateMetaData(
     val name: String,
     val startTime: Long
 ) : Writeable, ToXContentFragment {

src/main/kotlin/org/opensearch/indexmanagement/indexstatemanagement/model/ExplainFilter.kt

@@ -0,0 +1,127 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package org.opensearch.indexmanagement.indexstatemanagement.model
+
+import org.opensearch.core.common.io.stream.StreamInput
+import org.opensearch.core.common.io.stream.StreamOutput
+import org.opensearch.core.common.io.stream.Writeable
+import org.opensearch.core.xcontent.XContentParser
+import org.opensearch.core.xcontent.XContentParser.Token
+import org.opensearch.core.xcontent.XContentParserUtils.ensureExpectedToken
+import org.opensearch.index.query.BoolQueryBuilder
+import org.opensearch.index.query.Operator
+import org.opensearch.index.query.QueryBuilders
+import org.opensearch.indexmanagement.indexstatemanagement.util.MANAGED_INDEX_POLICY_ID_FIELD
+import org.opensearch.indexmanagement.spi.indexstatemanagement.model.ManagedIndexMetaData
+import java.io.IOException
+
+data class ExplainFilter(
+    val policyID: String?,
+    val state: String?,
+    val actionType: String?,
+    val failed: Boolean?
+) : Writeable {
+
+    constructor() : this(
+        policyID = null,
+        state = null,
+        actionType = null,
+        failed = null
+    )
+
+    @Throws(IOException::class)
+    constructor(sin: StreamInput) : this(
+        policyID = sin.readOptionalString(),
+        state = sin.readOptionalString(),
+        actionType = sin.readOptionalString(),
+        failed = sin.readOptionalBoolean()
+    )
+
+    @Throws(IOException::class)
+    override fun writeTo(out: StreamOutput) {
+        out.writeOptionalString(policyID)
+        out.writeOptionalString(state)
+        out.writeOptionalString(actionType)
+        out.writeOptionalBoolean(failed)
+    }
+
+    fun convertToBoolQueryBuilder(): BoolQueryBuilder {
+        val boolQuery = QueryBuilders.boolQuery()
+
+        if (policyID != null) {
+            boolQuery.must(
+                QueryBuilders
+                    .queryStringQuery(policyID)
+                    .field(MANAGED_INDEX_POLICY_ID_FIELD)
+                    .defaultOperator(Operator.AND)
+            )
+        }
+
+        return boolQuery
+    }
+
+    fun validMetaData(metaData: ManagedIndexMetaData): Boolean {
+        var ok = true
+
+        val stateMetaData = metaData.stateMetaData
+        if (state != null && (stateMetaData == null || stateMetaData.name != state)) {
+            ok = false
+        }
+
+        val actionMetaData = metaData.actionMetaData
+        if (actionType != null && (actionMetaData == null || actionMetaData.name != actionType)) {
+            ok = false
+        }
+
+        if (failed != null && (actionMetaData == null || actionMetaData.failed != failed)) {
+            ok = false
+        }
+
+        return ok
+    }
+
+    companion object {
+        const val FILTER_FIELD = "filter"
+        const val POLICY_ID_FIELD = "policy_id"
+        const val STATE_FIELD = "state"
+        const val ACTION_FIELD = "action_type"
+        const val FAILED_FIELD = "failed"
+
+        @JvmStatic
+        @Throws(IOException::class)
+        fun parse(xcp: XContentParser): ExplainFilter {
+            var policyID: String? = null
+            var state: String? = null
+            var actionType: String? = null
+            var failed: Boolean? = null
+
+            ensureExpectedToken(Token.START_OBJECT, xcp.currentToken(), xcp)
+            while (xcp.nextToken() != Token.END_OBJECT) {
+                val fieldName = xcp.currentName()
+                xcp.nextToken()
+
+                when (fieldName) {
+                    FILTER_FIELD -> {
+                        ensureExpectedToken(Token.START_OBJECT, xcp.currentToken(), xcp)
+                        while (xcp.nextToken() != Token.END_OBJECT) {
+                            val filter = xcp.currentName()
+                            xcp.nextToken()
+
+                            when (filter) {
+                                POLICY_ID_FIELD -> policyID = xcp.text()
+                                STATE_FIELD -> state = xcp.text()
+                                ACTION_FIELD -> actionType = xcp.text()
+                                FAILED_FIELD -> failed = xcp.booleanValue()
+                            }
+                        }
+                    }
+                }
+            }
+
+            return ExplainFilter(policyID, state, actionType, failed)
+        }
+    }
+}

src/main/kotlin/org/opensearch/indexmanagement/indexstatemanagement/resthandler/RestExplainAction.kt

@@ -9,8 +9,11 @@
 import org.opensearch.client.node.NodeClient
 import org.opensearch.core.common.Strings
 import org.opensearch.common.logging.DeprecationLogger
+import org.opensearch.core.xcontent.XContentParser.Token
+import org.opensearch.core.xcontent.XContentParserUtils.ensureExpectedToken
 import org.opensearch.indexmanagement.IndexManagementPlugin.Companion.ISM_BASE_URI
 import org.opensearch.indexmanagement.IndexManagementPlugin.Companion.LEGACY_ISM_BASE_URI
+import org.opensearch.indexmanagement.indexstatemanagement.model.ExplainFilter
 import org.opensearch.indexmanagement.indexstatemanagement.transport.action.explain.ExplainAction
 import org.opensearch.indexmanagement.indexstatemanagement.transport.action.explain.ExplainRequest
 import org.opensearch.indexmanagement.indexstatemanagement.util.DEFAULT_EXPLAIN_VALIDATE_ACTION
@@ -28,6 +31,7 @@
 import org.opensearch.rest.RestHandler.Route
 import org.opensearch.rest.RestRequest
 import org.opensearch.rest.RestRequest.Method.GET
+import org.opensearch.rest.RestRequest.Method.POST
 import org.opensearch.rest.action.RestToXContentListener
 
 private val log = LogManager.getLogger(RestExplainAction::class.java)
@@ -52,6 +56,14 @@
             ReplacedRoute(
                 GET, "$EXPLAIN_BASE_URI/{index}",
                 GET, "$LEGACY_EXPLAIN_BASE_URI/{index}"
+            ),
+            ReplacedRoute(
+                POST, EXPLAIN_BASE_URI,
+                POST, LEGACY_EXPLAIN_BASE_URI
+            ),
+            ReplacedRoute(
+                POST, "$EXPLAIN_BASE_URI/{index}",
+                POST, "$LEGACY_EXPLAIN_BASE_URI/{index}"
             )
         )
     }
@@ -69,6 +81,14 @@
 
         val indexType = request.param(TYPE_PARAM_KEY, DEFAULT_INDEX_TYPE)
 
+        val explainFilter = if (request.method() == RestRequest.Method.POST) {
+            val xcp = request.contentParser()
+            ensureExpectedToken(Token.START_OBJECT, xcp.nextToken(), xcp)
+            ExplainFilter.parse(xcp)
+        } else {
+            ExplainFilter()
+        }
+
         val clusterManagerTimeout = parseClusterManagerTimeout(
             request, DeprecationLogger.getLogger(RestExplainAction::class.java), name
         )
@@ -78,6 +98,7 @@
             request.paramAsBoolean("local", false),
             clusterManagerTimeout,
             searchParams,
+            explainFilter,
             request.paramAsBoolean(SHOW_POLICY_QUERY_PARAM, DEFAULT_EXPLAIN_SHOW_POLICY),
             request.paramAsBoolean(SHOW_VALIDATE_ACTION, DEFAULT_EXPLAIN_VALIDATE_ACTION),
             indexType

src/main/kotlin/org/opensearch/indexmanagement/indexstatemanagement/transport/action/explain/ExplainRequest.kt

@@ -12,6 +12,7 @@ import org.opensearch.core.common.io.stream.StreamInput
 import org.opensearch.core.common.io.stream.StreamOutput
 import org.opensearch.common.unit.TimeValue
 import org.opensearch.indexmanagement.common.model.rest.SearchParams
+import org.opensearch.indexmanagement.indexstatemanagement.model.ExplainFilter
 import org.opensearch.indexmanagement.indexstatemanagement.util.DEFAULT_INDEX_TYPE
 import java.io.IOException
 
@@ -21,6 +22,7 @@ class ExplainRequest : ActionRequest {
     val local: Boolean
     val clusterManagerTimeout: TimeValue
     val searchParams: SearchParams
+    val explainFilter: ExplainFilter
     val showPolicy: Boolean
     val validateAction: Boolean
     val indexType: String
@@ -31,6 +33,7 @@ class ExplainRequest : ActionRequest {
         local: Boolean,
         clusterManagerTimeout: TimeValue,
         searchParams: SearchParams,
+        explainFilter: ExplainFilter,
         showPolicy: Boolean,
         validateAction: Boolean,
         indexType: String
@@ -39,6 +42,7 @@ class ExplainRequest : ActionRequest {
         this.local = local
         this.clusterManagerTimeout = clusterManagerTimeout
         this.searchParams = searchParams
+        this.explainFilter = explainFilter
         this.showPolicy = showPolicy
         this.validateAction = validateAction
         this.indexType = indexType
@@ -50,6 +54,7 @@ class ExplainRequest : ActionRequest {
         local = sin.readBoolean(),
         clusterManagerTimeout = sin.readTimeValue(),
         searchParams = SearchParams(sin),
+        explainFilter = ExplainFilter(sin),
         showPolicy = sin.readBoolean(),
         validateAction = sin.readBoolean(),
         indexType = sin.readString()
@@ -72,6 +77,7 @@ class ExplainRequest : ActionRequest {
         out.writeBoolean(local)
         out.writeTimeValue(clusterManagerTimeout)
         searchParams.writeTo(out)
+        explainFilter.writeTo(out)
         out.writeBoolean(showPolicy)
         out.writeBoolean(validateAction)
         out.writeString(indexType)

src/main/kotlin/org/opensearch/indexmanagement/indexstatemanagement/transport/action/explain/TransportExplainAction.kt

@@ -155,11 +155,11 @@
         private fun getSearchMetadataRequest(params: SearchParams, indexUUIDs: List<String>, searchSize: Int): SearchRequest {
             val sortBuilder = params.getSortBuilder()
 
-            val queryBuilder = QueryBuilders.boolQuery()
+            val queryBuilder = request.explainFilter.convertToBoolQueryBuilder()
                 .must(
                     QueryBuilders
                         .queryStringQuery(params.queryString)
-                        .defaultField(MANAGED_INDEX_NAME_KEYWORD_FIELD)
+                        .field(MANAGED_INDEX_NAME_KEYWORD_FIELD)
                         .defaultOperator(Operator.AND)
                 ).filter(QueryBuilders.termsQuery(MANAGED_INDEX_INDEX_UUID_FIELD, indexUUIDs))
 
@@ -291,8 +291,25 @@
                 mgetMetadataReq,
                 object : ActionListener<MultiGetResponse> {
                     override fun onResponse(response: MultiGetResponse) {
-                        val metadataMap: Map<ManagedIndexMetadataDocUUID, ManagedIndexMetadataMap?> =
+                        var metadataMap: Map<ManagedIndexMetadataDocUUID, ManagedIndexMetadataMap?> =
                             response.responses.associate { it.id to getMetadata(it.response)?.toMap() }
+
+                        metadataMap = metadataMap.filter { (_, value) ->
+                            var ok = false
+
+                            if (value != null) {
+                                val metaData = ManagedIndexMetaData.fromMap(value)
+                                ok = request.explainFilter.validMetaData(metaData)
+                                if (!ok) {
+                                    indexNames.remove(metaData.index)
+                                    indexNamesToUUIDs.remove(metaData.index)
+                                    totalManagedIndices--
+                                }
+                            }
+
+                            ok
+                        }
+
                         buildResponse(indexNamesToUUIDs, metadataMap, clusterStateIndexMetadatas, threadContext)
                     }
 

src/main/kotlin/org/opensearch/indexmanagement/indexstatemanagement/util/RestHandlerUtils.kt

@@ -39,6 +39,7 @@ const val MANAGED_INDEX_FIELD = "managed_index"
 const val MANAGED_INDEX_NAME_KEYWORD_FIELD = "$MANAGED_INDEX_FIELD.name.keyword"
 const val MANAGED_INDEX_INDEX_FIELD = "$MANAGED_INDEX_FIELD.index"
 const val MANAGED_INDEX_INDEX_UUID_FIELD = "$MANAGED_INDEX_FIELD.index_uuid"
+const val MANAGED_INDEX_POLICY_ID_FIELD = "$MANAGED_INDEX_FIELD.policy_id"
 
 const val DEFAULT_JOB_SORT_FIELD = MANAGED_INDEX_INDEX_FIELD
 const val DEFAULT_POLICY_SORT_FIELD = "policy.policy_id.keyword"

src/test/kotlin/org/opensearch/indexmanagement/indexstatemanagement/transport/action/explain/ExplainRequestTests.kt

@@ -9,6 +9,7 @@ import org.opensearch.common.io.stream.BytesStreamOutput
 import org.opensearch.core.common.io.stream.StreamInput
 import org.opensearch.common.unit.TimeValue
 import org.opensearch.indexmanagement.common.model.rest.SearchParams
+import org.opensearch.indexmanagement.indexstatemanagement.model.ExplainFilter
 import org.opensearch.indexmanagement.indexstatemanagement.util.DEFAULT_INDEX_TYPE
 import org.opensearch.test.OpenSearchTestCase
 
@@ -19,9 +20,10 @@ class ExplainRequestTests : OpenSearchTestCase() {
         val local = true
         val clusterManagerTimeout = TimeValue.timeValueSeconds(30)
         val params = SearchParams(0, 20, "sort-field", "asc", "*")
+        val filter = ExplainFilter()
         val showPolicy = false
         val showValidationResult = false
-        val req = ExplainRequest(indices, local, clusterManagerTimeout, params, showPolicy, showValidationResult, DEFAULT_INDEX_TYPE)
+        val req = ExplainRequest(indices, local, clusterManagerTimeout, params, filter, showPolicy, showValidationResult, DEFAULT_INDEX_TYPE)
 
         val out = BytesStreamOutput()
         req.writeTo(out)
@@ -36,9 +38,10 @@ class ExplainRequestTests : OpenSearchTestCase() {
         val local = true
         val clusterManagerTimeout = TimeValue.timeValueSeconds(30)
         val params = SearchParams(0, 20, "sort-field", "asc", "*")
+        val filter = ExplainFilter()
         val showPolicy = false
         val showValidationResult = false
-        val req = ExplainRequest(indices, local, clusterManagerTimeout, params, showPolicy, showValidationResult, "non-existent-index-type")
+        val req = ExplainRequest(indices, local, clusterManagerTimeout, params, filter, showPolicy, showValidationResult, "non-existent-index-type")
 
         val actualException: String? = req.validate()?.validationErrors()?.firstOrNull()
         val expectedException: String = ExplainRequest.MULTIPLE_INDICES_CUSTOM_INDEX_TYPE_ERROR