8000 Stop mutating shared ParsedPersistenceXmlDescriptor in build steps (#51628) by ahus1 · Pull Request #54826 · keycloak/keycloak · GitHub
[go: up one dir, main page]
Skip to content

Stop mutating shared ParsedPersistenceXmlDescriptor in build steps (#51628) #54826

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

Draft
ahus1 wants to merge 1 commit into
base: release/26.6
Choose a base branch
from
Draft

Stop mutating shared ParsedPersistenceXmlDescriptor in build steps (#51628) #54826

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
71 changes: 41 additions & 30 deletions quarkus/deployment/src/main/java/org/keycloak/quarkus/deployment/KeycloakProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
Expand Down Expand Up @@ -167,7 +168,6 @@
import org.hibernate.jpa.boot.spi.PersistenceXmlParser;
import org.infinispan.protostream.SerializationContextInitializer;
import org.jboss.jandex.AnnotationInstance;
import org.jboss.jandex.AnnotationTarget;
import org.jboss.jandex.AnnotationTransformation;
import org.jboss.jandex.ClassInfo;
import org.jboss.jandex.DotName;
Expand Down Expand Up @@ -513,51 +513,78 @@ void configurePersistenceUnits(HibernateOrmConfig config,
List<PersistenceXmlDescriptorBuildItem> descriptors,
List<JdbcDataSourceBuildItem> jdbcDataSources,
BuildProducer<AdditionalJpaModelBuildItem> additionalJpaModel,
CombinedIndexBuildItem indexBuildItem,
BuildProducer<HibernateOrmIntegrationRuntimeConfiguredBuildItem> runtimeConfigured,
KeycloakRecorder recorder) {
ParsedPersistenceXmlDescriptor defaultUnitDescriptor = null;
List<String> userManagedEntities = new ArrayList<>();
boolean defaultUnitFound = false;

for (PersistenceXmlDescriptorBuildItem item : descriptors) {
ParsedPersistenceXmlDescriptor descriptor = (ParsedPersistenceXmlDescriptor) item.getDescriptor();
if (!(item.getDescriptor() instanceof ParsedPersistenceXmlDescriptor descriptor)) {
continue;
}

if (DEFAULT_PERSISTENCE_UNIT.equals(descriptor.getName())) {
defaultUnitDescriptor = descriptor;
configureDefaultPersistenceUnitProperties(defaultUnitDescriptor, config, getDefaultDataSource(jdbcDataSources));
runtimeConfigured.produce(new HibernateOrmIntegrationRuntimeConfiguredBuildItem("keycloak", defaultUnitDescriptor.getName())
defaultUnitFound = true;
configureDefaultPersistenceUnitProperties(descriptor, config, getDefaultDataSource(jdbcDataSources));
runtimeConfigured.produce(new HibernateOrmIntegrationRuntimeConfiguredBuildItem("keycloak", descriptor.getName())
.setInitListener(recorder.createDefaultUnitListener()));
} else {
String datasourceName = getDatasourceNameFromPersistenceXml(descriptor);
configurePersistenceUnitProperties(datasourceName, descriptor);
// register a listener for customizing the unit configuration at runtime
runtimeConfigured.produce(new HibernateOrmIntegrationRuntimeConfiguredBuildItem("keycloak", descriptor.getName())
.setInitListener(recorder.createUserDefinedUnitListener(datasourceName)));
userManagedEntities.addAll(descriptor.getManagedClassNames());
}
}

if (defaultUnitDescriptor == null) {
if (!defaultUnitFound) {
throw new RuntimeException("No default persistence unit found.");
}

configureDefaultPersistenceUnitEntities(defaultUnitDescriptor, indexBuildItem, userManagedEntities);
}

@BuildStep
@Consume(CheckJdbcBuildStep.class)
@Consume(CheckMultipleDatasourcesBuildStep.class)
void produceDefaultPersistenceUnit(BuildProducer<PersistenceXmlDescriptorBuildItem> producer) {
void produceDefaultPersistenceUnit(CombinedIndexBuildItem indexBuildItem,
BuildProducer<PersistenceXmlDescriptorBuildItem> producer) {
PersistenceXmlParser parser = PersistenceXmlParser.create();
PersistenceUnitDescriptor descriptor = parser.parse(Collections.singletonList(parser.getClassLoaderService().locateResource("default-persistence.xml")))
.values()
.stream()
.findAny()
.orElseThrow(() -> new NoSuchElementException("Cannot find the file 'default-persistence.xml'"));

Set<String> userManagedEntities = collectUserManagedEntities(parser);

if (descriptor instanceof ParsedPersistenceXmlDescriptor parsedDescriptor) {
IndexView index = indexBuildItem.getIndex();
Collection<AnnotationInstance> annotations = index.getAnnotations(DotName.createSimple(Entity.class.getName()));
List<String> additionalEntities = new ArrayList<>();
for (AnnotationInstance annotation : annotations) {
String targetName = annotation.target().asClass().name().toString();
if (!userManagedEntities.contains(targetName)
&& (!targetName.startsWith("org.keycloak") || targetName.startsWith("org.keycloak.testsuite"))) {
additionalEntities.add(targetName);
}
}
if (!additionalEntities.isEmpty()) {
parsedDescriptor.addClasses(additionalEntities);
}
}

producer.produce(new PersistenceXmlDescriptorBuildItem(descriptor));
}

// Parsed independently because this step produces PersistenceXmlDescriptorBuildItem
// and therefore cannot consume List<PersistenceXmlDescriptorBuildItem> (circular dependency).
private static Set<String> collectUserManagedEntities(PersistenceXmlParser parser) {
Set<String> result = new HashSet<>();
for (URL url : parser.getClassLoaderService().locateResources("META-INF/persistence.xml")) {
for (PersistenceUnitDescriptor pu : PersistenceXmlParser.create().parse(Collections.singletonList(url)).values()) {
result.addAll(pu.getManagedClassNames());
}
}
return result;
}

static void configurePersistenceUnitProperties(String datasourceName, ParsedPersistenceXmlDescriptor descriptor) {
Properties unitProperties = descriptor.getProperties();
var isResourceLocalSpecified = PersistenceUnitTransactionType.RESOURCE_LOCAL.equals(descriptor.getPersistenceUnitTransactionType()) ||
Expand Down Expand Up @@ -634,22 +661,6 @@ private void configureDefaultPersistenceUnitProperties(ParsedPersistenceXmlDescr
.ifPresent(v -> unitProperties.put(AvailableSettings.LOG_SLOW_QUERY, v));
}

private void configureDefaultPersistenceUnitEntities(ParsedPersistenceXmlDescriptor descriptor, CombinedIndexBuildItem indexBuildItem,
List<String> userManagedEntities) {
IndexView index = indexBuildItem.getIndex();
Collection<AnnotationInstance> annotations = index.getAnnotations(DotName.createSimple(Entity.class.getName()));

for (AnnotationInstance annotation : annotations) {
AnnotationTarget target = annotation.target();
String targetName = target.asClass().name().toString();

if (!userManagedEntities.contains(targetName)
&& (!targetName.startsWith("org.keycloak") || targetName.startsWith("org.keycloak.testsuite"))) {
descriptor.addClasses(targetName);
}
}
}

/**
* <p>Load the built-in provider factories during build time so we don't spend time looking up them at runtime. By loading
* providers at this stage we are also able to perform a more dynamic configuration based on the default providers.
Expand Down
Loading
0