Merge branch 'main' into copilot/fix-addpythonapp-virtual-env-error

Author: davidfowl

extension/src/dcp/types.ts

@@ -30,7 +30,8 @@ export function isProjectLaunchConfiguration(obj: any): obj is ProjectLaunchConf
 
 export interface PythonLaunchConfiguration extends ExecutableLaunchConfiguration {
     type: "python";
-    program_path: string;
+    program_path?: string;
+    project_path?: string; // leftover from 9.5 usage of project path
 }
 
 export function isPythonLaunchConfiguration(obj: any): obj is PythonLaunchConfiguration {

extension/src/debugger/languages/dotnet.ts

@@ -1,9 +1,11 @@
 import * as vscode from 'vscode';
 import { extensionLogOutputChannel } from '../../utils/logging';
 import { noCsharpBuildTask, buildFailedWithExitCode, noOutputFromMsbuild, failedToGetTargetPath, invalidLaunchConfiguration } from '../../loc/strings';
-import { execFile } from 'child_process';
+import { ChildProcessWithoutNullStreams, execFile, spawn } from 'child_process';
 import * as util from 'util';
 import * as path from 'path';
+import * as readline from 'readline';
+import * as os from 'os';
 import { doesFileExist } from '../../utils/io';
 import { AspireResourceExtendedDebugConfiguration, isProjectLaunchConfiguration } from '../../dcp/types';
 import { ResourceDebuggerExtension } from '../debuggerExtensions';
@@ -20,6 +22,7 @@ interface IDotNetService {
     getAndActivateDevKit(): Promise<boolean>
     buildDotNetProject(projectFile: string): Promise<void>;
     getDotNetTargetPath(projectFile: string): Promise<string>;
+    getDotNetRunApiOutput(projectFile: string): Promise<string>;
 }
 
 class DotNetService implements IDotNetService {
@@ -112,6 +115,68 @@ class DotNetService implements IDotNetService {
             throw new Error(failedToGetTargetPath(String(err)));
         }
     }
+
+    async getDotNetRunApiOutput(projectPath: string): Promise<string> {
+        return new Promise<string>(async (resolve, reject) => {
+            try {
+                let childProcess: ChildProcessWithoutNullStreams;
+                const timeout = setTimeout(() => {
+                    childProcess?.kill();
+                    reject(new Error('Timeout while waiting for dotnet run-api response'));
+                }, 10_000);
+
+                extensionLogOutputChannel.info('dotnet run-api - starting process');
+
+                childProcess = spawn('dotnet', ['run-api'], {
+                    cwd: path.dirname(projectPath),
+                    env: process.env,
+                    stdio: ['pipe', 'pipe', 'pipe']
+                });
+
+                childProcess.on('error', reject);
+                childProcess.on('exit', (code, signal) => {
+                    clearTimeout(timeout);
+                    reject(new Error(`dotnet run-api exited with ${code ?? signal}`));
+                });
+
+                const rl = readline.createInterface(childProcess.stdout);
+                rl.on('line', line => {
+                    clearTimeout(timeout);
+                    extensionLogOutputChannel.info(`dotnet run-api - received: ${line}`);
+                    resolve(line);
+                });
+
+                const message = JSON.stringify({ ['$type']: 'GetRunCommand', ['EntryPointFileFullPath']: projectPath });
+                extensionLogOutputChannel.info(`dotnet run-api - sending: ${message}`);
+                childProcess.stdin.write(message + os.EOL);
+                childProcess.stdin.end();
+            } catch (e) {
+                reject(e);
+            }
+        });
+    }
+}
+
+function isSingleFileAppHost(projectPath: string): boolean {
+    return path.basename(projectPath).toLowerCase() === 'apphost.cs';
+}
+
+function applyRunApiOutputToDebugConfiguration(runApiOutput: string, debugConfiguration: AspireResourceExtendedDebugConfiguration) {
+    const parsed = JSON.parse(runApiOutput);
+    if (parsed.$type === 'Error') {
+        throw new Error(`dotnet run-api failed: ${parsed.Message}`);
+    }
+    else if (parsed.$type !== 'RunCommand') {
+        throw new Error(`dotnet run-api failed: Unexpected response type '${parsed.$type}'`);
+    }
+
+    debugConfiguration.program = parsed.ExecutablePath;
+    if (parsed.EnvironmentVariables) {
+        debugConfiguration.env = {
+            ...debugConfiguration.env,
+            ...parsed.EnvironmentVariables
+        };
+    }
 }
 
 export function createProjectDebuggerExtension(dotNetService: IDotNetService): ResourceDebuggerExtension {
@@ -148,20 +213,27 @@ export function createProjectDebuggerExtension(dotNetService: IDotNetService): R
                 ? `Using launch profile '${profileName}' for project: ${projectPath}`
                 : `No launch profile selected for project: ${projectPath}`);
 
