Skip to content

Disable domain type inspection. #2631

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.

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

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

<groupId>org.springframework.data</groupId>
<artifactId>spring-data-jpa-parent</artifactId>
<version>3.0.0-SNAPSHOT</version>
<version>3.0.x-GH-2628-SNAPSHOT</version>
<packaging>pom</packaging>

<name>Spring Data JPA Parent</name>
Expand Down
4 changes: 2 additions & 2 deletions spring-data-envers/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@

<groupId>org.springframework.data</groupId>
<artifactId>spring-data-envers</artifactId>
<version>3.0.0-SNAPSHOT</version>
<version>3.0.x-GH-2628-SNAPSHOT</version>

<parent>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-jpa-parent</artifactId>
<version>3.0.0-SNAPSHOT</version>
<version>3.0.x-GH-2628-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>

Expand Down
2 changes: 1 addition & 1 deletion spring-data-jpa-distribution/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<parent>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-jpa-parent</artifactId>
<version>3.0.0-SNAPSHOT</version>
<version>3.0.x-GH-2628-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>

Expand Down
4 changes: 2 additions & 2 deletions spring-data-jpa/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<groupId>org.springframework.data</groupId>
<artifactId>spring-data-jpa</artifactId>
<version>3.0.0-SNAPSHOT</version>
<version>3.0.x-GH-2628-SNAPSHOT</version>

<name>Spring Data JPA</name>
<description>Spring Data module for JPA repositories.</description>
Expand All @@ -15,7 +15,7 @@
<parent>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-jpa-parent</artifactId>
<version>3.0.0-SNAPSHOT</version>
<version>3.0.x-GH-2628-SNAPSHOT</version>
<relativePath>../pom.xml</relativePath>
</parent>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@
import java.util.Optional;
import java.util.Set;

import org.springframework.aot.generate.GenerationContext;
import org.springframework.beans.factory.aot.BeanRegistrationAotProcessor;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.support.AbstractBeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
Expand All @@ -44,6 +46,8 @@
import org.springframework.core.io.ResourceLoader;
import org.springframework.dao.DataAccessException;
import org.springframework.dao.annotation.PersistenceExceptionTranslationPostProcessor;
import org.springframework.data.aot.AotRepositoryContext;
import org.springframework.data.aot.RepositoryRegistrationAotProcessor;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.support.DefaultJpaContext;
import org.springframework.data.jpa.repository.support.EntityManagerBeanDefinitionRegistrarPostProcessor;
Expand Down Expand Up @@ -118,6 +122,11 @@ public void postProcess(BeanDefinitionBuilder builder, RepositoryConfigurationSo
builder.addPropertyReference("mappingContext", JPA_MAPPING_CONTEXT_BEAN_NAME);
}

@Override
public Class<? extends BeanRegistrationAotProcessor> getRepositoryAotProcessor() {
return JpaRepositoryRegistrationAotProcessor.class;
}

