Skip to content

Conversation

pdelagrave
Copy link
Contributor

What's changed?

New recipe to replace calls to Logger.log(Level, ...) with the corresponding eponymous level method calls. For example Logger.log(Level.INFO, ...) to Logger.info(...).";

What's your motivation?

This is a sub-recipe to the more general JBoss Logging migration to SLF4J declarative recipe.

  • This recipe is a step to normalize the code before applying the actual migration recipes.
  • The other migration recipes will be able to focus on migrating only the logger.loglevel() invocations and be simpler than if they had to additionally support the various logger.log(), logger.logv() and logger.logf().
  • This recipe is also usable independently.

Anything in particular you'd like reviewers to focus on?

Anyone you would like to review specifically?

Have you considered any alternatives or workarounds?

Any additional context

  • Based on a similar recipe for JUL
  • Using imperative recipe instead of refaster or declarative because:
    • There's 108 combinations that'd require 108 refaster sub-recipes.
    • A declarative version would be very verbose and harder to read/maintain than the imperative version.

Checklist

  • I've added unit tests to cover both positive and negative cases
  • I've read and applied the recipe conventions and best practices
  • I've used the IntelliJ IDEA auto-formatter on affected files

@github-project-automation github-project-automation bot moved this to In Progress in OpenRewrite Jul 30, 2025
@pdelagrave pdelagrave self-assigned this Jul 30, 2025
@pdelagrave pdelagrave moved this from In Progress to Ready to Review in OpenRewrite Jul 30, 2025
@timtebeek timtebeek self-requested a review July 30, 2025 13:28
@timtebeek timtebeek added the recipe Recipe Requested label Jul 30, 2025
@jevanlingen
Copy link
Contributor

Add also a package-info.java file in the org.openrewrite.java.logging.jboss package to have that nice non-null default (just copy it from org.openrewrite.java.logging package). For more info see: https://jspecify.dev/docs/using/#defaulting-annotations.

@pdelagrave
Copy link
Contributor Author

