org.hibernate.search.engine.cfg.spi.ConfigurationPropertyChecker Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hibernate-search-engine Show documentation
Hibernate Search engine, always required
The newest version!
/*
 * SPDX-License-Identifier: Apache-2.0
 * Copyright Red Hat Inc. and Hibernate Authors
 */
package org.hibernate.search.engine.cfg.spi;

import java.lang.invoke.MethodHandles;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;

import org.hibernate.search.engine.cfg.ConfigurationPropertyCheckingStrategyName;
import org.hibernate.search.engine.cfg.ConfigurationPropertySource;
import org.hibernate.search.engine.cfg.EngineSettings;
import org.hibernate.search.engine.logging.impl.Log;
import org.hibernate.search.util.common.AssertionFailure;
import org.hibernate.search.util.common.impl.CollectionHelper;
import org.hibernate.search.util.common.logging.impl.LoggerFactory;

/**
 * A utility that checks usage of property keys
 * by wrapping a {@link ConfigurationPropertySource}
 * and requiring special hooks to be called before and after bootstrap.
 */
public final class ConfigurationPropertyChecker {

	private static final Log log = LoggerFactory.make( Log.class, MethodHandles.lookup() );

	private static final ConfigurationProperty<
			ConfigurationPropertyCheckingStrategyName> CONFIGURATION_PROPERTY_CHECKING_STRATEGY =
					ConfigurationProperty.forKey( EngineSettings.CONFIGURATION_PROPERTY_CHECKING_STRATEGY )
							.as( ConfigurationPropertyCheckingStrategyName.class,
									ConfigurationPropertyCheckingStrategyName::of )
							.withDefault( EngineSettings.Defaults.CONFIGURATION_PROPERTY_CHECKING_STRATEGY )
							.build();

	public static ConfigurationPropertyChecker create() {
		return new ConfigurationPropertyChecker();
	}

	private static boolean isRelevantPropertyEntry(String key, Object value) {
		return key.startsWith( EngineSettings.PREFIX )
				&& ConvertUtils.trimIfString( value ) != null;
	}

	private String configurationPropertyCheckingStrategyPropertyName;

	private final Set availablePropertyKeys = ConcurrentHashMap.newKeySet();
	private final Set consumedPropertyKeys = ConcurrentHashMap.newKeySet();

	private volatile boolean warn;

	private ConfigurationPropertyChecker() {
	}

	public ConfigurationPropertySource wrap(AllAwareConfigurationPropertySource source) {
		ConfigurationPropertySource trackingSource =
				new ConsumedPropertyTrackingConfigurationPropertySource(
						source, this::addConsumedPropertyKey
				);
		ConfigurationPropertyCheckingStrategyName checkingStrategy =
				CONFIGURATION_PROPERTY_CHECKING_STRATEGY.get( trackingSource );
		this.configurationPropertyCheckingStrategyPropertyName =
				CONFIGURATION_PROPERTY_CHECKING_STRATEGY.resolveOrRaw( source );
		switch ( checkingStrategy ) {
			case WARN:
				this.warn = true;
				availablePropertyKeys.addAll( source.resolveAll( ConfigurationPropertyChecker::isRelevantPropertyEntry ) );
				return trackingSource;
			case IGNORE:
				return source;
			default:
				throw new AssertionFailure(
						"Unexpected configuration property checking strategy name: " + checkingStrategy
				);
		}
	}

	public void beforeBoot() {
		if ( !warn ) {
			log.configurationPropertyTrackingDisabled();
		}

		checkHibernateSearch5Properties();
	}

	public void afterBoot(ConfigurationPropertyChecker firstPhaseChecker) {
		checkUnconsumedProperties( firstPhaseChecker );
	}

	private void checkHibernateSearch5Properties() {
		Set obsoleteKeys = new LinkedHashSet<>();
		for ( String propertyKey : availablePropertyKeys ) {
			if ( HibernateSearch5Properties.isSearch5PropertyKey( propertyKey ) ) {
				obsoleteKeys.add( propertyKey );
			}
		}
		if ( !obsoleteKeys.isEmpty() ) {
			throw log.obsoleteConfigurationPropertiesFromSearch5( obsoleteKeys );
		}
	}

	private void checkUnconsumedProperties(ConfigurationPropertyChecker firstPhaseChecker) {
		if ( !warn ) {
			return;
		}

		List checkers =
				CollectionHelper.asImmutableList( firstPhaseChecker, this );
		Set unconsumedPropertyKeys = new LinkedHashSet<>();

		// Add all available property keys
		for ( ConfigurationPropertyChecker checker : checkers ) {
			unconsumedPropertyKeys.addAll( checker.availablePropertyKeys );
		}

		// Remove all consumed property keys
		for ( ConfigurationPropertyChecker checker : checkers ) {
			unconsumedPropertyKeys.removeAll( checker.consumedPropertyKeys );
		}

		if ( !unconsumedPropertyKeys.isEmpty() ) {
			log.configurationPropertyTrackingUnusedProperties(
					unconsumedPropertyKeys,
					configurationPropertyCheckingStrategyPropertyName,
					ConfigurationPropertyCheckingStrategyName.IGNORE.externalRepresentation()
			);
		}
	}

	private void addConsumedPropertyKey(String key) {
		consumedPropertyKeys.add( key );
	}

}