Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Diagnostic for dependency class with no @Inject and no-arg constructor #217

Closed
wants to merge 2 commits into from
Closed

Diagnostic for dependency class with no @Inject and no-arg constructor #217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a5b2aad
Added diagnostics and quickfix for a managed bean class of generic type
KidoVin01 Nov 16, 2021
3d04ad8
Added quickfix to create no-arg constructor for managed beans
KidoVin01 Nov 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion ...arta.jdt.core/src/main/java/org/eclipse/lsp4jakarta/jdt/codeAction/CodeActionHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
import org.eclipse.lsp4jakarta.jdt.core.cdi.ConflictProducesInjectQuickFix;
import org.eclipse.lsp4jakarta.jdt.core.cdi.ManagedBeanConstants;
import org.eclipse.lsp4jakarta.jdt.core.cdi.ManagedBeanConstructorQuickFix;
import org.eclipse.lsp4jakarta.jdt.core.cdi.ManagedBeanNoArgConstructorQuickFix;
import org.eclipse.lsp4jakarta.jdt.core.cdi.ManagedBeanQuickFix;
import org.eclipse.lsp4jakarta.jdt.core.cdi.ScopeDeclarationQuickFix;
import org.eclipse.lsp4jakarta.jdt.core.di.DependencyInjectionConstants;
Expand All @@ -58,7 +59,6 @@
import org.eclipse.lsp4jakarta.jdt.core.servlet.ListenerImplementationQuickFix;
import org.eclipse.lsp4jakarta.jdt.core.servlet.ServletConstants;
import org.eclipse.lsp4jakarta.jdt.core.persistence.DeleteConflictMapKeyQuickFix;
import org.eclipse.lsp4jakarta.jdt.core.persistence.PersistenceConstants;
import org.eclipse.lsp4jakarta.jdt.core.JakartaCorePlugin;

