deprecating jarowinkler in favor of jaro_winkler

Author: olcbean

core/src/main/java/org/elasticsearch/search/suggest/phrase/DirectCandidateGeneratorBuilder.java

@@ -474,7 +474,10 @@ static StringDistance resolveDistance(String distanceVal) {
             return new LevensteinDistance();
         } else if ("levenshtein".equals(distanceVal)) {
             return new LevensteinDistance();
-        } else if ("jaro_winkler".equals(distanceVal) || "jarowinkler".equals(distanceVal)) {
+        } else if ("jarowinkler".equals(distanceVal)) {
+            DEPRECATION_LOGGER.deprecated("Deprecated distance [jarowinkler] used, replaced by [jaro_winkler]");
+            return new JaroWinklerDistance();
+        } else if ("jaro_winkler".equals(distanceVal)) {
             return new JaroWinklerDistance();
         } else if ("ngram".equals(distanceVal)) {
             return new NGramDistance();

core/src/main/java/org/elasticsearch/search/suggest/term/TermSuggestionBuilder.java

@@ -595,8 +595,10 @@ public static StringDistanceImpl resolve(final String str) {
                     return LEVENSHTEIN;
                 case "ngram":
                     return NGRAM;
-                case "jaro_winkler":
                 case "jarowinkler":
+                    DEPRECATION_LOGGER.deprecated("Deprecated distance [jarowinkler] used, replaced by [jaro_winkler]");
+                    return JARO_WINKLER;
+                case "jaro_winkler":
                     return JARO_WINKLER;
                 default: throw new IllegalArgumentException("Illegal distance option " + str);
             }

core/src/test/java/org/elasticsearch/search/suggest/phrase/DirectCandidateGeneratorTests.java

@@ -77,7 +77,6 @@ public void testFromString() {
         assertThat(DirectCandidateGeneratorBuilder.resolveDistance("damerau_levenshtein"), instanceOf(LuceneLevenshteinDistance.class));
         assertThat(DirectCandidateGeneratorBuilder.resolveDistance("levenshtein"), instanceOf(LevensteinDistance.class));
         assertThat(DirectCandidateGeneratorBuilder.resolveDistance("jaro_winkler"), instanceOf(JaroWinklerDistance.class));
-        assertThat(DirectCandidateGeneratorBuilder.resolveDistance("jaroWinkler"), instanceOf(JaroWinklerDistance.class));
         assertThat(DirectCandidateGeneratorBuilder.resolveDistance("ngram"), instanceOf(NGramDistance.class));
 
         expectThrows(IllegalArgumentException.class, () -> DirectCandidateGeneratorBuilder.resolveDistance("doesnt_exist"));
@@ -89,6 +88,11 @@ public void testLevensteinDeprecation() {
         assertWarnings("Deprecated distance [levenstein] used, replaced by [levenshtein]");
     }
 
+    public void testJaroWinklerDeprecation() {
+        assertThat(DirectCandidateGeneratorBuilder.resolveDistance("jaroWinkler"), instanceOf(JaroWinklerDistance.class));
+        assertWarnings("Deprecated distance [jarowinkler] used, replaced by [jaro_winkler]");
+    }
+
     private static DirectCandidateGeneratorBuilder mutate(DirectCandidateGeneratorBuilder original) throws IOException {
         DirectCandidateGeneratorBuilder mutation = copy(original);
         List<Supplier<DirectCandidateGeneratorBuilder>> mutators = new ArrayList<>();
@@ -214,7 +218,7 @@ public static DirectCandidateGeneratorBuilder randomCandidateGenerator() {
         maybeSet(generator::size, randomIntBetween(1, 20));
         maybeSet(generator::sort, randomFrom("score", "frequency"));
         maybeSet(generator::stringDistance,
-                randomFrom("internal", "damerau_levenshtein", "levenshtein", "jaro_winkler", "jarowinkler", "ngram"));
+                randomFrom("internal", "damerau_levenshtein", "levenshtein", "jaro_winkler", "ngram"));
         maybeSet(generator::suggestMode, randomFrom("missing", "popular", "always"));
         return generator;
     }

core/src/test/java/org/elasticsearch/search/suggest/term/StringDistanceImplTests.java

@@ -49,7 +49,6 @@ public void testFromString() {
         assertThat(StringDistanceImpl.resolve("damerau_levenshtein"), equalTo(StringDistanceImpl.DAMERAU_LEVENSHTEIN));
         assertThat(StringDistanceImpl.resolve("levenshtein"), equalTo(StringDistanceImpl.LEVENSHTEIN));
         assertThat(StringDistanceImpl.resolve("jaro_winkler"), equalTo(StringDistanceImpl.JARO_WINKLER));
-        assertThat(StringDistanceImpl.resolve("jarowinkler"), equalTo(StringDistanceImpl.JARO_WINKLER));
         assertThat(StringDistanceImpl.resolve("ngram"), equalTo(StringDistanceImpl.NGRAM));
 
         final String doesntExist = "doesnt_exist";
@@ -64,6 +63,11 @@ public void testLevensteinDeprecation() {
         assertWarnings("Deprecated distance [levenstein] used, replaced by [levenshtein]");
     }
 
+    public void testJaroWinklerDeprecation() {
+        assertThat(StringDistanceImpl.resolve("jaroWinkler"), equalTo(StringDistanceImpl.JARO_WINKLER));
+        assertWarnings("Deprecated distance [jarowinkler] used, replaced by [jaro_winkler]");
+    }
+
     @Override
     public void testWriteTo() throws IOException {
         assertWriteToStream(StringDistanceImpl.INTERNAL, 0);