Implemented filtering on the ISM eplain API #998
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| /* | ||
| * 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.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? = null, | ||
| val state: String? = null, | ||
| val actionType: String? = null, | ||
| val failed: Boolean? = null | ||
| ) : Writeable { | ||
|
|
||
| @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 byMetaData(metaData: ManagedIndexMetaData): Boolean { | ||
| var isValid = true | ||
|
|
||
| val stateMetaData = metaData.stateMetaData | ||
| if (state != null && (stateMetaData == null || stateMetaData.name != state)) { | ||
| isValid = false | ||
| } | ||
|
|
||
| val actionMetaData = metaData.actionMetaData | ||
| if (actionType != null && (actionMetaData == null || actionMetaData.name != actionType)) { | ||
| isValid = false | ||
| } | ||
|
|
||
| val retryInfoMetaData = metaData.policyRetryInfo | ||
| val actionFailedNotValid = actionMetaData == null || actionMetaData.failed != failed | ||
| val retryFailedNotValid = retryInfoMetaData == null || retryInfoMetaData.failed != failed | ||
| if (failed != null && actionFailedNotValid && retryFailedNotValid) { | ||
| isValid = false | ||
| } | ||
|
|
||
| return isValid | ||
| } | ||
|
|
||
| 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) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| fun BoolQueryBuilder.filterByPolicyID(explainFilter: ExplainFilter?): BoolQueryBuilder { | ||
| if (explainFilter?.policyID != null) { | ||
| this.filter(QueryBuilders.termsQuery(MANAGED_INDEX_POLICY_ID_FIELD, explainFilter.policyID)) | ||
| } | ||
|
|
||
| return this | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add unit tests for the codecov warning. Feel free to add in another PR
Let me know if you need any guidance on writing UTs