/**
Expand Down Expand Up @@ -102,6 +102,7 @@ public List<CodeAction> codeAction(JakartaJavaCodeActionParams params, JDTUtils
ConflictProducesInjectQuickFix ConflictProducesInjectQuickFix = new ConflictProducesInjectQuickFix();
BeanValidationQuickFix BeanValidationQuickFix = new BeanValidationQuickFix();
ManagedBeanConstructorQuickFix ManagedBeanConstructorQuickFix = new ManagedBeanConstructorQuickFix();
ManagedBeanNoArgConstructorQuickFix ManagedBeanNoArgConstructorQuickFix = new ManagedBeanNoArgConstructorQuickFix();
JsonbAnnotationQuickFix JsonbAnnotationQuickFix = new JsonbAnnotationQuickFix();
ScopeDeclarationQuickFix ScopeDeclarationQuickFix = new ScopeDeclarationQuickFix();
RemoveInjectAnnotationQuickFix RemoveInjectAnnotationQuickFix = new RemoveInjectAnnotationQuickFix();
Expand Down Expand Up @@ -162,13 +163,17 @@ public List<CodeAction> codeAction(JakartaJavaCodeActionParams params, JDTUtils
if (diagnostic.getCode().getLeft().equals(ManagedBeanConstants.DIAGNOSTIC_CODE_PRODUCES_INJECT)) {
codeActions.addAll(ConflictProducesInjectQuickFix.getCodeActions(context, diagnostic, monitor));
}
if (diagnostic.getCode().getLeft().equals(ManagedBeanConstants.DIAGNOSTIC_CODE_INVALID_INJECT_PARAM)) {
codeActions.addAll(RemoveInjectAnnotationQuickFix.getCodeActions(context, diagnostic, monitor));
}
if (diagnostic.getCode().getLeft().equals(BeanValidationConstants.DIAGNOSTIC_CODE_STATIC)
|| diagnostic.getCode().getLeft()
.equals(BeanValidationConstants.DIAGNOSTIC_CODE_INVALID_TYPE)) {
codeActions.addAll(BeanValidationQuickFix.getCodeActions(context, diagnostic, monitor));
}
if (diagnostic.getCode().getLeft().equals(ManagedBeanConstants.CONSTRUCTOR_DIAGNOSTIC_CODE)) {
codeActions.addAll(ManagedBeanConstructorQuickFix.getCodeActions(context, diagnostic, monitor));
codeActions.addAll(ManagedBeanNoArgConstructorQuickFix.getCodeActions(context, diagnostic, monitor));
}
if (diagnostic.getCode().getLeft().equals(JsonbConstants.DIAGNOSTIC_CODE_ANNOTATION)) {
codeActions.addAll(JsonbAnnotationQuickFix.getCodeActions(context, diagnostic, monitor));
Expand All @@ -192,6 +197,7 @@ public List<CodeAction> codeAction(JakartaJavaCodeActionParams params, JDTUtils
codeActions.addAll(RemoveInjectAnnotationQuickFix.getCodeActions(context, diagnostic, monitor));
codeActions.addAll(RemoveStaticModifierQuickFix.getCodeActions(context, diagnostic, monitor));
}

} catch (CoreException e) {
e.printStackTrace();
}
Expand Down
1 change: 1 addition & 0 deletions ...rta.jdt.core/src/main/java/org/eclipse/lsp4jakarta/jdt/core/cdi/ManagedBeanConstants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ public class ManagedBeanConstants {
public static final String DISPOSES = "Disposes";
public static final String OBSERVES = "Observes";
public static final String OBSERVES_ASYNC = "ObservesAsync";
public static final String DEPENDENT = "Dependent";


public static final String DIAGNOSTIC_SOURCE = "jakarta-cdi";
Expand Down
16 changes: 13 additions & 3 deletions ...e/src/main/java/org/eclipse/lsp4jakarta/jdt/core/cdi/ManagedBeanDiagnosticsCollector.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,8 @@
import java.util.Set;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.TreeSet;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import org.eclipse.jdt.core.Flags;
import org.eclipse.jdt.core.IAnnotation;
Expand Down Expand Up @@ -248,7 +246,19 @@ else if (!hasParameterizedInjectConstructor)
CONSTRUCTOR_DIAGNOSTIC_CODE);
diagnostics.add(diagnostic);
}

}
}

/**
* If a managed bean class is of generic type, it must be annotated with @Dependent
*/
if (isManagedBean) {
boolean isClassGeneric = type.getTypeParameters().length != 0;

if (isClassGeneric && managedBeanAnnotations.stream()
.anyMatch(annotation -> !annotation.equals("Dependent"))) {
diagnostics.add(createDiagnostic(type, unit, "Managed bean class of generic type must have scope @dependent.",
DIAGNOSTIC_CODE));
}
}

Expand Down
84 changes: 84 additions & 0 deletions ...c/main/java/org/eclipse/lsp4jakarta/jdt/core/cdi/ManagedBeanNoArgConstructorQuickFix.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
/*******************************************************************************
* Copyright (c) 2021 IBM Corporation.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* Hani Damlaj
*******************************************************************************/

package org.eclipse.lsp4jakarta.jdt.core.cdi;

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

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jdt.core.dom.ASTNode;
import org.eclipse.jdt.core.dom.IBinding;
import org.eclipse.jdt.core.dom.VariableDeclarationFragment;
import org.eclipse.jdt.internal.corext.dom.Bindings;
import org.eclipse.lsp4j.CodeAction;
import org.eclipse.lsp4j.Diagnostic;
import org.eclipse.lsp4jakarta.jdt.codeAction.IJavaCodeActionParticipant;
import org.eclipse.lsp4jakarta.jdt.codeAction.JavaCodeActionContext;
import org.eclipse.lsp4jakarta.jdt.codeAction.proposal.AddConstructorProposal;
import org.eclipse.lsp4jakarta.jdt.codeAction.proposal.ChangeCorrectionProposal;
import org.eclipse.lsp4jakarta.jdt.core.persistence.PersistenceConstants;

