org.openrewrite.java.jackson.codehaus.TransferJsonSerializeArgumentsFromCodehausToFasterXML Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rewrite-jackson Show documentation
Jackson Migration
There is a newer version: 0.5.0
/*
 * Copyright 2024 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.jackson.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.jackson.codehaus;

import lombok.RequiredArgsConstructor;
import org.jspecify.annotations.NonNull;
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.jackson.codehaus.RemoveDoublyAnnotatedCodehausAnnotations.FindDoublyAnnotatedVisitor;
import org.openrewrite.java.search.UsesType;
import org.openrewrite.java.tree.Expression;
import org.openrewrite.java.tree.J;
import org.openrewrite.java.tree.Space;

import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class TransferJsonSerializeArgumentsFromCodehausToFasterXML extends Recipe {

    private static final String[] TRANSFERABLE_ARGUMENTS = {"using", "contentUsing", "keyUsing", "nullUsing"};

    @Override
    public String getDisplayName() {
        return "Transfer @JsonSerialize arguments from Codehaus to FasterXML";
    }

    @Override
    public String getDescription() {
        return "Transfer @JsonSerialize annotation arguments (using, contentUsing, keyUsing, nullUsing) from Codehaus " +
                "to FasterXML. If the argument was set already, it will not be transferred.";
    }

    @Override
    public TreeVisitor getVisitor() {
        return Preconditions.check(Preconditions.and(
                        new UsesType<>("org.codehaus.jackson.map.annotate.JsonSerialize", false),
                        new UsesType<>("com.fasterxml.jackson.databind.annotation.JsonSerialize", false)),
                new JavaIsoVisitor() {
                    @Override
                    public J preVisit(@NonNull J tree, ExecutionContext ctx) {
                        stopAfterPreVisit();

                        // Map from codehaus -> fasterxml annotation
                        Map doubleAnnotated = new FindDoublyAnnotatedVisitor().reduce(tree, new HashMap<>());

                        for (String argumentName : TRANSFERABLE_ARGUMENTS) {
                            transferArgument(doubleAnnotated, argumentName);
                        }

                        return tree;
                    }

                    private void transferArgument(Map doubleAnnotated, String argumentName) {
                        Map argumentExpressionMap = mapToArgumentExpression(doubleAnnotated, argumentName);
                        doAfterVisit(new TransferArgumentsVisitor(argumentExpressionMap, argumentName));
                    }
                });
    }

    private static Map mapToArgumentExpression(Map doubleAnnotated, String argumentName) {
        // Map from fasterxml -> value of "using=..." in codehaus annotation
        Map mapToArgument = new HashMap<>();
        doubleAnnotated.forEach((key, value) -> {
            if (key.getArguments() != null || key.getArguments().isEmpty()) {
                key.getArguments().forEach(arg -> {
                    if (arg instanceof J.Assignment) {
                        J.Assignment assign = (J.Assignment) arg;
                        J.Identifier varId = (J.Identifier) assign.getVariable();
                        if (argumentName.equals(varId.getSimpleName())) {
                            mapToArgument.put(value, arg);
                        }
                    }
                });
            }
        });
        return mapToArgument;
    }

    @RequiredArgsConstructor
    private static class TransferArgumentsVisitor extends JavaIsoVisitor {

        private final Map fasterXmlToUsingExpression;
        private final String argumentName;

        @Override
        public J.Annotation visitAnnotation(J.Annotation annotation, ExecutionContext ctx) {
            Expression e = fasterXmlToUsingExpression.get(annotation);
            if (e != null) {
                List arguments = annotation.getArguments();
                if (arguments == null || arguments.isEmpty() || arguments.get(0) instanceof J.Empty) {
                    return annotation.withArguments(Collections.singletonList(e.withPrefix(Space.EMPTY)));
                }

                boolean notAlreadyUsing = arguments.stream().noneMatch(arg -> {
                    if (arg instanceof J.Assignment) {
                        J.Assignment assign = (J.Assignment) arg;
                        J.Identifier varId = (J.Identifier) assign.getVariable();
                        return argumentName.equals(varId.getSimpleName());
                    }
                    return false;
                });
                if (notAlreadyUsing) {
                    arguments.add(e);
                    return annotation.withArguments(arguments);
                }
            }
            return annotation;
        }
    }
}