pdelagrave commented Jul 30, 2025

}
logLevelName = extractLogLevelName(firstArgument) + suffix;
updatedArguments = ListUtils.concat(
(Expression) secondArgument.withPrefix(firstArgument.getPrefix()),
Copy link
Contributor

Choose a reason for hiding this comment

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

I am wondering what the best thing to do is here regarding the Space. Right now replacing the Space is not good enough, because what happens now would be something like this:

- logger.log(      /* comment 1 */           Logger.Level.TRACE,   /* comment 2 */                   msg, t);
+ logger.trace(      /* comment 1 */           msg, t);

This does not make any sense to me. We can just remove the first argument, like you do for the other case:

pdatedArguments = ListUtils.filter(args, it -> it != firstArgument);

That would remove the item including the whitespace and comments:

- logger.log(      /* comment 1 */           Logger.Level.TRACE,   /* comment 2 */                   msg, t);
+ logger.trace(   /* comment 2 */                   msg, t);

Another option would be to merge the comments and keep only the whitespace of the second argument. Maybe that's the best thing you can do. Then it would be something like:

- logger.log(      /* comment 1 */           Logger.Level.TRACE,   /* comment 2 */                   msg, t);
+ logger.trace(/* comment 1 */   /* comment 2 */                   msg, t);

Personally, I would just remove the first argument. If there is a comment, big chances are that this comment is no longer relevant. The same applies to the other case!

Copy link
Member

Choose a reason for hiding this comment

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

Thanks! Applied in 6f2f0bf

@pdelagrave pdelagrave removed their assignment Aug 4, 2025
@timtebeek timtebeek self-requested a review August 4, 2025 15:55
@timtebeek timtebeek moved this from Ready to Review to In Progress in OpenRewrite Aug 4, 2025
@timtebeek timtebeek marked this pull request as draft August 4, 2025 16:00
@timtebeek timtebeek removed their request for review August 4, 2025 16:22
@timtebeek timtebeek marked this pull request as ready for review August 4, 2025 23:13
@timtebeek timtebeek self-assigned this Aug 4, 2025
@timtebeek timtebeek self-requested a review August 4, 2025 23:13
timtebeek and others added 5 commits August 5, 2025 11:58
Added example documentation for the following recipes:
- ArgumentArrayToVarargs
- FormattedArgumentsToVMethodRecipes (JBoss)
- JBossLoggingBestPractices
- LoggerLevelArgumentToMethod (JBoss)

These examples demonstrate the transformations performed by each recipe.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@github-project-automation github-project-automation bot moved this from In Progress to Ready to Review in OpenRewrite Aug 5, 2025
@timtebeek timtebeek merged commit c59c405 into main Aug 5, 2025
2 checks passed
@timtebeek timtebeek deleted the loggerlevelarg-jboss branch August 5, 2025 10:18
@github-project-automation github-project-automation bot moved this from Ready to Review to Done in OpenRewrite Aug 5, 2025
@timtebeek timtebeek mentioned this pull request Aug 11, 2025
mergify bot added a commit to robfrank/linklift that referenced this pull request Aug 15, 2025
…rom 3.7.0 to 3.13.0 [skip ci]

Bumps [org.openrewrite.recipe:rewrite-logging-frameworks](https://github.com/openrewrite/rewrite-logging-frameworks) from 3.7.0 to 3.13.0.
Release notes

*Sourced from [org.openrewrite.recipe:rewrite-logging-frameworks's releases](https://github.com/openrewrite/rewrite-logging-frameworks/releases).*

> 3.13.0
> ------
>
> What's Changed
> --------------
>
> * Recipe to migrate deprecated JBoss Logging calls by [`@​pdelagrave`](https://github.com/pdelagrave) in [openrewrite/rewrite-logging-frameworks#245](https://redirect.github.com/openrewrite/rewrite-logging-frameworks/pull/245)
> * Add `ArgumentArrayToVarargs` for logger methods that take a var args argument Object array by [`@​timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-logging-frameworks#246](https://redirect.github.com/openrewrite/rewrite-logging-frameworks/pull/246)
> * Avoid unsafe changes in `JulParameterizedArguments` when `JavaType.Array` argument is not a `J.NewArray` by [`@​pdelagrave`](https://github.com/pdelagrave) in [openrewrite/rewrite-logging-frameworks#244](https://redirect.github.com/openrewrite/rewrite-logging-frameworks/pull/244)
> * LoggerLevelArgumentToMethod for JBoss Logging by [`@​pdelagrave`](https://github.com/pdelagrave) in [openrewrite/rewrite-logging-frameworks#243](https://redirect.github.com/openrewrite/rewrite-logging-frameworks/pull/243)
> * Add a recipe to migrate from JBoss Logging to SLF4J by [`@​pdelagrave`](https://github.com/pdelagrave) in [openrewrite/rewrite-logging-frameworks#241](https://redirect.github.com/openrewrite/rewrite-logging-frameworks/pull/241)
> * rename settings.local.json to settings.json by [`@​zieka`](https://github.com/zieka) in [openrewrite/rewrite-logging-frameworks#247](https://redirect.github.com/openrewrite/rewrite-logging-frameworks/pull/247)
>
> **Full Changelog**: <openrewrite/rewrite-logging-frameworks@v3.12.0...v3.13.0>
>
> 3.12.1
> ------
>
> What's Changed
> --------------
>
> * OpenRewrite v8.59.1: <https://github.com/openrewrite/rewrite>
>
> **Full Changelog**: <https://github.com/openrewrite/rewrite-logging-frameworks>
>
> 3.12.0
> ------
>
> What's Changed
> --------------
>
> * Adds filePattern parameter to ConfigureLoggerLevel by [`@​simonzn`](https://github.com/simonzn) in [openrewrite/rewrite-logging-frameworks#235](https://redirect.github.com/openrewrite/rewrite-logging-frameworks/pull/235)
> * Handle existing arguments alongside concatenation in `ParameterizedLogging` by [`@​timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-logging-frameworks#237](https://redirect.github.com/openrewrite/rewrite-logging-frameworks/pull/237)
> * Fix Slf4jLogShouldBeConstant to preserve format specifiers with width, alignment, and precision. by [`@​motlin`](https://github.com/motlin) in [openrewrite/rewrite-logging-frameworks#239](https://redirect.github.com/openrewrite/rewrite-logging-frameworks/pull/239)
>
> New Contributors
> ----------------
>
> * [`@​simonzn`](https://github.com/simonzn) made their first contribution in [openrewrite/rewrite-logging-frameworks#235](https://redirect.github.com/openrewrite/rewrite-logging-frameworks/pull/235)
> * [`@​motlin`](https://github.com/motlin) made their first contribution in [openrewrite/rewrite-logging-frameworks#239](https://redirect.github.com/openrewrite/rewrite-logging-frameworks/pull/239)
>
> **Full Changelog**: <openrewrite/rewrite-logging-frameworks@v3.11.0...v3.12.0>
>
> 3.11.0
> ------
>
> What's Changed
> --------------
>
> * fix: any last argument matching `Throwable.toString()` is left as is by [`@​pdelagrave`](https://github.com/pdelagrave) in [openrewrite/rewrite-logging-frameworks#229](https://redirect.github.com/openrewrite/rewrite-logging-frameworks/pull/229)
> * refactor: org.openrewrite.mavencentral by [`@​Laurens-W`](https://github.com/Laurens-W) in [openrewrite/rewrite-logging-frameworks#230](https://redirect.github.com/openrewrite/rewrite-logging-frameworks/pull/230)
> * Don't if-wrap logs when arguments are getters by [`@​pdelagrave`](https://github.com/pdelagrave) in [openrewrite/rewrite-logging-frameworks#233](https://redirect.github.com/openrewrite/rewrite-logging-frameworks/pull/233)
>
> **Full Changelog**: <openrewrite/rewrite-logging-frameworks@v3.10.0...v3.11.0>
>
> 3.10.0
> ------
>
> What's Changed
> --------------
>
> * Add recipe to change logger fields to private by [`@​jhl221123`](https://github.com/jhl221123) in [openrewrite/rewrite-logging-frameworks#221](https://redirect.github.com/openrewrite/rewrite-logging-frameworks/pull/221)
> * Add `MatchIsLogLevelEnabledWithLogStatements` to SLF4J best practices by [`@​timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-logging-frameworks#222](https://redirect.github.com/openrewrite/rewrite-logging-frameworks/pull/222)
> * Exclude spotbugs dependency by [`@​greg-at-moderne`](https://github.com/greg-at-moderne) in [openrewrite/rewrite-logging-frameworks#225](https://redirect.github.com/openrewrite/rewrite-logging-frameworks/pull/225)
> * Recipe to remove `.toString()` called on parameterized logging statement arguments by [`@​pdelagrave`](https://github.com/pdelagrave) in [openrewrite/rewrite-logging-frameworks#224](https://redirect.github.com/openrewrite/rewrite-logging-frameworks/pull/224)
> * fix: match `.toString()` on any type, not just java.lang.Object by [`@​pdelagrave`](https://github.com/pdelagrave) in [openrewrite/rewrite-logging-frameworks#226](https://redirect.github.com/openrewrite/rewrite-logging-frameworks/pull/226)
>
> New Contributors
> ----------------
>
> * [`@​jhl221123`](https://github.com/jhl221123) made their first contribution in [openrewrite/rewrite-logging-frameworks#221](https://redirect.github.com/openrewrite/rewrite-logging-frameworks/pull/221)
> * [`@​pdelagrave`](https://github.com/pdelagrave) made their first contribution in [openrewrite/rewrite-logging-frameworks#224](https://redirect.github.com/openrewrite/rewrite-logging-frameworks/pull/224)

... (truncated)


Commits

* [`946d0ce`](openrewrite/rewrite-logging-frameworks@946d0ce) Update documentation examples
* [`210eff9`](openrewrite/rewrite-logging-frameworks@210eff9) rename settings.local.json to settings.json ([#247](https://redirect.github.com/openrewrite/rewrite-logging-frameworks/issues/247))
* [`2e67627`](openrewrite/rewrite-logging-frameworks@2e67627) Add a recipe to migrate from JBoss Logging to SLF4J ([#241](https://redirect.github.com/openrewrite/rewrite-logging-frameworks/issues/241))
* [`c59c405`](openrewrite/rewrite-logging-frameworks@c59c405) LoggerLevelArgumentToMethod for JBoss Logging ([#243](https://redirect.github.com/openrewrite/rewrite-logging-frameworks/issues/243))
* [`36a5200`](openrewrite/rewrite-logging-frameworks@36a5200) OpenRewrite recipe best practices
* [`aa3f14f`](openrewrite/rewrite-logging-frameworks@aa3f14f) Avoid unsafe changes in `JulParameterizedArguments` when `JavaType.Array` arg...
* [`249944e`](openrewrite/rewrite-logging-frameworks@249944e) Add `ArgumentArrayToVarargs` for logger methods that take a var args argument...
* [`bb34ecf`](openrewrite/rewrite-logging-frameworks@bb34ecf) Create Claude settings file
* [`ce8bc2d`](openrewrite/rewrite-logging-frameworks@ce8bc2d) refactor: Static imports for Collections and Collectors
* [`af44c67`](openrewrite/rewrite-logging-frameworks@af44c67) Recipe to migrate deprecated JBoss Logging calls ([#245](https://redirect.github.com/openrewrite/rewrite-logging-frameworks/issues/245))
* Additional commits viewable in [compare view](openrewrite/rewrite-logging-frameworks@v3.7.0...v3.13.0)
  
[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility\_score?dependency-name=org.openrewrite.recipe:rewrite-logging-frameworks&package-manager=maven&previous-version=3.7.0&new-version=3.13.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.
[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)
---
Dependabot commands and options
  
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show  ignore conditions` will show all of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
recipe Recipe Requested
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants