Skip to content

Commit

Permalink
Merge pull request #15467 from mkouba/arc-devui-compare-fix
Browse files Browse the repository at this point in the history 
Dev UI - fix comparator for CDI observers
  • Loading branch information
@mkouba
mkouba authored Mar 4, 2021
2 parents 58062c8 + fee6b2b commit 7719a69
Show file tree
Hide file tree
Showing 4 changed files with 148 additions and 64 deletions.
73 changes: 43 additions & 30 deletions ...nsions/arc/deployment/src/main/java/io/quarkus/arc/deployment/devconsole/DevBeanInfo.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,60 +17,73 @@

public class DevBeanInfo implements Comparable<DevBeanInfo> {

private final DevBeanKind kind;
private final boolean isApplicationBean;
private final Name providerType;
private final String memberName;
private final Set<Name> types;
private final Set<Name> qualifiers;
private final Name scope;
private final Name declaringClass;

public DevBeanInfo(BeanInfo bean, CompletedApplicationClassPredicateBuildItem predicate) {
qualifiers = new HashSet<>();
public static DevBeanInfo from(BeanInfo bean, CompletedApplicationClassPredicateBuildItem predicate) {
Set<Name> qualifiers = new HashSet<>();
for (AnnotationInstance qualifier : bean.getQualifiers()) {
qualifiers.add(Name.from(qualifier));
}
scope = Name.from(bean.getScope().getDotName());
types = new HashSet<>();
Set<Name> types = new HashSet<>();
for (Type beanType : bean.getTypes()) {
types.add(Name.from(beanType));
}

providerType = Name.from(bean.getProviderType());
Name scope = Name.from(bean.getScope().getDotName());
Name providerType = Name.from(bean.getProviderType());

if (bean.getTarget().isPresent()) {
AnnotationTarget target = bean.getTarget().get();
DevBeanKind kind;
String memberName;
boolean isApplicationBean;
Name declaringClass;
if (target.kind() == Kind.METHOD) {
MethodInfo method = target.asMethod();
memberName = method.name();
this.kind = DevBeanKind.METHOD;
this.isApplicationBean = predicate.test(bean.getDeclaringBean().getBeanClass());
this.declaringClass = Name.from(bean.getDeclaringBean().getBeanClass());
kind = DevBeanKind.METHOD;
isApplicationBean = predicate.test(bean.getDeclaringBean().getBeanClass());
declaringClass = Name.from(bean.getDeclaringBean().getBeanClass());
} else if (target.kind() == Kind.FIELD) {
FieldInfo field = target.asField();
this.memberName = field.name();
this.kind = DevBeanKind.FIELD;
this.isApplicationBean = predicate.test(bean.getDeclaringBean().getBeanClass());
this.declaringClass = Name.from(bean.getDeclaringBean().getBeanClass());
memberName = field.name();
kind = DevBeanKind.FIELD;
isApplicationBean = predicate.test(bean.getDeclaringBean().getBeanClass());
declaringClass = Name.from(bean.getDeclaringBean().getBeanClass());
} else if (target.kind() == Kind.CLASS) {
ClassInfo clazz = target.asClass();
this.kind = DevBeanKind.CLASS;
this.memberName = null;
this.isApplicationBean = predicate.test(clazz.name());
this.declaringClass = null;
kind = DevBeanKind.CLASS;
memberName = null;
isApplicationBean = predicate.test(clazz.name());
declaringClass = null;
} else {
throw new IllegalArgumentException("Invalid annotation target: " + target);
}
return new DevBeanInfo(kind, isApplicationBean, providerType, memberName, types, qualifiers, scope, declaringClass);
} else {
// Synthetic bean
this.kind = DevBeanKind.SYNTHETIC;
this.isApplicationBean = false;
this.declaringClass = null;
this.memberName = null;
return new DevBeanInfo(DevBeanKind.SYNTHETIC, false, providerType, null, types, qualifiers, scope, null);
}
}

public DevBeanInfo(DevBeanKind kind, boolean isApplicationBean, Name providerType, String memberName, Set<Name> types,
Set<Name> qualifiers, Name scope, Name declaringClass) {
this.kind = kind;
this.isApplicationBean = isApplicationBean;
this.providerType = providerType;
this.memberName = memberName;
this.types = types;
this.qualifiers = qualifiers;
this.scope = scope;
this.declaringClass = declaringClass;
}

private final DevBeanKind kind;
private final boolean isApplicationBean;
private final Name providerType;
private final String memberName;
private final Set<Name> types;
private final Set<Name> qualifiers;
private final Name scope;
private final Name declaringClass;

public DevBeanKind getKind() {
return kind;
}
Expand Down
6 changes: 3 additions & 3 deletions ...rc/deployment/src/main/java/io/quarkus/arc/deployment/devconsole/DevConsoleProcessor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,13 +93,13 @@ public DevConsoleTemplateInfoBuildItem collectBeanInfo(ValidationPhaseBuildItem
BeanDeploymentValidator.ValidationContext validationContext = validationPhaseBuildItem.getContext();
DevBeanInfos beanInfos = new DevBeanInfos();
for (BeanInfo beanInfo : validationContext.beans()) {
beanInfos.addBean(new DevBeanInfo(beanInfo, predicate));
beanInfos.addBean(DevBeanInfo.from(beanInfo, predicate));
}
for (BeanInfo beanInfo : validationContext.removedBeans()) {
beanInfos.addRemovedBean(new DevBeanInfo(beanInfo, predicate));
beanInfos.addRemovedBean(DevBeanInfo.from(beanInfo, predicate));
}
for (ObserverInfo observerInfo : validationContext.get(BuildExtension.Key.OBSERVERS)) {
beanInfos.addObserver(new DevObserverInfo(observerInfo, predicate));
beanInfos.addObserver(DevObserverInfo.from(observerInfo, predicate));
}
beanInfos.sort();
return new DevConsoleTemplateInfoBuildItem("devBeanInfos", beanInfos);
Expand Down
84 changes: 53 additions & 31 deletions ...ns/arc/deployment/src/main/java/io/quarkus/arc/deployment/devconsole/DevObserverInfo.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,24 @@

public class DevObserverInfo implements Comparable<DevObserverInfo> {

public static DevObserverInfo from(ObserverInfo observer, CompletedApplicationClassPredicateBuildItem predicate) {
List<Name> qualifiers;
if (observer.getQualifiers().isEmpty()) {
qualifiers = Collections.emptyList();
} else {
qualifiers = observer.getQualifiers().stream().map(Name::from).collect(Collectors.toList());
}
if (observer.getDeclaringBean() != null) {
return new DevObserverInfo(predicate.test(observer.getObserverMethod().declaringClass().name()),
Name.from(observer.getObserverMethod().declaringClass().name()), observer.getObserverMethod().name(),
Name.from(observer.getObservedType()), qualifiers, observer.getPriority(), observer.isAsync(),
observer.getReception(), observer.getTransactionPhase());
} else {
return new DevObserverInfo(false, null, null, Name.from(observer.getObservedType()), qualifiers,
observer.getPriority(), observer.isAsync(), observer.getReception(), observer.getTransactionPhase());
}
}

private final boolean isApplicationObserver;
private final Name declaringClass;
private final String methodName;
Expand All @@ -22,27 +40,17 @@ public class DevObserverInfo implements Comparable<DevObserverInfo> {
private final Reception reception;
private final TransactionPhase transactionPhase;

public DevObserverInfo(ObserverInfo observer, CompletedApplicationClassPredicateBuildItem predicate) {
priority = observer.getPriority();
reception = observer.getReception();
transactionPhase = observer.getTransactionPhase();
isAsync = observer.isAsync();
observedType = Name.from(observer.getObservedType());

if (observer.getQualifiers().isEmpty()) {
qualifiers = Collections.emptyList();
} else {
qualifiers = observer.getQualifiers().stream().map(Name::from).collect(Collectors.toList());
}
if (observer.getDeclaringBean() != null) {
declaringClass = Name.from(observer.getObserverMethod().declaringClass().name());
methodName = observer.getObserverMethod().name();
isApplicationObserver = predicate.test(observer.getObserverMethod().declaringClass().name());
} else {
declaringClass = null;
methodName = null;
isApplicationObserver = false;
}
public DevObserverInfo(boolean isApplicationObserver, Name declaringClass, String methodName, Name observedType,
List<Name> qualifiers, int priority, boolean isAsync, Reception reception, TransactionPhase transactionPhase) {
this.isApplicationObserver = isApplicationObserver;
this.declaringClass = declaringClass;
this.methodName = methodName;
this.observedType = observedType;
this.qualifiers = qualifiers;
this.priority = priority;
this.isAsync = isAsync;
this.reception = reception;
this.transactionPhase = transactionPhase;
}

public Name getDeclaringClass() {
Expand Down Expand Up @@ -82,17 +90,31 @@ public boolean isApplicationObserver() {
}

@Override
public int compareTo(DevObserverInfo o) {
// Application beans should go first
if (isApplicationObserver == o.isApplicationObserver) {
if (declaringClass == null && o.declaringClass != null) {
return -1;
} else if (declaringClass != null && o.declaringClass == null) {
return 1;
public int compareTo(DevObserverInfo other) {
// Application observers should go first
int ret = 0;
if (isApplicationObserver != other.isApplicationObserver) {
ret = isApplicationObserver ? -1 : 1;
} else {
// Note that declaringClass and methodName are null for synthetic observers
if (declaringClass == null && other.declaringClass == null) {
// Synthetic observers
ret = observedType.compareTo(other.observedType);
} else {
// At this point we can be sure that at least one of the observers is not synthetic
if (declaringClass == null && other.declaringClass != null) {
ret = 1;
} else if (declaringClass != null && other.declaringClass == null) {
ret = -1;
} else {
ret = declaringClass.compareTo(other.declaringClass);
}
if (ret == 0) {
// Observers are not synthetic - method name must be present
ret = methodName.compareTo(other.methodName);
}
}
int ret = declaringClass.compareTo(o.declaringClass);
return ret == 0 ? methodName.compareTo(o.methodName) : ret;
}
return isApplicationObserver ? -1 : 1;
return ret;
}
}
49 changes: 49 additions & 0 deletions ...ions/arc/deployment/src/test/java/io/quarkus/arc/test/devconsole/DevObserverInfoTest.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
package io.quarkus.arc.test.devconsole;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNull;

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

import javax.enterprise.event.Reception;
import javax.enterprise.event.TransactionPhase;

import org.junit.jupiter.api.Test;

import io.quarkus.arc.deployment.devconsole.DevObserverInfo;
import io.quarkus.arc.deployment.devconsole.Name;

public class DevObserverInfoTest {

@Test
public void testCompare() {
List<DevObserverInfo> observers = new ArrayList<>();
// Synthetic non-app - should be last
observers.add(new DevObserverInfo(false, null, null, new Name("Delta"),
Collections.emptyList(), 0, false, Reception.ALWAYS, TransactionPhase.IN_PROGRESS));
// App observers
observers.add(new DevObserverInfo(true, new Name("Alpha"), "fooish", new Name("java.lang.String"),
Collections.emptyList(), 0, false, Reception.ALWAYS, TransactionPhase.IN_PROGRESS));
observers.add(new DevObserverInfo(true, new Name("Alpha"), "blabla", new Name("java.lang.String"),
Collections.emptyList(), 1, false, Reception.ALWAYS, TransactionPhase.IN_PROGRESS));
observers.add(new DevObserverInfo(true, null, null, new Name("Charlie"),
Collections.emptyList(), 0, false, Reception.ALWAYS, TransactionPhase.IN_PROGRESS));
observers.add(new DevObserverInfo(true, new Name("Bravo"), "hop", new Name("java.lang.String"),
Collections.emptyList(), 0, false, Reception.IF_EXISTS, TransactionPhase.IN_PROGRESS));

Collections.sort(observers);
assertEquals("blabla", observers.get(0).getMethodName());
assertEquals("Alpha", observers.get(0).getDeclaringClass().toString());
assertEquals("fooish", observers.get(1).getMethodName());
assertEquals("Alpha", observers.get(1).getDeclaringClass().toString());
assertEquals("hop", observers.get(2).getMethodName());
assertEquals("Bravo", observers.get(2).getDeclaringClass().toString());
assertNull(observers.get(3).getMethodName());
assertEquals("Charlie", observers.get(3).getObservedType().toString());
assertEquals("Delta", observers.get(observers.size() - 1).getObservedType().toString());
assertNull(observers.get(observers.size() - 1).getDeclaringClass());
}

}

0 comments on commit 7719a69

Please sign in to comment.