Skip to content

Improve "Add explicit Common Annotations dependencies" in "Migrate to Java 11" #816

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Aug 12, 2025
+146 −74
Merged

Improve "Add explicit Common Annotations dependencies" in "Migrate to Java 11" #816

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
27ff0a2
Proper AddCommonAnnotationsDependencies implementation
jevanlingen Aug 12, 2025
3a31e27
Add test
jevanlingen Aug 12, 2025
faf679f
Polish
jevanlingen Aug 12, 2025
aeb7d2f
Polish
jevanlingen Aug 12, 2025
c70fb4c
Polish
jevanlingen Aug 12, 2025
a8b75a0
Add a new separate test instead of expanding the documentation example
timtebeek Aug 12, 2025
baace2f
Only add the classpath dependency to the new test that needs it
timtebeek Aug 12, 2025
f7e71b2
Shorted comment
timtebeek Aug 12, 2025
7cf4f81
Inline the now dependency only `UpdateJakartaAnnotations2`
timtebeek Aug 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ recipeDependencies {
parserClasspath("jakarta.servlet:jakarta.servlet-api:6.0.0")
parserClasspath("javax.persistence:javax.persistence-api:2.2")
parserClasspath("org.glassfish:javax.servlet:3.0")
parserClasspath("javax.annotation:javax.annotation-api:1.3.2")
}

val rewriteVersion = rewriteRecipe.rewriteVersion.get()
Expand Down
5 changes: 4 additions & 1 deletion src/main/resources/META-INF/rewrite/add-common-annotations-dependencies.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,16 @@ tags:
- jsr250
- jakarta
recipeList:
# Add or update the jakarta.annotation-api to a maven project. This artifact still uses the javax.annotation name space.
# Add or update the jakarta.annotation-api. Use version 1.3.x, as this version still kept the old javax namespace (starting from 2.x it's changed to jakarta).
- org.openrewrite.java.dependencies.ChangeDependency:
oldGroupId: javax.annotation
oldArtifactId: javax.annotation-api
newGroupId: jakarta.annotation
newArtifactId: jakarta.annotation-api
newVersion: 1.3.x
# set explicitly even if managed, as higher versions do not have the javax namespace
overrideManagedVersion: true
changeManagedDependency: false
# Jakarta EE recommends `provided` scope
- org.openrewrite.maven.ChangeDependencyScope:
groupId: jakarta.annotation
Expand Down
Binary file modified src/main/resources/META-INF/rewrite/classpath.tsv.zip
View file
Open in desktop
Binary file not shown.
21 changes: 4 additions & 17 deletions src/main/resources/META-INF/rewrite/jakarta-ee-10.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,15 @@ tags:
- jakarta
# NOTE: The spec versions in this section comes from https://github.com/jakartaee/jakartaee-api/blob/10.0.0/pom.xml
recipeList:
- org.openrewrite.java.migrate.jakarta.UpdateJakartaAnnotations2
- org.openrewrite.java.migrate.jakarta.UpdateJakartaXmlWsEE10
- org.openrewrite.java.dependencies.UpgradeDependencyVersion:
groupId: jakarta.activation
artifactId: jakarta.activation-api
newVersion: 2.1.x
- org.openrewrite.java.dependencies.UpgradeDependencyVersion:
groupId: jakarta.annotation
artifactId: jakarta.annotation-api
newVersion: 2.1.x
- org.openrewrite.java.dependencies.UpgradeDependencyVersion:
groupId: jakarta.authentication
artifactId: jakarta.authentication-api
Expand Down Expand Up @@ -386,22 +389,6 @@ recipeList:
newVersion: 10.0.0
---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.jakarta.UpdateJakartaAnnotations2
displayName: Update Jakarta EE annotation Dependencies to 2.1.x.
description: Update Jakarta EE annotation Dependencies to 2.1.x.
recipeList:
- org.openrewrite.java.dependencies.UpgradeDependencyVersion:
groupId: jakarta.annotation
artifactId: jakarta.annotation-api
newVersion: 2.1.x
- org.openrewrite.java.ChangeType:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ℹ️ The UpdateJakartaAnnotations2 recipe should not contain these ChangeType changes, as the JavaxAnnotationMigrationToJakartaAnnotation recipe, located in jakarta-ee-9.xml, does already do these migrations:

https://github.com/openrewrite/rewrite-migrate-java/blob/main/src/main/resources/META-INF/rewrite/jakarta-ee-9.yml#L94-L129

Because jakarta-ee-10 calls jakarta-ee-9, the namespace fix will already be applied.

