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

Jump to bottom
Merged
elasticsearchmachine merged 5 commits into from
Feb 7, 2025
Merged

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

elasticsearchmachine merged 5 commits into from
Feb 7, 2025

Conversation

@gmarouli
Copy link
Contributor

@gmarouli gmarouli commented Feb 7, 2025 •
edited
Loading

In this PR we improve the deprecation warning about configuring source in the mapping.

  • We reduce the size of the warning message so it looks better in kibana.
  • We keep the original message in the details.
  • We use an alias help url, so we can associate it with the guide when it's created.

@gmarouli gmarouli added >non-issue :Data Management/Indices APIs APIs to create and manage indices and templates :StorageEngine/Mapping The storage related side of mappings labels Feb 7, 2025
@gmarouli gmarouli requested a review from kkrik-es February 7, 2025 15:16
@elasticsearchmachine
Copy link
Collaborator

elasticsearchmachine commented Feb 7, 2025

Pinging @elastic/es-storage-engine (Team:StorageEngine)

@elasticsearchmachine
Copy link
Collaborator

elasticsearchmachine commented Feb 7, 2025

Pinging @elastic/es-data-management (Team:Data Management)

kkrik-es
kkrik-es reviewed Feb 7, 2025
View reviewed changes
server/src/main/java/org/elasticsearch/index/mapper/SourceFieldMapper.java Outdated
public static final String DEPRECATION_WARNING = "Configuring source mode in mappings is deprecated and will be removed "
public static final String DEPRECATION_WARNING = "Configuring source mode in mappings is deprecated.";

public static final String DEPRECATION_DETAILS = "Configuring source mode in mappings is deprecated and will be removed "
Copy link
Contributor

@kkrik-es kkrik-es Feb 7, 2025

Choose a reason for hiding this comment

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

Since this is used in many places, let's keep this as is and add DEPRECATION_WARNING_TITLE above.

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.

Good point! I adjusted it. I did not notice that this is also added a header warning.

gmarouli
gmarouli commented Feb 7, 2025
View reviewed changes
...eprecation/src/main/java/org/elasticsearch/xpack/deprecation/TemplateDeprecationChecker.java
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

@gmarouli gmarouli requested a review from kkrik-es February 7, 2025 15:33
kkrik-es
kkrik-es approved these changes Feb 7, 2025
View reviewed changes
Copy link
Contributor

@kkrik-es kkrik-es left a comment

Choose a reason for hiding this comment

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

Thanks Mary! @martijnvg fyi, no pressure on getting the migration guide in.

@gmarouli gmarouli added auto-merge-without-approval Automatically merge pull request when CI checks pass (NB doesn't wait for reviews!) v8.18.1 v8.19.0 v9.0.1 auto-backport Automatically create backport pull requests when merged labels Feb 7, 2025
@gmarouli gmarouli mentioned this pull request Feb 7, 2025
Closed
martijnvg
martijnvg approved these changes Feb 7, 2025
View reviewed changes
Copy link
Member

@martijnvg martijnvg left a comment

Choose a reason for hiding this comment

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

LGTM

@elasticsearchmachine elasticsearchmachine merged commit 1fe1055 into elastic:main Feb 7, 2025
17 checks passed
@gmarouli gmarouli deleted the fix-source-mapping-deprecation-warning branch February 7, 2025 17:55
@gmarouli gmarouli mentioned this pull request Feb 7, 2025
Merged
@elasticsearchmachine
Copy link
Collaborator

elasticsearchmachine commented Feb 7, 2025 •
edited by gmarouli
Loading

💚 Backport successful

Status Branch Result
✅ 8.18
✅ 8.x
✅ 9.0

You can use sqren/backport to manually backport by running backport --upstream elastic/elasticsearch --pr 122041

gmarouli added a commit to gmarouli/elasticsearch that referenced this pull request Feb 7, 2025
@gmarouli
[Deprecation API] Adjust details in the SourceFieldMapper deprecation…
40fb466 
… warning (elastic#122041)

In this PR we improve the deprecation warning about configuring source
in the mapping.

- We reduce the size of the warning message so it looks better in kibana.
- We keep the original message in the details.
- We use an alias help url, so we can associate it with the guide when it's created.
@gmarouli gmarouli removed the auto-merge-without-approval Automatically merge pull request when CI checks pass (NB doesn't wait for reviews!) label Feb 7, 2025
@gmarouli gmarouli mentioned this pull request Feb 7, 2025
Merged
elasticsearchmachine pushed a commit that referenced this pull request Feb 7, 2025
@gmarouli
[8.x] Adjust details in the SourceFieldMapper deprecation warning (#1…
a18856e 
…22083)

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

* Update test
elasticsearchmachine pushed a commit that referenced this pull request Feb 7, 2025
@gmarouli
[8.x] Adjust details in the SourceFieldMapper deprecation warning (#1…
eab1b3f 
…22083) (#122098)

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

* Update test
elasticsearchmachine pushed a commit that referenced this pull request Feb 7, 2025
@gmarouli
[9.0] [Deprecation API] Adjust details in the SourceFieldMapper depre…
a699e97 
…cation warning (#122041) (#122068)

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

In this PR we improve the deprecation warning about configuring source
in the mapping.

- We reduce the size of the warning message so it looks better in kibana.
- We keep the original message in the details.
- We use an alias help url, so we can associate it with the guide when it's created.

* Remove bwc code
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@martijnvg martijnvg martijnvg approved these changes

@kkrik-es kkrik-es kkrik-es approved these changes

Assignees

No one assigned

Labels

auto-backport Automatically create backport pull requests when merged :Data Management/Indices APIs APIs to create and manage indices and templates >non-issue :StorageEngine/Mapping The storage related side of mappings Team:Data Management Meta label for data/management team Team:StorageEngine v8.18.1 v8.19.0 v9.0.1 v9.1.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@gmarouli @elasticsearchmachine @martijnvg @kkrik-es