-            // Build project if needed
-            const outputPath = await dotNetService.getDotNetTargetPath(projectPath);
-            if ((!(await doesFileExist(outputPath)) || launchOptions.forceBuild) && await dotNetService.getAndActivateDevKit()) {
-                await dotNetService.buildDotNetProject(projectPath);
-            }
-
             // Configure debug session with launch profile settings
-            debugConfiguration.program = outputPath;
             debugConfiguration.cwd = determineWorkingDirectory(projectPath, baseProfile);
             debugConfiguration.args = determineArguments(baseProfile?.commandLineArgs, args);
             debugConfiguration.env = Object.fromEntries(mergeEnvironmentVariables(baseProfile?.environmentVariables, env));
             debugConfiguration.executablePath = baseProfile?.executablePath;
             debugConfiguration.checkForDevCert = baseProfile?.useSSL;
             debugConfiguration.serverReadyAction = determineServerReadyAction(baseProfile?.launchBrowser, baseProfile?.applicationUrl);
+
+            // Build project if needed
+            if (!isSingleFileAppHost(projectPath)) {
+                const outputPath = await dotNetService.getDotNetTargetPath(projectPath);
+                if ((!(await doesFileExist(outputPath)) || launchOptions.forceBuild) && await dotNetService.getAndActivateDevKit()) {
+                    await dotNetService.buildDotNetProject(projectPath);
+                }
+
+                debugConfiguration.program = outputPath;
+            }
+            else {
+                const runApiOutput = await dotNetService.getDotNetRunApiOutput(projectPath);
+                applyRunApiOutputToDebugConfiguration(runApiOutput, debugConfiguration);
+            }
         }
     };
 }

extension/src/debugger/languages/python.ts

@@ -9,7 +9,10 @@ export const pythonDebuggerExtension: ResourceDebuggerExtension = {
     displayName: 'Python',
     getProjectFile: (launchConfig) => {
         if (isPythonLaunchConfiguration(launchConfig)) {
-            return launchConfig.program_path;
+            const programPath = launchConfig.program_path || launchConfig.project_path;
+            if (programPath) {
+                return programPath;
+            }
         }
 
         throw new Error(invalidLaunchConfiguration(JSON.stringify(launchConfig)));

extension/src/server/interactionService.ts

@@ -87,7 +87,8 @@ export class InteractionService implements IInteractionService {
                 }
 
                 return null;
-            }
+            },
+            ignoreFocusOut: true
         });
 
         return input || null;
@@ -117,7 +118,8 @@ export class InteractionService implements IInteractionService {
                 }
 
                 return null;
-            }
+            },
+            ignoreFocusOut: true
         });
 
         return input || null;
