Deprecation message for lenient Boolean parsing (#137885)

* Deprecation message for lenient Boolean parsing

#128993

* Update docs/changelog/137885.yaml

* Update docs/changelog/137885.yaml

* Update 137885.yaml

* Update 137885.yaml

* Update docs/changelog/137885.yaml

* Address review comments

* Changed message and made some calls strict

* Address review comments

* Address review comments

Author: mamazzol

docs/changelog/137885.yaml

@@ -0,0 +1,11 @@
+pr: 137885
+summary: Add deprecation lenient booleans usage for analysis boolean setting (3rd party plugins) and boolean system properties.
+area: Infra/Logging
+type: deprecation
+issues:
+  - 128993
+deprecation:
+  title: Add deprecation lenient booleans usage for analysis boolean setting (3rd party plugins) and boolean system properties.
+  area: Logging
+  details: Usage of lenient booleans was deprecated for analysis boolean setting in external plugins using the stable plugin API and various boolean system properties.
+  impact: Usage of lenient booleans other than `true` or `false` will result in deprecations logs. Future releases of ES may only accept strict boolean values `true` or `false.

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

@@ -21,7 +21,7 @@
 import org.elasticsearch.common.text.SizeLimitingStringWriter;
 import org.elasticsearch.common.unit.ByteSizeValue;
 import org.elasticsearch.common.unit.MemorySizeValue;
-import org.elasticsearch.core.SuppressForbidden;
+import org.elasticsearch.core.Booleans;
 import org.elasticsearch.script.GeneralScriptException;
 import org.elasticsearch.script.Script;
 import org.elasticsearch.script.ScriptContext;
@@ -114,11 +114,8 @@ private static CustomMustacheFactory createMustacheFactory(Map<String, String> o
         return builder.build();
     }
 
-    @SuppressForbidden(
-        reason = "TODO Deprecate any lenient usage of Boolean#parseBoolean https://github.com/elastic/elasticsearch/issues/128993"
-    )
     private static boolean getDetectMissingParamsOption(Map<String, String> options) {
-        return Boolean.valueOf(options.get(DETECT_MISSING_PARAMS_OPTION));
+        return Booleans.parseBoolean(options.get(DETECT_MISSING_PARAMS_OPTION));
     }
 
     @Override

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

@@ -11,7 +11,7 @@
 
 import org.elasticsearch.SpecialPermission;
 import org.elasticsearch.common.settings.Settings;
-import org.elasticsearch.core.SuppressForbidden;
+import org.elasticsearch.core.Booleans;
 import org.elasticsearch.painless.Compiler.Loader;
 import org.elasticsearch.painless.lookup.PainlessLookup;
 import org.elasticsearch.painless.lookup.PainlessLookupBuilder;
@@ -415,7 +415,7 @@ private CompilerSettings buildCompilerSettings(Map<String, String> params) {
 
             value = copy.remove(CompilerSettings.PICKY);
             if (value != null) {
-                compilerSettings.setPicky(parseBoolean(value));
+                compilerSettings.setPicky(Booleans.parseBoolean(value));
             }
 
             value = copy.remove(CompilerSettings.INITIAL_CALL_SITE_DEPTH);
@@ -440,13 +440,6 @@ private CompilerSettings buildCompilerSettings(Map<String, String> params) {
         return compilerSettings;
     }
 
-    @SuppressForbidden(
-        reason = "TODO Deprecate any lenient usage of Boolean#parseBoolean https://github.com/elastic/elasticsearch/issues/128993"
-    )
-    private static boolean parseBoolean(String value) {
-        return Boolean.parseBoolean(value);
-    }
-
     private static ScriptException convertToScriptException(String scriptSource, Throwable t) {
         // create a script stack: this is just the script portion
         List<String> scriptStack = new ArrayList<>();

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

@@ -26,7 +26,6 @@
 import org.elasticsearch.common.util.PageCacheRecycler;
 import org.elasticsearch.core.Assertions;
 import org.elasticsearch.core.Booleans;
-import org.elasticsearch.core.SuppressForbidden;
 import org.elasticsearch.monitor.jvm.JvmInfo;
 
 import java.util.Arrays;
@@ -170,11 +169,8 @@ public int pageSize() {
         };
     }
 
-    @SuppressForbidden(
-        reason = "TODO Deprecate any lenient usage of Boolean#parseBoolean https://github.com/elastic/elasticsearch/issues/128993"
-    )
     private static boolean useG1GC() {
-        return Boolean.parseBoolean(JvmInfo.jvmInfo().useG1GC());
+        return Booleans.parseBooleanLenient(JvmInfo.jvmInfo().useG1GC(), false);
     }
 
     public static void logAllocatorDescriptionIfNeeded() {

server/src/main/java/org/elasticsearch/cluster/metadata/LifecycleExecutionState.java

@@ -11,7 +11,8 @@
 
 import org.elasticsearch.ElasticsearchException;
 import org.elasticsearch.common.Strings;
-import org.elasticsearch.core.SuppressForbidden;
+import org.elasticsearch.common.logging.DeprecationCategory;
+import org.elasticsearch.common.util.LenientBooleans;
 
 import java.util.Collections;
 import java.util.HashMap;
@@ -212,11 +213,13 @@ public static LifecycleExecutionState fromCustomMetadata(Map<String, String> cus
         return builder.build();
     }
 
-    @SuppressForbidden(
-        reason = "TODO Deprecate any lenient usage of Boolean#parseBoolean https://github.com/elastic/elasticsearch/issues/128993"
-    )
     private static boolean parseIsAutoRetryableError(String isAutoRetryableError) {
-        return Boolean.parseBoolean(isAutoRetryableError);
+        return LenientBooleans.parseAndCheckForDeprecatedUsage(
+            isAutoRetryableError,
+            LenientBooleans.UsageCategory.INDEX_METADATA,
+            IS_AUTO_RETRYABLE_ERROR,
+            DeprecationCategory.PARSING
+        );
     }
 
     /**

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

@@ -11,8 +11,8 @@
 
 import org.apache.lucene.util.BytesRef;
 import org.apache.lucene.util.Constants;
+import org.elasticsearch.core.Booleans;
 import org.elasticsearch.core.Predicates;
-import org.elasticsearch.core.SuppressForbidden;
 
 import java.io.IOException;
 import java.net.Inet4Address;
@@ -47,11 +47,8 @@ private NetworkUtils() {}
     @Deprecated
     static final boolean PREFER_V6 = preferIPv6Addresses();
 
-    @SuppressForbidden(
-        reason = "TODO Deprecate any lenient usage of Boolean#parseBoolean https://github.com/elastic/elasticsearch/issues/128993"
-    )
     private static boolean preferIPv6Addresses() {
-        return Boolean.parseBoolean(System.getProperty("java.net.preferIPv6Addresses", "false"));
+        return Booleans.parseBooleanLenient(System.getProperty("java.net.preferIPv6Addresses", "false"), false);
     }
 
     /**

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

@@ -0,0 +1,64 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the "Elastic License
+ * 2.0", the "GNU Affero General Public License v3.0 only", and the "Server Side
+ * Public License v 1"; you may not use this file except in compliance with, at
+ * your election, the "Elastic License 2.0", the "GNU Affero General Public
+ * License v3.0 only", or the "Server Side Public License, v 1".
+ */
+
+package org.elasticsearch.common.util;
+
+import org.elasticsearch.common.logging.DeprecationCategory;
+import org.elasticsearch.common.logging.DeprecationLogger;
+import org.elasticsearch.core.Booleans;
+import org.elasticsearch.core.SuppressForbidden;
+import org.elasticsearch.core.UpdateForV10;
+
+import java.util.Locale;
+
+import static org.elasticsearch.common.util.LenientBooleans.DeprecationLoggerHolder.deprecationLogger;
+
+@UpdateForV10(owner = UpdateForV10.Owner.CORE_INFRA)
+public class LenientBooleans {
+
+    /**
+     * Category of use of lenient Boolean parsing.
+     */
+    public enum UsageCategory {
+        SYSTEM_PROPERTY("system property"),
+        INDEX_METADATA("index metadata"),
+        SETTING("setting");
+
+        private final String displayValue;
+
+        UsageCategory(String displayValue) {
+            this.displayValue = displayValue;
+        }
+
+        public String displayValue() {
+            return displayValue;
+        }
+    }
+
+    private static final String DEPRECATED_MESSAGE_TEMPLATE = "Usage of lenient boolean value [{}] for {} [{}] was deprecated. "
+        + "Future releases of Elasticsearch may only accept `true` or `false`.";
+
+    static class DeprecationLoggerHolder {
+        static DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(LenientBooleans.class);
+    }
+
+    @SuppressForbidden(reason = "wrap lenient parsing of booleans for deprecation logging.")
+    public static boolean parseAndCheckForDeprecatedUsage(
+        String value,
+        UsageCategory usageCategory,
+        String name,
+        DeprecationCategory deprecationCategory
+    ) {
+        if (Booleans.isBoolean(value) == false) {
+            String key = String.format(Locale.ROOT, "lenient.%s.%s", usageCategory, name);
+            deprecationLogger.critical(deprecationCategory, key, DEPRECATED_MESSAGE_TEMPLATE, value, usageCategory.displayValue(), name);
+        }
+        return Boolean.parseBoolean(value);
+    }
+}

server/src/main/java/org/elasticsearch/index/codec/tsdb/es819/ES819TSDBDocValuesFormat.java

@@ -13,7 +13,8 @@
 import org.apache.lucene.codecs.DocValuesProducer;
 import org.apache.lucene.index.SegmentReadState;
 import org.apache.lucene.index.SegmentWriteState;
-import org.elasticsearch.core.SuppressForbidden;
+import org.elasticsearch.common.logging.DeprecationCategory;
+import org.elasticsearch.common.util.LenientBooleans;
 import org.elasticsearch.index.codec.tsdb.BinaryDVCompressionMode;
 
 import java.io.IOException;
@@ -111,11 +112,13 @@ public class ES819TSDBDocValuesFormat extends org.apache.lucene.codecs.DocValues
         OPTIMIZED_MERGE_ENABLE_DEFAULT = getOptimizedMergeEnabledDefault();
     }
 
-    @SuppressForbidden(
-        reason = "TODO Deprecate any lenient usage of Boolean#parseBoolean https://github.com/elastic/elasticsearch/issues/128993"
-    )
     private static boolean getOptimizedMergeEnabledDefault() {
-        return Boolean.parseBoolean(System.getProperty(OPTIMIZED_MERGE_ENABLED_NAME, Boolean.TRUE.toString()));
+        return LenientBooleans.parseAndCheckForDeprecatedUsage(
+            System.getProperty(OPTIMIZED_MERGE_ENABLED_NAME, Boolean.TRUE.toString()),
+            LenientBooleans.UsageCategory.SYSTEM_PROPERTY,
+            OPTIMIZED_MERGE_ENABLED_NAME,
+            DeprecationCategory.PARSING
+        );
     }
 
     /**

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

@@ -11,8 +11,8 @@
 
 import org.apache.lucene.index.IndexFileNames;
 import org.elasticsearch.common.util.Maps;
+import org.elasticsearch.core.Booleans;
 import org.elasticsearch.core.Nullable;
-import org.elasticsearch.core.SuppressForbidden;
 
 import java.util.Collections;
 import java.util.Map;
@@ -96,11 +96,8 @@ public enum LuceneFilesExtensions {
      * that checks that all encountered file extensions are known to this class.
      * In the future, we would like to add a proper plugin extension point for this.
      */
-    @SuppressForbidden(
-        reason = "TODO Deprecate any lenient usage of Boolean#parseBoolean https://github.com/elastic/elasticsearch/issues/128993"
-    )
     private static boolean allowUnknownLuceneFileExtensions() {
-        return Boolean.parseBoolean(System.getProperty("es.allow_unknown_lucene_file_extensions", "false"));
+        return Booleans.parseBoolean(System.getProperty("es.allow_unknown_lucene_file_extensions", "false"));
     }
 
     /**

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

@@ -11,8 +11,9 @@
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.elasticsearch.common.logging.DeprecationCategory;
 import org.elasticsearch.common.settings.Settings;
-import org.elasticsearch.core.SuppressForbidden;
+import org.elasticsearch.common.util.LenientBooleans;
 import org.elasticsearch.env.Environment;
 import org.elasticsearch.plugin.settings.BooleanSetting;
 import org.elasticsearch.plugin.settings.IntSetting;
@@ -47,9 +48,6 @@ public static <T> T create(Settings settings, Class<T> parameterType, Environmen
         );
     }
 
-    @SuppressForbidden(
-        reason = "TODO Deprecate any lenient usage of Boolean#parseBoolean https://github.com/elastic/elasticsearch/issues/128993"
-    )
     @Override
     public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
         assert method.getAnnotations().length == 1;
@@ -60,7 +58,16 @@ public Object invoke(Object proxy, Method method, Object[] args) throws Throwabl
         } else if (annotation instanceof LongSetting setting) {
             return getValue(Long::valueOf, setting.path(), setting.defaultValue());
         } else if (annotation instanceof BooleanSetting setting) {
-            return getValue(Boolean::valueOf, setting.path(), setting.defaultValue());
+            return getValue(
+                v -> LenientBooleans.parseAndCheckForDeprecatedUsage(
+                    v,
+                    LenientBooleans.UsageCategory.SETTING,
+                    setting.path(),
+                    DeprecationCategory.SETTINGS
+                ),
+                setting.path(),
+                setting.defaultValue()
+            );
         } else if (annotation instanceof StringSetting setting) {
             return getValue(String::valueOf, setting.path(), setting.defaultValue());
         } else if (annotation instanceof ListSetting setting) {