Skip to content

[Deprecation API] Adjust details in the SourceFieldMapper deprecation warning #122041

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

Merged
elasticsearchmachine merged 5 commits into from
Feb 7, 2025
Merged

[Deprecation API] Adjust details in the SourceFieldMapper deprecation warning #122041

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7ed7655
Adjust details in the SourceFieldMapper deprecation warning
gmarouli Feb 7, 2025
bb38010
Use an alias link to allow us to provide a proper guide soon.
gmarouli Feb 7, 2025
3a90357
Keep the deprecation warning and introduce a title.
gmarouli Feb 7, 2025
2f5affc
Use the correct warning
gmarouli Feb 7, 2025
3947328
Add bwc assertions until the backports are completed.
gmarouli Feb 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion ...-upgrade/src/javaRestTest/java/org/elasticsearch/upgrades/SourceModeRollingUpgradeIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ private void assertDeprecationWarningForTemplate(String templateName) throws IOE
Map<?, ?> issuesByTemplate = (Map<?, ?>) response.get("templates");
assertThat(issuesByTemplate.containsKey(templateName), equalTo(true));
var templateIssues = (List<?>) issuesByTemplate.get(templateName);
assertThat(((Map<?, ?>) templateIssues.getFirst()).get("message"), equalTo(SourceFieldMapper.DEPRECATION_WARNING));
assertThat(((Map<?, ?>) templateIssues.getFirst()).get("message"), equalTo(SourceFieldMapper.DEPRECATION_WARNING_TITLE));
assertThat(((Map<?, ?>) templateIssues.getFirst()).get("details"), equalTo(SourceFieldMapper.DEPRECATION_WARNING));
}
}
2 changes: 2 additions & 0 deletions server/src/main/java/org/elasticsearch/index/mapper/SourceFieldMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ public class SourceFieldMapper extends MetadataFieldMapper {

public static final String LOSSY_PARAMETERS_ALLOWED_SETTING_NAME = "index.lossy.source-mapping-parameters";

public static final String DEPRECATION_WARNING_TITLE = "Configuring source mode in mappings is deprecated.";

public static final String DEPRECATION_WARNING = "Configuring source mode in mappings is deprecated and will be removed "
+ "in future versions. Use [index.mapping.source.mode] index setting instead.";

Expand Down
4 changes: 2 additions & 2 deletions ...ecation/src/main/java/org/elasticsearch/xpack/deprecation/TemplateDeprecationChecker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,9 @@ private DeprecationIssue checkSourceModeInComponentTemplates(ComponentTemplate t
if (sourceMap.containsKey("mode")) {
return new DeprecationIssue(
DeprecationIssue.Level.CRITICAL,
SourceFieldMapper.DEPRECATION_WARNING_TITLE,
"https://ela.st/migrate-source-mode",
Copy link
Contributor Author

@gmarouli gmarouli Feb 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This for now points at #117172 but now we can update it when we have the guide, without having as much time pressure. Let me know if you do not agree with this approach.

Copy link
Member

@martijnvg martijnvg Feb 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Mary! We need to regenerate changelogs, because the change now shows up as deprecation instead of a breaking change: https://www.elastic.co/guide/en/elasticsearch/reference/master/migrating-9.0.html#deprecations_90_mapping

SourceFieldMapper.DEPRECATION_WARNING,
"https://github.com/elastic/elasticsearch/pull/117172",
null,
false,
null
);
Expand Down
4 changes: 2 additions & 2 deletions ...on/src/test/java/org/elasticsearch/xpack/deprecation/TemplateDeprecationCheckerTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,9 @@ public void testCheckSourceModeInComponentTemplates() throws IOException {
Map<String, List<DeprecationIssue>> issuesByComponentTemplate = checker.check(clusterState);
final DeprecationIssue expected = new DeprecationIssue(
DeprecationIssue.Level.CRITICAL,
SourceFieldMapper.DEPRECATION_WARNING_TITLE,
"https://ela.st/migrate-source-mode",
SourceFieldMapper.DEPRECATION_WARNING,
"https://github.com/elastic/elasticsearch/pull/117172",
null,
false,
null
);
Expand Down