changing parameter name to merge_type

Author: masseyke

docs/changelog/132210.yaml

@@ -1,5 +1,5 @@
 pr: 132210
-summary: Adding a `mapping_merge_reason` parameter to the ingest simulate API
+summary: Adding a `merge_type` parameter to the ingest simulate API
 area: Ingest Node
 type: enhancement
 issues:

qa/smoke-test-ingest-with-all-dependencies/src/yamlRestTest/resources/rest-api-spec/test/ingest/80_ingest_simulate.yml

@@ -1985,7 +1985,7 @@ setup:
       headers:
         Content-Type: application/json
       simulate.ingest:
-        mapping_merge_reason: "index_template"
+        merge_type: "template"
         body: >
           {
             "docs": [

rest-api-spec/src/main/resources/rest-api-spec/api/simulate.ingest.json

@@ -39,9 +39,9 @@
         "type":"string",
         "description":"The pipeline id to preprocess incoming documents with if no pipeline is given for a particular document"
       },
-      "mapping_merge_reason":{
+      "merge_type":{
         "type":"string",
-        "description":"The mapping merge reason if mapping overrides are being provided in mapping_addition, index_template_substitutions, or component_template_substitutions. The allowed values are one of mapping_update or index_template. The mapping_update option merges mappings the way they would be merged into an existing index. The index_template option merges mappings the way they would be merged into a template.",
+        "description":"The mapping merge type if mapping overrides are being provided in mapping_addition, index_template_substitutions, or component_template_substitutions. The allowed values are one of index or template. The index option merges mappings the way they would be merged into an existing index. The template option merges mappings the way they would be merged into a template.",
         "default": "mapping_update"
       }
     },

server/src/main/java/org/elasticsearch/TransportVersions.java

@@ -356,7 +356,7 @@ static TransportVersion def(int id) {
     public static final TransportVersion PIPELINE_TRACKING_INFO = def(9_131_0_00);
     public static final TransportVersion COMPONENT_TEMPLATE_TRACKING_INFO = def(9_132_0_00);
     public static final TransportVersion TO_CHILD_BLOCK_JOIN_QUERY = def(9_133_0_00);
-    public static final TransportVersion SIMULATE_INGEST_MAPPING_MERGE_REASON = def(9_134_0_00);
+    public static final TransportVersion SIMULATE_INGEST_MAPPING_MERGE_TYPE = def(9_134_0_00);
 
     /*
      * STOP! READ THIS FIRST! No, really,

server/src/main/java/org/elasticsearch/action/bulk/SimulateBulkRequest.java

@@ -103,7 +103,7 @@ public class SimulateBulkRequest extends BulkRequest {
     private final Map<String, Map<String, Object>> componentTemplateSubstitutions;
     private final Map<String, Map<String, Object>> indexTemplateSubstitutions;
     private final Map<String, Object> mappingAddition;
-    private final String mappingMergeReason;
+    private final String mappingMergeType;
 
     /**
      * @param pipelineSubstitutions The pipeline definitions that are to be used in place of any pre-existing pipeline definitions with
@@ -120,7 +120,7 @@ public SimulateBulkRequest(
         Map<String, Map<String, Object>> componentTemplateSubstitutions,
         Map<String, Map<String, Object>> indexTemplateSubstitutions,
         Map<String, Object> mappingAddition,
-        String mappingMergeReason
+        String mappingMergeType
     ) {
         super();
         Objects.requireNonNull(pipelineSubstitutions);
@@ -131,7 +131,7 @@ public SimulateBulkRequest(
         this.componentTemplateSubstitutions = componentTemplateSubstitutions;
         this.indexTemplateSubstitutions = indexTemplateSubstitutions;
         this.mappingAddition = mappingAddition;
-        this.mappingMergeReason = mappingMergeReason;
+        this.mappingMergeType = mappingMergeType;
     }
 
     @SuppressWarnings("unchecked")
@@ -150,10 +150,10 @@ public SimulateBulkRequest(StreamInput in) throws IOException {
         } else {
             mappingAddition = Map.of();
         }
-        if (in.getTransportVersion().onOrAfter(TransportVersions.SIMULATE_INGEST_MAPPING_MERGE_REASON)) {
-            mappingMergeReason = in.readOptionalString();
+        if (in.getTransportVersion().onOrAfter(TransportVersions.SIMULATE_INGEST_MAPPING_MERGE_TYPE)) {
+            mappingMergeType = in.readOptionalString();
         } else {
-            mappingMergeReason = null;
+            mappingMergeType = null;
         }
     }
 
@@ -168,8 +168,8 @@ public void writeTo(StreamOutput out) throws IOException {
         if (out.getTransportVersion().onOrAfter(TransportVersions.V_8_17_0)) {
             out.writeGenericValue(mappingAddition);
         }
-        if (out.getTransportVersion().onOrAfter(TransportVersions.SIMULATE_INGEST_MAPPING_MERGE_REASON)) {
-            out.writeOptionalString(mappingMergeReason);
+        if (out.getTransportVersion().onOrAfter(TransportVersions.SIMULATE_INGEST_MAPPING_MERGE_TYPE)) {
+            out.writeOptionalString(mappingMergeType);
         }
     }
 
@@ -200,8 +200,8 @@ public Map<String, Object> getMappingAddition() {
         return mappingAddition;
     }
 
-    public String getMappingMergeReason() {
-        return mappingMergeReason;
+    public String getMappingMergeType() {
+        return mappingMergeType;
     }
 
     private static ComponentTemplate convertRawTemplateToComponentTemplate(Map<String, Object> rawTemplate) {
@@ -231,7 +231,7 @@ public BulkRequest shallowClone() {
             componentTemplateSubstitutions,
             indexTemplateSubstitutions,
             mappingAddition,
-            mappingMergeReason
+            mappingMergeType
         );
         bulkRequest.setRefreshPolicy(getRefreshPolicy());
         bulkRequest.waitForActiveShards(waitForActiveShards());

server/src/main/java/org/elasticsearch/action/bulk/TransportSimulateBulkAction.java

@@ -68,7 +68,6 @@
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.List;
-import java.util.Locale;
 import java.util.Map;
 import java.util.Optional;
 import java.util.Set;
@@ -137,9 +136,7 @@ protected void doInternalExecute(
         Map<String, ComponentTemplate> componentTemplateSubstitutions = bulkRequest.getComponentTemplateSubstitutions();
         Map<String, ComposableIndexTemplate> indexTemplateSubstitutions = bulkRequest.getIndexTemplateSubstitutions();
         Map<String, Object> mappingAddition = ((SimulateBulkRequest) bulkRequest).getMappingAddition();
-        MapperService.MergeReason mappingMergeReason = Optional.ofNullable(((SimulateBulkRequest) bulkRequest).getMappingMergeReason())
-            .map(mergeReason -> MapperService.MergeReason.valueOf(mergeReason.toUpperCase(Locale.ROOT)))
-            .orElse(MapperService.MergeReason.MAPPING_UPDATE);
+        MapperService.MergeReason mappingMergeReason = getMergeReason(((SimulateBulkRequest) bulkRequest).getMappingMergeType());
         for (int i = 0; i < bulkRequest.requests.size(); i++) {
             DocWriteRequest<?> docRequest = bulkRequest.requests.get(i);
             assert docRequest instanceof IndexRequest : "TransportSimulateBulkAction should only ever be called with IndexRequests";
@@ -175,6 +172,14 @@ protected void doInternalExecute(
         );
     }
 
+    private MapperService.MergeReason getMergeReason(String mergeType) {
+        return Optional.ofNullable(mergeType).map(type -> switch (type) {
+            case "index" -> MapperService.MergeReason.MAPPING_UPDATE;
+            case "template" -> MapperService.MergeReason.INDEX_TEMPLATE;
+            default -> throw new IllegalArgumentException("Unsupported merge type " + mergeType);
+        }).orElse(MapperService.MergeReason.MAPPING_UPDATE);
+    }
+
     /**
      * This creates a temporary index with the mappings of the index in the request, and then attempts to index the source from the request
      * into it. If there is a mapping exception, that exception is returned. On success the returned exception is null.

server/src/main/java/org/elasticsearch/rest/action/ingest/RestSimulateIngestAction.java

@@ -85,13 +85,13 @@ public RestChannelConsumer prepareRequest(final RestRequest request, final NodeC
             "index_template_substitutions"
         );
         Object mappingAddition = sourceMap.remove("mapping_addition");
-        String mappingMergeReason = request.param("mapping_merge_reason");
+        String mappingMergeType = request.param("merge_type");
         SimulateBulkRequest bulkRequest = new SimulateBulkRequest(
             pipelineSubstitutions == null ? Map.of() : pipelineSubstitutions,
             componentTemplateSubstitutions == null ? Map.of() : componentTemplateSubstitutions,
             indexTemplateSubstitutions == null ? Map.of() : indexTemplateSubstitutions,
             mappingAddition == null ? Map.of() : Map.of("_doc", mappingAddition),
-            mappingMergeReason
+            mappingMergeType
         );
         BytesReference transformedData = convertToBulkRequestXContentBytes(sourceMap);
         bulkRequest.add(

server/src/test/java/org/elasticsearch/action/bulk/SimulateBulkRequestTests.java

@@ -14,14 +14,12 @@
 import org.elasticsearch.cluster.metadata.ComposableIndexTemplate;
 import org.elasticsearch.common.bytes.BytesArray;
 import org.elasticsearch.common.xcontent.XContentHelper;
-import org.elasticsearch.index.mapper.MapperService;
 import org.elasticsearch.test.ESTestCase;
 import org.elasticsearch.xcontent.XContentType;
 
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.util.List;
-import java.util.Locale;
 import java.util.Map;
 
 import static java.util.Map.entry;
@@ -36,7 +34,7 @@ public void testSerialization() throws Exception {
             getMapOrEmpty(getTestComponentTemplateSubstitutions()),
             getMapOrEmpty(getTestIndexTemplateSubstitutions()),
             getMapOrEmpty(getTestMappingAddition()),
-            getTestMappingMergeReason()
+            getTestMappingMergeType()
         );
     }
 
@@ -56,7 +54,7 @@ public void testNullsNotAllowed() {
                 getTestPipelineSubstitutions(),
                 getTestComponentTemplateSubstitutions(),
                 getTestMappingAddition(),
-                getTestMappingMergeReason()
+                getTestMappingMergeType()
             )
         );
         assertThrows(
@@ -66,7 +64,7 @@ public void testNullsNotAllowed() {
                 null,
                 getTestComponentTemplateSubstitutions(),
                 getTestMappingAddition(),
-                getTestMappingMergeReason()
+                getTestMappingMergeType()
             )
         );
         assertThrows(
@@ -76,7 +74,7 @@ public void testNullsNotAllowed() {
                 getTestPipelineSubstitutions(),
                 null,
                 getTestMappingAddition(),
-                getTestMappingMergeReason()
+                getTestMappingMergeType()
             )
         );
         assertThrows(
@@ -86,7 +84,7 @@ public void testNullsNotAllowed() {
                 getTestPipelineSubstitutions(),
                 getTestComponentTemplateSubstitutions(),
                 null,
-                getTestMappingMergeReason()
+                getTestMappingMergeType()
             )
         );
     }
@@ -96,22 +94,22 @@ private void testSerialization(
         Map<String, Map<String, Object>> componentTemplateSubstitutions,
         Map<String, Map<String, Object>> indexTemplateSubstitutions,
         Map<String, Object> mappingAddition,
-        String mappingMergeReason
+        String mappingMergeType
     ) throws IOException {
         SimulateBulkRequest simulateBulkRequest = new SimulateBulkRequest(
             pipelineSubstitutions,
             componentTemplateSubstitutions,
             indexTemplateSubstitutions,
             mappingAddition,
-            mappingMergeReason
+            mappingMergeType
         );
         /*
          * Note: SimulateBulkRequest does not implement equals or hashCode, so we can't test serialization in the usual way for a
          * Writable
          */
         SimulateBulkRequest copy = copyWriteable(simulateBulkRequest, null, SimulateBulkRequest::new);
         assertThat(copy.getPipelineSubstitutions(), equalTo(simulateBulkRequest.getPipelineSubstitutions()));
-        assertThat(copy.getMappingMergeReason(), equalTo(simulateBulkRequest.getMappingMergeReason()));
+        assertThat(copy.getMappingMergeType(), equalTo(simulateBulkRequest.getMappingMergeType()));
     }
 
     @SuppressWarnings({ "unchecked", "rawtypes" })
@@ -121,7 +119,7 @@ public void testGetComponentTemplateSubstitutions() throws IOException {
             Map.of(),
             Map.of(),
             Map.of(),
-            getTestMappingMergeReason()
+            getTestMappingMergeType()
         );
         assertThat(simulateBulkRequest.getComponentTemplateSubstitutions(), equalTo(Map.of()));
         String substituteComponentTemplatesString = """
@@ -161,7 +159,7 @@ public void testGetComponentTemplateSubstitutions() throws IOException {
             substituteComponentTemplates,
             Map.of(),
             Map.of(),
-            getTestMappingMergeReason()
+            getTestMappingMergeType()
         );
         Map<String, ComponentTemplate> componentTemplateSubstitutions = simulateBulkRequest.getComponentTemplateSubstitutions();
         assertThat(componentTemplateSubstitutions.size(), equalTo(2));
@@ -192,7 +190,7 @@ public void testGetIndexTemplateSubstitutions() throws IOException {
             Map.of(),
             Map.of(),
             Map.of(),
-            getTestMappingMergeReason()
+            getTestMappingMergeType()
         );
         assertThat(simulateBulkRequest.getIndexTemplateSubstitutions(), equalTo(Map.of()));
         String substituteIndexTemplatesString = """
@@ -229,7 +227,7 @@ public void testGetIndexTemplateSubstitutions() throws IOException {
             randomBoolean(),
             XContentType.JSON
         ).v2();
-        simulateBulkRequest = new SimulateBulkRequest(Map.of(), Map.of(), substituteIndexTemplates, Map.of(), getTestMappingMergeReason());
+        simulateBulkRequest = new SimulateBulkRequest(Map.of(), Map.of(), substituteIndexTemplates, Map.of(), getTestMappingMergeType());
         Map<String, ComposableIndexTemplate> indexTemplateSubstitutions = simulateBulkRequest.getIndexTemplateSubstitutions();
         assertThat(indexTemplateSubstitutions.size(), equalTo(2));
         assertThat(
@@ -256,7 +254,7 @@ public void testShallowClone() throws IOException {
             getTestComponentTemplateSubstitutions(),
             getTestIndexTemplateSubstitutions(),
             getTestMappingAddition(),
-            getTestMappingMergeReason()
+            getTestMappingMergeType()
         );
         simulateBulkRequest.setRefreshPolicy(randomFrom(WriteRequest.RefreshPolicy.values()));
         simulateBulkRequest.waitForActiveShards(randomIntBetween(1, 10));
@@ -343,11 +341,11 @@ private static Map<String, Object> getTestMappingAddition() {
         );
     }
 
-    private static String getTestMappingMergeReason() {
+    private static String getTestMappingMergeType() {
         if (randomBoolean()) {
             return null;
         } else {
-            return randomFrom(MapperService.MergeReason.values()).toString().toLowerCase(Locale.ROOT);
+            return randomFrom("index", "template");
         }
     }
 }