Skip to content

Commit 7e7c54d

Browse files
committed
Add deprecation log for delimited_payload_filter
1 parent 7704d34 commit 7e7c54d

File tree

4 files changed

+19
-5
lines changed

4 files changed

+19
-5
lines changed

core/src/main/java/org/elasticsearch/index/analysis/AnalysisRegistry.java

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727
import org.elasticsearch.common.logging.DeprecationLogger;
2828
import org.elasticsearch.common.logging.Loggers;
2929
import org.elasticsearch.common.settings.Settings;
30-
import org.elasticsearch.common.util.set.Sets;
3130
import org.elasticsearch.env.Environment;
3231
import org.elasticsearch.index.Index;
3332
import org.elasticsearch.index.IndexSettings;
@@ -42,7 +41,6 @@
4241
import java.util.HashMap;
4342
import java.util.Locale;
4443
import java.util.Map;
45-
import java.util.Set;
4644
import java.util.concurrent.ConcurrentHashMap;
4745
import java.util.stream.Collectors;
4846

@@ -53,6 +51,8 @@
5351
* This class exists per node and allows to create per-index {@link IndexAnalyzers} via {@link #build(IndexSettings)}
5452
*/
5553
public final class AnalysisRegistry implements Closeable {
54+
private static final DeprecationLogger DEPRECATION_LOGGER = new DeprecationLogger(Loggers.getLogger(AnalysisRegistry.class));
55+
5656
public static final String INDEX_ANALYSIS_CHAR_FILTER = "index.analysis.char_filter";
5757
public static final String INDEX_ANALYSIS_FILTER = "index.analysis.filter";
5858
public static final String INDEX_ANALYSIS_TOKENIZER = "index.analysis.tokenizer";
@@ -384,6 +384,9 @@ private <T> AnalysisProvider<T> getAnalysisProvider(Component component, Map<Str
384384
if (typeName == null) {
385385
throw new IllegalArgumentException(component + " [" + name + "] must specify either an analyzer type, or a tokenizer");
386386
}
387+
if ("delimited_payload_filter".equals(typeName)) {
388+
DEPRECATION_LOGGER.deprecated("Deprecated [delimited_payload_filter] used, replaced by [delimited_payload]");
389+
}
387390
AnalysisProvider<T> type = providerMap.get(typeName);
388391
if (type == null) {
389392
throw new IllegalArgumentException("Unknown " + component + " type [" + typeName + "] for [" + name + "]");
@@ -421,6 +424,9 @@ public AnalysisModule.AnalysisProvider<CharFilterFactory> getCharFilterFactory(S
421424
}
422425

423426
public AnalysisModule.AnalysisProvider<TokenFilterFactory> getTokenFilterFactory(String name) {
427+
if ("delimited_payload_filter".equals(name)) {
428+
DEPRECATION_LOGGER.deprecated("Deprecated [delimited_payload_filter] used, replaced by [delimited_payload]");
429+
}
424430
return preConfiguredTokenFilters.get(name);
425431
}
426432

modules/analysis-common/src/main/java/org/elasticsearch/analysis/common/CommonAnalysisPlugin.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,6 @@ public Map<String, AnalysisProvider<TokenFilterFactory>> getTokenFilters() {
103103
filters.put("czech_stem", CzechStemTokenFilterFactory::new);
104104
filters.put("common_grams", requriesAnalysisSettings(CommonGramsTokenFilterFactory::new));
105105
filters.put("decimal_digit", DecimalDigitFilterFactory::new);
106-
// TODO deprecate delimited_payload_filter
107106
filters.put("delimited_payload_filter", DelimitedPayloadTokenFilterFactory::new);
108107
filters.put("delimited_payload", DelimitedPayloadTokenFilterFactory::new);
109108
filters.put("dictionary_decompounder", requriesAnalysisSettings(DictionaryCompoundWordTokenFilterFactory::new));

modules/analysis-common/src/test/java/org/elasticsearch/analysis/common/CommonAnalysisFactoryTests.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,6 @@ protected Map<String, Class<?>> getPreConfiguredTokenFilters() {
169169
filters.put("common_grams", null);
170170
filters.put("czech_stem", null);
171171
filters.put("decimal_digit", null);
172-
// TODO deprecate delimited_payload_filter
173172
filters.put("delimited_payload_filter", org.apache.lucene.analysis.payloads.DelimitedPayloadTokenFilterFactory.class);
174173
filters.put("delimited_payload", org.apache.lucene.analysis.payloads.DelimitedPayloadTokenFilterFactory.class);
175174
filters.put("dutch_stem", SnowballPorterFilterFactory.class);

modules/analysis-common/src/test/resources/rest-api-spec/test/analysis-common/40_token_filters.yml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1026,9 +1026,15 @@
10261026
- match: { tokens.10.token: ちた }
10271027

10281028
---
1029-
# Deprecate delimited_payload_filter
10301029
"delimited_payload_filter":
1030+
- skip:
1031+
version: " - 6.99.99"
1032+
reason: delimited_payload_filter deprecated in 7.0, replaced by delimited_payload
1033+
features: "warnings"
1034+
10311035
- do:
1036+
warnings:
1037+
- "Deprecated [delimited_payload_filter] used, replaced by [delimited_payload]"
10321038
indices.create:
10331039
index: test
10341040
body:
@@ -1040,6 +1046,8 @@
10401046
delimiter: ^
10411047
encoding: identity
10421048
- do:
1049+
warnings:
1050+
- "Deprecated [delimited_payload_filter] used, replaced by [delimited_payload]"
10431051
indices.analyze:
10441052
index: test
10451053
body:
@@ -1051,6 +1059,8 @@
10511059

10521060
# Test pre-configured token filter too:
10531061
- do:
1062+
warnings:
1063+
- "Deprecated [delimited_payload_filter] used, replaced by [delimited_payload]"
10541064
indices.analyze:
10551065
body:
10561066
text: foo|5

0 commit comments

Comments
 (0)