Use BiConsumer for customMetadata

felixbarny · felixbarny · commit fd161dcdf886 · 2025-08-22T06:40:05.000+02:00
diff --git a/modules/data-streams/src/main/java/org/elasticsearch/datastreams/DataStreamIndexSettingsProvider.java b/modules/data-streams/src/main/java/org/elasticsearch/datastreams/DataStreamIndexSettingsProvider.java
@@ -12,7 +12,6 @@
 import org.elasticsearch.cluster.metadata.IndexMetadata;
 import org.elasticsearch.cluster.metadata.ProjectMetadata;
 import org.elasticsearch.common.UUIDs;
-import org.elasticsearch.common.collect.ImmutableOpenMap;
 import org.elasticsearch.common.compress.CompressedXContent;
 import org.elasticsearch.common.settings.Settings;
 import org.elasticsearch.common.time.DateFormatter;
@@ -39,6 +38,7 @@
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;
+import java.util.function.BiConsumer;
 
 import static org.elasticsearch.cluster.metadata.IndexMetadata.INDEX_ROUTING_PATH;
 
@@ -66,7 +66,7 @@ public Settings getAdditionalIndexSettings(
         Instant resolvedAt,
         Settings indexTemplateAndCreateRequestSettings,
         List<CompressedXContent> combinedTemplateMappings,
-        ImmutableOpenMap.Builder<String, Map<String, String>> extraCustomMetadata
+        BiConsumer<String, Map<String, String>> extraCustomMetadata
     ) {
         if (dataStreamName != null) {
             DataStream dataStream = projectMetadata.dataStreams().get(dataStreamName);
diff --git a/modules/data-streams/src/main/java/org/elasticsearch/datastreams/action/TransportGetDataStreamsAction.java b/modules/data-streams/src/main/java/org/elasticsearch/datastreams/action/TransportGetDataStreamsAction.java
@@ -207,7 +207,7 @@ static IndexMode resolveMode(
                 Instant.now(),
                 settings,
                 List.of(),
-                ImmutableOpenMap.builder()
+                ImmutableOpenMap.builder()::put
             );
             var rawMode = addlSettinsg.get(IndexSettings.MODE.getKey());
             if (rawMode != null) {
diff --git a/modules/data-streams/src/test/java/org/elasticsearch/datastreams/DataStreamIndexSettingsProviderTests.java b/modules/data-streams/src/test/java/org/elasticsearch/datastreams/DataStreamIndexSettingsProviderTests.java
@@ -12,7 +12,6 @@
 import org.elasticsearch.cluster.metadata.DataStreamTestHelper;
 import org.elasticsearch.cluster.metadata.IndexMetadata;
 import org.elasticsearch.cluster.metadata.ProjectMetadata;
-import org.elasticsearch.common.collect.ImmutableOpenMap;
 import org.elasticsearch.common.compress.CompressedXContent;
 import org.elasticsearch.common.settings.Settings;
 import org.elasticsearch.core.Strings;
@@ -84,7 +83,7 @@ public void testGetAdditionalIndexSettings() throws Exception {
             now,
             settings,
             List.of(new CompressedXContent(mapping)),
-            ImmutableOpenMap.builder()
+            (k, v) -> {}
         );
         // The index.time_series.end_time setting requires index.mode to be set to time_series adding it here so that we read this setting:
         // (in production the index.mode setting is usually provided in an index or component template)
@@ -130,7 +129,7 @@ public void testGetAdditionalIndexSettingsIndexRoutingPathAlreadyDefined() throw
             now,
             settings,
             List.of(new CompressedXContent(mapping)),
-            ImmutableOpenMap.builder()
+            (k, v) -> {}
         );
         // The index.time_series.end_time setting requires index.mode to be set to time_series adding it here so that we read this setting:
         // (in production the index.mode setting is usually provided in an index or component template)
@@ -201,7 +200,7 @@ public void testGetAdditionalIndexSettingsMappingsMerging() throws Exception {
             now,
             settings,
             List.of(new CompressedXContent(mapping1), new CompressedXContent(mapping2), new CompressedXContent(mapping3)),
-            ImmutableOpenMap.builder()
+            (k, v) -> {}
         );
         // The index.time_series.end_time setting requires index.mode to be set to time_series adding it here so that we read this setting:
         // (in production the index.mode setting is usually provided in an index or component template)
@@ -227,7 +226,7 @@ public void testGetAdditionalIndexSettingsNoMappings() {
             now,
             settings,
             List.of(),
-            ImmutableOpenMap.builder()
+            (k, v) -> {}
         );
         // The index.time_series.end_time setting requires index.mode to be set to time_series adding it here so that we read this setting:
         // (in production the index.mode setting is usually provided in an index or component template)
@@ -253,7 +252,7 @@ public void testGetAdditionalIndexSettingsLookAheadTime() throws Exception {
             now,
             settings,
             List.of(new CompressedXContent("{}")),
-            ImmutableOpenMap.builder()
+            (k, v) -> {}
         );
         // The index.time_series.end_time setting requires index.mode to be set to time_series adding it here so that we read this setting:
         // (in production the index.mode setting is usually provided in an index or component template)
@@ -279,7 +278,7 @@ public void testGetAdditionalIndexSettingsLookBackTime() throws Exception {
             now,
             settings,
             List.of(new CompressedXContent("{}")),
-            ImmutableOpenMap.builder()
+            (k, v) -> {}
         );
         // The index.time_series.end_time setting requires index.mode to be set to time_series adding it here so that we read this setting:
         // (in production the index.mode setting is usually provided in an index or component template)
@@ -312,7 +311,7 @@ public void testGetAdditionalIndexSettingsDataStreamAlreadyCreated() throws Exce
             now,
             settings,
             List.of(new CompressedXContent("{}")),
-            ImmutableOpenMap.builder()
+            (k, v) -> {}
         );
         assertThat(result.size(), equalTo(2));
         assertThat(result.get(IndexSettings.TIME_SERIES_START_TIME.getKey()), equalTo(FORMATTER.format(currentEnd)));
@@ -350,7 +349,7 @@ public void testGetAdditionalIndexSettingsDataStreamAlreadyCreatedTimeSettingsMi
                 now,
                 settings,
                 null,
-                ImmutableOpenMap.builder()
+                (k, v) -> {}
             )
         );
         assertThat(
@@ -377,7 +376,7 @@ public void testGetAdditionalIndexSettingsNonTsdbTemplate() {
             Instant.ofEpochMilli(1L),
             settings,
             null,
-            ImmutableOpenMap.builder()
+            (k, v) -> {}
         );
         assertThat(result.size(), equalTo(0));
     }
