org.openrewrite.java.spring.boot2.MigrateErrorPropertiesIncludeStackTraceConstants Maven / Gradle / Ivy
Show all versions of rewrite-spring Show documentation
/*
* Copyright 2021 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.spring.boot2;
import org.openrewrite.*;
import org.openrewrite.java.JavaIsoVisitor;
import org.openrewrite.java.search.UsesType;
import org.openrewrite.java.tree.Flag;
import org.openrewrite.java.tree.J;
import org.openrewrite.java.tree.JavaType;
import org.openrewrite.java.tree.TypeUtils;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import static java.util.Collections.emptyList;
public class MigrateErrorPropertiesIncludeStackTraceConstants extends Recipe {
@Override
public String getDisplayName() {
return "Use `ErrorProperties#IncludeStacktrace.ON_PARAM`";
}
@Override
public String getDescription() {
return "`ErrorProperties#IncludeStacktrace.ON_TRACE_PARAM` was deprecated in 2.3.x and removed in 2.5.0.";
}
@Override
public TreeVisitor getVisitor() {
return Preconditions.check(new UsesType<>("org.springframework.boot.autoconfigure.web.ErrorProperties$IncludeStacktrace", false),
new MigrateErrorPropertiesIncludeStackTraceConstants.UpdateDeprecatedConstantFieldNames());
}
private static class UpdateDeprecatedConstantFieldNames extends JavaIsoVisitor {
private static final JavaType.FullyQualified ORIGINAL_FQN =
JavaType.ShallowClass.build("org.springframework.boot.autoconfigure.web.ErrorProperties$IncludeStacktrace");
private final Map updateDeprecatedFields = new HashMap<>();
UpdateDeprecatedConstantFieldNames() {
updateDeprecatedFields.put("ON_TRACE_PARAM", "ON_PARAM");
}
@Override
public J.ClassDeclaration visitClassDeclaration(J.ClassDeclaration classDecl, ExecutionContext ctx) {
J.ClassDeclaration cd = super.visitClassDeclaration(classDecl, ctx);
if (!classDecl.getSimpleName().equals(ORIGINAL_FQN.getClassName())) {
maybeRemoveImport(ORIGINAL_FQN);
}
return cd;
}
@Override
public J.Import visitImport(J.Import anImport, ExecutionContext ctx) {
J.Identifier name = anImport.getQualid().getName();
if (anImport.isStatic() && updateDeprecatedFields.containsKey(name.getSimpleName()) &&
TypeUtils.isOfClassType(anImport.getQualid().getTarget().getType(), ORIGINAL_FQN.getFullyQualifiedName())) {
return anImport.withQualid(anImport.getQualid().withName(name.withSimpleName(updateDeprecatedFields.get(name.getSimpleName()))));
}
return super.visitImport(anImport, ctx);
}
@Override
public J.FieldAccess visitFieldAccess(J.FieldAccess fieldAccess, ExecutionContext ctx) {
J.FieldAccess fa = super.visitFieldAccess(fieldAccess, ctx);
if (isTargetClass() &&
TypeUtils.isOfType(ORIGINAL_FQN, fa.getTarget().getType()) &&
updateDeprecatedFields.containsKey(fa.getName().getSimpleName())) {
fa = fa.withName(fa.getName().withSimpleName(updateDeprecatedFields.get(fa.getName().getSimpleName())));
String className;
if (fa.getTarget() instanceof J.Identifier) {
className = ORIGINAL_FQN.getClassName().substring(ORIGINAL_FQN.getClassName().lastIndexOf(".") + 1);
} else {
className = ORIGINAL_FQN.getClassName();
}
fa = fa.withTarget(new J.Identifier(
Tree.randomId(),
fa.getTarget().getPrefix(),
fa.getTarget().getMarkers(),
emptyList(),
className,
ORIGINAL_FQN,
null));
}
return fa;
}
@Override
public J.Identifier visitIdentifier(J.Identifier identifier, ExecutionContext ctx) {
J.Identifier id = super.visitIdentifier(identifier, ctx);
if (isTargetClass() && isTargetFieldType(id) && updateDeprecatedFields.containsKey(id.getSimpleName())) {
JavaType.Variable fieldType = id.getFieldType();
id = new J.Identifier(
Tree.randomId(),
id.getPrefix(),
id.getMarkers(),
emptyList(),
updateDeprecatedFields.get(id.getSimpleName()),
id.getType(),
fieldType == null ? null : new JavaType.Variable(
null,
Flag.flagsToBitMap(fieldType.getFlags()),
updateDeprecatedFields.get(id.getSimpleName()),
ORIGINAL_FQN,
ORIGINAL_FQN,
Collections.emptyList()));
}
return id;
}
private boolean isTargetClass() {
Cursor parentCursor = getCursor().dropParentUntil(
is -> is instanceof SourceFile ||
is instanceof J.ClassDeclaration);
return parentCursor.getValue() instanceof J.ClassDeclaration &&
!((J.ClassDeclaration) parentCursor.getValue()).getName().getSimpleName().equals(ORIGINAL_FQN.getClassName());
}
private boolean isTargetFieldType(J.Identifier identifier) {
if (identifier.getFieldType() != null) {
JavaType.FullyQualified fqn = TypeUtils.asFullyQualified(identifier.getFieldType().getOwner());
return fqn != null && ORIGINAL_FQN.getFullyQualifiedName().equals(fqn.getFullyQualifiedName());
}
return false;
}
}
}