DefaultModelXmlFactory: make location tracking opt-in—disabled by default, enabled when an InputLocationFormatter is provided.

Adapt formatter to Function<InputLocation,String> and write to the actually opened stream for path output.
Fixes #10939.

Author: arturobernalg

impl/maven-impl/src/main/java/org/apache/maven/impl/DefaultModelXmlFactory.java

@@ -25,11 +25,13 @@
 import java.net.URL;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.util.Objects;
 import java.util.function.Function;
 
 import org.apache.maven.api.annotations.Nonnull;
 import org.apache.maven.api.di.Named;
 import org.apache.maven.api.di.Singleton;
+import org.apache.maven.api.model.InputLocation;
 import org.apache.maven.api.model.InputSource;
 import org.apache.maven.api.model.Model;
 import org.apache.maven.api.services.xml.ModelXmlFactory;
@@ -115,28 +117,38 @@ private Model doRead(XmlReaderRequest request) throws XmlReaderException {
     }
 
     @Override
-    public void write(XmlWriterRequest<Model> request) throws XmlWriterException {
-        requireNonNull(request, "request");
-        Model content = requireNonNull(request.getContent(), "content");
-        Path path = request.getPath();
-        OutputStream outputStream = request.getOutputStream();
-        Writer writer = request.getWriter();
-        Function<Object, String> inputLocationFormatter = request.getInputLocationFormatter();
+    public void write(final XmlWriterRequest<Model> request) throws XmlWriterException {
+        Objects.requireNonNull(request, "request can not be null");
+        final Model content = Objects.requireNonNull(request.getContent(), "content can not be null");
+
+        final Path path = request.getPath();
+        final OutputStream outputStream = request.getOutputStream();
+        final Writer writer = request.getWriter();
+
         if (writer == null && outputStream == null && path == null) {
             throw new IllegalArgumentException("writer, outputStream or path must be non null");
         }
+
         try {
-            MavenStaxWriter w = new MavenStaxWriter();
-            if (inputLocationFormatter != null) {
-                w.setStringFormatter((Function) inputLocationFormatter);
+            // OFF by default
+            final MavenStaxWriter xmlWriter = new MavenStaxWriter();
+            xmlWriter.setAddLocationInformation(false);
+
+            // Opt-in when a formatter is provided; adapt to the required type
+            final Function<Object, String> fmt = request.getInputLocationFormatter();
+            if (fmt != null) {
+                xmlWriter.setAddLocationInformation(true);
+                final Function<InputLocation, String> adapter = fmt::apply;
+                xmlWriter.setStringFormatter(adapter);
             }
+
             if (writer != null) {
-                w.write(writer, content);
+                xmlWriter.write(writer, content);
             } else if (outputStream != null) {
-                w.write(outputStream, content);
+                xmlWriter.write(outputStream, content);
             } else {
                 try (OutputStream os = Files.newOutputStream(path)) {
-                    w.write(os, content);
+                    xmlWriter.write(os, content);
                 }
             }
         } catch (Exception e) {

impl/maven-impl/src/test/java/org/apache/maven/impl/DefaultModelXmlFactoryTest.java

@@ -19,14 +19,18 @@
 package org.apache.maven.impl;
 
 import java.io.StringReader;
+import java.io.StringWriter;
+import java.util.function.Function;
 
 import org.apache.maven.api.model.Model;
 import org.apache.maven.api.services.xml.XmlReaderException;
 import org.apache.maven.api.services.xml.XmlReaderRequest;
+import org.apache.maven.api.services.xml.XmlWriterRequest;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
@@ -122,4 +126,63 @@ void testMalformedModelVersion() throws Exception {
         Model model = factory.read(request);
         assertEquals("invalid.version", model.getModelVersion());
     }
+
+    @Test
+    void testWriteWithoutFormatterDisablesLocationTracking() throws Exception {
+        // minimal valid model we can round-trip
+        String xml =
+                """
+                <project xmlns="http://maven.apache.org/POM/4.0.0">
+                  <modelVersion>4.0.0</modelVersion>
+                  <groupId>g</groupId>
+                  <artifactId>a</artifactId>
+                  <version>1</version>
+                </project>""";
+
+        Model model = factory.read(XmlReaderRequest.builder()
+                .reader(new StringReader(xml))
+                .strict(true)
+                .build());
+
+        StringWriter out = new StringWriter();
+        factory.write(XmlWriterRequest.<Model>builder()
+                .writer(out)
+                .content(model)
+                // no formatter -> tracking should be OFF
+                .build());
+
+        String result = out.toString();
+        // And certainly not our marker
+        assertFalse(result.contains("LOC_MARK"), "Unexpected marker found in output");
+    }
+
+    @Test
+    void testWriteWithFormatterEnablesLocationTracking() throws Exception {
+        String xml =
+                """
+                <project xmlns="http://maven.apache.org/POM/4.0.0">
+                  <modelVersion>4.0.0</modelVersion>
+                  <groupId>g</groupId>
+                  <artifactId>a</artifactId>
+                  <version>1</version>
+                </project>""";
+
+        Model model = factory.read(XmlReaderRequest.builder()
+                .reader(new StringReader(xml))
+                .strict(true)
+                .build());
+
+        StringWriter out = new StringWriter();
+        Function<Object, String> formatter = o -> "LOC_MARK";
+
+        factory.write(XmlWriterRequest.<Model>builder()
+                .writer(out)
+                .content(model)
+                .inputLocationFormatter(formatter)
+                .build());
+
+        String result = out.toString();
+        // Presence of our formatter's output proves tracking was enabled and formatter applied
+        assertTrue(result.contains("LOC_MARK"), "Expected formatter marker in output when tracking is enabled");
+    }
 }