@@ -400,7 +399,7 @@ public void testGetAdditionalIndexSettingsMigrateToTsdb() {
             now,
             settings,
             List.of(),
-            ImmutableOpenMap.builder()
+            (k, v) -> {}
         );
         // The index.time_series.end_time setting requires index.mode to be set to time_series adding it here so that we read this setting:
         // (in production the index.mode setting is usually provided in an index or component template)
@@ -431,7 +430,7 @@ public void testGetAdditionalIndexSettingsDowngradeFromTsdb() {
             Instant.ofEpochMilli(1L),
             settings,
             List.of(),
-            ImmutableOpenMap.builder()
+            (k, v) -> {}
         );
         assertThat(result.size(), equalTo(0));
     }
@@ -711,7 +710,7 @@ private Settings generateTsdbSettings(String mapping, Instant now) throws IOExce
             now,
             settings,
             List.of(new CompressedXContent(mapping)),
-            ImmutableOpenMap.builder()
+            (k, v) -> {}
         );
         // The index.time_series.end_time setting requires index.mode to be set to time_series adding it here so that we read this setting:
         // (in production the index.mode setting is usually provided in an index or component template)
diff --git a/modules/data-streams/src/test/java/org/elasticsearch/datastreams/action/TransportGetDataStreamsActionTests.java b/modules/data-streams/src/test/java/org/elasticsearch/datastreams/action/TransportGetDataStreamsActionTests.java
@@ -22,7 +22,6 @@
 import org.elasticsearch.cluster.metadata.IndexNameExpressionResolver;
 import org.elasticsearch.cluster.metadata.ProjectMetadata;
 import org.elasticsearch.cluster.metadata.Template;
-import org.elasticsearch.common.collect.ImmutableOpenMap;
 import org.elasticsearch.common.compress.CompressedXContent;
 import org.elasticsearch.common.settings.ClusterSettings;
 import org.elasticsearch.common.settings.Settings;
@@ -44,6 +43,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
+import java.util.function.BiConsumer;
 import java.util.stream.Collectors;
 
 import static org.elasticsearch.cluster.metadata.DataStream.getDefaultBackingIndexName;
