Allow forcing DataSourceClosingSpringLiquibase when manually defining a @LiquibaseDataSource

[Tristan971]

Hello, this is an enhancement suggestion (which I'm happy to implement as well but wanted to make sure there's not a good reason that it was not done before prior to working on it).

As part of #9218, the DataSourceClosingSpringLiquibase class was added.
This allows closing the connection pool once the liquibase migrations are applied (in case of Liquibase being ran on application startup mostly) instead of hanging around for the whole application lifecycle.

Unfortunately it is only auto-configured (instead of the standard SpringLiquibase) if no DataSource has been configured with @LiquibaseDataSource annotated on it, as that datasource would be autowired here:

spring-boot/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/liquibase/LiquibaseAutoConfiguration.java

Lines 82 to 90 in a6f8351

	public LiquibaseConfiguration(LiquibaseProperties properties,
	ResourceLoader resourceLoader,
	ObjectProvider<DataSource> dataSourceProvider,
	@LiquibaseDataSource ObjectProvider<DataSource> liquibaseDataSource) {
	this.properties = properties;
	this.resourceLoader = resourceLoader;
	this.dataSource = dataSourceProvider.getIfUnique();
	this.liquibaseDataSource = liquibaseDataSource.getIfAvailable();
	}

and yield the "standard" branch here:

spring-boot/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/liquibase/LiquibaseAutoConfiguration.java

Lines 118 to 129 in a6f8351

	private SpringLiquibase createSpringLiquibase() {
	SpringLiquibase liquibase;
	DataSource dataSource = getDataSource();
	if (dataSource == null) {
	dataSource = DataSourceBuilder.create().url(this.properties.getUrl())
	.username(this.properties.getUser())
	.password(this.properties.getPassword()).build();
	liquibase = new DataSourceClosingSpringLiquibase();
	}
	else {
	liquibase = new SpringLiquibase();
	}

The proposal is to allow forcing DataSourceClosingSpringLiquibase through a property of LiquibaseProperties.

Probably something like closeDataSourceOnceMigrated as it's already named in DataSourceClosingSpringLiquibase itself right now and overriden in LiquibaseEndpointAutoConfiguration#preventDataSourceCloseBeanPostProcessor if the Liquibase endpoint is enabled.

As for the motivation, it would allow more customization of the underlying DataSource used. So we could set hikari-level configuration that is specific to the Liquibase pool, (pool name, max pool size... and other such things as we already do for other DataSource instances) without having to share it with other "post-initialization" datasources.

Thank you

[Tristan971]

Hello,
Just chiming in to know if you have not had time to look at it yet or are discussing it internally?
Or should I make a PR to show how the general idea would work?
Thanks 🙂

[wilkinsona]

Sorry, @Tristan971. We've discussed this and have been meaning to follow up. Rather than using a property that is bound to LiquibaseProperties, we think it might be better to add an attribute to the @LiquibaseDataSource annotation. If you'd like to prepare a pull request in that direction we would be more than happy to review it. It may be a little bit tricky to get the definition for the @LiquibaseDataSource bean to retrieve the annotation and its attribute but we think it should be possible.

[Tristan971]

Seems like a good compromise ; I'll get a PR ready for it soon-ish :-)

[Tristan971]

Alright I got something, and indeed, It may be a little bit tricky proved to be its own little adventure 🙂

[philwebb]

Closing in favor of PR #18240