UpdateMavenModel does not handle valid XML properly

[smurf667]

UpdateMavenModel does not handle valid XML properly

[timtebeek]

Thanks again for the report @smurf667 ; you can try it out through our snapshot versions, before we release somewhere in the next two weeks.

[smurf667]

Thank you @timtebeek - I am very impressed with the handling of the issue and the speed of the fix. I tried the 8.12.0-SNAPSHOT, and it works for me. Good job, and thanks again!

[timtebeek]

Thanks for providing context to the issue; indeed unfortunate that you have to deal with such escapes, and we have to handle that better.

[timtebeek]

Exploring the issue here for a bit; your test indeed fails; this passes, despite the escape

@Test
void escapedAinArtifactId() {
    rewriteRun(
      pomXml(
        """
          <project>
            <groupId>com.mycompany.app</groupId>
            <artifactId>my-app</artifactId>
            <version>1</version>
            <dependencies>
              <dependency>
                <groupId>org.slf4j</groupId>
                <artifactId>slf4j-&#0097;pi</artifactId>
                <version>2.0.9</version>
              </dependency>
            </dependencies>
          </project>
          """,
        spec -> spec.afterRecipe(pomXml -> {
            assertThat(pomXml.getMarkers().findFirst(MavenResolutionResult.class).orElseThrow()
              .getDependencies().get(Scope.Compile))
              .singleElement()
              .satisfies(dep -> assertThat(dep.getArtifactId()).isEqualTo("slf4j-api"));
        })
      )
    );
}

[timtebeek]

And this indeed shows what you also found, that the artifactId contains an ArrayList instead of a regular value

@Test
void escapedAinArtifactIdVisited() {
    rewriteRun(
      spec -> spec.recipe(RewriteTest.toRecipe(() -> new XmlVisitor<>() {
          @Override
          public Xml visitTag(Xml.Tag tag, ExecutionContext ctx) {
              if (new XPathMatcher("/project/dependencies/dependency").matches(getCursor())) {
                  var child = tag.getChild("artifactId");
                  var childValue = tag.getChildValue("artifactId");
                  var children = tag.getChildren("artifactId");
                  System.out.println();
              }
              return super.visitTag(tag, ctx);
          }
      })),
      pomXml(
        """
          <project>
            <groupId>com.mycompany.app</groupId>
            <artifactId>my-app</artifactId>
            <version>1</version>
            <dependencies>
              <dependency>
                <groupId>org.slf4j</groupId>
                <artifactId>slf4j-&#0097;pi</artifactId>
                <version>2.0.9</version>
              </dependency>
            </dependencies>
          </project>
          """
      )
    );
}

[knutwannheden]

@traceyyoshima It seems like the XML entity fix you made doesn't also extend to XML character references and needs a separate fix.

[timtebeek]

I think I have a fix in

• #3813

[timtebeek]

Glad to hear that works and thanks for confirming here!