// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using System.Linq;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Diagnostics.HealthChecks;
 
namespace Microsoft.AspNetCore.Diagnostics.HealthChecks;
 
/// <summary>
/// Contains options for the <see cref="HealthCheckMiddleware"/>.
/// </summary>
public class HealthCheckOptions
{
    /// <summary>
    /// Gets or sets a predicate that is used to filter the set of health checks executed.
    /// </summary>
    /// <remarks>
    /// If <see cref="Predicate"/> is <c>null</c>, the <see cref="HealthCheckMiddleware"/> will run all
    /// registered health checks - this is the default behavior. To run a subset of health checks,
    /// provide a function that filters the set of checks.
    /// </remarks>
    public Func<HealthCheckRegistration, bool>? Predicate { get; set; }
 
    private IDictionary<HealthStatus, int> _resultStatusCodes = new Dictionary<HealthStatus, int>(DefaultStatusCodesMapping);
 
    private static readonly IReadOnlyDictionary<HealthStatus, int> DefaultStatusCodesMapping = new Dictionary<HealthStatus, int>
        {
            {HealthStatus.Healthy, StatusCodes.Status200OK},
            {HealthStatus.Degraded, StatusCodes.Status200OK},
            {HealthStatus.Unhealthy, StatusCodes.Status503ServiceUnavailable},
        };
 
    /// <summary>
    /// Gets or sets a dictionary mapping the <see cref="HealthStatus"/> to an HTTP status code applied
    /// to the response. This property can be used to configure the status codes returned for each status.
    /// </summary>
    /// <remarks>
    /// Setting this property to <c>null</c> resets the mapping to its default value which maps
    /// <see cref="HealthStatus.Healthy"/> to 200 (OK), <see cref="HealthStatus.Degraded"/> to 200 (OK) and
    /// <see cref="HealthStatus.Unhealthy"/> to 503 (Service Unavailable).
    /// </remarks>
    /// <exception cref="InvalidOperationException">Thrown if at least one <see cref="HealthStatus"/> is missing when setting this property.</exception>
    public IDictionary<HealthStatus, int> ResultStatusCodes
    {
        get => _resultStatusCodes;
        set => _resultStatusCodes = value != null ? ValidateStatusCodesMapping(value) : new Dictionary<HealthStatus, int>(DefaultStatusCodesMapping);
    }
 
    private static IDictionary<HealthStatus, int> ValidateStatusCodesMapping(IDictionary<HealthStatus, int> mapping)
    {
        var missingHealthStatus = Enum.GetValues<HealthStatus>().Except(mapping.Keys).ToList();
        if (missingHealthStatus.Count > 0)
        {
            var missing = string.Join(", ", missingHealthStatus.Select(status => $"{nameof(HealthStatus)}.{status}"));
            var message =
                $"The {nameof(ResultStatusCodes)} dictionary must include an entry for all possible " +
                $"{nameof(HealthStatus)} values. Missing: {missing}";
            throw new InvalidOperationException(message);
        }
        return mapping;
    }
 
    /// <summary>
    /// Gets or sets a delegate used to write the response.
    /// </summary>
    /// <remarks>
    /// The default value is a delegate that will write a minimal <c>text/plain</c> response with the value
    /// of <see cref="HealthReport.Status"/> as a string.
    /// </remarks>
    public Func<HttpContext, HealthReport, Task> ResponseWriter { get; set; } = HealthCheckResponseWriters.WriteMinimalPlaintext;
 
    /// <summary>
    /// Gets or sets a value that controls whether responses from the health check middleware can be cached.
    /// </summary>
    /// <remarks>
    /// <para>
    /// The health check middleware does not perform caching of any kind. This setting configures whether
    /// the middleware will apply headers to the HTTP response that instruct clients to avoid caching.
    /// </para>
    /// <para>
    /// If the value is <c>false</c> the health check middleware will set or override the
    /// <c>Cache-Control</c>, <c>Expires</c>, and <c>Pragma</c> headers to prevent response caching. If the value
    /// is <c>true</c> the health check middleware will not modify the cache headers of the response.
    /// </para>
    /// </remarks>
    public bool AllowCachingResponses { get; set; }
}