Improve detach mode: fix pipe handle inheritance and unify log naming #14424
+161
−43
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 14424Or
iex "& { $(irm https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 14424" |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves aspire run --detach behavior by preventing pipe/handle inheritance issues (notably on Windows) and standardizing how CLI log files are named and discovered, so detached failures can reliably point users to the right diagnostics.
Changes:
- Adds a hidden
--log-fileoption and passes it from the detach parent process to the detach child process. - Introduces
FileLoggerProvider.GenerateLogFilePath(...)and updates log file naming tocli_yyyyMMddTHHmmss_{pid}[_{suffix}].log. - Improves detached-mode failure UX by mapping
FailedToBuildArtifactsto a friendlier localized message and pointing to the child’s log file.
Reviewed changes
Copilot reviewed 18 out of 19 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Aspire.Cli/Program.cs | Parses --log-file early and uses it to initialize file logging before host build. |
| src/Aspire.Cli/Diagnostics/FileLoggerProvider.cs | Adds centralized log filename generation and updates default naming format. |
| src/Aspire.Cli/Commands/RunCommand.cs | Adds hidden --log-file, stops redirecting detached child stdout/stderr, passes explicit child log path, and improves failure messaging. |
| src/Aspire.Cli/Commands/CacheCommand.cs | Updates log filename suffix matching to align with new cli_{timestamp}_{pid}.log format. |
| src/Aspire.Cli/Resources/RunCommandStrings.resx | Adds new AppHostFailedToBuild resource string. |
| src/Aspire.Cli/Resources/RunCommandStrings.Designer.cs | Regenerates strongly-typed accessor for AppHostFailedToBuild. |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.cs.xlf | Adds AppHostFailedToBuild localization entry (new). |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.de.xlf | Adds AppHostFailedToBuild localization entry (new). |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.es.xlf | Adds AppHostFailedToBuild localization entry (new). |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.fr.xlf | Adds AppHostFailedToBuild localization entry (new). |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.it.xlf | Adds AppHostFailedToBuild localization entry (new). |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.ja.xlf | Adds AppHostFailedToBuild localization entry (new). |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.ko.xlf | Adds AppHostFailedToBuild localization entry (new). |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.pl.xlf | Adds AppHostFailedToBuild localization entry (new). |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.pt-BR.xlf | Adds AppHostFailedToBuild localization entry (new). |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.ru.xlf | Adds AppHostFailedToBuild localization entry (new). |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.tr.xlf | Adds AppHostFailedToBuild localization entry (new). |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.zh-Hans.xlf | Adds AppHostFailedToBuild localization entry (new). |
| src/Aspire.Cli/Resources/xlf/RunCommandStrings.zh-Hant.xlf | Adds AppHostFailedToBuild localization entry (new). |
Files not reviewed (1)
- src/Aspire.Cli/Resources/RunCommandStrings.Designer.cs: Language not supported
Comments suppressed due to low confidence (2)
src/Aspire.Cli/Commands/CacheCommand.cs:121
cache clearskips deleting the current log file by checking a filename suffix based onEnvironment.ProcessId, but the CLI can now run with an explicit--log-filepath (and detached child logs also include an extra suffix). This can cause the current session’s log file to be deleted while still in use. Consider skipping deletion by comparing againstExecutionContext.LogFilePath(full path) instead of relying on the filename pattern.
// Also clear the logs directory (skip current process's log file)
var logsDirectory = ExecutionContext.LogsDirectory;
// Log files are named cli_{timestamp}_{pid}.log, so we need to check the suffix
var currentLogFileSuffix = $"_{Environment.ProcessId}.log";
if (logsDirectory.Exists)
{
foreach (var file in logsDirectory.GetFiles("*", SearchOption.AllDirectories))
{
// Skip the current process's log file to avoid deleting it while in use
if (file.Name.EndsWith(currentLogFileSuffix, StringComparison.OrdinalIgnoreCase))
{
src/Aspire.Cli/Commands/RunCommand.cs:665
- Detached mode now generates/passes a
childLogFileand (on failure) points users to that file, but the success paths still report_fileLoggerProvider.LogFilePath(parent session log) in JSON output and the rendered summary. Since the child process is the one that continues running and writing logs, consider returning/displaying the child log file path consistently to avoid sending users/tools to a log that won’t contain the relevant AppHost build/runtime output.
// Build the arguments for the child CLI process
// Tell the child where to write its log so we can find it on failure.
var childLogFile = GenerateChildLogFilePath();
var args = new List<string>
{
"run",
"--non-interactive",
"--project",
effectiveAppHostFile.FullName,
"--log-file",
childLogFile
};
Comment on lines
+898
to
+901
| return Diagnostics.FileLoggerProvider.GenerateLogFilePath( | ||
| ExecutionContext.LogsDirectory.FullName, | ||
| _timeProvider, | ||
| suffix: "detach-child"); |
There was a problem hiding this comment.
GenerateChildLogFilePath() calls FileLoggerProvider.GenerateLogFilePath(), which embeds Environment.ProcessId. Since this method runs in the parent process, the child log file name ends up containing the parent PID, which is misleading and breaks the “pid in filename == process writing the log” convention used elsewhere. Consider adjusting the helper to accept an explicit PID (or use a different uniqueness token for precomputed paths) so detached child log files can reflect the child process ID.
This issue also appears on line 653 of the same file.
Suggested change
| return Diagnostics.FileLoggerProvider.GenerateLogFilePath( | |
| ExecutionContext.LogsDirectory.FullName, | |
| _timeProvider, | |
| suffix: "detach-child"); | |
| var logsDirectory = ExecutionContext.LogsDirectory.FullName; | |
| var now = _timeProvider.GetUtcNow(); | |
| var timestamp = now.ToString("yyyyMMddHHmmssfff", CultureInfo.InvariantCulture); | |
| var uniqueId = Guid.NewGuid().ToString("N", CultureInfo.InvariantCulture); | |
| var fileName = $"aspire-detach-child-{timestamp}-{uniqueId}.log"; | |
| return Path.Combine(logsDirectory, fileName); |
Comment on lines
+822
to
+828
| // Show a friendly message based on well-known exit codes from the child | ||
| var errorMessage = childExitCode switch | ||
| { | ||
| ExitCodeConstants.FailedToBuildArtifacts => RunCommandStrings.AppHostFailedToBuild, | ||
| _ => string.Format(CultureInfo.CurrentCulture, RunCommandStrings.AppHostExitedWithCode, childExitCode) | ||
| }; | ||
| _interactionService.DisplayError(errorMessage); |
There was a problem hiding this comment.
Changes to detached execution introduced new behaviors that are currently untested (e.g., --log-file propagation, exit-code-to-message mapping for FailedToBuildArtifacts, and ensuring the correct log file path is surfaced on failure). There are existing RunCommandTests, but none cover --detach; adding focused unit/integration tests for these paths would help prevent regressions on Windows and in programmatic consumers.
Contributor
🎬 CLI E2E Test RecordingsThe following terminal recordings are available for commit
📹 Recordings uploaded automatically from CI run #21858978808 |
davidfowl
force-pushed
the
davidfowl/detach-more
branch
from
7642ece to
f98890f
Compare
davidfowl
force-pushed
the
davidfowl/detach-more
branch
from
f98890f to
ba11a15
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
When running
aspire run --detach, the child CLI process inherited pipe handles from stdout/stderr redirection. This kept pipes open until the AppHost grandchild died, preventing callers using synchronous process APIs (e.g. Node.jsexecSync) from detecting that the CLI had exited. This is primarily a Windows issue due to how handle inheritance works.Changes
--log-filehidden option — parent passes an explicit log file path to the child so the parent knows where to point on failure.FileLoggerProvider.GenerateLogFilePathstatic helper used by both the normal logger and the detach child path. Format:cli_20260210T074038_12345.log(with optional suffix).FailedToBuildArtifactsexit code to a friendly message. Points to the child's log file on failure.Checklist