// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
 
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using Aspire.Dashboard.Model;
using static Aspire.Hosting.Resources.MessageStrings;
 
namespace Aspire.Hosting.ApplicationModel;
 
/// <summary>
/// A resource that represents a specified dotnet tool.
/// </summary>
/// <remarks>
/// This class is used to define and manage resources for .NET CLI tools. It associates a tool's name and
/// command with its package ID, and ensures that the required metadata is properly annotated.
/// </remarks>
[Experimental("ASPIREDOTNETTOOL", UrlFormat = "https://aka.ms/aspire/diagnostics/{0}")]
[DebuggerDisplay("Type = {GetType().Name,nq}, Name = {Name}, Tool = {ToolConfiguration?.PackageId}")]
public class DotnetToolResource : ExecutableResource
{
    /// <summary>
    /// Initializes a new instance of the <see cref="DotnetToolResource"/> class.
    /// </summary>
    /// <param name="name">The name of the resource.</param>
    /// <param name="packageId">The package id of the tool.</param>
    public DotnetToolResource(string name, string packageId)
        : base(name, "dotnet", ".")
    {
        ArgumentException.ThrowIfNullOrWhiteSpace(packageId, nameof(packageId));
        Annotations.Add(new DotnetToolAnnotation { PackageId = packageId });
    }
 
    internal DotnetToolAnnotation? ToolConfiguration
    {
        get
        {
            this.TryGetLastAnnotation<DotnetToolAnnotation>(out var toolConfig);
            return toolConfig;
        }
    }
 
    internal IEnumerable<ResourcePropertySnapshot> CreateSnapshotProperties()
    {
        var toolConfig = ToolConfiguration;
        if (toolConfig is null)
        {
            yield break;
        }
 
        yield return CreateHighlightedProperty(KnownProperties.Tool.Package, toolConfig.PackageId, ResourcePropertyToolPackageDisplayName, sortOrder: 0);
        yield return CreateHighlightedProperty(KnownProperties.Tool.Version, toolConfig.Version, ResourcePropertyToolVersionDisplayName, sortOrder: 1);
        yield return new(KnownProperties.Resource.Source, toolConfig.PackageId);
    }
 
    private static ResourcePropertySnapshot CreateHighlightedProperty(string name, object? value, string displayName, int sortOrder)
    {
        return new(name, value)
        {
            DisplayName = displayName,
            IsHighlighted = true,
            SortOrder = sortOrder
        };
    }
}