@@ -503,7 +503,7 @@ public Settings getAdditionalIndexSettings(
                     Instant resolvedAt,
                     Settings indexTemplateAndCreateRequestSettings,
                     List<CompressedXContent> combinedTemplateMappings,
-                    ImmutableOpenMap.Builder<String, Map<String, String>> extraCustomMetadata
+                    BiConsumer<String, Map<String, String>> extraCustomMetadata
                 ) {
                     return Settings.builder().put("index.mode", IndexMode.LOOKUP).build();
                 }
diff --git a/server/src/main/java/org/elasticsearch/action/admin/indices/template/post/TransportSimulateIndexTemplateAction.java b/server/src/main/java/org/elasticsearch/action/admin/indices/template/post/TransportSimulateIndexTemplateAction.java
@@ -287,7 +287,7 @@ public static Template resolveTemplate(
                 now,
                 templateSettings,
                 mappings,
-                ImmutableOpenMap.builder()
+                ImmutableOpenMap.builder()::put
             );
             MetadataCreateIndexService.validateAdditionalSettings(provider, result, additionalSettings);
             dummySettings.put(result);
diff --git a/server/src/main/java/org/elasticsearch/cluster/metadata/MetadataCreateIndexService.java b/server/src/main/java/org/elasticsearch/cluster/metadata/MetadataCreateIndexService.java
@@ -1163,7 +1163,7 @@ static Settings aggregateIndexSettings(
                     resolvedAt,
                     templateAndRequestSettings,
                     combinedTemplateMappings,
-                    customMetadataBuilder
+                    customMetadataBuilder::put
                 );
                 validateAdditionalSettings(provider, newAdditionalSettings, additionalIndexSettings);
                 additionalIndexSettings.put(newAdditionalSettings);
diff --git a/server/src/main/java/org/elasticsearch/cluster/metadata/MetadataIndexTemplateService.java b/server/src/main/java/org/elasticsearch/cluster/metadata/MetadataIndexTemplateService.java
@@ -800,7 +800,7 @@ void validateIndexTemplateV2(ProjectMetadata projectMetadata, String name, Compo
                 now,
                 combinedSettings,
                 combinedMappings,
-                customMetadataBuilder
+                customMetadataBuilder::put
             );
             MetadataCreateIndexService.validateAdditionalSettings(provider, newAdditionalSettings, finalSettings);
             finalSettings.put(newAdditionalSettings);