/**
* XML configurations do not support {@link Character} values. This method catches the exception thrown and returns an
* {@link Optional#empty()} instead.
Expand Down Expand Up @@ -285,4 +294,18 @@ static boolean isActive(@Nullable ClassLoader classLoader) {
.anyMatch(agentClass -> ClassUtils.isPresent(agentClass, classLoader));
}
}

/**
* A {@link RepositoryRegistrationAotProcessor} implementation that maintains aot repository setup but skips domain
* type inspection which is handled by the core framework support for
* {@link org.springframework.orm.jpa.persistenceunit.PersistenceManagedTypes}.
*
* @since 3.0
*/
public static class JpaRepositoryRegistrationAotProcessor extends RepositoryRegistrationAotProcessor {

protected void contribute(AotRepositoryContext repositoryContext, GenerationContext generationContext) {
// don't register domain types nor annotations.
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,18 @@
import static org.assertj.core.api.Assertions.*;
import static org.mockito.Mockito.*;

import java.util.Arrays;
import java.util.Collections;

import jakarta.persistence.EntityManagerFactory;
import jakarta.persistence.metamodel.Metamodel;

import java.util.Arrays;
import java.util.Collections;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;
import org.mockito.junit.jupiter.MockitoSettings;
import org.mockito.quality.Strictness;

import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.beans.factory.support.BeanDefinitionReaderUtils;
import org.springframework.beans.factory.support.DefaultListableBeanFactory;
Expand Down Expand Up @@ -141,6 +140,13 @@ public Class<?> loadClass(String name) throws ClassNotFoundException {
assertThat(classLoader).isNotInstanceOf(InspectionClassLoader.class);
}

@Test // GH-2628
void exposesJpaAotProcessor() {

assertThat(new JpaRepositoryConfigExtension().getRepositoryAotProcessor())
.isEqualTo(JpaRepositoryConfigExtension.JpaRepositoryRegistrationAotProcessor.class);
}

private void assertOnlyOnePersistenceAnnotationBeanPostProcessorRegistered(DefaultListableBeanFactory factory,
String expectedBeanName) {

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
/*
* Copyright 2022 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.springframework.data.jpa.repository.config;

import static org.assertj.core.api.Assertions.*;

import jakarta.persistence.Entity;

import java.lang.annotation.Annotation;
import java.util.Collections;
import java.util.Set;

import org.junit.jupiter.api.Test;
import org.springframework.aot.generate.ClassNameGenerator;
import org.springframework.aot.generate.DefaultGenerationContext;
import org.springframework.aot.generate.GenerationContext;
import org.springframework.aot.generate.InMemoryGeneratedFiles;
import org.springframework.aot.hint.predicate.RuntimeHintsPredicates;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.core.annotation.MergedAnnotation;
import org.springframework.data.aot.AotRepositoryContext;
import org.springframework.data.repository.core.RepositoryInformation;

/**
* @author Christoph Strobl
*/
class JpaRepositoryRegistrationAotProcessorUnitTests {

@Test // GH-2628
void aotProcessorMustNotRegisterDomainTypes() {

GenerationContext ctx = new DefaultGenerationContext(new ClassNameGenerator(Object.class),
new InMemoryGeneratedFiles());

new JpaRepositoryConfigExtension.JpaRepositoryRegistrationAotProcessor()
.contribute(new DummyAotRepositoryContext() {
@Override
public Set<Class<?>> getResolvedTypes() {
return Collections.singleton(Person.class);
}
}, ctx);

assertThat(RuntimeHintsPredicates.reflection().onType(Person.class)).rejects(ctx.getRuntimeHints());
}

@Test // GH-2628
void aotProcessorMustNotRegisterAnnotations() {

GenerationContext ctx = new DefaultGenerationContext(new ClassNameGenerator(Object.class),
new InMemoryGeneratedFiles());

new JpaRepositoryConfigExtension.JpaRepositoryRegistrationAotProcessor()
.contribute(new DummyAotRepositoryContext() {

@Override
public Set<MergedAnnotation<Annotation>> getResolvedAnnotations() {

MergedAnnotation mergedAnnotation = MergedAnnotation.of(Entity.class);
return Set.of(mergedAnnotation);
}
}, ctx);

assertThat(RuntimeHintsPredicates.reflection().onType(Entity.class)).rejects(ctx.getRuntimeHints());
}

static class Person {}

static class DummyAotRepositoryContext implements AotRepositoryContext {

@Override
public String getBeanName() {
return "jpaRepository";
}

@Override
public Set<String> getBasePackages() {
return Collections.singleton(this.getClass().getPackageName());
}

@Override
public Set<Class<? extends Annotation>> getIdentifyingAnnotations() {
return Collections.singleton(Entity.class);
}

@Override
public RepositoryInformation getRepositoryInformation() {
return null;
}

@Override
public Set<MergedAnnotation<Annotation>> getResolvedAnnotations() {
return null;
}

@Override
public Set<Class<?>> getResolvedTypes() {
return null;
}

@Override
public ConfigurableListableBeanFactory getBeanFactory() {
return null;
}

@Override
public TypeIntrospector introspectType(String typeName) {
return null;
}

@Override
public IntrospectedBeanDefinition introspectBeanDefinition(String beanName) {
return null;
}
}
}