Deprecation message for lenient Boolean parsing #137885

mamazzol · 2025-11-11T11:23:45Z

Wrapping user-facing usages of Boolean.parseBoolean in a util method to send a deprecation log.

elasticsearchmachine · 2025-11-11T11:24:24Z

Pinging @elastic/es-core-infra (Team:Core/Infra)

elasticsearchmachine · 2025-11-11T11:24:46Z

Hi @mamazzol, I've created a changelog YAML for you. Note that since this PR is labelled >deprecation, you need to update the changelog YAML to fill out the extended information sections.

elasticsearchmachine · 2025-11-11T13:02:06Z

Hi @mamazzol, I've updated the changelog YAML for you.

mosche

Thanks @mamazzol, a couple of points below.
That's a lot less places than I feared to see 😅 And I think some of these could actually be lenient for good.

server/src/main/java/org/elasticsearch/common/util/Booleans.java

modules/lang-mustache/src/main/java/org/elasticsearch/script/mustache/MustacheScriptEngine.java

modules/lang-painless/src/main/java/org/elasticsearch/painless/PainlessScriptEngine.java

modules/transport-netty4/src/main/java/org/elasticsearch/transport/netty4/NettyAllocator.java

server/src/main/java/org/elasticsearch/common/network/NetworkUtils.java

server/src/main/java/org/elasticsearch/common/util/Booleans.java

elasticsearchmachine · 2025-11-12T09:55:37Z

Hi @mamazzol, I've updated the changelog YAML for you. Note that since this PR is labelled >deprecation, you need to update the changelog YAML to fill out the extended information sections.

server/src/main/java/org/elasticsearch/search/SearchService.java

docs/changelog/137885.yaml

jdconrad

I left a couple comments on the scripting portion.

modules/lang-mustache/src/main/java/org/elasticsearch/script/mustache/MustacheScriptEngine.java

modules/lang-painless/src/main/java/org/elasticsearch/painless/PainlessScriptEngine.java

server/src/main/java/org/elasticsearch/index/store/LuceneFilesExtensions.java

server/src/main/java/org/elasticsearch/indices/analysis/wrappers/SettingsInvocationHandler.java

server/src/main/java/org/elasticsearch/common/util/LenientBooleans.java

server/src/main/java/org/elasticsearch/indices/analysis/wrappers/SettingsInvocationHandler.java

mosche · 2025-11-18T08:52:31Z

server/src/main/java/org/elasticsearch/index/store/LuceneFilesExtensions.java

