Umbraco-CMS/src/Umbraco.Core/Cache/DeepCloneAppCache.cs

using Umbraco.Cms.Core.Models;
using Umbraco.Cms.Core.Models.Entities;
using Umbraco.Extensions;

namespace Umbraco.Cms.Core.Cache;

/// <summary>
///     Implements <see cref="IAppPolicyCache" /> by wrapping an inner other <see cref="IAppPolicyCache" />
///     instance, and ensuring that all inserts and returns are deep cloned copies of the cache item,
///     when the item is deep-cloneable.
/// </summary>
public class DeepCloneAppCache : IAppPolicyCache, IDisposable
{
    private bool _disposedValue;

    /// <summary>
    ///     Initializes a new instance of the <see cref="DeepCloneAppCache" /> class.
    /// </summary>
    public DeepCloneAppCache(IAppPolicyCache innerCache)
    {
        Type type = typeof(DeepCloneAppCache);

        if (innerCache.GetType() == type)
        {
            throw new InvalidOperationException($"A {type} cannot wrap another instance of itself.");
        }

        InnerCache = innerCache;
    }

    /// <summary>
    ///     Gets the inner cache.
    /// </summary>
    private IAppPolicyCache InnerCache { get; }

    /// <inheritdoc />
    public object? Get(string key)
    {
        var item = InnerCache.Get(key);
        return CheckCloneableAndTracksChanges(item);
    }

    /// <inheritdoc />
    public object? Get(string key, Func<object?> factory)
    {
        var cached = InnerCache.Get(key, () =>
        {
            Lazy<object?> result = SafeLazy.GetSafeLazy(factory);
            var value = result.Value; // force evaluation now - this may throw if cacheItem throws, and then nothing goes into cache

            // do not store null values (backward compat), clone / reset to go into the cache
            return value == null ? null : CheckCloneableAndTracksChanges(value);
        });
        return CheckCloneableAndTracksChanges(cached);
    }

    /// <inheritdoc />
    public IEnumerable<object?> SearchByKey(string keyStartsWith) =>
        InnerCache.SearchByKey(keyStartsWith)
            .Select(CheckCloneableAndTracksChanges);

    /// <inheritdoc />
    public IEnumerable<object?> SearchByRegex(string regex) =>
        InnerCache.SearchByRegex(regex)
            .Select(CheckCloneableAndTracksChanges);

    /// <inheritdoc />
    public object? Get(string key, Func<object?> factory, TimeSpan? timeout, bool isSliding = false, string[]? dependentFiles = null)
    {
        var cached = InnerCache.Get(
            key,
            () =>
        {
            Lazy<object?> result = SafeLazy.GetSafeLazy(factory);
            var value = result
                .Value; // force evaluation now - this may throw if cacheItem throws, and then nothing goes into cache

            // do not store null values (backward compat), clone / reset to go into the cache
            return value == null ? null : CheckCloneableAndTracksChanges(value);

            // clone / reset to go into the cache
        },
            timeout,
            isSliding,
            dependentFiles);

        // clone / reset to go into the cache
        return CheckCloneableAndTracksChanges(cached);
    }

    /// <inheritdoc />
    public void Insert(string key, Func<object?> factory, TimeSpan? timeout = null, bool isSliding = false, string[]? dependentFiles = null) =>
        InnerCache.Insert(
            key,
            () =>
        {
            Lazy<object?> result = SafeLazy.GetSafeLazy(factory);
            var value = result
                .Value; // force evaluation now - this may throw if cacheItem throws, and then nothing goes into cache

            // do not store null values (backward compat), clone / reset to go into the cache
            return value == null ? null : CheckCloneableAndTracksChanges(value);
        },
            timeout,
            isSliding,
            dependentFiles);

    /// <inheritdoc />
    public void Clear() => InnerCache.Clear();

    /// <inheritdoc />
    public void Clear(string key) => InnerCache.Clear(key);

    /// <inheritdoc />
    public void ClearOfType(Type type) => InnerCache.ClearOfType(type);

    /// <inheritdoc />
    public void ClearOfType<T>() => InnerCache.ClearOfType<T>();

    /// <inheritdoc />
    public void ClearOfType<T>(Func<string, T, bool> predicate) => InnerCache.ClearOfType(predicate);

    /// <inheritdoc />
    public void ClearByKey(string keyStartsWith) => InnerCache.ClearByKey(keyStartsWith);

    /// <inheritdoc />
    public void ClearByRegex(string regex) => InnerCache.ClearByRegex(regex);

    public void Dispose() =>

        // Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
        Dispose(true);

    protected virtual void Dispose(bool disposing)
    {
        if (!_disposedValue)
        {
            if (disposing)
            {
                InnerCache.DisposeIfDisposable();
            }

            _disposedValue = true;
        }
    }

    private static object? CheckCloneableAndTracksChanges(object? input)
    {
        if (input is IDeepCloneable cloneable)
        {
            input = cloneable.DeepClone();
        }

        // reset dirty initial properties
        if (input is IRememberBeingDirty tracksChanges)
        {
            tracksChanges.ResetDirtyProperties(false);
            input = tracksChanges;
        }

        return input;
    }
}