Recipe ReplaceAnnotation doesn't replace full qualified name

[rregout]

I have created a rewrite.yml with the following recipe list:

type: specs.openrewrite.org/v1beta/recipe
name: com.example.ReplaceSingletonAnnotation
displayName: Replace annotation example
recipeList:
  - org.openrewrite.java.ReplaceAnnotation:
      annotationPatternToReplace: '@javax.ejb.Singleton'
      annotationTemplateToInsert: '@org.springframework.stereotype.Component'

With this a simple module project:

A parent pom:

<project>
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>parent-project</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>pom</packaging>

    <modules>
        <module>services</module>
    </modules>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>javax</groupId>
                <artifactId>javaee-api</artifactId>
                <version>7.0</version>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>3.3.1</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>

and a module pom:

<project>
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>com.example</groupId>
        <artifactId>parent-project</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>

    <artifactId>services</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>javax</groupId>
            <artifactId>javaee-api</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
    </dependencies>

</project>

And within the module an example Java class:

package com.example;

import javax.ejb.Singleton;

@Singleton
public class SingletonExample {

}

After running the command mvn -U org.openrewrite.maven:rewrite-maven-plugin:run -Drewrite.activeRecipes=com.example.ReplaceSingletonAnnotation the result is the SingletonExample class with:

package com.example;

@org.springframework.stereotype.Component
public class SingletonExample {

}

Why is a full qualified name added and not an import to Component?

[timtebeek]

Hoi @rregout , No idea why the import isn't shortened in your particular case. The recipe does contain instructions to shorten those imports where possible.

rewrite/rewrite-java/src/main/java/org/openrewrite/java/ReplaceAnnotation.java

Lines 93 to 97 in 03aa622

	maybeRemoveImport(TypeUtils.asFullyQualified(a.getType()));
	JavaCoordinates replaceCoordinate = a.getCoordinates().replace();
	a = replacement.apply(getCursor(), replaceCoordinate);
	doAfterVisit(service(ImportService.class).shortenFullyQualifiedTypeReferencesIn(a));
	return a;

If you look at our unit tests you'll see that we do shorten the imports for the cases seen there.

rewrite/rewrite-java/src/test/java/org/openrewrite/java/ReplaceAnnotationTest.java

Lines 54 to 78 in 03aa622

	@Test
	@DocumentExample
	void matchWithPrams() {
	rewriteRun(
	spec -> spec.recipe(new ReplaceAnnotation("@org.jetbrains.annotations.NotNull(\"Test\")", "@lombok.NonNull", null)),
	java(
	"""
	import org.jetbrains.annotations.NotNull;
	class A {
	@NotNull("Test")
	String testMethod() {}
	}
	""",
	"""
	import lombok.NonNull;
	class A {
	@NonNull
	String testMethod() {}
	}
	"""
	)
	);
	}

You could always run the recipe we have to shorten fully qualified type references explicitly after the annotation has been replaced to check whether that sees any improvement: https://docs.openrewrite.org/recipes/java/shortenfullyqualifiedtypereferences

[rregout]

Hoi Tim,

Thanks for your reply. Running the recipe ShortenFullyQualifiedTypeReferences afterwards does create an import for the annotation.

[timtebeek]

Odd that it didn't work when part of the ReplaceAnnotation recipe run; Good that we at least have a workaround then for now by adding that recipe to your recipeList:, if that's acceptable to you. Given that we already have comparable unit tests that pass I wonder what we can do to flush out this issue, or whether it's specific to your project setup. If you feel strongly about having a proper fix then you're welcome to explore with mvnDebug and report your findings.