diff --git a/server/src/main/java/org/elasticsearch/cluster/metadata/MetadataMappingService.java b/server/src/main/java/org/elasticsearch/cluster/metadata/MetadataMappingService.java
@@ -225,8 +225,10 @@ private ClusterState applyRequest(
                     indexMetadataBuilder.mappingVersion(1 + indexMetadataBuilder.mappingVersion())
                         .mappingsUpdatedVersion(IndexVersion.current());
                     for (IndexSettingProvider provider : indexSettingProviders.getIndexSettingProviders()) {
-                        Settings newAdditionalSettings = provider.onUpdateMappings(indexMetadata, customMetadataBuilder, docMapper);
-                        if (newAdditionalSettings.isEmpty() == false) {
+                        Settings.Builder newAdditionalSettingsBuilder = Settings.builder();
+                        provider.onUpdateMappings(indexMetadata, docMapper, newAdditionalSettingsBuilder, customMetadataBuilder::put);
+                        if (newAdditionalSettingsBuilder.keys().isEmpty() == false) {
+                            Settings newAdditionalSettings = newAdditionalSettingsBuilder.build();
                             MetadataCreateIndexService.validateAdditionalSettings(provider, newAdditionalSettings, additionalIndexSettings);
                             additionalIndexSettings.put(newAdditionalSettings);
                             updatedSettings = true;
diff --git a/server/src/main/java/org/elasticsearch/cluster/routing/allocation/DataTier.java b/server/src/main/java/org/elasticsearch/cluster/routing/allocation/DataTier.java
@@ -16,7 +16,6 @@
 import org.elasticsearch.cluster.node.DiscoveryNode;
 import org.elasticsearch.cluster.node.DiscoveryNodeRole;
 import org.elasticsearch.common.Strings;
-import org.elasticsearch.common.collect.ImmutableOpenMap;
 import org.elasticsearch.common.compress.CompressedXContent;
 import org.elasticsearch.common.settings.Setting;
 import org.elasticsearch.common.settings.Setting.Property;
@@ -34,6 +33,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
+import java.util.function.BiConsumer;
 import java.util.function.Function;
 
 /**
@@ -226,14 +226,14 @@ public static class DefaultHotAllocationSettingProvider implements IndexSettingP
 
         @Override
         public Settings getAdditionalIndexSettings(
-            String indexName,
-            @Nullable String dataStreamName,
-            IndexMode templateIndexMode,
-            ProjectMetadata projectMetadata,
-            Instant resolvedAt,
-            Settings indexTemplateAndCreateRequestSettings,
-            List<CompressedXContent> combinedTemplateMappings,
-            ImmutableOpenMap.Builder<String, Map<String, String>> extraCustomMetadata
+                String indexName,
+                @Nullable String dataStreamName,
+                IndexMode templateIndexMode,
+                ProjectMetadata projectMetadata,
+                Instant resolvedAt,
+                Settings indexTemplateAndCreateRequestSettings,
+                List<CompressedXContent> combinedTemplateMappings,
+                BiConsumer<String, Map<String, String>> extraCustomMetadata
         ) {
             Set<String> settings = indexTemplateAndCreateRequestSettings.keySet();
             if (settings.contains(TIER_PREFERENCE)) {
diff --git a/server/src/main/java/org/elasticsearch/common/settings/Settings.java b/server/src/main/java/org/elasticsearch/common/settings/Settings.java
@@ -1178,6 +1178,11 @@ public Builder putList(String setting, List<String> values) {
             return this;
         }
 
+        public <T> Builder put(Setting<T> setting, T value) {
+            map.put(setting.getKey(), value);
+            return this;
+        }
+
         /**
          * Sets all the provided settings including secure settings
          */
diff --git a/server/src/main/java/org/elasticsearch/index/IndexMode.java b/server/src/main/java/org/elasticsearch/index/IndexMode.java
@@ -14,7 +14,6 @@
 import org.elasticsearch.cluster.metadata.MetadataCreateDataStreamService;
 import org.elasticsearch.cluster.metadata.ProjectMetadata;
 import org.elasticsearch.cluster.routing.IndexRouting;
-import org.elasticsearch.common.collect.ImmutableOpenMap;
 import org.elasticsearch.common.compress.CompressedXContent;
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
@@ -47,6 +46,7 @@
 import java.util.Locale;
 import java.util.Map;
 import java.util.Objects;
+import java.util.function.BiConsumer;
 import java.util.function.BooleanSupplier;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
@@ -624,7 +624,7 @@ public Settings getAdditionalIndexSettings(
             Instant resolvedAt,
             Settings indexTemplateAndCreateRequestSettings,
             List<CompressedXContent> combinedTemplateMappings,
-            ImmutableOpenMap.Builder<String, Map<String, String>> extraCustomMetadata
+            BiConsumer<String, Map<String, String>> extraCustomMetadata
         ) {
             IndexMode indexMode = templateIndexMode;
             if (indexMode == null) {
diff --git a/server/src/main/java/org/elasticsearch/index/IndexSettingProvider.java b/server/src/main/java/org/elasticsearch/index/IndexSettingProvider.java
@@ -12,7 +12,6 @@
 import org.elasticsearch.cluster.metadata.IndexMetadata;
 import org.elasticsearch.cluster.metadata.ProjectMetadata;
 import org.elasticsearch.cluster.service.ClusterService;
-import org.elasticsearch.common.collect.ImmutableOpenMap;
 import org.elasticsearch.common.compress.CompressedXContent;
 import org.elasticsearch.common.settings.Settings;
 import org.elasticsearch.core.CheckedFunction;
@@ -24,6 +23,7 @@
 import java.time.Instant;
 import java.util.List;
 import java.util.Map;
+import java.util.function.BiConsumer;
 
 /**
  * An {@link IndexSettingProvider} is a provider for index level settings that can be set
@@ -54,7 +54,7 @@ default Settings getAdditionalIndexSettings(
         Instant resolvedAt,
         Settings indexTemplateAndCreateRequestSettings,
         List<CompressedXContent> combinedTemplateMappings,
-        ImmutableOpenMap.Builder<String, Map<String, String>> extraCustomMetadata
+        BiConsumer<String, Map<String, String>> extraCustomMetadata
     ) {
         return Settings.EMPTY;
     }
@@ -63,18 +63,16 @@ default Settings getAdditionalIndexSettings(
      * Called when the mappings for an index are updated, before the new index metadata is created.
      * This method can be used to update index settings based on the new mappings.
      *
-     * @param indexMetadata        the index metadata for the index being updated
-     * @param extraCustomMetadata  a builder for custom metadata that can be used to add custom index metadata
-     * @param documentMapper       the document mapper containing the updated mappings
-     * @return additional settings to be applied to the index or {@link Settings#EMPTY} if no additional settings are needed
+     * @param indexMetadata          the index metadata for the index being updated
+     * @param customMetadataConsumer allows to apply additional custom index metadata
+     * @param documentMapper         the document mapper containing the updated mappings
      */
-    default Settings onUpdateMappings(
+    default void onUpdateMappings(
         IndexMetadata indexMetadata,
-        ImmutableOpenMap.Builder<String, Map<String, String>> extraCustomMetadata,
-        DocumentMapper documentMapper
-    ) {
-        return Settings.EMPTY;
-    }
+        DocumentMapper documentMapper,
+        Settings.Builder additionalSettings,
+        BiConsumer<String, Map<String, String>> customMetadataConsumer
+    ) {}
 
     /**
      * Infrastructure class that holds services that can be used by {@link IndexSettingProvider} instances.
diff --git a/server/src/test/java/org/elasticsearch/action/admin/indices/template/post/TransportSimulateIndexTemplateActionTests.java b/server/src/test/java/org/elasticsearch/action/admin/indices/template/post/TransportSimulateIndexTemplateActionTests.java
@@ -13,7 +13,6 @@
 import org.elasticsearch.cluster.metadata.IndexMetadata;
 import org.elasticsearch.cluster.metadata.ProjectMetadata;
 import org.elasticsearch.cluster.metadata.Template;
-import org.elasticsearch.common.collect.ImmutableOpenMap;
 import org.elasticsearch.common.compress.CompressedXContent;
 import org.elasticsearch.common.settings.Settings;
 import org.elasticsearch.index.IndexMode;
@@ -26,6 +25,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
+import java.util.function.BiConsumer;
 
 import static org.hamcrest.CoreMatchers.is;
 import static org.mockito.ArgumentMatchers.any;
@@ -71,7 +71,7 @@ public Settings getAdditionalIndexSettings(
                 Instant resolvedAt,
                 Settings allSettings,
                 List<CompressedXContent> combinedTemplateMappings,
-                ImmutableOpenMap.Builder<String, Map<String, String>> extraCustomMetadata
+                BiConsumer<String, Map<String, String>> extraCustomMetadata
             ) {
                 return Settings.builder().put("test-setting", 0).build();
             }
@@ -85,7 +85,7 @@ public Settings getAdditionalIndexSettings(
                 Instant resolvedAt,
                 Settings indexTemplateAndCreateRequestSettings,
                 List<CompressedXContent> combinedTemplateMappings,
-                ImmutableOpenMap.Builder<String, Map<String, String>> extraCustomMetadata
+                BiConsumer<String, Map<String, String>> extraCustomMetadata
             ) {
                 return Settings.builder().put("test-setting-2", 10).build();
             }
diff --git a/server/src/test/java/org/elasticsearch/cluster/metadata/MetadataCreateIndexServiceTests.java b/server/src/test/java/org/elasticsearch/cluster/metadata/MetadataCreateIndexServiceTests.java
diff --git a/server/src/test/java/org/elasticsearch/cluster/metadata/MetadataMappingServiceTests.java b/server/src/test/java/org/elasticsearch/cluster/metadata/MetadataMappingServiceTests.java
diff --git a/server/src/test/java/org/elasticsearch/index/IndexSettingProviderTests.java b/server/src/test/java/org/elasticsearch/index/IndexSettingProviderTests.java
diff --git a/x-pack/plugin/logsdb/src/main/java/org/elasticsearch/xpack/logsdb/LogsdbIndexModeSettingsProvider.java b/x-pack/plugin/logsdb/src/main/java/org/elasticsearch/xpack/logsdb/LogsdbIndexModeSettingsProvider.java
diff --git a/x-pack/plugin/logsdb/src/test/java/org/elasticsearch/xpack/logsdb/LogsdbIndexModeSettingsProviderTests.java b/x-pack/plugin/logsdb/src/test/java/org/elasticsearch/xpack/logsdb/LogsdbIndexModeSettingsProviderTests.java
diff --git a/x-pack/plugin/logsdb/src/test/java/org/elasticsearch/xpack/logsdb/LogsdbIndexSettingsProviderLegacyLicenseTests.java b/x-pack/plugin/logsdb/src/test/java/org/elasticsearch/xpack/logsdb/LogsdbIndexSettingsProviderLegacyLicenseTests.java