public class ManagedBeanNoArgConstructorQuickFix implements IJavaCodeActionParticipant {

@Override
public List<? extends CodeAction> getCodeActions(JavaCodeActionContext context, Diagnostic diagnostic,
IProgressMonitor monitor) throws CoreException {
ASTNode node = context.getCoveredNode();
IBinding parentType = getBinding(node);
if (parentType != null) {
List<CodeAction> codeActions = new ArrayList<>();

codeActions.addAll(addConstructor(diagnostic, context, parentType));


return codeActions;
}
return null;
}

protected static IBinding getBinding(ASTNode node) {
if (node.getParent() instanceof VariableDeclarationFragment) {
VariableDeclarationFragment fragment = (VariableDeclarationFragment) node.getParent();
return ((VariableDeclarationFragment) node.getParent()).resolveBinding();
}
return Bindings.getBindingOfParentType(node);
}

private List<CodeAction> addConstructor(Diagnostic diagnostic, JavaCodeActionContext context, IBinding parentType) throws CoreException {
List<CodeAction> codeActions = new ArrayList<>();

// option for protected constructor
String name = "Add a no-arg protected constructor to this class";
ChangeCorrectionProposal proposal = new AddConstructorProposal(name,
context.getCompilationUnit(), context.getASTRoot(), parentType, 0);
CodeAction codeAction = context.convertToCodeAction(proposal, diagnostic);

if (codeAction != null) {
codeActions.add(codeAction);
}

// option for public constructor
name = "Add a no-arg public constructor to this class";
proposal = new AddConstructorProposal(name,
context.getCompilationUnit(), context.getASTRoot(), parentType, 0, "public");
codeAction = context.convertToCodeAction(proposal, diagnostic);

if (codeAction != null) {
codeActions.add(codeAction);
}

return codeActions;
}
}
4 changes: 4 additions & 0 deletions ....core/src/main/java/org/eclipse/lsp4jakarta/jdt/core/di/DependencyInjectionConstants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@

package org.eclipse.lsp4jakarta.jdt.core.di;

import java.util.Arrays;
import java.util.HashSet;
import java.util.Set;

import org.eclipse.lsp4j.DiagnosticSeverity;

public class DependencyInjectionConstants {
Expand Down
6 changes: 1 addition & 5 deletions ...ain/java/org/eclipse/lsp4jakarta/jdt/core/di/DependencyInjectionDiagnosticsCollector.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@

package org.eclipse.lsp4jakarta.jdt.core.di;

import static org.eclipse.lsp4jakarta.jdt.core.di.DependencyInjectionConstants.DIAGNOSTIC_SOURCE;
import static org.eclipse.lsp4jakarta.jdt.core.di.DependencyInjectionConstants.SEVERITY;
import static org.eclipse.lsp4jakarta.jdt.core.di.DependencyInjectionConstants.*;

import java.util.ArrayList;
Expand All @@ -37,7 +35,6 @@
import org.eclipse.lsp4jakarta.jdt.core.JDTUtils;
import org.eclipse.lsp4jakarta.jdt.core.JakartaCorePlugin;
import org.eclipse.jdt.core.IJavaElement;
import org.eclipse.jdt.core.IMethod;

/**
*
Expand Down Expand Up @@ -93,7 +90,6 @@ public void collectDiagnostics(ICompilationUnit unit, List<Diagnostic> diagnosti
alltypes = unit.getAllTypes();
for (IType type : alltypes) {
allAnnotations = type.getAnnotations();

IField[] allFields = type.getFields();
for (IField field : allFields) {
int fieldFlags = field.getFlags();
Expand Down Expand Up @@ -164,7 +160,6 @@ public void collectDiagnostics(ICompilationUnit unit, List<Diagnostic> diagnosti
for (IType type : alltypes) {
List<IMethod> constructorMethods = Arrays.stream(type.getMethods()).filter(this::isConstructorMethod)
.collect(Collectors.toList());

// there are no constructors
if (constructorMethods.size() == 0)
return;
Expand All @@ -173,6 +168,7 @@ public void collectDiagnostics(ICompilationUnit unit, List<Diagnostic> diagnosti
int numInjectedConstructors = 0;
List<IMethod> injectedConstructors = new ArrayList<IMethod>();
for (IMethod m : constructorMethods) {

hasInjectConstructor = Arrays.stream(m.getAnnotations())
.map(annotation -> annotation.getElementName())
.anyMatch(annotation -> annotation.equals("Inject"));
Expand Down