/
DistanceSearchSortBaseIT.java
450 lines (395 loc) · 17.9 KB
/
DistanceSearchSortBaseIT.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
/*
* Hibernate Search, full-text search for your domain model
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
*/
package org.hibernate.search.integrationtest.backend.tck.search.sort;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.hibernate.search.integrationtest.backend.tck.testsupport.types.values.AscendingUniqueDistanceFromCenterValues.CENTER_POINT;
import static org.hibernate.search.util.impl.integrationtest.common.assertion.SearchResultAssert.assertThatQuery;
import static org.hibernate.search.util.impl.integrationtest.mapper.stub.StubMapperUtils.documentProvider;
import static org.junit.Assume.assumeFalse;
import static org.junit.Assume.assumeTrue;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Set;
import java.util.function.Function;
import org.hibernate.search.engine.backend.common.DocumentReference;
import org.hibernate.search.engine.backend.document.model.dsl.IndexSchemaElement;
import org.hibernate.search.engine.backend.types.Sortable;
import org.hibernate.search.engine.search.common.SortMode;
import org.hibernate.search.engine.search.query.SearchQuery;
import org.hibernate.search.engine.search.sort.dsl.DistanceSortOptionsStep;
import org.hibernate.search.engine.search.sort.dsl.SearchSortFactory;
import org.hibernate.search.engine.spatial.GeoPoint;
import org.hibernate.search.integrationtest.backend.tck.testsupport.model.singlefield.SingleFieldIndexBinding;
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;
import org.hibernate.search.util.impl.integrationtest.mapper.stub.BulkIndexer;
import org.hibernate.search.util.impl.integrationtest.mapper.stub.SimpleMappedIndex;
import org.hibernate.search.util.impl.integrationtest.mapper.stub.StubMappingScope;
import org.hibernate.search.util.impl.test.annotation.TestForIssue;
import org.junit.BeforeClass;
import org.junit.ClassRule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
/**
* Tests basic behavior of sorts by distance.
*/
@RunWith(Parameterized.class)
public class DistanceSearchSortBaseIT {
private static final GeoPointFieldTypeDescriptor fieldType = GeoPointFieldTypeDescriptor.INSTANCE;
private static final Set<FieldTypeDescriptor<GeoPoint>> supportedFieldTypes = Collections.singleton( fieldType );
private static List<DataSet> dataSets;
@Parameterized.Parameters(name = "{0} - {2} - {1}")
public static Object[][] parameters() {
dataSets = new ArrayList<>();
List<Object[]> parameters = new ArrayList<>();
for ( TestedFieldStructure fieldStructure : TestedFieldStructure.all() ) {
// We need two separate datasets when the sort mode is not defined,
// because then the sort mode will be inferred automatically to
// MIN for desc order, or MAX for asc order.
DataSet dataSetForAsc = new DataSet( fieldStructure, null, SortMode.MIN );
dataSets.add( dataSetForAsc );
DataSet dataSetForDesc = new DataSet( fieldStructure, null, SortMode.MAX );
dataSets.add( dataSetForDesc );
parameters.add( new Object[] { fieldStructure, null, dataSetForAsc, dataSetForDesc } );
for ( SortMode sortMode : SortMode.values() ) {
// When the sort mode is defined, we only need one dataset.
dataSetForAsc = new DataSet( fieldStructure, sortMode, sortMode );
dataSets.add( dataSetForAsc );
dataSetForDesc = dataSetForAsc;
parameters.add( new Object[] { fieldStructure, sortMode, dataSetForAsc, dataSetForDesc } );
}
}
return parameters.toArray( new Object[0][] );
}
private static final int BEFORE_DOCUMENT_1_ORDINAL = 0;
private static final int DOCUMENT_1_ORDINAL = 1;
private static final int BETWEEN_DOCUMENT_1_AND_2_ORDINAL = 2;
private static final int DOCUMENT_2_ORDINAL = 3;
private static final int BETWEEN_DOCUMENT_2_AND_3_ORDINAL = 4;
private static final int DOCUMENT_3_ORDINAL = 5;
private static final int AFTER_DOCUMENT_3_ORDINAL = 6;
@ClassRule
public static SearchSetupHelper setupHelper = new SearchSetupHelper();
private static final Function<IndexSchemaElement, SingleFieldIndexBinding> bindingFactory =
root -> SingleFieldIndexBinding.create( root, supportedFieldTypes, c -> c.sortable( Sortable.YES ) );
private static final SimpleMappedIndex<SingleFieldIndexBinding> index = SimpleMappedIndex.of( bindingFactory );
@BeforeClass
public static void setup() {
setupHelper.start().withIndex( index ).setup();
BulkIndexer indexer = index.bulkIndexer();
for ( DataSet dataSet : dataSets ) {
dataSet.contribute( indexer );
}
indexer.join();
}
private final TestedFieldStructure fieldStructure;
private final SortMode sortMode;
private final DataSet dataSetForAsc;
private final DataSet dataSetForDesc;
public DistanceSearchSortBaseIT(TestedFieldStructure fieldStructure, SortMode sortMode,
DataSet dataSetForAsc, DataSet dataSetForDesc) {
this.fieldStructure = fieldStructure;
this.sortMode = sortMode;
this.dataSetForAsc = dataSetForAsc;
this.dataSetForDesc = dataSetForDesc;
}
@Test
public void simple() {
assumeTestParametersWork();
DataSet dataSet;
SearchQuery<DocumentReference> query;
String fieldPath = getFieldPath();
dataSet = dataSetForAsc;
query = simpleQuery( dataSet, b -> b.distance( fieldPath, CENTER_POINT ) );
assertThatQuery( query )
.hasDocRefHitsExactOrder( index.typeName(), dataSet.doc1Id, dataSet.doc2Id, dataSet.doc3Id, dataSet.emptyDoc1Id );
dataSet = dataSetForAsc;
query = simpleQuery(
dataSet,
b -> b.distance( fieldPath, CENTER_POINT.latitude(), CENTER_POINT.longitude() )
);
assertThatQuery( query )
.hasDocRefHitsExactOrder( index.typeName(), dataSet.doc1Id, dataSet.doc2Id, dataSet.doc3Id, dataSet.emptyDoc1Id );
dataSet = dataSetForAsc;
query = simpleQuery(
dataSet,
b -> b.distance( fieldPath, CENTER_POINT.latitude(), CENTER_POINT.longitude() )
.asc()
);
assertThatQuery( query )
.hasDocRefHitsExactOrder( index.typeName(), dataSet.doc1Id, dataSet.doc2Id, dataSet.doc3Id, dataSet.emptyDoc1Id );
dataSet = dataSetForDesc;
query = simpleQuery(
dataSet,
b -> b.distance( fieldPath, CENTER_POINT ).desc()
);
assertThatQuery( query )
.hasDocRefHitsExactOrder( index.typeName(), dataSet.emptyDoc1Id, dataSet.doc3Id, dataSet.doc2Id, dataSet.doc1Id );
dataSet = dataSetForDesc;
query = simpleQuery(
dataSet,
b -> b.distance( fieldPath, CENTER_POINT.latitude(), CENTER_POINT.longitude() )
.desc()
);
assertThatQuery( query )
.hasDocRefHitsExactOrder( index.typeName(), dataSet.emptyDoc1Id, dataSet.doc3Id, dataSet.doc2Id, dataSet.doc1Id );
}
@Test
public void missingValue_explicit() {
assumeTestParametersWork();
DataSet dataSet;
SearchQuery<DocumentReference> query;
String fieldPath = getFieldPath();
// Explicit order with missing().last()
dataSet = dataSetForAsc;
query = simpleQuery(
dataSet,
b -> b.distance( fieldPath, CENTER_POINT.latitude(), CENTER_POINT.longitude() )
.asc().missing().last()
);
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( "Invalid use of 'missing().last()' for a descending distance sort.",
"Elasticsearch always assumes missing values have a distance of '+Infinity', and this behavior cannot be customized." );
}
else {
dataSet = dataSetForDesc;
query = simpleQuery(
dataSet,
b -> b.distance( fieldPath, CENTER_POINT.latitude(), CENTER_POINT.longitude() )
.desc().missing().last()
);
assertThatQuery( query )
.hasDocRefHitsExactOrder( index.typeName(), dataSet.doc3Id, dataSet.doc2Id, dataSet.doc1Id, dataSet.emptyDoc1Id );
}
// Explicit order with missing().first()
dataSet = dataSetForDesc;
query = simpleQuery(
dataSet,
b -> b.distance( fieldPath, CENTER_POINT.latitude(), CENTER_POINT.longitude() )
.desc().missing().first()
);
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( "Invalid use of 'missing().first()' for an ascending distance sort.",
"Elasticsearch always assumes missing values have a distance of '+Infinity', and this behavior cannot be customized.");
}
else {
dataSet = dataSetForAsc;
query = simpleQuery(
dataSet,
b -> b.distance( fieldPath, CENTER_POINT.latitude(), CENTER_POINT.longitude() )
.asc().missing().first()
);
assertThatQuery( query )
.hasDocRefHitsExactOrder( index.typeName(), dataSet.emptyDoc1Id, dataSet.doc1Id, dataSet.doc2Id, dataSet.doc3Id );
}
// 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( "Invalid use of 'missing().use(...)' for a distance sort.",
"Elasticsearch always assumes missing values have a distance of '+Infinity', and this behavior cannot be customized.");
return;
}
// Backend supports missing().use( ... )
dataSet = dataSetForAsc;
query = simpleQuery(
dataSet,
b -> b.distance( fieldPath, CENTER_POINT.latitude(), CENTER_POINT.longitude() )
.asc().missing().use( getSingleValueForMissingUse( BEFORE_DOCUMENT_1_ORDINAL ) )
);
assertThatQuery( query )
.hasDocRefHitsExactOrder( index.typeName(), dataSet.emptyDoc1Id, dataSet.doc1Id, dataSet.doc2Id, dataSet.doc3Id );
dataSet = dataSetForAsc;
query = simpleQuery(
dataSet,
b -> b.distance( fieldPath, CENTER_POINT.latitude(), CENTER_POINT.longitude() )
.asc().missing().use( getSingleValueForMissingUse( BETWEEN_DOCUMENT_1_AND_2_ORDINAL ) )
);
assertThatQuery( query )
.hasDocRefHitsExactOrder( index.typeName(), dataSet.doc1Id, dataSet.emptyDoc1Id, dataSet.doc2Id, dataSet.doc3Id );
dataSet = dataSetForAsc;
query = simpleQuery(
dataSet,
b -> b.distance( fieldPath, CENTER_POINT.latitude(), CENTER_POINT.longitude() )
.asc().missing().use( getSingleValueForMissingUse( BETWEEN_DOCUMENT_2_AND_3_ORDINAL ) )
);
assertThatQuery( query )
.hasDocRefHitsExactOrder( index.typeName(), dataSet.doc1Id, dataSet.doc2Id, dataSet.emptyDoc1Id, dataSet.doc3Id );
dataSet = dataSetForAsc;
query = simpleQuery(
dataSet,
b -> b.distance( fieldPath, CENTER_POINT.latitude(), CENTER_POINT.longitude() )
.asc().missing().use( getSingleValueForMissingUse( AFTER_DOCUMENT_3_ORDINAL ) )
);
assertThatQuery( query )
.hasDocRefHitsExactOrder( index.typeName(), dataSet.doc1Id, dataSet.doc2Id, dataSet.doc3Id, dataSet.emptyDoc1Id );
}
@Test
@TestForIssue(jiraKey = { "HSEARCH-3103" })
public void medianWithNestedField() {
assumeTrue(
"This test is only relevant when using SortMode.MEDIAN in nested fields",
isMedianWithNestedField()
);
String fieldPath = getFieldPath();
assertThatThrownBy( () -> simpleQuery( dataSetForAsc, b -> b.distance( fieldPath, CENTER_POINT ) ) )
.isInstanceOf( SearchException.class )
.hasMessageContainingAll(
"Invalid sort mode: MEDIAN",
"This sort mode is not supported for fields in nested documents",
fieldPath
);
}
@Test
@TestForIssue(jiraKey = { "HSEARCH-3103" })
public void sum() {
assumeTrue(
"This test is only relevant when using SortMode.SUM",
isSum()
);
String fieldPath = getFieldPath();
assertThatThrownBy( () -> simpleQuery( dataSetForAsc, b -> b.distance( fieldPath, CENTER_POINT ) ) )
.isInstanceOf( SearchException.class )
.hasMessageContainingAll(
"Invalid sort mode: SUM. This sort mode is not supported for a distance sort",
"Only MIN, MAX, AVG and MEDIAN are supported",
fieldPath
);
}
private void assumeTestParametersWork() {
assumeFalse(
"This combination is not expected to work",
isMedianWithNestedField() || isSum()
);
}
private boolean isMedianWithNestedField() {
return SortMode.MEDIAN.equals( sortMode ) && fieldStructure.isInNested();
}
private boolean isSum() {
return SortMode.SUM.equals( sortMode );
}
private SearchQuery<DocumentReference> simpleQuery(DataSet dataSet,
Function<? super SearchSortFactory, ? extends DistanceSortOptionsStep<?, ?>> sortContributor) {
StubMappingScope scope = index.createScope();
return scope.query()
.where( f -> f.matchAll() )
.routing( dataSet.routingKey )
.sort( sortContributor.andThen( this::applySortMode ).andThen( this::applyFilter ) )
.toQuery();
}
private DistanceSortOptionsStep<?, ?> applySortMode(DistanceSortOptionsStep<?, ?> optionsStep) {
if ( sortMode != null ) {
return optionsStep.mode( sortMode );
}
else {
return optionsStep;
}
}
private DistanceSortOptionsStep<?, ?> applyFilter(DistanceSortOptionsStep<?, ?> optionsStep) {
if ( fieldStructure.isInNested() ) {
return optionsStep.filter( f -> f.match()
.field( index.binding().getDiscriminatorFieldPath( fieldStructure ) )
.matching( "included" ) );
}
else {
return optionsStep;
}
}
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;
private final String routingKey;
private final String doc1Id;
private final String doc2Id;
private final String doc3Id;
private final String emptyDoc1Id;
private DataSet(TestedFieldStructure fieldStructure, SortMode sortModeOrNull,
SortMode expectedSortMode) {
this.fieldStructure = fieldStructure;
this.expectedSortMode = expectedSortMode;
this.routingKey = fieldStructure.getUniqueName() + "_" + sortModeOrNull + "_" + expectedSortMode;
this.doc1Id = docId( 1 );
this.doc2Id = docId( 2 );
this.doc3Id = docId( 3 );
this.emptyDoc1Id = emptyDocId( 1 );
}
private String docId(int docNumber) {
return routingKey + "_doc_" + docNumber;
}
private String emptyDocId(int docNumber) {
return routingKey + "_emptyDoc_" + docNumber;
}
private void contribute(BulkIndexer indexer) {
if ( fieldStructure.isSingleValued() ) {
List<GeoPoint> values = AscendingUniqueDistanceFromCenterValues.INSTANCE.getSingle();
// Important: do not index the documents in the expected order after sorts (1, 2, 3)
indexer.add( documentProvider( doc2Id, routingKey,
document -> index.binding().initSingleValued( fieldType, fieldStructure.location,
document, values.get( DOCUMENT_2_ORDINAL ), values.get( DOCUMENT_3_ORDINAL ) ) ) );
indexer.add( documentProvider( doc1Id, routingKey,
document -> index.binding().initSingleValued( fieldType, fieldStructure.location,
document, values.get( DOCUMENT_1_ORDINAL ), values.get( DOCUMENT_2_ORDINAL ) ) ) );
indexer.add( documentProvider( doc3Id, routingKey,
document -> index.binding().initSingleValued( fieldType, fieldStructure.location,
document, values.get( DOCUMENT_3_ORDINAL ), values.get( DOCUMENT_1_ORDINAL ) ) ) );
indexer.add( documentProvider( emptyDoc1Id, routingKey,
document -> index.binding().initSingleValued( fieldType, fieldStructure.location,
document, null, null ) ) );
}
else {
List<List<GeoPoint>> values = AscendingUniqueDistanceFromCenterValues.INSTANCE
.getMultiResultingInSingle( expectedSortMode );
// Important: do not index the documents in the expected order after sorts (1, 2, 3)
indexer.add( documentProvider( doc2Id, routingKey,
document -> index.binding().initMultiValued( fieldType, fieldStructure.location,
document, values.get( DOCUMENT_2_ORDINAL ), values.get( DOCUMENT_3_ORDINAL ) ) ) );
indexer.add( documentProvider( doc1Id, routingKey,
document -> index.binding().initMultiValued( fieldType, fieldStructure.location,
document, values.get( DOCUMENT_1_ORDINAL ), values.get( DOCUMENT_2_ORDINAL ) ) ) );
indexer.add( documentProvider( doc3Id, routingKey,
document -> index.binding().initMultiValued( fieldType, fieldStructure.location,
document, values.get( DOCUMENT_3_ORDINAL ), values.get( DOCUMENT_1_ORDINAL ) ) ) );
indexer.add( documentProvider( emptyDoc1Id, routingKey,
document -> index.binding().initSingleValued( fieldType, fieldStructure.location,
document, null, null ) ) );
}
}
}
}