Skip to content

Commit

Permalink
Fix range queries on _type field for singe type indices (#31756) (#…
Browse files Browse the repository at this point in the history 
…32161)

With the introduction of single types in 6.x, the `_type` field is no longer
indexed, which leads to certain queries that were working before throw errors
now. One such query is the `range` query, that, if performed on a single typer
index, currently throws an IAE since the field is not indexed.
This change adds special treatment for this case in the TypeFieldMapper,
comparing the range queries lower and upper bound to the one existing type and
either returns a MatchAllDocs or a MatchNoDocs query.

Relates to #31632
Closes #31476
  • Loading branch information
Christoph Büscher authored Jul 23, 2018
1 parent 373cec0 commit 864711b
Show file tree
Hide file tree
Showing 3 changed files with 123 additions and 13 deletions.
37 changes: 37 additions & 0 deletions server/src/main/java/org/elasticsearch/index/mapper/TypeFieldMapper.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,10 @@
import org.apache.lucene.search.Query;
import org.apache.lucene.search.TermInSetQuery;
import org.apache.lucene.search.TermQuery;
import org.apache.lucene.search.TermRangeQuery;
import org.apache.lucene.util.BytesRef;
import org.elasticsearch.common.logging.DeprecationLogger;
import org.elasticsearch.common.logging.ESLoggerFactory;
import org.elasticsearch.common.lucene.Lucene;
import org.elasticsearch.common.lucene.search.Queries;
import org.elasticsearch.common.xcontent.XContentBuilder;
Expand Down Expand Up @@ -91,6 +94,8 @@ public MetadataFieldMapper getDefault(MappedFieldType fieldType, ParserContext c

static final class TypeFieldType extends StringFieldType {

private static final DeprecationLogger DEPRECATION_LOGGER = new DeprecationLogger(ESLoggerFactory.getLogger(TypeFieldType.class));

TypeFieldType() {
}

Expand Down Expand Up @@ -174,6 +179,38 @@ public Query termsQuery(List<?> values, QueryShardContext context) {
}
}

@Override
public Query rangeQuery(Object lowerTerm, Object upperTerm, boolean includeLower, boolean includeUpper, QueryShardContext context) {
if (context.getIndexSettings().isSingleType() == false) {
return new TermRangeQuery(name(), lowerTerm == null ? null : indexedValueForSearch(lowerTerm),
upperTerm == null ? null : indexedValueForSearch(upperTerm), includeLower, includeUpper);
} else {
// this means the index has a single type and the type field is implicit
DEPRECATION_LOGGER.deprecatedAndMaybeLog("range_single_type",
"Running [range] query on [_type] field for an index with a single type. As types are deprecated, this functionality will be removed in future releases.");
Collection<String> types = context.getMapperService().types();
String type = types.iterator().hasNext() ? types.iterator().next() : null;
if (type != null) {
Query result = new MatchAllDocsQuery();
BytesRef typeBytes = new BytesRef(type);
if (lowerTerm != null) {
int comp = indexedValueForSearch(lowerTerm).compareTo(typeBytes);
if (comp > 0 || (comp == 0 && includeLower == false)) {
result = new MatchNoDocsQuery("[_type] was lexicographically smaller than lower bound of range");
}
}
if (upperTerm != null) {
int comp = indexedValueForSearch(upperTerm).compareTo(typeBytes);
if (comp < 0 || (comp == 0 && includeUpper == false)) {
result = new MatchNoDocsQuery("[_type] was lexicographically greater than upper bound of range");
}
}
return result;
} else {
return new MatchNoDocsQuery();
}
}
}
}

