com.sdl.dxa.caching.DefaultNamedCacheProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dxa-tridion-common Show documentation
Tridion Common contains common code for Tridion for other DXA artifacts expect model-specific (like DD4T)
The newest version!
package com.sdl.dxa.caching;

import com.sdl.web.client.cache.CacheProviderInitializer;
import com.sdl.web.client.cache.GeneralCacheProvider;
import com.sdl.web.client.configuration.ClientConstants;
import com.sdl.web.client.configuration.api.ConfigurationException;
import com.sdl.web.content.client.configuration.impl.BaseClientConfigurationLoader;
import com.tridion.util.ReflectionUtil;
import lombok.Getter;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.tuple.Triple;
import org.ehcache.config.builders.CacheConfigurationBuilder;
import org.ehcache.config.builders.ResourcePoolsBuilder;
import org.ehcache.expiry.Duration;
import org.ehcache.xml.XmlConfiguration;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

import jakarta.annotation.PostConstruct;
import javax.cache.Cache;
import javax.cache.CacheManager;
import javax.cache.Caching;
import javax.cache.spi.CachingProvider;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Collection;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.ConcurrentSkipListMap;
import java.util.concurrent.ConcurrentSkipListSet;
import java.util.concurrent.TimeUnit;

import static com.sdl.web.client.configuration.ClientConstants.Cache.DEFAULT_CACHE_URI;
import static java.nio.file.Files.exists;
import static org.ehcache.config.builders.CacheConfigurationBuilder.newCacheConfigurationBuilder;
import static org.ehcache.expiry.Duration.of;
import static org.ehcache.expiry.Expirations.timeToLiveExpiration;
import static org.ehcache.jsr107.Eh107Configuration.fromEhcacheCacheConfiguration;

/**
 * Default implementation of DXA cache.
 *
 */
@Slf4j
@Component
public class DefaultNamedCacheProvider extends BaseClientConfigurationLoader implements NamedCacheProvider {
    private static final Logger LOG = LoggerFactory.getLogger(DefaultNamedCacheProvider.class);

    @Value("#{'${dxa.caching.disabled.caches}'.split('[,\\s]')}")
    private Set disabledCaches;

    @Value("#{'${dxa.caching.required.caches}'.split('[,\\s]')}")
    private Set requiredCaches;

    @Value("${dxa.caching.configuration:#{null}}")
    private String cachingConfigurationFile;

    private boolean isCilConfigUsed;

    @Getter
    private CacheManager cacheManager;

    private ConcurrentSkipListSet ownCachesNames = new ConcurrentSkipListSet<>();

    private ConcurrentMap, Cache> ownCaches = new ConcurrentSkipListMap<>();

    private com.sdl.web.client.cache.CacheProvider cilCacheProvider;

    public DefaultNamedCacheProvider() throws ConfigurationException {
        // empty
    }

    @PostConstruct
    public void init() throws ConfigurationException {
        cilCacheProvider = CacheProviderInitializer.getCacheProvider(getCacheConfiguration());

        boolean cilUsesGeneralCache = cilCacheProvider instanceof GeneralCacheProvider;
        isCilConfigUsed = cilUsesGeneralCache;
        String cacheConfigurationUri = cilUsesGeneralCache ?
                getCacheConfiguration().getProperty(ClientConstants.Cache.CLIENT_CACHE_URI) :
                cachingConfigurationFile;
        log.info("Using cache config {}, CIL uses GeneralCacheProvider: {}", cacheConfigurationUri, isCilConfigUsed);
        cacheManager = getCacheManager(cacheConfigurationUri);

        //cannot be null because of default value
        //noinspection ConstantConditions
        cacheManager.getCacheNames().forEach(requiredCaches::remove);
        log.info("Required caches not yet created: '{}', creating them...", requiredCaches);
        requiredCaches.forEach(this::getCache);
    }

    @Override
    protected String getServiceUrl() {
        return "";
    }

    @Override
    public  Cache getCache(String cacheName, Class keyType, Class valueType) {
        log.debug("Trying to get cache name '{}' for key '{}' and value '{}'", cacheName, keyType, valueType);
        Cache newCache = cacheManager.getCache(cacheName, keyType, valueType);
        if (newCache == null) {
            log.debug("Cache name '{}' for such key/value does not exist, auto-creating...", cacheName);
            newCache = cacheManager.createCache(cacheName, buildDefaultCacheConfiguration(keyType, valueType));
        }

        if (ownCachesNames.add(cacheName)) {
            Triple triple = Triple.of(cacheName, keyType, valueType);
            Cache oldCache = ownCaches.put(triple, newCache);
            if (oldCache == null) {
                log.debug("Added cache '{}' to own caches of DXA", cacheName);
            }
        }
        return newCache;
    }

    @Override
    public Cache getCache(String cacheName) {
        return getCache(cacheName, Object.class, Object.class);
    }

    @Override
    public Collection getOwnCaches() {
        return ownCaches.values();
    }

    @Override
    public boolean isCacheEnabled() {
        return cilCacheProvider.isCacheEnabled();
    }

    @Override
    public boolean isCacheEnabled(String cacheName) {
        return isCacheEnabled() && !disabledCaches.contains(cacheName);
    }

    @NotNull
    private  javax.cache.configuration.Configuration buildDefaultCacheConfiguration(Class keyType, Class valueType) {
        return fromEhcacheCacheConfiguration(isCilConfigUsed ?
                buildDefaultCilCacheConfiguration(keyType, valueType) :
                buildDefaultConfigCacheConfiguration(keyType, valueType));
    }