@@ -317,11 +319,14 @@ export class InteractionService implements IInteractionService {
     }
 
     logMessage(logLevel: CSLogLevel, message: string) {
+        // Unable to log trace or debug messages, these levels are ignored by default
+        // and we cannot set the log level programmatically. So for now, log as info
+        // https://github.com/microsoft/vscode/issues/223536
         if (logLevel === 'Trace') {
-            extensionLogOutputChannel.trace(formatText(message));
+            extensionLogOutputChannel.info(`[trace] ${formatText(message)}`);
         }
         else if (logLevel === 'Debug') {
-            extensionLogOutputChannel.debug(formatText(message));
+            extensionLogOutputChannel.info(`[debug] ${formatText(message)}`);
         }
         else if (logLevel === 'Information') {
             extensionLogOutputChannel.info(formatText(message));
@@ -368,7 +373,8 @@ export class InteractionService implements IInteractionService {
             noDebug: !debug,
         };
 
-        const didDebugStart = await vscode.debug.startDebugging(vscode.workspace.workspaceFolders?.[0], debugConfiguration);
+        const workspaceFolder = vscode.workspace.getWorkspaceFolder(vscode.Uri.file(workingDirectory));
+        const didDebugStart = await vscode.debug.startDebugging(workspaceFolder, debugConfiguration);
         if (!didDebugStart) {
             throw new Error(failedToStartDebugSession);
         }

extension/src/test/dotnetDebugger.test.ts

@@ -37,6 +37,10 @@ class TestDotNetService {
     getAndActivateDevKit(): Promise<boolean> {
         return Promise.resolve(this._hasDevKit);
     }
+
+    getDotNetRunApiOutput(projectPath: string): Promise<string> {
+        return Promise.resolve('');
+    }
 }
 
 suite('Dotnet Debugger Extension Tests', () => {

extension/src/utils/AspireTerminalProvider.ts

@@ -3,7 +3,7 @@ import { aspireTerminalName, dcpServerNotInitialized, rpcServerNotInitialized }
 import { extensionLogOutputChannel } from './logging';
 import { RpcServerConnectionInfo } from '../server/AspireRpcServer';
 import { DcpServerConnectionInfo } from '../dcp/types';
-import { getRunSessionInfo } from '../capabilities';
+import { getRunSessionInfo, getSupportedCapabilities } from '../capabilities';
 
 export interface AspireTerminal {
     terminal: vscode.Terminal;
@@ -114,7 +114,9 @@ export class AspireTerminalProvider implements vscode.Disposable {
             env.ASPIRE_EXTENSION_DEBUG_SESSION_ID = debugSessionId;
             env.DCP_INSTANCE_ID_PREFIX = debugSessionId + '-';
             env.DEBUG_SESSION_RUN_MODE = noDebug === false ? "Debug" : "NoDebug";
+            env.ASPIRE_EXTENSION_DEBUG_RUN_MODE = noDebug === false ? "Debug" : "NoDebug";
             env.DEBUG_SESSION_INFO = JSON.stringify(getRunSessionInfo());
+            env.ASPIRE_EXTENSION_CAPABILITIES = getSupportedCapabilities().join(',');
         }
 
         return env;

src/Aspire.Cli/Commands/DeployCommand.cs

@@ -1,6 +1,7 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System.CommandLine;
 using Aspire.Cli.Configuration;
 using Aspire.Cli.DotNet;
 using Aspire.Cli.Interaction;
@@ -13,16 +14,23 @@ namespace Aspire.Cli.Commands;
 
 internal sealed class DeployCommand : PublishCommandBase
 {
+    private readonly Option<bool> _clearCacheOption;
+
     public DeployCommand(IDotNetCliRunner runner, IInteractionService interactionService, IProjectLocator projectLocator, AspireCliTelemetry telemetry, IDotNetSdkInstaller sdkInstaller, IFeatures features, ICliUpdateNotifier updateNotifier, CliExecutionContext executionContext)
         : base("deploy", DeployCommandStrings.Description, runner, interactionService, projectLocator, telemetry, sdkInstaller, features, updateNotifier, executionContext)
     {
+        _clearCacheOption = new Option<bool>("--clear-cache")
+        {
+            Description = "Clear the deployment cache associated with the current environment and do not save deployment state"
+        };
+        Options.Add(_clearCacheOption);
     }
 
     protected override string OperationCompletedPrefix => DeployCommandStrings.OperationCompletedPrefix;
     protected override string OperationFailedPrefix => DeployCommandStrings.OperationFailedPrefix;
     protected override string GetOutputPathDescription() => DeployCommandStrings.OutputPathArgumentDescription;
 
-    protected override string[] GetRunArguments(string? fullyQualifiedOutputPath, string[] unmatchedTokens)
+    protected override string[] GetRunArguments(string? fullyQualifiedOutputPath, string[] unmatchedTokens, ParseResult parseResult)
     {
         var baseArgs = new List<string> { "--operation", "publish", "--publisher", "default" };
 
@@ -32,6 +40,13 @@ protected override string[] GetRunArguments(string? fullyQualifiedOutputPath, st
         }
 
         baseArgs.AddRange(["--deploy", "true"]);
+
+        var clearCache = parseResult.GetValue(_clearCacheOption);
+        if (clearCache)
+        {
+            baseArgs.AddRange(["--clear-cache", "true"]);
+        }
+
         baseArgs.AddRange(unmatchedTokens);
 
         return [.. baseArgs];

src/Aspire.Cli/Commands/PublishCommand.cs

@@ -1,6 +1,7 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System.CommandLine;
 using Aspire.Cli.Configuration;
 using Aspire.Cli.DotNet;
 using Aspire.Cli.Interaction;
@@ -44,7 +45,7 @@ public PublishCommand(IDotNetCliRunner runner, IInteractionService interactionSe
     protected override string OperationFailedPrefix => PublishCommandStrings.OperationFailedPrefix;
     protected override string GetOutputPathDescription() => PublishCommandStrings.OutputPathArgumentDescription;
 
-    protected override string[] GetRunArguments(string? fullyQualifiedOutputPath, string[] unmatchedTokens)
+    protected override string[] GetRunArguments(string? fullyQualifiedOutputPath, string[] unmatchedTokens, ParseResult parseResult)
     {
         var baseArgs = new List<string> { "--operation", "publish", "--publisher", "default" };
 

src/Aspire.Cli/Commands/PublishCommandBase.cs

@@ -75,7 +75,7 @@ protected PublishCommandBase(string name, string description, IDotNetCliRunner r
     }
 
     protected abstract string GetOutputPathDescription();
-    protected abstract string[] GetRunArguments(string? fullyQualifiedOutputPath, string[] unmatchedTokens);
+    protected abstract string[] GetRunArguments(string? fullyQualifiedOutputPath, string[] unmatchedTokens, ParseResult parseResult);
     protected abstract string GetCanceledMessage();
     protected abstract string GetProgressMessage();
 
@@ -173,7 +173,7 @@ protected override async Task<int> ExecuteAsync(ParseResult parseResult, Cancell
                 effectiveAppHostFile,
                 false,
                 true,
-                GetRunArguments(fullyQualifiedOutputPath, unmatchedTokens),
+                GetRunArguments(fullyQualifiedOutputPath, unmatchedTokens, parseResult),
                 env,
                 backchannelCompletionSource,
                 operationRunOptions,

src/Aspire.Cli/Commands/RunCommand.cs

@@ -144,7 +144,7 @@ protected override async Task<int> ExecuteAsync(ParseResult parseResult, Cancell
 
             if (!watch)
             {
-                if (!isSingleFileAppHost)
+                if (!isSingleFileAppHost || isExtensionHost)
                 {
                     var buildOptions = new DotNetCliRunnerInvocationOptions
                     {
@@ -154,7 +154,8 @@ protected override async Task<int> ExecuteAsync(ParseResult parseResult, Cancell
 
                     // The extension host will build the app host project itself, so we don't need to do it here if host exists.
                     if (!ExtensionHelper.IsExtensionHost(InteractionService, out _, out var extensionBackchannel)
-                        || !await extensionBackchannel.HasCapabilityAsync(KnownCapabilities.DevKit, cancellationToken))
+                        || !await extensionBackchannel.HasCapabilityAsync(KnownCapabilities.DevKit, cancellationToken)
+                        || isSingleFileAppHost)
                     {
                         var buildExitCode = await AppHostHelper.BuildAppHostAsync(_runner, InteractionService, effectiveAppHostFile, buildOptions, ExecutionContext.WorkingDirectory, cancellationToken);