forked from opensearch-project/OpenSearch
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add SortResponseProcessor to Search Pipelines (opensearch-project#14785)
* Add SortResponseProcessor for search pipelines Signed-off-by: Daniel Widdis <[email protected]> * Add stupid and unnecessary javadocs to satisfy overly strict CI Signed-off-by: Daniel Widdis <[email protected]> * Split casting and sorting methods for readability Signed-off-by: Daniel Widdis <[email protected]> * Register the sort processor factory Signed-off-by: Daniel Widdis <[email protected]> * Address code review comments Signed-off-by: Daniel Widdis <[email protected]> * Cast individual list elements to avoid creating two lists Signed-off-by: Daniel Widdis <[email protected]> * Add yamlRestTests Signed-off-by: Daniel Widdis <[email protected]> * Clarify why there's unusual sorting Signed-off-by: Daniel Widdis <[email protected]> * Use instanceof instead of isAssignableFrom Signed-off-by: Daniel Widdis <[email protected]> --------- Signed-off-by: Daniel Widdis <[email protected]>
- Loading branch information
Showing
7 changed files
with
596 additions
and
4 deletions.
There are no files selected for viewing
This file contains 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 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
209 changes: 209 additions & 0 deletions
209
...ine-common/src/main/java/org/opensearch/search/pipeline/common/SortResponseProcessor.java
This file contains 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,209 @@ | ||
| /* | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
|
|
||
| package org.opensearch.search.pipeline.common; | ||
|
|
||
| import org.opensearch.action.search.SearchRequest; | ||
| import org.opensearch.action.search.SearchResponse; | ||
| import org.opensearch.common.collect.Tuple; | ||
| import org.opensearch.common.document.DocumentField; | ||
| import org.opensearch.common.xcontent.XContentHelper; | ||
| import org.opensearch.core.common.bytes.BytesReference; | ||
| import org.opensearch.core.xcontent.MediaType; | ||
| import org.opensearch.core.xcontent.XContentBuilder; | ||
| import org.opensearch.ingest.ConfigurationUtils; | ||
| import org.opensearch.search.SearchHit; | ||
| import org.opensearch.search.pipeline.AbstractProcessor; | ||
| import org.opensearch.search.pipeline.Processor; | ||
| import org.opensearch.search.pipeline.SearchResponseProcessor; | ||
|
|
||
| import java.util.Comparator; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Objects; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| /** | ||
| * Processor that sorts an array of items. | ||
| * Throws exception is the specified field is not an array. | ||
| */ | ||
| public class SortResponseProcessor extends AbstractProcessor implements SearchResponseProcessor { | ||
| /** Key to reference this processor type from a search pipeline. */ | ||
| public static final String TYPE = "sort"; | ||
| /** Key defining the array field to be sorted. */ | ||
| public static final String SORT_FIELD = "field"; | ||
| /** Optional key defining the sort order. */ | ||
| public static final String SORT_ORDER = "order"; | ||
| /** Optional key to put the sorted values in a different field. */ | ||
| public static final String TARGET_FIELD = "target_field"; | ||
| /** Default sort order if not specified */ | ||
| public static final String DEFAULT_ORDER = "asc"; | ||
|
|
||
| /** Enum defining how elements will be sorted */ | ||
| public enum SortOrder { | ||
| /** Sort in ascending (natural) order */ | ||
| ASCENDING("asc"), | ||
| /** Sort in descending (reverse) order */ | ||
| DESCENDING("desc"); | ||
|
|
||
| private final String direction; | ||
|
|
||
| SortOrder(String direction) { | ||
| this.direction = direction; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return this.direction; | ||
| } | ||
|
|
||
| /** | ||
| * Converts the string representation of the enum value to the enum. | ||
| * @param value A string ("asc" or "desc") | ||
| * @return the corresponding enum value | ||
| */ | ||
| public static SortOrder fromString(String value) { | ||
| if (value == null) { | ||
| throw new IllegalArgumentException("Sort direction cannot be null"); | ||
| } | ||
|
|
||
| if (value.equals(ASCENDING.toString())) { | ||
| return ASCENDING; | ||
| } else if (value.equals(DESCENDING.toString())) { | ||
| return DESCENDING; | ||
| } | ||
| throw new IllegalArgumentException("Sort direction [" + value + "] not recognized." + " Valid values are: [asc, desc]"); | ||
| } | ||
| } | ||
|
|
||
| private final String sortField; | ||
| private final SortOrder sortOrder; | ||
| private final String targetField; | ||
|
|
||
| SortResponseProcessor( | ||
| String tag, | ||
| String description, | ||
| boolean ignoreFailure, | ||
| String sortField, | ||
| SortOrder sortOrder, | ||
| String targetField | ||
| ) { | ||
| super(tag, description, ignoreFailure); | ||
| this.sortField = Objects.requireNonNull(sortField); | ||
| this.sortOrder = Objects.requireNonNull(sortOrder); | ||
| this.targetField = targetField == null ? sortField : targetField; | ||
| } | ||
|
|
||
| /** | ||
| * Getter function for sortField | ||
| * @return sortField | ||
| */ | ||
| public String getSortField() { | ||
| return sortField; | ||
| } | ||
|
|
||
| /** | ||
| * Getter function for targetField | ||
| * @return targetField | ||
| */ | ||
| public String getTargetField() { | ||
| return targetField; | ||
| } | ||
|
|
||
| /** | ||
| * Getter function for sortOrder | ||
| * @return sortOrder | ||
| */ | ||
| public SortOrder getSortOrder() { | ||
| return sortOrder; | ||
| } | ||
|
|
||
| @Override | ||
| public String getType() { | ||
| return TYPE; | ||
| } | ||
|
|
||
| @Override | ||
| public SearchResponse processResponse(SearchRequest request, SearchResponse response) throws Exception { | ||
| SearchHit[] hits = response.getHits().getHits(); | ||
| for (SearchHit hit : hits) { | ||
| Map<String, DocumentField> fields = hit.getFields(); | ||
| if (fields.containsKey(sortField)) { | ||
| DocumentField docField = hit.getFields().get(sortField); | ||
| if (docField == null) { | ||
| throw new IllegalArgumentException("field [" + sortField + "] is null, cannot sort."); | ||
| } | ||
| hit.setDocumentField(targetField, new DocumentField(targetField, getSortedValues(docField.getValues()))); | ||
| } | ||
| if (hit.hasSource()) { | ||
| BytesReference sourceRef = hit.getSourceRef(); | ||
| Tuple<? extends MediaType, Map<String, Object>> typeAndSourceMap = XContentHelper.convertToMap( | ||
| sourceRef, | ||
| false, | ||
| (MediaType) null | ||
| ); | ||
|
|
||
| Map<String, Object> sourceAsMap = typeAndSourceMap.v2(); | ||
| if (sourceAsMap.containsKey(sortField)) { | ||
| Object val = sourceAsMap.get(sortField); | ||
| if (val instanceof List) { | ||
| @SuppressWarnings("unchecked") | ||
| List<Object> listVal = (List<Object>) val; | ||
| sourceAsMap.put(targetField, getSortedValues(listVal)); | ||
| } | ||
| XContentBuilder builder = XContentBuilder.builder(typeAndSourceMap.v1().xContent()); | ||
| builder.map(sourceAsMap); | ||
| hit.sourceRef(BytesReference.bytes(builder)); | ||
| } | ||
| } | ||
| } | ||
| return response; | ||
| } | ||
|
|
||
| private List<Object> getSortedValues(List<Object> values) { | ||
| return values.stream() | ||
| .map(this::downcastToComparable) | ||
| .sorted(sortOrder.equals(SortOrder.ASCENDING) ? Comparator.naturalOrder() : Comparator.reverseOrder()) | ||
| .collect(Collectors.toList()); | ||
| } | ||
|
|
||
| @SuppressWarnings("unchecked") | ||
| private Comparable<Object> downcastToComparable(Object obj) { | ||
| if (obj instanceof Comparable) { | ||
| return (Comparable<Object>) obj; | ||
| } else if (obj == null) { | ||
| throw new IllegalArgumentException("field [" + sortField + "] contains a null value.]"); | ||
| } else { | ||
| throw new IllegalArgumentException("field [" + sortField + "] of type [" + obj.getClass().getName() + "] is not comparable.]"); | ||
| } | ||
| } | ||
|
|
||
| static class Factory implements Processor.Factory<SearchResponseProcessor> { | ||
|
|
||
| @Override | ||
| public SortResponseProcessor create( | ||
| Map<String, Processor.Factory<SearchResponseProcessor>> processorFactories, | ||
| String tag, | ||
| String description, | ||
| boolean ignoreFailure, | ||
| Map<String, Object> config, | ||
| PipelineContext pipelineContext | ||
| ) { | ||
| String sortField = ConfigurationUtils.readStringProperty(TYPE, tag, config, SORT_FIELD); | ||
| String targetField = ConfigurationUtils.readStringProperty(TYPE, tag, config, TARGET_FIELD, sortField); | ||
| try { | ||
| SortOrder sortOrder = SortOrder.fromString( | ||
| ConfigurationUtils.readStringProperty(TYPE, tag, config, SORT_ORDER, DEFAULT_ORDER) | ||
| ); | ||
| return new SortResponseProcessor(tag, description, ignoreFailure, sortField, sortOrder, targetField); | ||
| } catch (IllegalArgumentException e) { | ||
| throw ConfigurationUtils.newConfigurationException(TYPE, tag, SORT_ORDER, e.getMessage()); | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains 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 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
Oops, something went wrong.