    @NotNull
    private  CacheConfigurationBuilder buildDefaultConfigCacheConfiguration(Class keyType, Class valueType) {
        String message = "Could not create caches from configuration file " +
                "(see 'dxa.caching.configuration' property value " +
                "and cd_client_conf.xml  in 'ServiceConfig' attributes) {}, " +
                "will be using fallback configuration";
        if (cachingConfigurationFile == null || cachingConfigurationFile.isEmpty()) {
            log.warn(message + " cause config is empty");
            return buildFallbackCacheConfiguration(keyType, valueType);
        }
        try {
            return buildConfigCacheConfiguration(cachingConfigurationFile, keyType, valueType);
        } catch (ConfigurationException e) {
            log.warn(message, cachingConfigurationFile);
        } catch (IOException | ReflectiveOperationException e) {
            log.warn(message, cachingConfigurationFile, e);
        }
        return buildFallbackCacheConfiguration(keyType, valueType);
    }

    @NotNull
    private  CacheConfigurationBuilder buildDefaultCilCacheConfiguration(Class keyType, Class valueType) {
        CacheConfigurationBuilder configurationBuilder;
        try {
            Properties cacheConfiguration = getCacheConfiguration();
            String cacheClass = cacheConfiguration.getProperty(ClientConstants.Cache.CLIENT_CACHE_PROVIDER_CLASSNAME);
            String cacheEnabled = cacheConfiguration.getProperty(ClientConstants.Cache.CLIENT_CACHE_ENABLED);
            String cacheConfigFileName = cacheConfiguration.getProperty(ClientConstants.Cache.CLIENT_CACHE_URI);
            log.debug("CIL cache defined with class '{}' and configuration '{}' from 'cd_client_conf.xml': {}",
                    cacheClass, cacheEnabled, cacheConfigFileName);
            configurationBuilder = buildConfigCacheConfiguration(cacheConfigFileName, keyType, valueType);
        } catch (ConfigurationException | ReflectiveOperationException | IOException e) {
            log.warn("Cannot create a default CIL cache configuration, fallback to default configuration", e);
            configurationBuilder = buildDefaultConfigCacheConfiguration(keyType, valueType);
        }

        Integer cacheExpirationPeriod = cilCacheProvider.getCacheExpirationPeriod();
        Duration timeToLive;
        if (cacheExpirationPeriod != null) {
            timeToLive = of(cacheExpirationPeriod, TimeUnit.SECONDS);
        } else {
            log.warn("Cache Expiration Period is not set, fallback to 5 minutes, set it in 'cd_client_conf.xml'");
            timeToLive = of(5, TimeUnit.MINUTES);
        }

        return configurationBuilder.withExpiry(timeToLiveExpiration(timeToLive));
    }

    @NotNull
    private  CacheConfigurationBuilder buildConfigCacheConfiguration(String config, Class keyType, Class valueType)
            throws IOException, ReflectiveOperationException, ConfigurationException {
        URI configUri = getConfigUri(config);
        if (configUri == null) {
            throw new MalformedURLException("Cannot load config file: " + config);
        }

        XmlConfiguration xmlConfiguration = new XmlConfiguration(configUri.toURL());
        CacheConfigurationBuilder builder =
                xmlConfiguration.newCacheConfigurationBuilderFromTemplate("default", keyType, valueType);
        if (builder != null) {
            return builder;
        }
        String allTemplatesDefined = "(no defined templates found in xml)";
        try {
            Map templates = (Map)
                    ReflectionUtil.getPrivateField(xmlConfiguration, "templates");
            allTemplatesDefined = templates.keySet().toString();
        } catch (ReflectiveOperationException ex) {
            throw ex;
        }
        LOG.debug("whole config xml: {}", xmlConfiguration.asRenderedDocument());
        throw new ConfigurationException("Cannot load 'default' template from " + configUri.toURL() +
                ", templates: " + allTemplatesDefined);
    }

    private  CacheConfigurationBuilder buildFallbackCacheConfiguration(Class keyType, Class valueType) {
        return newCacheConfigurationBuilder(keyType, valueType, ResourcePoolsBuilder.heap(10000))
                .withExpiry(timeToLiveExpiration(of(5, TimeUnit.MINUTES)));
    }

    private CacheManager getCacheManager(String cacheManagerUri) {
        CachingProvider cachingProvider = Caching.getCachingProvider(); // NOSONAR
        URI configUri = getConfigUri(cacheManagerUri);
        return configUri != null ?
                cachingProvider.getCacheManager(configUri, null) :
                cachingProvider.getCacheManager();
    }

    @Nullable
    private URI getConfigUri(String cacheManagerUri) {
        String configUrl = cacheManagerUri;
        if (configUrl == null || configUrl.isEmpty()) {
            log.warn("Config URI for Cache Provider is empty, will use " +
                    "'ehcache-default.xml' (as a default fallback option)");
            configUrl = DEFAULT_CACHE_URI;
        }

        Path configPath = Paths.get(configUrl);
        boolean exists = exists(configPath);
        boolean readable = Files.isReadable(configPath);

        if (exists && readable) {
            log.info("Config file {} exists and readable", configPath.toFile().getAbsolutePath());
            return configPath.toUri();
        }
        if (!exists) {
            log.info("Config file {} does not exist", configPath.toFile().getAbsolutePath());
        } else {
            log.info("Config file {} cannot be read", configPath.toFile().getAbsolutePath());
        }
        URL resource = getClass().getClassLoader().getResource(configUrl);
        if (resource != null) {
            try {
                log.info("Config file {} is found", resource.toURI());
                return resource.toURI();
            } catch (URISyntaxException e) {
                log.warn("Config URI {} is not syntactically correct", cacheManagerUri, e);
                return null;
            }
        }
        log.warn("Cannot find EhCache config file {}", cacheManagerUri);
        return null;
    }
}