org.openrewrite.java.logging.log4j.ConvertJulExiting Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rewrite-logging-frameworks Show documentation
Enforce logging best practices and migrate between logging frameworks. Automatically.
The newest version!
/*
 * Copyright 2023 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 

 * https://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.openrewrite.java.logging.log4j;

import lombok.EqualsAndHashCode;
import lombok.Value;
import org.openrewrite.ExecutionContext;
import org.openrewrite.Preconditions;
import org.openrewrite.Recipe;
import org.openrewrite.TreeVisitor;
import org.openrewrite.java.JavaIsoVisitor;
import org.openrewrite.java.MethodMatcher;
import org.openrewrite.java.search.UsesMethod;
import org.openrewrite.java.tree.*;

import java.util.ArrayList;
import java.util.List;

/**
 * This recipe rewrites JUL's {@link java.util.logging.Logger#entering} method.
 */
@Value
@EqualsAndHashCode(callSuper = false)
public class ConvertJulExiting extends Recipe {

    private static final MethodMatcher METHOD_MATCHER = new MethodMatcher("java.util.logging.Logger exiting(String, String, ..)", false);

    @Override
    public String getDisplayName() {
        return "Rewrites JUL's Logger#exiting method to Log4j API";
    }

    @Override
    public String getDescription() {
        return "Replaces JUL's Logger#exiting method calls to Log4j API Logger#traceEntry calls.";
    }

    @Override
    public TreeVisitor getVisitor() {
        return Preconditions.check(new UsesMethod<>(METHOD_MATCHER), new JavaIsoVisitor() {
            @Override
            public J.MethodInvocation visitMethodInvocation(J.MethodInvocation method, ExecutionContext ctx) {
                J.MethodInvocation m = super.visitMethodInvocation(method, ctx);
                if (METHOD_MATCHER.matches(m) && m.getMethodType() != null) {
                    List> originalArgs = m.getPadding()
                            .getArguments()
                            .getPadding()
                            .getElements();
                    List originalTypes = m.getMethodType().getParameterTypes();
                    int originalArgCount = originalArgs.size();
                    if (3 < originalArgCount) {
                        return m;
                    }
                    List modifiedArgs = new ArrayList<>();
                    List modifiedTypes = new ArrayList<>();
                    if (originalArgCount > 2) {
                        modifiedArgs.add(originalArgs.get(2).getElement().withPrefix(Space.EMPTY));
                        modifiedTypes.add(originalTypes.get(2));
                    }
                    JavaType.Method mt = m.getMethodType().withParameterTypes(modifiedTypes);
                    JavaType.FullyQualified dt = mt.getDeclaringType()
                            .withFullyQualifiedName("org.apache.logging.log4j.Logger");
                    return m.withMethodType(mt)
                            .withName(m.getName().withSimpleName("traceExit"))
                            .withArguments(modifiedArgs)
                            .withDeclaringType(dt);
                }
                return m;
            }
        });
    }
}