The reason these ChangeType recipes were added here, was because there was a bug in the JavaxAnnotationMigrationToJakartaAnnotation recipe, what let to an unchanged javax namespace. That bug has been fixed, so we don't need there recipe here anymore.

oldFullyQualifiedTypeName: javax.annotation.Nullable
newFullyQualifiedTypeName: jakarta.annotation.Nullable
- org.openrewrite.java.ChangeType:
oldFullyQualifiedTypeName: javax.annotation.Nonnull
newFullyQualifiedTypeName: jakarta.annotation.Nonnull
---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.jakarta.UpdateJakartaXmlWsEE10
displayName: Update Jakarta EE XML Web Services Dependencies for EE 10.
description: Update Jakarta EE XML Web Services Dependencies for EE 10.
Expand Down
7 changes: 4 additions & 3 deletions src/main/resources/META-INF/rewrite/jakarta-ee-9.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ recipeList:
- org.openrewrite.java.migrate.jakarta.ApplicationPathWildcardNoLongerAccepted
- org.openrewrite.java.migrate.jakarta.UpdateApacheWSSecurityPackages
- org.openrewrite.java.migrate.jakarta.JavaxEEApiToJakarta
- org.openrewrite.java.migrate.jakarta.RemoveJakartaAnnotationDependency
- org.openrewrite.java.migrate.jakarta.RemoveJakartaAnnotationDependencyWhenManagedBySpringBoot

---
type: specs.openrewrite.org/v1beta/recipe
Expand Down Expand Up @@ -1079,10 +1079,11 @@ recipeList:
newVersion: 9.1.0
---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.jakarta.RemoveJakartaAnnotationDependency
name: org.openrewrite.java.migrate.jakarta.RemoveJakartaAnnotationDependencyWhenManagedBySpringBoot
displayName: Remove `jakarta.annotation-api` dependency when managed by Spring Boot
description: Counteract the `jakarta.annotation-api` added by `org.openrewrite.java.migrate.javax.AddCommonAnnotationsDependencies` for Spring Boot applications.
description: Best practice recipe to cleanup a direct dependency which also comes transitively for Spring Boot applications.
preconditions:
# TODO: This recipe can be broadened by checking if `jakarta.annotation-api` is transitively on the classpath OR move this recipe to be part of org.openrewrite.java.spring.boot3.UpgradeSpringBoot_3_0 recipe.
- org.openrewrite.java.migrate.jakarta.HasNoJakartaAnnotations
- org.openrewrite.java.dependencies.DependencyInsight:
groupIdPattern: org.springframework.boot
Expand Down
28 changes: 28 additions & 0 deletions src/main/resources/META-INF/rewrite/java-version-17.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ recipeList:
- org.openrewrite.java.migrate.lang.SwitchCaseAssignmentsToSwitchExpression
- org.openrewrite.java.migrate.lang.SwitchCaseReturnsToSwitchExpression
- org.openrewrite.java.migrate.lang.SwitchExpressionYieldToArrow
- org.openrewrite.java.migrate.UpdateJakartaAnnotationsIfForJavax
- org.openrewrite.java.migrate.UpdateJakartaAnnotationsIfExistsForJakarta

---
type: specs.openrewrite.org/v1beta/recipe
Expand Down Expand Up @@ -326,3 +328,29 @@ recipeList:
groupId: org.projectlombok
artifactId: lombok-mapstruct-binding
version: 0.2.0

---
# The scanning phase comes before the editing phase, therefor we check if a javax.annotation dependency is on the classpath (with whatever version)
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.UpdateJakartaAnnotationsIfForJavax
displayName: Update `jakarta.annotation-api` dependency if it exists
description: Counteract the `jakarta.annotation-api` by updating to `jakarta` namespace
preconditions:
- org.openrewrite.java.dependencies.search.ModuleHasDependency:
groupIdPattern: javax.annotation
artifactIdPattern: javax.annotation-api
recipeList:
- org.openrewrite.java.migrate.jakarta.JavaxAnnotationMigrationToJakartaAnnotation

---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.UpdateJakartaAnnotationsIfExistsForJakarta
displayName: Update `jakarta.annotation-api` dependency if it exists
description: Counteract the `jakarta.annotation-api` by updating to `jakarta` namespace
preconditions:
- org.openrewrite.java.dependencies.search.ModuleHasDependency:
groupIdPattern: jakarta.annotation
artifactIdPattern: jakarta.annotation-api
version: 1.3.x
recipeList:
- org.openrewrite.java.migrate.jakarta.JavaxAnnotationMigrationToJakartaAnnotation
Loading