Skip to content

Add CAP Java 5.0 OpenRewrite recipes to migration table#2647

Open
rjayasinghe wants to merge 3 commits into
mainfrom
update_recipe_list
Open

Add CAP Java 5.0 OpenRewrite recipes to migration table#2647
rjayasinghe wants to merge 3 commits into
mainfrom
update_recipe_list

Conversation

@rjayasinghe

Copy link
Copy Markdown
Contributor

Extends the Currently Released CAP Java Migrations table in java/migration.md with the new recipes added for the CAP Java 5.0 release, and adds a second table listing the umbrella recipes.

Fine-grained recipes added

  • Cap_4.9_Properties — was already shipped but missing from the table; renames cds.mcp.autoConfig.*cds.mcp.autoWired.* and cds.taskScheduler.enabledcds.outbox.persistent.scheduler.enabled.
  • Cap_5.0_Properties — removes properties no longer supported in CAP Java 5.0 (cds.errors.combined, cds.sql.collate, cds.sql.hana.optimizationMode, cds.odataV4.searchMode, cds.odataV2.searchMode, the two removed cds.multiTenancy.serviceManager.* flags).
  • Cap_5.0_OutboxOrdered — adds ordered: true to custom cds.outbox.services entries to preserve the previous behavior, since the default flips from true to false in 5.0.

Umbrella recipes table added

New table lists Cap_4.8, Cap_4.9, and Cap_5.0, describing which fine-grained recipes each one bundles and which Maven version it upgrades CAP Java dependencies to.

Source: recipe YAMLs under cds-services-recipes/src/main/resources/META-INF/rewrite/.

Extend the 'Currently Released CAP Java Migrations' table with the
recipes added for the CAP Java 5.0 release (Cap_5.0_Properties,
Cap_5.0_OutboxOrdered) and also list the previously missing
Cap_4.9_Properties recipe. Add a second table listing the umbrella
recipes (Cap_4.8, Cap_4.9, Cap_5.0) and what each one bundles.
Comment thread java/migration.md Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

better update to latest recipe

Comment thread java/migration.md Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

ditto

Comment thread java/migration.md
|[com.sap.cds.services.migrations.UclMigration](#removed-java-apis-4-to-5)|Migrates deprecated UCL result getter and setter methods to the new API.|4.9.0|
|com.sap.cds.services.migrations.Cap_4.9_Properties|Replaces deprecated application properties with their CAP Java 4.9 equivalents (for example `cds.mcp.autoConfig.*` → `cds.mcp.autoWired.*`, `cds.taskScheduler.enabled` → `cds.outbox.persistent.scheduler.enabled`).|4.9.0|
|[com.sap.cds.services.migrations.Cap_5.0_Properties](#removed-properties-4-to-5)|Removes application properties that are no longer supported in CAP Java 5.0 and have no replacement (for example `cds.errors.combined`, `cds.sql.collate`, `cds.sql.hana.optimizationMode`, `cds.odataV4.searchMode`, `cds.odataV2.searchMode`, and the removed `cds.multiTenancy.serviceManager.*` flags).|5.0.0|
|[com.sap.cds.services.migrations.Cap_5.0_OutboxOrdered](#adjusted-defaults-4-to-5)|Adds `ordered: true` to every custom entry under `cds.outbox.services` (except the built-in `DefaultOutboxOrdered`/`DefaultOutboxUnordered`) to preserve the previous behavior, as the default of `cds.outbox.services.<name>.ordered` changes from `true` to `false` in CAP Java 5.0.|5.0.0|

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

So far we didn´t put the CAP version as part of recipe name for individual recipes. except the ones for properties and the umbrella ones. But that´s not changeable anymore I guess.

Comment thread java/migration.md

In addition, the following umbrella recipes are provided per release. Each one includes all individual recipes for APIs deprecated in this AND previous releases, plus Maven dependency upgrades for all CAP Java modules to the matching version. Run the latest umbrella recipe matching the version of the CAP Java SDK you are upgrading to.

|Name |Description|Available since|

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The table feels redundant as the table above already specifies the initial release of the recipe. It´s the same information in a different representation. Maybe it is sufficient to tell that each release gets a dedicated umbrella recipe.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants