Skip to content

chore: prevent NPE in solution annotation processing #1684

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

Merged
triceo merged 3 commits into from
Jul 7, 2025
Merged

chore: prevent NPE in solution annotation processing #1684

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
36f4b78
chore: prevent NPE in solution annotation processing
triceo Jul 7, 2025
804be5a
chore: improve fail-fast messages
triceo Jul 7, 2025
5495f0b
chore: better method name
triceo Jul 7, 2025
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
59 changes: 35 additions & 24 deletions ...main/java/ai/timefold/solver/core/impl/domain/solution/descriptor/SolutionDescriptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@
import ai.timefold.solver.core.preview.api.domain.metamodel.PlanningSolutionMetaModel;
import ai.timefold.solver.core.preview.api.domain.solution.diff.PlanningSolutionDiff;

import org.jspecify.annotations.NonNull;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand Down Expand Up @@ -395,20 +396,9 @@ Maybe add a getScore() method with a @%s annotation."""
}

private void processSolutionAnnotations(DescriptorPolicy descriptorPolicy) {
Comment thread
triceo marked this conversation as resolved.
var solutionAnnotation = solutionClass.getAnnotation(PlanningSolution.class);
var parentSolutionAnnotation =
solutionClass.getSuperclass() != null ? solutionClass.getSuperclass().getAnnotation(PlanningSolution.class)
: null;
if (solutionAnnotation == null && parentSolutionAnnotation == null) {
throw new IllegalStateException(
"The solutionClass (%s) has been specified as a solution in the configuration, but does not have a @%s annotation."
.formatted(solutionClass, PlanningSolution.class.getSimpleName()));
}
var annotation = solutionAnnotation != null ? solutionAnnotation : parentSolutionAnnotation;
var annotation = extractMostRelevantPlanningSolutionAnnotation();
autoDiscoverMemberType = annotation.autoDiscoverMemberType();
// We accept only the child class cloner
var solutionClonerClass =
Comment thread
triceo marked this conversation as resolved.
solutionAnnotation != null ? solutionAnnotation.solutionCloner() : PlanningSolution.NullSolutionCloner.class;
var solutionClonerClass = annotation.solutionCloner();
if (solutionClonerClass != PlanningSolution.NullSolutionCloner.class) {
solutionCloner = ConfigUtils.newInstance(this::toString, "solutionClonerClass", solutionClonerClass);
}
Expand All @@ -417,6 +407,29 @@ private void processSolutionAnnotations(DescriptorPolicy descriptorPolicy) {
new LookUpStrategyResolver(descriptorPolicy, lookUpStrategyType);
}

private @NonNull PlanningSolution extractMostRelevantPlanningSolutionAnnotation() {
var solutionAnnotation = solutionClass.getAnnotation(PlanningSolution.class);
if (solutionAnnotation != null) {
return solutionAnnotation;
}
var solutionSuperclass = solutionClass.getSuperclass(); // Null if interface.
if (solutionSuperclass == null) {
throw new IllegalStateException("""
The solutionClass (%s) has been specified as a solution in the configuration, \
but does not have a @%s annotation."""
.formatted(solutionClass.getCanonicalName(), PlanningSolution.class.getSimpleName()));
Comment thread
triceo marked this conversation as resolved.
}
var parentSolutionAnnotation = solutionSuperclass.getAnnotation(PlanningSolution.class);
if (parentSolutionAnnotation == null) {
throw new IllegalStateException("""
The solutionClass (%s) has been specified as a solution in the configuration, \
but neither it nor its superclass (%s) have a @%s annotation."""
.formatted(solutionClass.getCanonicalName(), solutionSuperclass.getCanonicalName(),
PlanningSolution.class.getSimpleName()));
}
return parentSolutionAnnotation;
}

private void processValueRangeProviderAnnotation(DescriptorPolicy descriptorPolicy, Member member) {
if (((AnnotatedElement) member).isAnnotationPresent(ValueRangeProvider.class)) {
var memberAccessor = descriptorPolicy.getMemberAccessorFactory().buildAndCacheMemberAccessor(member,
Expand Down Expand Up @@ -579,7 +592,7 @@ private void processProblemFactPropertyAnnotation(DescriptorPolicy descriptorPol
var type = memberAccessor.getType();
if (!(Collection.class.isAssignableFrom(type) || type.isArray())) {
throw new IllegalStateException(
"The solutionClass (%s) has a @%s annotated member (%s) that does not return a %s or an array."
"The solutionClass (%s) has a @%s-annotated member (%s) that does not return a %s or an array."
Comment thread
zepfred marked this conversation as resolved.
.formatted(solutionClass, ProblemFactCollectionProperty.class.getSimpleName(), member,
Collection.class.getSimpleName()));
}
Expand All @@ -596,16 +609,14 @@ private void processProblemFactPropertyAnnotation(DescriptorPolicy descriptorPol
throw new IllegalStateException("Impossible situation with annotationClass (" + annotationClass + ").");
}
if (problemFactType.isAnnotationPresent(PlanningEntity.class)) {
throw new IllegalStateException(
"The solutionClass (%s) has a @%s annotated member (%s) that returns a @%s. Maybe use @%s instead?"
.formatted(
solutionClass,
annotationClass,
memberAccessor.getName(),
PlanningEntity.class.getSimpleName(),
((annotationClass == ProblemFactProperty.class)
? PlanningEntityProperty.class.getSimpleName()
: PlanningEntityCollectionProperty.class.getSimpleName())));
throw new IllegalStateException("""
The solutionClass (%s) has a @%s-annotated member (%s) that returns a @%s.
Maybe use @%s instead?"""
.formatted(solutionClass, annotationClass.getSimpleName(), memberAccessor.getName(),
PlanningEntity.class.getSimpleName(),
((annotationClass == ProblemFactProperty.class)
? PlanningEntityProperty.class.getSimpleName()
: PlanningEntityCollectionProperty.class.getSimpleName())));
}
}

Expand Down
Loading