Consider Lombok annotations for loggers

[miguelchico]

What problem are you trying to solve?

I'm trying to use logging recipes in a project that uses Lombok to declare SLF4J loggers.
The recipes I've tried so far don't change my source code if the logger instance is created by the Lombok Slf4j annotation.

For example try to use the "Use logger instead of printStackTrace()" with the following code:

package justatest;

import org.slf4j.Logger;

@Slf4j
public class Test {

  void thisIsJustATest() {
      try {
      } catch (Exception e) {
        e.printStackTrace()
      }
  }

}

and it won't make any changes to the code.

If I don't use the Lombok annotation and just create a Logger by myself, everything works perfectly

Describe the solution you'd like

It is desirable that Lombok annotations are included in the existing recipes (not just the one in the example above)

Have you considered any alternatives or workarounds?

There is no workaround possible that I'm aware of

[timtebeek]

Hi @migualchico; interesting case! In part this is down to OpenRewrite not yet supporting Lombok annotations; support for that is tracked in:

• Support Lombok Annotations rewrite#1297

Because we don't yet support Lombok annotations, this conditional fails, as there's no such field found

rewrite-logging-frameworks/src/main/java/org/openrewrite/java/logging/PrintStackTraceToLogError.java

Lines 79 to 80 in 73eb21a

	Set<J.VariableDeclarations> loggers = FindFieldsOfType.find(clazz, framework.getLoggerType());
	if (!loggers.isEmpty()) {

We can likely do two things to hope to resolve your immediate issue:

1. generically support the lombok logging annotations by adding a synthetic logging field, that's available to recipes, but not modifiable or printed (high effort and complexity)
2. specifically for this recipe, look for lombok logging annotations, and if found, generate a logging template that uses the default "log" field generated (for simplicity, not taking into account lombok.log.fieldName)

The second approach might be easier to tackle, starting with a draft pull request that merely adds a test to verify the desired behavior. Would you be willing to try your hand at that?

[timtebeek]

Thanks for reporting your findings here! This should be fixed in

• Support for Lombok log annotations in three recipes #115

You can try out this change through our snapshot versions, pending the next release.

Please let us know how this works for you! :)