HSEARCH-3863 Test validation on missing options on ES sort

hibernate · Feb 8, 2021 · 4891b6b · 4891b6b
1 parent 10be35e
commit 4891b6b
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 0 deletions.
diff --git a/...tegrationtest/backend/elasticsearch/testsupport/util/ElasticsearchTckBackendFeatures.java b/...tegrationtest/backend/elasticsearch/testsupport/util/ElasticsearchTckBackendFeatures.java
@@ -132,4 +132,14 @@ public boolean supportsExistsForFieldWithoutDocValues(Class<?> fieldType) {
 		}
 		return true;
 	}
+
+	@Override
+	public boolean geoDistanceSortingSupportsConfigurableMissingValues() {
+		// See https://www.elastic.co/guide/en/elasticsearch/reference/7.10/sort-search-results.html
+		// In particular:
+		// geo distance sorting does not support configurable missing values:
+		// the distance will always be considered equal to Infinity when a document does not have values for the field
+		// that is used for distance computation.
+		return false;
+	}
 }
diff --git a/...rg/hibernate/search/integrationtest/backend/tck/search/sort/DistanceSearchSortBaseIT.java b/...rg/hibernate/search/integrationtest/backend/tck/search/sort/DistanceSearchSortBaseIT.java
@@ -31,6 +31,7 @@
 import org.hibernate.search.integrationtest.backend.tck.testsupport.types.FieldTypeDescriptor;
 import org.hibernate.search.integrationtest.backend.tck.testsupport.types.GeoPointFieldTypeDescriptor;
 import org.hibernate.search.integrationtest.backend.tck.testsupport.types.values.AscendingUniqueDistanceFromCenterValues;
+import org.hibernate.search.integrationtest.backend.tck.testsupport.util.TckConfiguration;
 import org.hibernate.search.integrationtest.backend.tck.testsupport.util.TestedFieldStructure;
 import org.hibernate.search.integrationtest.backend.tck.testsupport.util.rule.SearchSetupHelper;
 import org.hibernate.search.util.common.SearchException;
@@ -186,6 +187,16 @@ public void missingValue_explicit() {
 		assertThatQuery( query )
 				.hasDocRefHitsExactOrder( index.typeName(), dataSet.doc1Id, dataSet.doc2Id, dataSet.doc3Id, dataSet.emptyDoc1Id );
 
+		if ( !TckConfiguration.get().getBackendFeatures().geoDistanceSortingSupportsConfigurableMissingValues() ) {
+			assertThatThrownBy( () -> simpleQuery(
+					dataSetForDesc,
+					b -> b.distance( fieldPath, CENTER_POINT.latitude(), CENTER_POINT.longitude() )
+							.desc().missing().last()
+			) )
+					.isInstanceOf( SearchException.class )
+					.hasMessageContainingAll( "Missing last on sort with descending order is not supported." );
+		}
+
 		// Explicit order with missing().first()
 		dataSet = dataSetForDesc;
 		query = simpleQuery(
@@ -195,6 +206,27 @@ public void missingValue_explicit() {
 		);
 		assertThatQuery( query )
 				.hasDocRefHitsExactOrder( index.typeName(), dataSet.emptyDoc1Id, dataSet.doc3Id, dataSet.doc2Id, dataSet.doc1Id );
+
+		if ( !TckConfiguration.get().getBackendFeatures().geoDistanceSortingSupportsConfigurableMissingValues() ) {
+			assertThatThrownBy( () -> simpleQuery(
+					dataSetForAsc,
+					b -> b.distance( fieldPath, CENTER_POINT.latitude(), CENTER_POINT.longitude() )
+							.asc().missing().first()
+			) )
+					.isInstanceOf( SearchException.class )
+					.hasMessageContainingAll( "Missing first on sort with ascending order is not supported." );
+		}
+
+		// Explicit order with missing().use( ... )
+		if ( !TckConfiguration.get().getBackendFeatures().geoDistanceSortingSupportsConfigurableMissingValues() ) {
+			assertThatThrownBy( () -> simpleQuery(
+					dataSetForAsc,
+					b -> b.distance( fieldPath, CENTER_POINT.latitude(), CENTER_POINT.longitude() )
+							.asc().missing().use( getSingleValueForMissingUse( BEFORE_DOCUMENT_1_ORDINAL ) )
+			) )
+					.isInstanceOf( SearchException.class )
+					.hasMessageContainingAll( "Missing as on sort is not supported" );
+		}
 	}
 
 	@Test
@@ -284,6 +316,10 @@ private String getFieldPath() {
 		return index.binding().getFieldPath( fieldStructure, fieldType );
 	}
 
+	private GeoPoint getSingleValueForMissingUse(int ordinal) {
+		return AscendingUniqueDistanceFromCenterValues.INSTANCE.getSingle().get( ordinal );
+	}
+
 	private static class DataSet {
 		private final TestedFieldStructure fieldStructure;
 		private final SortMode expectedSortMode;

diff --git a/...org/hibernate/search/integrationtest/backend/tck/testsupport/util/TckBackendFeatures.java b/...org/hibernate/search/integrationtest/backend/tck/testsupport/util/TckBackendFeatures.java
@@ -74,4 +74,8 @@ public boolean supportsTruncateAfterForScroll() {
 	public boolean supportsExistsForFieldWithoutDocValues(Class<?> fieldType) {
 		return true;
 	}
+
+	public boolean geoDistanceSortingSupportsConfigurableMissingValues() {
+		return true;
+	}
 }