Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Deprecation check for classic similarity #36577

Merged
merged 6 commits into from Dec 18, 2018
Merged

Deprecation check for classic similarity #36577

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d6c6bb2
Deprecation check for classic similarity
gwbrown Dec 13, 2018
c0dc347
Merge branch '6.x' into depcheck/classic-similarity
gwbrown Dec 13, 2018
828b1ad
Merge branch '6.x' into depcheck/classic-similarity
gwbrown Dec 14, 2018
ea06bec
Add check for classic similarity in settings
gwbrown Dec 14, 2018
c2be013
Merge branch '6.x' into depcheck/classic-similarity
gwbrown Dec 14, 2018
788ab02
Merge branch '6.x' into depcheck/classic-similarity
gwbrown Dec 17, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion ...ugin/deprecation/src/main/java/org/elasticsearch/xpack/deprecation/DeprecationChecks.java
View file
Open in desktop
Expand Up @@ -54,7 +54,9 @@ private DeprecationChecks() {
IndexDeprecationChecks::percolatorUnmappedFieldsAsStringCheck,
IndexDeprecationChecks::indexNameCheck,
IndexDeprecationChecks::nodeLeftDelayedTimeCheck,
IndexDeprecationChecks::shardOnStartupCheck
IndexDeprecationChecks::shardOnStartupCheck,
IndexDeprecationChecks::classicSimilarityMappingCheck,
IndexDeprecationChecks::classicSimilaritySettingsCheck
));

/**
Expand Down
36 changes: 34 additions & 2 deletions ...deprecation/src/main/java/org/elasticsearch/xpack/deprecation/IndexDeprecationChecks.java
View file
Open in desktop
Expand Up @@ -24,6 +24,7 @@
import java.util.Map;
import java.util.function.BiConsumer;
import java.util.function.Function;
import java.util.stream.Collectors;

/**
* Index-specific deprecation checks
Expand Down Expand Up @@ -133,7 +134,38 @@ static DeprecationIssue percolatorUnmappedFieldsAsStringCheck(IndexMetaData inde
}
return null;
}


static DeprecationIssue classicSimilarityMappingCheck(IndexMetaData indexMetaData) {
List<String> issues = new ArrayList<>();
fieldLevelMappingIssue(indexMetaData, ((mappingMetaData, sourceAsMap) -> issues.addAll(
findInPropertiesRecursively(mappingMetaData.type(), sourceAsMap,
property -> "classic".equals(property.get("similarity"))))));
if (issues.size() > 0) {
return new DeprecationIssue(DeprecationIssue.Level.WARNING,
"Classic similarity has been removed",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/" +
"#_the_literal_classic_literal_similarity_has_been_removed",
"Fields which use classic similarity: " + issues.toString());
}
return null;
}

static DeprecationIssue classicSimilaritySettingsCheck(IndexMetaData indexMetaData) {
Map<String, Settings> similarities = indexMetaData.getSettings().getGroups("index.similarity");
List<String> classicSimilarities = similarities.entrySet().stream()
.filter(entry -> "classic".equals(entry.getValue().get("type")))
.map(Map.Entry::getKey)
.collect(Collectors.toList());
if (classicSimilarities.size() > 0) {
return new DeprecationIssue(DeprecationIssue.Level.WARNING,
"Classic similarity has been removed",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/" +
"#_the_literal_classic_literal_similarity_has_been_removed",
"Custom similarities defined using classic similarity: " + classicSimilarities.toString());
}
return null;
}

static DeprecationIssue nodeLeftDelayedTimeCheck(IndexMetaData indexMetaData) {
String setting = UnassignedInfo.INDEX_DELAYED_NODE_LEFT_TIMEOUT_SETTING.getKey();
String value = indexMetaData.getSettings().get(setting);
Expand All @@ -150,7 +182,7 @@ static DeprecationIssue nodeLeftDelayedTimeCheck(IndexMetaData indexMetaData) {
}
return null;
}

static DeprecationIssue shardOnStartupCheck(IndexMetaData indexMetaData) {
String setting = IndexSettings.INDEX_CHECK_ON_STARTUP.getKey();
String value = indexMetaData.getSettings().get(setting);
Expand Down
48 changes: 48 additions & 0 deletions ...cation/src/test/java/org/elasticsearch/xpack/deprecation/IndexDeprecationChecksTests.java
View file
Open in desktop
Expand Up @@ -15,6 +15,7 @@
import org.elasticsearch.xpack.core.deprecation.DeprecationInfoAction;
import org.elasticsearch.xpack.core.deprecation.DeprecationIssue;

import java.io.IOException;
import java.util.List;
import java.util.Locale;

Expand Down Expand Up @@ -109,6 +110,53 @@ public void testPercolatorUnmappedFieldsAsStringCheck() {
assertTrue(noIssues.isEmpty());
}

public void testClassicSimilarityMappingCheck() throws IOException {
String mappingJson = "{\n" +
" \"properties\": {\n" +
" \"default_field\": {\n" +
" \"type\": \"text\"\n" +
" },\n" +
" \"classic_sim_field\": {\n" +
" \"type\": \"text\",\n" +
" \"similarity\": \"classic\"\n" +
" }\n" +
" }\n" +
"}";
IndexMetaData index = IndexMetaData.builder(randomAlphaOfLengthBetween(5,10))
.settings(settings(
VersionUtils.randomVersionBetween(random(), Version.V_6_0_0, VersionUtils.getPreviousVersion(Version.CURRENT))))
.numberOfShards(randomIntBetween(1,100))
.numberOfReplicas(randomIntBetween(1, 100))
.putMapping("_doc", mappingJson)
.build();
DeprecationIssue expected = new DeprecationIssue(DeprecationIssue.Level.WARNING,
"Classic similarity has been removed",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/" +
"#_the_literal_classic_literal_similarity_has_been_removed",
"Fields which use classic similarity: [[type: _doc, field: classic_sim_field]]");
List<DeprecationIssue> issues = DeprecationChecks.filterChecks(INDEX_SETTINGS_CHECKS, c -> c.apply(index));
assertEquals(singletonList(expected), issues);
}

public void testClassicSimilaritySettingsCheck() {
IndexMetaData index = IndexMetaData.builder(randomAlphaOfLengthBetween(5, 10))
.settings(settings(
VersionUtils.randomVersionBetween(random(), Version.V_6_0_0, VersionUtils.getPreviousVersion(Version.CURRENT)))
.put("index.similarity.my_classic_similarity.type", "classic")
.put("index.similarity.my_okay_similarity.type", "BM25"))
.numberOfShards(randomIntBetween(1, 100))
.numberOfReplicas(randomIntBetween(1, 100))
.build();

DeprecationIssue expected = new DeprecationIssue(DeprecationIssue.Level.WARNING,
"Classic similarity has been removed",
"https://www.elastic.co/guide/en/elasticsearch/reference/master/" +
"#_the_literal_classic_literal_similarity_has_been_removed",
"Custom similarities defined using classic similarity: [my_classic_similarity]");
List<DeprecationIssue> issues = DeprecationChecks.filterChecks(INDEX_SETTINGS_CHECKS, c -> c.apply(index));
assertEquals(singletonList(expected), issues);
}

public void testNodeLeftDelayedTimeCheck() {
String negativeTimeValue = "-" + randomPositiveTimeValue();
String indexName = randomAlphaOfLengthBetween(0, 10);
Expand Down