// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System.Collections.Frozen;
using System.Globalization;
using Aspire.Cli.Configuration;
using Aspire.Cli.DotNet;
using Aspire.Cli.Resources;
using Aspire.Cli.Telemetry;
using Microsoft.Extensions.Caching.Memory;
using NuGetPackage = Aspire.Shared.NuGetPackageCli;
namespace Aspire.Cli.NuGet;
internal interface INuGetPackageCache
{
Task<IEnumerable<NuGetPackage>> GetTemplatePackagesAsync(DirectoryInfo workingDirectory, bool prerelease, FileInfo? nugetConfigFile, CancellationToken cancellationToken);
Task<IEnumerable<NuGetPackage>> GetIntegrationPackagesAsync(DirectoryInfo workingDirectory, bool prerelease, FileInfo? nugetConfigFile, CancellationToken cancellationToken);
Task<IEnumerable<NuGetPackage>> GetCliPackagesAsync(DirectoryInfo workingDirectory, bool prerelease, FileInfo? nugetConfigFile, CancellationToken cancellationToken);
Task<IEnumerable<NuGetPackage>> GetPackagesAsync(DirectoryInfo workingDirectory, string packageId, Func<string, bool>? filter, bool prerelease, FileInfo? nugetConfigFile, bool useCache, CancellationToken cancellationToken);
Task<IEnumerable<NuGetPackage>> GetPackageVersionsAsync(DirectoryInfo workingDirectory, string exactPackageId, bool prerelease, FileInfo? nugetConfigFile, bool useCache, CancellationToken cancellationToken);
}
/// <summary>
/// Packages that have been superseded and should be hidden from integration listings by default.
/// </summary>
internal static class DeprecatedPackages
{
private static readonly FrozenSet<string> s_all = new[]
{
"Aspire.Hosting.Dapr",
"Aspire.Hosting.GitHub.Models",
"Aspire.Hosting.NodeJs"
}.ToFrozenSet(StringComparer.OrdinalIgnoreCase);
public static bool IsDeprecated(string packageId) => s_all.Contains(packageId);
}
internal static class PackageIdFilters
{
public static bool IsOfficialOrCommunityToolkitPackage(string packageId)
{
var isHostingOrCommunityToolkitNamespaced = packageId.StartsWith("Aspire.Hosting.", StringComparison.OrdinalIgnoreCase) ||
packageId.StartsWith("CommunityToolkit.Aspire.Hosting.", StringComparison.OrdinalIgnoreCase) ||
packageId.Equals("Aspire.ProjectTemplates", StringComparison.OrdinalIgnoreCase) ||
packageId.Equals("Aspire.Cli", StringComparison.OrdinalIgnoreCase);
return isHostingOrCommunityToolkitNamespaced && !IsExcludedHostingPackage(packageId);
}
public static bool IsIntegrationPackageId(string packageId)
{
var isHostingOrCommunityToolkitNamespaced = packageId.StartsWith("Aspire.Hosting.", StringComparison.OrdinalIgnoreCase) ||
packageId.StartsWith("CommunityToolkit.Aspire.Hosting.", StringComparison.OrdinalIgnoreCase);
return isHostingOrCommunityToolkitNamespaced && !IsExcludedHostingPackage(packageId);
}
private static bool IsExcludedHostingPackage(string packageId)
{
return packageId.StartsWith("Aspire.Hosting.AppHost", StringComparison.OrdinalIgnoreCase) ||
packageId.StartsWith("Aspire.Hosting.Sdk", StringComparison.OrdinalIgnoreCase) ||
packageId.StartsWith("Aspire.Hosting.Orchestration", StringComparison.OrdinalIgnoreCase) ||
packageId.StartsWith("Aspire.Hosting.Testing", StringComparison.OrdinalIgnoreCase) ||
packageId.StartsWith("Aspire.Hosting.Msi", StringComparison.OrdinalIgnoreCase) ||
packageId.Equals("Aspire.Hosting.Integration.Analyzers", StringComparison.OrdinalIgnoreCase);
}
}
internal sealed class NuGetPackageCache(IDotNetCliRunner cliRunner, IMemoryCache memoryCache, AspireCliTelemetry telemetry, IFeatures features) : INuGetPackageCache
{
private const int SearchPageSize = 1000;
public async Task<IEnumerable<NuGetPackage>> GetTemplatePackagesAsync(DirectoryInfo workingDirectory, bool prerelease, FileInfo? nugetConfigFile, CancellationToken cancellationToken)
{
var nuGetConfigHashSuffix = nugetConfigFile is not null ? await ComputeNuGetConfigHashSuffixAsync(nugetConfigFile, cancellationToken) : string.Empty;
var key = $"TemplatePackages-{workingDirectory.FullName}-{prerelease}-{nuGetConfigHashSuffix}";
var packages = await memoryCache.GetOrCreateAsync(key, async (entry) =>
{
var packages = await GetPackagesAsync(workingDirectory, "Aspire.ProjectTemplates", null, prerelease, nugetConfigFile, true, cancellationToken);
return packages.Where(p => p.Id.Equals("Aspire.ProjectTemplates", StringComparison.OrdinalIgnoreCase));
}) ?? throw new NuGetPackageCacheException(ErrorStrings.FailedToRetrieveCachedTemplatePackages);
return packages;
}
public async Task<IEnumerable<NuGetPackage>> GetIntegrationPackagesAsync(DirectoryInfo workingDirectory, bool prerelease, FileInfo? nugetConfigFile, CancellationToken cancellationToken)
{
return await GetPackagesAsync(workingDirectory, "Aspire.Hosting", null, prerelease, nugetConfigFile, true, cancellationToken);
}
public async Task<IEnumerable<NuGetPackage>> GetCliPackagesAsync(DirectoryInfo workingDirectory, bool prerelease, FileInfo? nugetConfigFile, CancellationToken cancellationToken)
{
var nuGetConfigHashSuffix = nugetConfigFile is not null ? await ComputeNuGetConfigHashSuffixAsync(nugetConfigFile, cancellationToken) : string.Empty;
var key = $"CliPackages-{workingDirectory.FullName}-{prerelease}-{nuGetConfigHashSuffix}";
var packages = await memoryCache.GetOrCreateAsync(key, async (entry) =>
{
// Set cache expiration to 1 hour for CLI updates
entry.AbsoluteExpirationRelativeToNow = TimeSpan.FromHours(1);
var packages = await GetPackagesAsync(workingDirectory, "Aspire.Cli", null, prerelease, nugetConfigFile, false, cancellationToken);
return packages.Where(p => p.Id.Equals("Aspire.Cli", StringComparison.OrdinalIgnoreCase));
}) ?? [];
return packages;
}
private static async Task<string> ComputeNuGetConfigHashSuffixAsync(FileInfo nugetConfigFile, CancellationToken cancellationToken)
{
using var stream = nugetConfigFile.OpenRead();
using var sha256 = System.Security.Cryptography.SHA256.Create();
var hashBytes = await sha256.ComputeHashAsync(stream, cancellationToken);
return Convert.ToHexString(hashBytes);
}
public async Task<IEnumerable<NuGetPackage>> GetPackagesAsync(DirectoryInfo workingDirectory, string query, Func<string, bool>? filter, bool prerelease, FileInfo? nugetConfigFile, bool useCache, CancellationToken cancellationToken)
{
using var activity = telemetry.StartDiagnosticActivity();
var collectedPackages = new List<NuGetPackage>();
var skip = 0;
bool continueFetching;
do
{
// This search should pick up Aspire.Hosting.* and CommunityToolkit.Aspire.Hosting.*
var result = await cliRunner.SearchPackagesAsync(
workingDirectory,
query,
exactMatch: false,
prerelease,
SearchPageSize,
skip,
nugetConfigFile,
useCache, // Pass through the useCache parameter
new ProcessInvocationOptions { SuppressLogging = true },
cancellationToken
);
if (result.ExitCode != 0)
{
throw new NuGetPackageCacheException(string.Format(CultureInfo.CurrentCulture, ErrorStrings.FailedToSearchForPackages, result.ExitCode));
}
else
{
if (result.Packages?.Length > 0)
{
collectedPackages.AddRange(result.Packages);
}
if (result.Packages?.Length < SearchPageSize)
{
continueFetching = false;
}
else
{
continueFetching = true;
skip += SearchPageSize;
}
}
} while (continueFetching);
// If no specific filter is specified we use the fallback filter which is useful in most circumstances
// other that aspire update which really needs to see all the packages to work effectively.
var showDeprecatedPackages = features.IsFeatureEnabled(KnownFeatures.ShowDeprecatedPackages, defaultValue: false);
var effectiveFilter = (NuGetPackage p) =>
{
if (filter is not null)
{
return filter(p.Id);
}
var isOfficialPackage = PackageIdFilters.IsOfficialOrCommunityToolkitPackage(p.Id);
// Apply deprecated package filter unless the user wants to show deprecated packages
if (isOfficialPackage && !showDeprecatedPackages)
{
return !DeprecatedPackages.IsDeprecated(p.Id);
}
return isOfficialPackage;
};
return collectedPackages.Where(effectiveFilter);
}
public async Task<IEnumerable<NuGetPackage>> GetPackageVersionsAsync(DirectoryInfo workingDirectory, string exactPackageId, bool prerelease, FileInfo? nugetConfigFile, bool useCache, CancellationToken cancellationToken)
{
using var activity = telemetry.StartDiagnosticActivity();
var collectedPackages = new List<NuGetPackage>();
var result = await cliRunner.SearchPackagesAsync(
workingDirectory,
exactPackageId,
exactMatch: true,
prerelease,
take: 0,
skip: 0, // skip and take parameters are ignored when exactMatch is true
nugetConfigFile,
useCache, // Pass through the useCache parameter
new ProcessInvocationOptions { SuppressLogging = true },
cancellationToken
);
if (result.ExitCode != 0)
{
throw new NuGetPackageCacheException(string.Format(CultureInfo.CurrentCulture, ErrorStrings.FailedToSearchForPackages, result.ExitCode));
}
if (result.Packages?.Length > 0)
{
collectedPackages.AddRange(result.Packages);
}
// If no specific filter is specified we use the fallback filter which is useful in most circumstances
// other that aspire update which really needs to see all the packages to work effectively.
var effectiveFilter = (NuGetPackage p) =>
{
// Apply deprecated package filter unless the user wants to show deprecated packages
if (!features.IsFeatureEnabled(KnownFeatures.ShowDeprecatedPackages, defaultValue: false))
{
return !DeprecatedPackages.IsDeprecated(p.Id);
}
return true;
};
return collectedPackages.Where(effectiveFilter);
}
}
internal sealed class NuGetPackageCacheException(string message) : Exception(message)
{
}