-    @SuppressForbidden(
-        reason = "TODO Deprecate any lenient usage of Boolean#parseBoolean https://github.com/elastic/elasticsearch/issues/128993"
-    )
    private static boolean allowUnknownLuceneFileExtensions() {


@mamazzol I noticed this is only used in an assertion (and disabled in production), so we can make this one strict as well

mosche · 2025-11-18T09:08:03Z

server/src/main/java/org/elasticsearch/common/util/LenientBooleans.java

+    public static boolean parseAndCheckForDeprecatedUsage(String value, Category category, String name) {
+        if (Booleans.isBoolean(value) == false) {
+            String key = String.format(Locale.ROOT, "lenient.%s.%s", category, name);
+            deprecationLogger.warn(DeprecationCategory.PARSING, key, DEPRECATED_MESSAGE_TEMPLATE, value, category.displayValue(), name);


Two more points, level has to be critical (our default for deprecations) and we should also put the deprecation category on the signature. For SettingsInvocationHandler the category should be SETTINGS.

mosche

Thanks @mamazzol , lgtm.
As soon as the breaking change is approved, we can merge.

mosche · 2025-11-18T13:26:08Z

server/src/main/java/org/elasticsearch/common/util/LenientBooleans.java

     * Category of use of lenient Boolean parsing.
     */
-    public enum Category {
+    public enum UsageCategory {


just throwing it out as an option, looking at the latest change DeprecationCategory could also be a field of UsageCategory

Deprecation message for lenient Boolean parsing

87310d6

elastic#128993

mamazzol requested a review from a team as a code owner November 11, 2025 11:23

mamazzol added :Core/Infra/Logging Log management and logging utilities >deprecation labels Nov 11, 2025

elasticsearchmachine added v9.3.0 Team:Core/Infra Meta label for core/infra team labels Nov 11, 2025

Update docs/changelog/137885.yaml

2a168f7

Merge branch 'main' into lax-boolean

2f574be

mamazzol added >tech debt and removed >deprecation labels Nov 11, 2025

Update docs/changelog/137885.yaml

930ed45

mamazzol added 2 commits November 11, 2025 13:17

Update 137885.yaml

d03cbc3

Update 137885.yaml

2317d9c

mosche reviewed Nov 12, 2025

View reviewed changes

mosche added >deprecation and removed >tech debt labels Nov 12, 2025

Update docs/changelog/137885.yaml

0f80711

mosche reviewed Nov 12, 2025

View reviewed changes

server/src/main/java/org/elasticsearch/search/SearchService.java Show resolved Hide resolved

mosche reviewed Nov 12, 2025

View reviewed changes

docs/changelog/137885.yaml Outdated Show resolved Hide resolved

mamazzol added 4 commits November 12, 2025 16:36

Address review comments

a87a0c6

Merge branch 'main' into lax-boolean

573507d

Merge branch 'main' into lax-boolean

b630426

Merge branch 'main' into lax-boolean

6033740

jdconrad reviewed Nov 13, 2025

View reviewed changes

modules/lang-mustache/src/main/java/org/elasticsearch/script/mustache/MustacheScriptEngine.java Show resolved Hide resolved

modules/lang-painless/src/main/java/org/elasticsearch/painless/PainlessScriptEngine.java Outdated Show resolved Hide resolved

mosche reviewed Nov 14, 2025

View reviewed changes

server/src/main/java/org/elasticsearch/index/store/LuceneFilesExtensions.java Outdated Show resolved Hide resolved

mosche reviewed Nov 14, 2025

View reviewed changes

server/src/main/java/org/elasticsearch/indices/analysis/wrappers/SettingsInvocationHandler.java Outdated Show resolved Hide resolved

mamazzol added 2 commits November 14, 2025 10:38

Changed message and made some calls strict

6ac4a66

Merge branch 'main' into lax-boolean

e376e79

mosche reviewed Nov 14, 2025

View reviewed changes

server/src/main/java/org/elasticsearch/common/util/LenientBooleans.java Outdated Show resolved Hide resolved

mosche reviewed Nov 14, 2025

View reviewed changes

server/src/main/java/org/elasticsearch/indices/analysis/wrappers/SettingsInvocationHandler.java Outdated Show resolved Hide resolved

mamazzol added 4 commits November 14, 2025 14:45

Address review comments

89e270d

Merge branch 'main' into lax-boolean

d64d910

Merge branch 'main' into lax-boolean

6f5d02d

Merge branch 'main' into lax-boolean

5648ab7

mosche reviewed Nov 18, 2025

View reviewed changes

mamazzol added 2 commits November 18, 2025 11:31

Address review comments

199bd96

Merge branch 'main' into lax-boolean

8a420a3

mosche approved these changes Nov 18, 2025

View reviewed changes

mamazzol added 3 commits November 18, 2025 15:03

Merge branch 'main' into lax-boolean

1110fd8

Merge branch 'main' into lax-boolean

cc26284

Merge branch 'main' into lax-boolean

ccb8b73

mamazzol merged commit aedf9e3 into elastic:main Dec 1, 2025
34 checks passed

mamazzol deleted the lax-boolean branch December 1, 2025 17:15

Deprecation message for lenient Boolean parsing #137885

Deprecation message for lenient Boolean parsing #137885

Uh oh!

Conversation

mamazzol commented Nov 11, 2025

Uh oh!

elasticsearchmachine commented Nov 11, 2025

Uh oh!

elasticsearchmachine commented Nov 11, 2025

Uh oh!

elasticsearchmachine commented Nov 11, 2025

Uh oh!

mosche left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

elasticsearchmachine commented Nov 12, 2025

Uh oh!

Uh oh!

Uh oh!

jdconrad left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mosche Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

mosche Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

mosche left a comment

Choose a reason for hiding this comment

Uh oh!

mosche Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants