Skip to content

Commit

Permalink
GH-431 - Include JSR 303 ConstraintValidator implementations in boots…
Browse files Browse the repository at this point in the history
…trap dependency analysis.

Spring Boot configures Hibernate Validator in a way that the latter looks up the components it needs to instantiate via the Spring container. That in turn then creates prototype instances of the types requested. This means, implementations of e.g. ConstraintValidator do not need to be explicitly marked as Spring beans, but could still declare dependencies to other Spring beans. If such a dependency crosses a module boundary, we currently fail to detect that implicitly established module dependency.

This is now fixed by considering ConstraintValidator implementations Spring beans implicitly in out bootstrap dependency analysis.
  • Loading branch information
odrotbohm committed Dec 21, 2023
1 parent 3b8b104 commit 9ce5b33
Show file tree
Hide file tree
Showing 5 changed files with 57 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -589,10 +589,12 @@ private static Classes filterSpringBeans(JavaPackage source) {
Classes repositories = source.that(isSpringDataRepository());
Classes coreComponents = source.that(not(INTERFACES).and(isComponent()));
Classes configurationProperties = source.that(isConfigurationProperties());
Classes jsr303Validator = source.that(isJsr303Validator());

return coreComponents //
.and(repositories) //
.and(configurationProperties) //
.and(jsr303Validator) //
.and(collect.getOrDefault(true, Collections.emptyList())) //
.and(collect.getOrDefault(false, Collections.emptyList()));
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,10 @@ static DescribedPredicate<? super JavaClass> isConfigurationProperties() {
return isAnnotatedWith(AT_CONFIGURATION_PROPERTIES);
}

static DescribedPredicate<? super JavaClass> isJsr303Validator() {
return implement("jakarta.validation.ConstraintValidator");
}

static boolean isAtBeanMethod(JavaMethod method) {
return isAnnotatedWith(SpringTypes.AT_BEAN).test(method);
}
Expand Down
5 changes: 5 additions & 0 deletions spring-modulith-integration-test/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,11 @@
<artifactId>spring-tx</artifactId>
</dependency>

<dependency>
<groupId>jakarta.validation</groupId>
<artifactId>jakarta.validation-api</artifactId>
</dependency>

<!-- Test -->

<dependency>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
/*
* Copyright 2023 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 com.acme.myproject.validator;

import jakarta.validation.ConstraintValidator;
import jakarta.validation.ConstraintValidatorContext;

import com.acme.myproject.moduleA.ServiceComponentA;

public class SampleValidator implements ConstraintValidator<Override, Object> {

public SampleValidator(ServiceComponentA dependency) {}

@Override
public boolean isValid(Object value, ConstraintValidatorContext context) {
return false;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
import com.acme.myproject.moduleA.ServiceComponentA;
import com.acme.myproject.moduleA.SomeConfigurationA.SomeAtBeanComponentA;
import com.acme.myproject.moduleB.ServiceComponentB;
import com.acme.myproject.validator.SampleValidator;

/**
* @author Oliver Drotbohm
Expand Down Expand Up @@ -196,6 +197,20 @@ void excludesSpringAOTGeneratedTypes() {
});
}

@Test // GH-418
void detectsDependencyInducedByValidatorImplementation() {

assertThat(modules.getModuleByName("validator")).hasValueSatisfying(it -> {

assertThat(it.getSpringBeans())
.extracting(SpringBean::getFullyQualifiedTypeName)
.containsExactly(SampleValidator.class.getName());

assertThat(it.getBootstrapDependencies(modules).map(ApplicationModule::getName))
.containsExactly("moduleA");
});
}

private static void verifyNamedInterfaces(NamedInterfaces interfaces, String name, Class<?>... types) {

Stream.of(types).forEach(type -> {
Expand Down

0 comments on commit 9ce5b33

Please sign in to comment.