Skip to content

The Jakarta migration keeps a provided API provided instead of adding it again in compile scope - #1279

Merged
jkschneider merged 4 commits into
jakarta/legacy-api-coordinatesfrom
jakarta/provided-api-scope
Oct 3, 2026
Merged

jkschneider merged 4 commits into
jakarta/legacy-api-coordinatesfrom
jakarta/provided-api-scope

Conversation

@jkschneider

Copy link
Copy Markdown
Member

After ChangeDependency relocated a provided API such as javax.enterprise:cdi-api or javax.mail:mail, the AddDependency that follows it, run for the migrated sources, changed the Jakarta API's scope to compile, which packages a container API into the application. New recipe DoesNotHaveProvidedApiDependency finds build files that declare none of the given coordinates in Maven provided scope (by declared scope, because Maven's provided resolution scope also lists compile and runtime dependencies) or Gradle compileOnly, and new declarative recipes AddJakartaCdiDependency, AddJakartaAnnotationDependency, AddJakartaElDependency, AddJakartaEjbDependency and AddJakartaMailDependency use it as the precondition of the existing AddDependency steps. An API declared in runtime scope is still promoted to compile for the main sources that use it. The four commits get there in steps, CDI first, then Mail, then one precondition with the coordinates as an option for all five, and its test relies on the legacy artifacts relocated in the previous pull request.

Found by a team of coding agents reviewing a Moderne run of org.openrewrite.java.migrate.jakarta.JavaxMigrationToJakarta over the 31 Arquillian repositories (run 20261003120559-YQoma). The issues are provided-api-scope-overwritten in the run's io.moderne.RecipeIssues data table (4 rows) and cdi-provided-scope-promoted (message board only), and the fix was discussed and reviewed on the run's message board. A row from the table, as a generalized example:

The migration changes a server-provided API dependency to compile scope. (arquillian/arquillian-core, testenrichers/cdi/pom.xml, recipe org.openrewrite.java.dependencies.AddDependency)

Before:

javax.enterprise:cdi-api:1.2 (provided)

What the recipe produced:

jakarta.enterprise:jakarta.enterprise.cdi-api:3.0.1 (compile)

Expected:

jakarta.enterprise:jakarta.enterprise.cdi-api:3.0.1 (provided)

Stacked on #1278 (16 of 19); merge that one first.

@jkschneider
jkschneider force-pushed the jakarta/provided-api-scope branch from 2849b00 to e767624 Compare October 3, 2026 22:26
@jkschneider
jkschneider added this pull request to stack #1283 October 3, 2026 22:39
@jkschneider
jkschneider merged commit 4ab423c into jakarta/reflective-type-names Oct 3, 2026
@jkschneider
jkschneider deleted the jakarta/provided-api-scope branch October 3, 2026 22:41
jkschneider added a commit that referenced this pull request Oct 4, 2026
#1271)

* javax-reflective-names-retained: migrate runtime Jakarta type names

* maven-coordinate-literal-retained: migrate validation artifact lookups (#1272)

* weld-javax-provider-retained: align Weld core with Jakarta CDI (#1273)

* `JettyUpgradeEE9` also upgrades the other Jetty dependencies, the servlet packages and the Java version (#1274)

* jetty-ee9-java-baseline: align Jetty dependencies packages and Java baseline

* jetty-ee9-java-baseline: leave standalone Jetty utility dependencies unchanged

* jetty-ee9-java-baseline: require a direct dependency before upgrading Java

* `JacksonJavaxToJakarta` keeps newer Jackson versions and shared version properties when relocating artifacts (#1275)

* jackson-version-downgrade: preserve newer versions and shared properties

* jackson-shared-version-property-split: cover older shared Jackson versions

* The Jakarta JAXB migration keeps the `javax.xml.bind` API for Arquillian Recorder 1.x binaries (#1276)

* recorder-javax-jaxb-api-removed: retain the API needed by Recorder binaries

* recorder-javax-jaxb-api-removed: limit retention to external binaries after migration

* hibernate-validator-javax-provider-retained: migrate legacy validation providers (#1277)

* legacy-javaee-api-coordinate-retained: migrate legacy annotation EL and EJB aliases (#1278)

* The Jakarta migration keeps a provided API provided instead of adding it again in compile scope (#1279)

* cdi-provided-scope-promoted: preserve provided CDI API scope

* cdi-provided-scope-promoted: distinguish provided declarations from runtime APIs

* provided-api-scope-overwritten: preserve provided Mail API scope

* provided-api-scope-overwritten: preserve container API scopes across Jakarta migrations

* The Jackson Jakarta migration adds the `defaultView` parameter to `ProviderBase._configForWriting` overrides (#1280)

* jackson-provider-override-signature: forward the default view parameter

* jackson-provider-override-signature: update callers of migrated overrides

* invocation-context-get-constructor-missing: complete legacy decorators (#1281)

* jakarta-api-duplicates-platform: respect provided platform APIs (#1282)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant