Skip to content
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

Multiple Hibernate ORM multitenancy fixes #40680

Merged
merged 3 commits into from
May 17, 2024
+63 −68
Merged

Multiple Hibernate ORM multitenancy fixes #40680

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
edbdda9
Avoid unnecessary copying of datasources for SCHEMA multi-tenancy
yrodiere May 16, 2024
28c7fed
Avoid unnecessary definition of a DataSourceTenantConnectionResolver …
yrodiere May 16, 2024
a1a0ecd
Deprecate quarkus.hibernate-orm.multitenant-schema-datasource
yrodiere May 16, 2024
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 docs/src/main/asciidoc/hibernate-orm.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1132,7 +1132,7 @@ quarkus.hibernate-orm.database.generation=none
# Enable SCHEMA approach and use default datasource
quarkus.hibernate-orm.multitenant=SCHEMA
# You could use a non-default datasource by using the following setting
# quarkus.hibernate-orm.multitenant-schema-datasource=other
# quarkus.hibernate-orm.datasource=other

# The default data source used for all tenant schemas
quarkus.datasource.db-kind=postgresql
Expand Down
3 changes: 3 additions & 0 deletions .../src/main/java/io/quarkus/hibernate/orm/deployment/HibernateOrmConfigPersistenceUnit.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,10 @@ public interface HibernateOrmConfigPersistenceUnit {
/**
* Defines the name of the datasource to use in case of SCHEMA approach. The datasource of the persistence unit will be used
* if not set.
*
* @deprecated Use {@link #datasource()} instead.
*/
@Deprecated
@WithConverter(TrimmedStringConverter.class)
Optional<String> multitenantSchemaDatasource();

Expand Down
68 changes: 43 additions & 25 deletions ...m/deployment/src/main/java/io/quarkus/hibernate/orm/deployment/HibernateOrmProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -670,33 +670,51 @@ public void multitenancy(HibernateOrmRecorder recorder,
boolean multitenancyEnabled = false;

for (PersistenceUnitDescriptorBuildItem persistenceUnitDescriptor : persistenceUnitDescriptors) {
if (persistenceUnitDescriptor.getConfig().getMultiTenancyStrategy() == MultiTenancyStrategy.NONE) {
continue;
}
String persistenceUnitConfigName = persistenceUnitDescriptor.getConfigurationName();
var multitenancyStrategy = persistenceUnitDescriptor.getConfig().getMultiTenancyStrategy();
switch (multitenancyStrategy) {
case NONE -> {
}
case DISCRIMINATOR -> multitenancyEnabled = true;
case DATABASE, SCHEMA -> {
multitenancyEnabled = true;

String multiTenancySchemaDataSource = persistenceUnitDescriptor.getMultiTenancySchemaDataSource();
Optional<String> datasource;
if (multitenancyStrategy == MultiTenancyStrategy.SCHEMA && multiTenancySchemaDataSource != null) {
LOG.warnf("Configuration property '%1$s' is deprecated. Use '%2$s' instead.",
HibernateOrmRuntimeConfig.puPropertyKey(persistenceUnitConfigName,
"multitenant-schema-datasource"),
HibernateOrmRuntimeConfig.puPropertyKey(persistenceUnitConfigName, "datasource"));
datasource = Optional.of(multiTenancySchemaDataSource);
} else {
datasource = persistenceUnitDescriptor.getConfig().getDataSource();
}

multitenancyEnabled = true;

ExtendedBeanConfigurator configurator = SyntheticBeanBuildItem.configure(DataSourceTenantConnectionResolver.class)
.scope(ApplicationScoped.class)
.types(TenantConnectionResolver.class)
.setRuntimeInit()
.defaultBean()
.unremovable()
.supplier(recorder.dataSourceTenantConnectionResolver(persistenceUnitDescriptor.getPersistenceUnitName(),
persistenceUnitDescriptor.getConfig().getDataSource(),
persistenceUnitDescriptor.getConfig().getMultiTenancyStrategy(),
persistenceUnitDescriptor.getMultiTenancySchemaDataSource()));

if (PersistenceUnitUtil.isDefaultPersistenceUnit(persistenceUnitDescriptor.getPersistenceUnitName())) {
configurator.addQualifier(Default.class);
} else {
configurator.addQualifier().annotation(DotNames.NAMED)
.addValue("value", persistenceUnitDescriptor.getPersistenceUnitName()).done();
configurator.addQualifier().annotation(PersistenceUnit.class)
.addValue("value", persistenceUnitDescriptor.getPersistenceUnitName()).done();
}
ExtendedBeanConfigurator configurator = SyntheticBeanBuildItem
.configure(DataSourceTenantConnectionResolver.class)
.scope(ApplicationScoped.class)
.types(TenantConnectionResolver.class)
.setRuntimeInit()
.defaultBean()
.unremovable()
.supplier(recorder.dataSourceTenantConnectionResolver(
persistenceUnitDescriptor.getPersistenceUnitName(),
datasource,
persistenceUnitDescriptor.getConfig().getMultiTenancyStrategy()));

if (PersistenceUnitUtil.isDefaultPersistenceUnit(persistenceUnitDescriptor.getPersistenceUnitName())) {
configurator.addQualifier(Default.class);
} else {
configurator.addQualifier().annotation(DotNames.NAMED)
.addValue("value", persistenceUnitDescriptor.getPersistenceUnitName()).done();
configurator.addQualifier().annotation(PersistenceUnit.class)
.addValue("value", persistenceUnitDescriptor.getPersistenceUnitName()).done();
}

syntheticBeans.produce(configurator.done());
syntheticBeans.produce(configurator.done());
}
}
}

if (multitenancyEnabled) {
Expand Down
5 changes: 2 additions & 3 deletions ...nate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/HibernateOrmRecorder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,11 @@ public void created(BeanContainer beanContainer) {

public Supplier<DataSourceTenantConnectionResolver> dataSourceTenantConnectionResolver(String persistenceUnitName,
Optional<String> dataSourceName,
MultiTenancyStrategy multiTenancyStrategy, String multiTenancySchemaDataSourceName) {
MultiTenancyStrategy multiTenancyStrategy) {
return new Supplier<DataSourceTenantConnectionResolver>() {
@Override
public DataSourceTenantConnectionResolver get() {
return new DataSourceTenantConnectionResolver(persistenceUnitName, dataSourceName, multiTenancyStrategy,
multiTenancySchemaDataSourceName);
return new DataSourceTenantConnectionResolver(persistenceUnitName, dataSourceName, multiTenancyStrategy);
}
};
}
Expand Down
53 changes: 14 additions & 39 deletions ...main/java/io/quarkus/hibernate/orm/runtime/tenant/DataSourceTenantConnectionResolver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
import org.jboss.logging.Logger;

import io.agroal.api.AgroalDataSource;
import io.agroal.api.configuration.AgroalDataSourceConfiguration;
import io.quarkus.agroal.DataSource;
import io.quarkus.arc.Arc;
import io.quarkus.datasource.common.runtime.DataSourceUtil;
Expand All @@ -35,67 +34,43 @@ public class DataSourceTenantConnectionResolver implements TenantConnectionResol

private MultiTenancyStrategy multiTenancyStrategy;

private String multiTenancySchemaDataSourceName;

public DataSourceTenantConnectionResolver() {
}

public DataSourceTenantConnectionResolver(String persistenceUnitName, Optional<String> dataSourceName,
MultiTenancyStrategy multiTenancyStrategy, String multiTenancySchemaDataSourceName) {
MultiTenancyStrategy multiTenancyStrategy) {
this.persistenceUnitName = persistenceUnitName;
this.dataSourceName = dataSourceName;
this.multiTenancyStrategy = multiTenancyStrategy;
this.multiTenancySchemaDataSourceName = multiTenancySchemaDataSourceName;
}

@Override
public ConnectionProvider resolve(String tenantId) {
LOG.debugv("resolve((persistenceUnitName={0}, tenantIdentifier={1})", persistenceUnitName, tenantId);
LOG.debugv("multitenancy strategy: {0}", multiTenancyStrategy);

AgroalDataSource dataSource = tenantDataSource(dataSourceName, tenantId, multiTenancyStrategy,
multiTenancySchemaDataSourceName);
AgroalDataSource dataSource = tenantDataSource(dataSourceName, tenantId, multiTenancyStrategy);
if (dataSource == null) {
throw new IllegalStateException(
String.format(Locale.ROOT, "No instance of datasource found for persistence unit '%1$s' and tenant '%2$s'",
persistenceUnitName, tenantId));
}
if (multiTenancyStrategy == MultiTenancyStrategy.SCHEMA) {
return new SchemaTenantConnectionProvider(tenantId, dataSource);
}
return new QuarkusConnectionProvider(dataSource);
}

/**
* Create a new data source from the given configuration.
*
* @param config Configuration to use.
*
* @return New data source instance.
*/
private static AgroalDataSource createFrom(AgroalDataSourceConfiguration config) {
try {
return AgroalDataSource.from(config);
} catch (SQLException ex) {
throw new IllegalStateException("Failed to create a new data source based on the existing datasource configuration",
ex);
}
return switch (multiTenancyStrategy) {
case DATABASE -> new QuarkusConnectionProvider(dataSource);
case SCHEMA -> new SchemaTenantConnectionProvider(tenantId, dataSource);
default -> throw new IllegalStateException("Unexpected multitenancy strategy: " + multiTenancyStrategy);
};
}

private static AgroalDataSource tenantDataSource(Optional<String> dataSourceName, String tenantId,
MultiTenancyStrategy strategy, String multiTenancySchemaDataSourceName) {
if (strategy != MultiTenancyStrategy.SCHEMA) {
return Arc.container().instance(AgroalDataSource.class, new DataSource.DataSourceLiteral(tenantId)).get();
}

if (multiTenancySchemaDataSourceName == null) {
// The datasource name should always be present when using SCHEMA multi-tenancy;
MultiTenancyStrategy strategy) {
return switch (strategy) {
case DATABASE -> Arc.container().instance(AgroalDataSource.class, new DataSource.DataSourceLiteral(tenantId)).get();
// The datasource name should always be present when using a multi-tenancy other than DATABASE;
// we perform checks in HibernateOrmProcessor during the build.
AgroalDataSource dataSource = getDataSource(dataSourceName.get());
return createFrom(dataSource.getConfiguration());
}

return getDataSource(multiTenancySchemaDataSourceName);
case SCHEMA -> getDataSource(dataSourceName.get());
default -> throw new IllegalStateException("Unexpected multitenancy strategy: " + strategy);
};
}

private static AgroalDataSource getDataSource(String dataSourceName) {
Expand Down
Loading