/**
Expand Down
63 changes: 50 additions & 13 deletions server/src/test/java/org/elasticsearch/index/mapper/TypeFieldTypeTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,15 @@
import org.apache.lucene.search.PhraseQuery;
import org.apache.lucene.search.Query;
import org.apache.lucene.search.TermQuery;
import org.apache.lucene.search.TermRangeQuery;
import org.apache.lucene.store.Directory;
import org.apache.lucene.util.BytesRef;
import org.elasticsearch.core.internal.io.IOUtils;
import org.elasticsearch.Version;
import org.elasticsearch.cluster.metadata.IndexMetaData;
import org.elasticsearch.common.UUIDs;
import org.elasticsearch.common.lucene.search.Queries;
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.core.internal.io.IOUtils;
import org.elasticsearch.index.IndexSettings;
import org.elasticsearch.index.query.QueryShardContext;
import org.elasticsearch.test.VersionUtils;
Expand All @@ -51,15 +52,17 @@
import java.util.Collections;
import java.util.Set;

import static org.hamcrest.Matchers.instanceOf;

public class TypeFieldTypeTests extends FieldTypeTestCase {
@Override
protected MappedFieldType createDefaultFieldType() {
return new TypeFieldMapper.TypeFieldType();
}

public void testTermsQueryWhenTypesAreDisabled() throws Exception {
private QueryShardContext createMockContext(Version versionFrom, Version versionTo) {
QueryShardContext context = Mockito.mock(QueryShardContext.class);
Version indexVersionCreated = VersionUtils.randomVersionBetween(random(), Version.V_6_0_0, Version.CURRENT);
Version indexVersionCreated = VersionUtils.randomVersionBetween(random(), versionFrom, versionTo);
Settings indexSettings = Settings.builder()
.put(IndexMetaData.SETTING_VERSION_CREATED, indexVersionCreated)
.put(IndexMetaData.SETTING_NUMBER_OF_REPLICAS, 0)
Expand All @@ -70,6 +73,12 @@ public void testTermsQueryWhenTypesAreDisabled() throws Exception {
Mockito.when(context.getIndexSettings()).thenReturn(mockSettings);
Mockito.when(context.indexVersionCreated()).thenReturn(indexVersionCreated);

return context;
}

public void testTermsQueryWhenTypesAreDisabled() throws Exception {
QueryShardContext context = createMockContext(Version.V_6_0_0, Version.CURRENT);

MapperService mapperService = Mockito.mock(MapperService.class);
Set<String> types = Collections.emptySet();
Mockito.when(mapperService.types()).thenReturn(types);
Expand Down Expand Up @@ -100,16 +109,7 @@ public void testTermsQueryWhenTypesAreEnabled() throws Exception {
IndexWriter w = new IndexWriter(dir, newIndexWriterConfig());
IndexReader reader = openReaderWithNewType("my_type", w);

QueryShardContext context = Mockito.mock(QueryShardContext.class);
Settings indexSettings = Settings.builder()
.put(IndexMetaData.SETTING_VERSION_CREATED, Version.V_5_6_0) // to allow for multiple types
.put(IndexMetaData.SETTING_NUMBER_OF_REPLICAS, 0)
.put(IndexMetaData.SETTING_NUMBER_OF_SHARDS, 1)
.put(IndexMetaData.SETTING_INDEX_UUID, UUIDs.randomBase64UUID())
.build();
IndexMetaData indexMetaData = IndexMetaData.builder(IndexMetaData.INDEX_UUID_NA_VALUE).settings(indexSettings).build();
IndexSettings mockSettings = new IndexSettings(indexMetaData, Settings.EMPTY);
Mockito.when(context.getIndexSettings()).thenReturn(mockSettings);
QueryShardContext context = createMockContext(Version.V_5_6_0, Version.V_5_6_0); // to allow for multiple types

TypeFieldMapper.TypeFieldType ft = new TypeFieldMapper.TypeFieldType();
ft.setName(TypeFieldMapper.NAME);
Expand Down Expand Up @@ -166,6 +166,43 @@ public void testTermsQueryWhenTypesAreEnabled() throws Exception {
IOUtils.close(reader, w, dir);
}

public void testRangeWhenTypesAreDisabled() throws Exception {
QueryShardContext context = createMockContext(Version.V_6_0_0, Version.CURRENT);

MapperService mapperService = Mockito.mock(MapperService.class);
Set<String> types = Collections.emptySet();
Mockito.when(mapperService.types()).thenReturn(types);
Mockito.when(context.getMapperService()).thenReturn(mapperService);

TypeFieldMapper.TypeFieldType ft = new TypeFieldMapper.TypeFieldType();
ft.setName(TypeFieldMapper.NAME);
Query query = ft.rangeQuery("a_type", "z_type", randomBoolean(), randomBoolean(), context);
assertEquals(new MatchNoDocsQuery(), query);

types = Collections.singleton("my_type");
Mockito.when(mapperService.types()).thenReturn(types);
query = ft.rangeQuery("a_type", "z_type", randomBoolean(), randomBoolean(), context);
assertEquals(new MatchAllDocsQuery(), query);

query = ft.rangeQuery("n_type", "z_type", randomBoolean(), randomBoolean(), context);
assertEquals(new MatchNoDocsQuery(), query);

query = ft.rangeQuery("a_type", "l_type", randomBoolean(), randomBoolean(), context);
assertEquals(new MatchNoDocsQuery(), query);
assertWarnings("Running [range] query on [_type] field for an index with a single type. As types are deprecated, this "
+ "functionality will be removed in future releases.");
}

public void testRangeWhenTypesEnabled() throws Exception {
TypeFieldMapper.TypeFieldType ft = new TypeFieldMapper.TypeFieldType();
ft.setName(TypeFieldMapper.NAME);
String lowerTerm = randomBoolean() ? "a_type" : null;
String upperTerm = randomBoolean() ? "z_type" : null;
QueryShardContext context = createMockContext(Version.V_5_6_0, Version.V_5_6_0); // to allow for multiple types
Query query = ft.rangeQuery(lowerTerm, upperTerm, randomBoolean(), randomBoolean(), context);
assertThat(query, instanceOf(TermRangeQuery.class));
}

static DirectoryReader openReaderWithNewType(String type, IndexWriter writer) throws IOException {
Document doc = new Document();
StringField typeField = new StringField(TypeFieldMapper.NAME, type, Store.NO);
Expand Down
36 changes: 36 additions & 0 deletions server/src/test/java/org/elasticsearch/search/query/SearchQueryIT.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1858,4 +1858,40 @@ public void testRangeQueryRangeFields_24744() throws Exception {
SearchResponse searchResponse = client().prepareSearch("test").setQuery(range).get();
assertHitCount(searchResponse, 1);
}

public void testRangeQueryTypeField_31476() throws Exception {
assertAcked(prepareCreate("test").addMapping("foo", "field", "type=keyword"));

client().prepareIndex("test", "foo", "1").setSource("field", "value").get();
refresh();

RangeQueryBuilder range = new RangeQueryBuilder("_type").from("ape").to("zebra");
SearchResponse searchResponse = client().prepareSearch("test").setQuery(range).get();
assertHitCount(searchResponse, 1);

range = new RangeQueryBuilder("_type").from("monkey").to("zebra");
searchResponse = client().prepareSearch("test").setQuery(range).get();
assertHitCount(searchResponse, 0);

range = new RangeQueryBuilder("_type").from("ape").to("donkey");
searchResponse = client().prepareSearch("test").setQuery(range).get();
assertHitCount(searchResponse, 0);

range = new RangeQueryBuilder("_type").from("ape").to("foo").includeUpper(false);
searchResponse = client().prepareSearch("test").setQuery(range).get();
assertHitCount(searchResponse, 0);

range = new RangeQueryBuilder("_type").from("ape").to("foo").includeUpper(true);
searchResponse = client().prepareSearch("test").setQuery(range).get();
assertHitCount(searchResponse, 1);

range = new RangeQueryBuilder("_type").from("foo").to("zebra").includeLower(false);
searchResponse = client().prepareSearch("test").setQuery(range).get();
assertHitCount(searchResponse, 0);

range = new RangeQueryBuilder("_type").from("foo").to("zebra").includeLower(true);
searchResponse = client().prepareSearch("test").setQuery(range).get();
assertHitCount(searchResponse, 1);
}

}

0 comments on commit 864711b

Please sign in to comment.