Prevent breakage of usages of Spring's @nullable (#602)

* Prevent breakage of usages of Spring's @nullable * Update jspecify.yml * Fix test by being more specific about the recipe it runs --------- Co-authored-by: Tim te Beek <[email protected]>
openrewrite · Nov 13, 2024 · 20b8fff · 20b8fff
1 parent dd7ec21
commit 20b8fff
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/src/main/resources/META-INF/rewrite/jspecify.yml b/src/main/resources/META-INF/rewrite/jspecify.yml
@@ -26,7 +26,10 @@ recipeList:
   - org.openrewrite.java.jspecify.MigrateFromJavaxAnnotationApi
   - org.openrewrite.java.jspecify.MigrateFromJakartaAnnotationApi
   - org.openrewrite.java.jspecify.MigrateFromJetbrainsAnnotations
-  - org.openrewrite.java.jspecify.MigrateFromSpringFrameworkAnnotations
+  # Running the following recipe on current versions of Spring can cause Spring to misunderstand a nullable field.
+  #   For instance, a custom Prometheus scrape endpoint with @Nullable Set<String> includedNames will fail if 
+  #   includedNames is null and if @Nullable is @org.jspecify.annotations.Nullable.
+  # - org.openrewrite.java.jspecify.MigrateFromSpringFrameworkAnnotations
 
 ---
 type: specs.openrewrite.org/v1beta/recipe

diff --git a/src/test/java/org/openrewrite/java/migrate/jspecify/MigrateToJspecifyTest.java b/src/test/java/org/openrewrite/java/migrate/jspecify/MigrateToJspecifyTest.java
@@ -17,6 +17,7 @@
 
 import org.junit.jupiter.api.Test;
 import org.openrewrite.DocumentExample;
+import org.openrewrite.Issue;
 import org.openrewrite.java.JavaParser;
 import org.openrewrite.test.RecipeSpec;
 import org.openrewrite.test.RewriteTest;
@@ -324,9 +325,13 @@ class Bar {
         );
     }
 
+    @Issue("https://github.com/openrewrite/rewrite-migrate-java/pull/602")
     @Test
     void migrateFromSpringFrameworkAnnotationsToJspecify() {
         rewriteRun(
+          spec -> spec.recipeFromResource(
+            "/META-INF/rewrite/jspecify.yml",
+            "org.openrewrite.java.jspecify.MigrateFromSpringFrameworkAnnotations"),
           mavenProject("foo",
             //language=java
             srcMainJava(