|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System.Globalization;
using System.Text.Json;
using Aspire.Cli.Configuration;
using Aspire.Cli.Interaction;
using Aspire.Cli.Resources;
using Aspire.Cli.Telemetry;
using Aspire.Cli.Utils;
using Aspire.Hosting.Utils;
using Microsoft.Extensions.Logging;
namespace Aspire.Cli.Projects;
internal interface IProjectLocator
{
Task<AppHostProjectSearchResult> UseOrFindAppHostProjectFileAsync(FileInfo? projectFile, MultipleAppHostProjectsFoundBehavior multipleAppHostProjectsFoundBehavior, bool createSettingsFile, CancellationToken cancellationToken = default);
Task<FileInfo?> UseOrFindAppHostProjectFileAsync(FileInfo? projectFile, bool createSettingsFile, CancellationToken cancellationToken);
}
internal sealed class ProjectLocator(
ILogger<ProjectLocator> logger,
CliExecutionContext executionContext,
IInteractionService interactionService,
IConfigurationService configurationService,
IAppHostProjectFactory projectFactory,
AspireCliTelemetry telemetry) : IProjectLocator
{
public async Task<List<FileInfo>> FindAppHostProjectFilesAsync(string searchDirectory, CancellationToken cancellationToken)
{
var allCandidates = await FindAppHostProjectFilesAsync(new DirectoryInfo(searchDirectory), cancellationToken);
return [..allCandidates.BuildableAppHost, ..allCandidates.UnbuildableSuspectedAppHostProjects];
}
private async Task<(List<FileInfo> BuildableAppHost, List<FileInfo> UnbuildableSuspectedAppHostProjects)> FindAppHostProjectFilesAsync(DirectoryInfo searchDirectory, CancellationToken cancellationToken)
{
using var activity = telemetry.ActivitySource.StartActivity();
return await interactionService.ShowStatusAsync(InteractionServiceStrings.SearchingProjects, async () =>
{
var appHostProjects = new List<FileInfo>();
var unbuildableSuspectedAppHostProjects = new List<FileInfo>();
var lockObject = new object();
logger.LogDebug("Searching for project files in {SearchDirectory}", searchDirectory.FullName);
var enumerationOptions = new EnumerationOptions
{
RecurseSubdirectories = true,
IgnoreInaccessible = true
};
interactionService.DisplayMessage("magnifying_glass_tilted_left", InteractionServiceStrings.FindingAppHosts);
var parallelOptions = new ParallelOptions
{
CancellationToken = cancellationToken,
MaxDegreeOfParallelism = Environment.ProcessorCount
};
// Get all detection patterns from registered project handlers
var allPatterns = projectFactory.GetAllProjects()
.SelectMany(p => p.DetectionPatterns)
.Distinct()
.ToArray();
logger.LogDebug("Searching for patterns: {Patterns}", string.Join(", ", allPatterns));
// Process each pattern
foreach (var pattern in allPatterns)
{
var candidateFiles = searchDirectory.GetFiles(pattern, enumerationOptions);
logger.LogDebug("Found {CandidateCount} files matching pattern '{Pattern}'", candidateFiles.Length, pattern);
await Parallel.ForEachAsync(candidateFiles, parallelOptions, async (candidateFile, ct) =>
{
logger.LogDebug("Checking candidate file {CandidateFile}", candidateFile.FullName);
// Check if any handler can handle this file
var handler = projectFactory.TryGetProject(candidateFile);
if (handler is null)
{
logger.LogTrace("No handler found for {CandidateFile}", candidateFile.FullName);
return;
}
// Validate the candidate file using the handler
var validationResult = await handler.ValidateAppHostAsync(candidateFile, ct);
if (validationResult.IsValid)
{
logger.LogDebug("Found {Language} apphost {CandidateFile}", handler.DisplayName, candidateFile.FullName);
var relativePath = Path.GetRelativePath(executionContext.WorkingDirectory.FullName, candidateFile.FullName);
interactionService.DisplaySubtleMessage(relativePath);
lock (lockObject)
{
appHostProjects.Add(candidateFile);
}
}
else if (validationResult.IsPossiblyUnbuildable)
{
var relativePath = Path.GetRelativePath(executionContext.WorkingDirectory.FullName, candidateFile.FullName);
interactionService.DisplayMessage("warning", string.Format(CultureInfo.CurrentCulture, ErrorStrings.ProjectFileMayBeUnbuildableAppHost, relativePath));
lock (lockObject)
{
unbuildableSuspectedAppHostProjects.Add(candidateFile);
}
}
else
{
logger.LogTrace("File {CandidateFile} is not a valid Aspire host", candidateFile.FullName);
}
});
}
// This sort is done here to make results deterministic since we get all the app
// host information in parallel and the order may vary.
appHostProjects.Sort((x, y) => x.FullName.CompareTo(y.FullName));
return (appHostProjects, unbuildableSuspectedAppHostProjects);
});
}
private async Task<FileInfo?> GetAppHostProjectFileFromSettingsAsync(CancellationToken cancellationToken)
{
var searchDirectory = executionContext.WorkingDirectory;
while (true)
{
var settingsFile = new FileInfo(ConfigurationHelper.BuildPathToSettingsJsonFile(searchDirectory.FullName));
if (settingsFile.Exists)
{
using var stream = settingsFile.OpenRead();
var json = await JsonDocument.ParseAsync(stream, cancellationToken: cancellationToken);
if (json.RootElement.TryGetProperty("appHostPath", out var appHostPathProperty) && appHostPathProperty.GetString() is { } appHostPath)
{
var qualifiedAppHostPath = Path.IsPathRooted(appHostPath) ? appHostPath : Path.Combine(settingsFile.Directory!.FullName, appHostPath);
qualifiedAppHostPath = PathNormalizer.NormalizePathForCurrentPlatform(qualifiedAppHostPath);
var appHostFile = new FileInfo(qualifiedAppHostPath);
if (appHostFile.Exists)
{
return appHostFile;
}
else
{
// AppHost file was specified but doesn't exist, return null to trigger fallback logic
interactionService.DisplayMessage("warning", string.Format(CultureInfo.CurrentCulture, ErrorStrings.AppHostWasSpecifiedButDoesntExist, settingsFile.FullName, qualifiedAppHostPath));
return null;
}
}
}
if (searchDirectory.Parent is not null)
{
searchDirectory = searchDirectory.Parent;
}
else
{
return null;
}
}
}
public async Task<AppHostProjectSearchResult> UseOrFindAppHostProjectFileAsync(FileInfo? projectFile, MultipleAppHostProjectsFoundBehavior multipleAppHostProjectsFoundBehavior, bool createSettingsFile, CancellationToken cancellationToken = default)
{
logger.LogDebug("Finding project file in {CurrentDirectory}", executionContext.WorkingDirectory);
if (projectFile is not null)
{
// Check if the provided path is actually a directory
if (Directory.Exists(projectFile.FullName))
{
logger.LogDebug("Provided path {Path} is a directory, searching for project files recursively", projectFile.FullName);
var directory = new DirectoryInfo(projectFile.FullName);
// Reuse the main search logic
var searchResults = await FindAppHostProjectFilesAsync(directory, cancellationToken);
var appHostProjects = searchResults.BuildableAppHost;
interactionService.DisplayEmptyLine();
if (appHostProjects.Count == 0)
{
logger.LogError("No AppHost project files found in directory {Directory}", directory.FullName);
throw new ProjectLocatorException(ErrorStrings.ProjectFileDoesntExist);
}
else if (appHostProjects.Count == 1)
{
logger.LogDebug("Found single AppHost project file {ProjectFile} in directory {Directory}", appHostProjects[0].FullName, directory.FullName);
projectFile = appHostProjects[0];
}
else
{
if (multipleAppHostProjectsFoundBehavior is MultipleAppHostProjectsFoundBehavior.Prompt)
{
logger.LogDebug("Multiple AppHost project files found in directory {Directory}, prompting user to select", directory.FullName);
projectFile = await interactionService.PromptForSelectionAsync(
InteractionServiceStrings.SelectAppHostToUse,
appHostProjects,
file => $"{file.Name} ({Path.GetRelativePath(executionContext.WorkingDirectory.FullName, file.FullName)})",
cancellationToken
);
}
else if (multipleAppHostProjectsFoundBehavior is MultipleAppHostProjectsFoundBehavior.None)
{
logger.LogDebug("Multiple AppHost project files found in directory {Directory}, selecting none", directory.FullName);
projectFile = null;
}
else if (multipleAppHostProjectsFoundBehavior is MultipleAppHostProjectsFoundBehavior.Throw)
{
logger.LogError("Multiple AppHost project files found in directory {Directory}, throwing exception", directory.FullName);
throw new ProjectLocatorException(ErrorStrings.MultipleProjectFilesFound);
}
}
}
if (projectFile is not null)
{
// If the project file is passed, validate it.
if (!projectFile.Exists)
{
logger.LogError("Project file {ProjectFile} does not exist.", projectFile.FullName);
throw new ProjectLocatorException(ErrorStrings.ProjectFileDoesntExist);
}
// Check if any handler can handle this file
var handler = projectFactory.TryGetProject(projectFile);
if (handler is not null)
{
logger.LogDebug("Using {Language} apphost {ProjectFile}", handler.DisplayName, projectFile.FullName);
return new AppHostProjectSearchResult(projectFile, [projectFile]);
}
// If no handler matched, for .cs files check if we should search the parent directory
if (projectFile.Name.Equals("apphost.cs", StringComparison.OrdinalIgnoreCase) && projectFile.Directory is { } parentDirectory)
{
// File exists but is not a valid single-file apphost. Search in the parent directory
return await UseOrFindAppHostProjectFileAsync(new FileInfo(parentDirectory.FullName), multipleAppHostProjectsFoundBehavior, createSettingsFile, cancellationToken);
}
// No handler can process this file
throw new ProjectLocatorException(ErrorStrings.ProjectFileDoesntExist);
}
}
projectFile = await GetAppHostProjectFileFromSettingsAsync(cancellationToken);
if (projectFile is not null)
{
return new AppHostProjectSearchResult(projectFile, [projectFile]);
}
logger.LogDebug("No project file specified, searching for apphost projects in {CurrentDirectory}", executionContext.WorkingDirectory);
var results = await FindAppHostProjectFilesAsync(executionContext.WorkingDirectory, cancellationToken);
interactionService.DisplayEmptyLine();
logger.LogDebug("Found {ProjectFileCount} project files.", results.BuildableAppHost.Count);
FileInfo? selectedAppHost = null;
if (results.BuildableAppHost.Count == 0 && results.UnbuildableSuspectedAppHostProjects.Count == 0)
{
throw new ProjectLocatorException(ErrorStrings.NoProjectFileFound);
}
else if (results.BuildableAppHost.Count == 0 && results.UnbuildableSuspectedAppHostProjects.Count > 0)
{
throw new ProjectLocatorException(ErrorStrings.AppHostsMayNotBeBuildable);
}
else if (results.BuildableAppHost.Count == 1)
{
selectedAppHost = results.BuildableAppHost[0];
}
else if (results.BuildableAppHost.Count > 1)
{
selectedAppHost = multipleAppHostProjectsFoundBehavior switch
{
MultipleAppHostProjectsFoundBehavior.Throw => throw new ProjectLocatorException(ErrorStrings.MultipleProjectFilesFound),
MultipleAppHostProjectsFoundBehavior.Prompt => await interactionService.PromptForSelectionAsync(InteractionServiceStrings.SelectAppHostToUse, results.BuildableAppHost, projectFile => $"{projectFile.Name} ({Path.GetRelativePath(executionContext.WorkingDirectory.FullName, projectFile.FullName)})", cancellationToken),
MultipleAppHostProjectsFoundBehavior.None => null,
_ => selectedAppHost
};
}
if (createSettingsFile)
{
await CreateSettingsFileAsync(selectedAppHost!, cancellationToken);
}
return new AppHostProjectSearchResult(selectedAppHost, results.BuildableAppHost);
}
public async Task<FileInfo?> UseOrFindAppHostProjectFileAsync(FileInfo? projectFile, bool createSettingsFile, CancellationToken cancellationToken = default)
{
var result = await UseOrFindAppHostProjectFileAsync(projectFile, MultipleAppHostProjectsFoundBehavior.Prompt, createSettingsFile, cancellationToken);
return result.SelectedProjectFile;
}
private async Task CreateSettingsFileAsync(FileInfo projectFile, CancellationToken cancellationToken)
{
var settingsFilePath = ConfigurationHelper.BuildPathToSettingsJsonFile(executionContext.WorkingDirectory.FullName);
var settingsFile = new FileInfo(settingsFilePath);
logger.LogDebug("Creating settings file at {SettingsFilePath}", settingsFile.FullName);
var relativePathToProjectFile = Path.GetRelativePath(settingsFile.Directory!.FullName, projectFile.FullName).Replace(Path.DirectorySeparatorChar, '/');
// Use the configuration writer to set the appHostPath, which will merge with any existing settings
await configurationService.SetConfigurationAsync("appHostPath", relativePathToProjectFile, isGlobal: false, cancellationToken);
var relativeSettingsFilePath = Path.GetRelativePath(executionContext.WorkingDirectory.FullName, settingsFile.FullName).Replace(Path.DirectorySeparatorChar, '/');
interactionService.DisplayMessage("file_cabinet", string.Format(CultureInfo.CurrentCulture, InteractionServiceStrings.CreatedSettingsFile, $"[bold]'{relativeSettingsFilePath}'[/]"));
}
}
internal class ProjectLocatorException : System.Exception
{
public ProjectLocatorException(string message) : base(message) { }
}
internal record AppHostProjectSearchResult(FileInfo? SelectedProjectFile, List<FileInfo> AllProjectFileCandidates);
internal enum MultipleAppHostProjectsFoundBehavior
{
Prompt,
Throw,
None
}
|