Add new API dotnet.findPath to find the .NET host to use if one already exists that meets a requirement.

sample/package.json

@@ -7,7 +7,7 @@
 		"url": "https://github.com/dotnet/vscode-dotnet-runtime.git"
 	},
 	"license": "MIT",
-	"version": "0.0.1",
+	"version": "0.0.9",
 	"publisher": "ms-dotnettools",
 	"engines": {
 		"vscode": "^1.75.0"
@@ -66,6 +66,11 @@
 				"title": "Install .NET SDK Globally via .NET Install Tool (Former Runtime Extension)",
 				"category": "Sample"
 			},
+			{
+				"command": "sample.dotnet.findPath",
+				"title": "Find the .NET on the PATH",
+				"category": "Sample"
+			},
 			{
 				"command": "sample.dotnet-sdk.acquire",
 				"title": "Acquire .NET SDK",

sample/src/extension.ts

@@ -8,12 +8,14 @@ import * as path from 'path';
 import * as vscode from 'vscode';
 import {
     DotnetInstallMode,
+    DotnetVersionSpecRequirement,
     IDotnetAcquireContext,
     IDotnetAcquireResult,
+    IDotnetFindPathContext,
     IDotnetListVersionsResult,
 } from 'vscode-dotnet-runtime-library';
-import * as runtimeExtension from 'vscode-dotnet-runtime';
-import * as sdkExtension from 'vscode-dotnet-sdk';
+import * as runtimeExtension from 'vscode-dotnet-runtime'; // comment this out when packing the extension
+import * as sdkExtension from 'vscode-dotnet-sdk'; // comment this out when packing the extension
 import { install } from 'source-map-support';
 
 export function activate(context: vscode.ExtensionContext) {
@@ -33,8 +35,8 @@ export function activate(context: vscode.ExtensionContext) {
     */
 
     const requestingExtensionId = 'ms-dotnettools.sample-extension';
-    runtimeExtension.activate(context);
-    sdkExtension.activate(context);
+    runtimeExtension.activate(context); // comment this out when packing the extension
+    sdkExtension.activate(context); // comment this out when packing the extension
 
 
     // --------------------------------------------------------------------------
@@ -167,17 +169,6 @@ ${stderr}`);
         }
     });
 
-    context.subscriptions.push(
-        sampleHelloWorldRegistration,
-        sampleAcquireRegistration,
-        sampleAcquireASPNETRegistration,
-        sampleAcquireStatusRegistration,
-        sampleDotnetUninstallAllRegistration,
-        sampleConcurrentTest,
-        sampleConcurrentASPNETTest,
-        sampleShowAcquisitionLogRegistration,
-    );
-
     const sampleGlobalSDKFromRuntimeRegistration = vscode.commands.registerCommand('sample.dotnet.acquireGlobalSDK', async (version) => {
         if (!version) {
             version = await vscode.window.showInputBox({
@@ -199,6 +190,48 @@ ${stderr}`);
         }
     });
 
+    const sampleFindPathRegistration = vscode.commands.registerCommand('sample.dotnet.findPath', async () =>
+    {
+        const version = await vscode.window.showInputBox(
+        {
+            placeHolder: '8.0',
+            value: '8.0',
+            prompt: 'The .NET runtime version.',
+        });
+
+        const arch = await vscode.window.showInputBox({
+            placeHolder: 'x64',
+            value: 'x64',
+            prompt: 'The .NET runtime architecture.',
+        });
+
+        const requirement = await vscode.window.showInputBox({
+            placeHolder: 'greater_than_or_equal',
+            value: 'greater_than_or_equal',
+            prompt: 'The condition to search for a requirement.',
+        });
+
+        let commandContext : IDotnetFindPathContext = { acquireContext: {version: version, requestingExtensionId: requestingExtensionId, architecture : arch, mode : 'runtime'} as IDotnetAcquireContext,
+        versionSpecRequirement: requirement as DotnetVersionSpecRequirement};
+
+        const result = await vscode.commands.executeCommand('dotnet.findPath', commandContext);
+
+        vscode.window.showInformationMessage(`.NET Path Discovered\n
+${JSON.stringify(result) ?? 'undefined'}`);
+    });
+
+    context.subscriptions.push(
+        sampleHelloWorldRegistration,
+        sampleAcquireRegistration,
+        sampleAcquireASPNETRegistration,
+        sampleAcquireStatusRegistration,
+        sampleDotnetUninstallAllRegistration,
+        sampleConcurrentTest,
+        sampleConcurrentASPNETTest,
+        sampleShowAcquisitionLogRegistration,
+        sampleFindPathRegistration,
+    );
+
     // --------------------------------------------------------------------------
 
     // ---------------------sdk extension registrations--------------------------

sample/yarn.lock

@@ -1809,6 +1809,7 @@ util-deprecate@^1.0.1:
     "@types/vscode" "1.74.0"
     "@vscode/extension-telemetry" "^0.9.7"
     "@vscode/sudo-prompt" "^9.3.1"
+    "@vscode/test-electron" "^2.4.1"
     axios "^1.7.4"
     axios-cache-interceptor "^1.5.3"
     axios-retry "^3.4.0"
@@ -1825,12 +1826,11 @@ util-deprecate@^1.0.1:
     semver "^7.6.2"
     shelljs "^0.8.5"
     typescript "^5.5.4"
-    vscode-test "^1.6.1"
   optionalDependencies:
     fsevents "^2.3.3"
 
 "vscode-dotnet-runtime@file:../vscode-dotnet-runtime-extension":
-  version "2.1.6"
+  version "2.1.7"
   resolved "file:../vscode-dotnet-runtime-extension"
   dependencies:
     "@types/chai-as-promised" "^7.1.8"

vscode-dotnet-runtime-extension/CHANGELOG.md

@@ -7,7 +7,11 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
-## [2.1.6] - 2024-09-05
+## [2.1.7] - 2024-09-31
+
+Adds the API dotnet.findPath() to see if there's an existing .NET installation on the PATH.
+
+## [2.1.6] - 2024-09-20
 
 Fixes an issue with SDK installs on Mac M1 or Arm Mac where the non-emulation path was used.
 Fixes an issue where spaces in the username will cause failure for SDK resolution.

vscode-dotnet-runtime-extension/package.json

@@ -11,9 +11,9 @@
 	"author": "Microsoft Corporation",
 	"displayName": ".NET Install Tool",
 	"description": "This extension installs and manages different versions of the .NET SDK and Runtime.",
-	"appInsightsKey": "02dc18e0-7494-43b2-b2a3-18ada5fcb522",
+	"connectionString": "InstrumentationKey=02dc18e0-7494-43b2-b2a3-18ada5fcb522;IngestionEndpoint=https://westus2-0.in.applicationinsights.azure.com/;LiveEndpoint=https://westus2.livediagnostics.monitor.azure.com/;ApplicationId=e8e56970-a18a-4101-b7d1-1c5dd7c29eeb",
 	"icon": "images/dotnetIcon.png",
-	"version": "2.1.6",
+	"version": "2.1.7",
 	"publisher": "ms-dotnettools",
 	"engines": {
 		"vscode": "^1.81.1"
@@ -79,7 +79,7 @@
 				"dotnetAcquisitionExtension.existingDotnetPath": {
 					"type": "array",
 					"markdownDescription": "The path to an existing .NET host executable for an extension's code to run under, not for your project to run under.\nRestart VS Code to apply changes.\n\n⚠️ This is NOT the .NET Runtime that your project will use to run. Extensions such as `C#`, `C# DevKit`, and more have components written in .NET. This .NET PATH is the `dotnet.exe` that these extensions will use to run their code, not your code.\n\nUsing a path value in which .NET does not meet the requirements of a specific extension will cause that extension to fail.\n\n🚀 The version of .NET that is used for your project is determined by the .NET host, or dotnet.exe. The .NET host picks a runtime based on your project. To use a specific version of .NET for your project, install the .NET SDK using the `.NET Install Tool - Install SDK System-Wide` command, install .NET manually using [our instructions](https://dotnet.microsoft.com/download), or edit your PATH environment variable to point to a `dotnet.exe` that has an `/sdk/` folder with only one SDK.",
-                    "description": "The path to an existing .NET host executable for an extension's code to run under, not for your project to run under.\nRestart VS Code to apply changes.\n\n⚠️ This is NOT the .NET Runtime that your project will use to run. Extensions such as 'C#', 'C# DevKit', and more have components written in .NET. This .NET PATH is the 'dotnet.exe' that these extensions will use to run their code, not your code.\n\nUsing a path value in which .NET does not meet the requirements of a specific extension will cause that extension to fail.\n\n🚀 The version of .NET that is used for your project is determined by the .NET host, or dotnet.exe. The .NET host picks a runtime based on your project. To use a specific version of .NET for your project, install the .NET SDK using the '.NET Install Tool - Install SDK System-Wide' command, use the instructions at https://dotnet.microsoft.com/download to manually install the .NET SDK, or edit your PATH environment variable to point to a 'dotnet.exe' that has an '/sdk/' folder with only one SDK.",
+					"description": "The path to an existing .NET host executable for an extension's code to run under, not for your project to run under.\nRestart VS Code to apply changes.\n\n⚠️ This is NOT the .NET Runtime that your project will use to run. Extensions such as 'C#', 'C# DevKit', and more have components written in .NET. This .NET PATH is the 'dotnet.exe' that these extensions will use to run their code, not your code.\n\nUsing a path value in which .NET does not meet the requirements of a specific extension will cause that extension to fail.\n\n🚀 The version of .NET that is used for your project is determined by the .NET host, or dotnet.exe. The .NET host picks a runtime based on your project. To use a specific version of .NET for your project, install the .NET SDK using the '.NET Install Tool - Install SDK System-Wide' command, use the instructions at https://dotnet.microsoft.com/download to manually install the .NET SDK, or edit your PATH environment variable to point to a 'dotnet.exe' that has an '/sdk/' folder with only one SDK.",
 					"examples": [
 						"C:\\Program Files\\dotnet\\dotnet.exe",
 						"/usr/local/share/dotnet/dotnet",
@@ -99,7 +99,7 @@
 					"type": "string",
 					"description": "URL to a proxy if you use one, such as: https://proxy:port"
 				},
-                "dotnetAcquisitionExtension.allowInvalidPaths": {
+				"dotnetAcquisitionExtension.allowInvalidPaths": {
 					"type": "boolean",
 					"description": "If you'd like to continue using a .NET path that is not meant to be used for an extension and may cause instability (please read above about the existingDotnetPath setting) then set this to true and restart."
 				}

vscode-dotnet-runtime-extension/src/extension.ts

@@ -66,6 +66,16 @@ import {
     getMajorMinor,
     DotnetOfflineWarning,
     IUtilityContext,
+    IDotnetFindPathContext,
+    DotnetVersionSpecRequirement,
+    DotnetConditionValidator,
+    DotnetPathFinder,
+    IDotnetConditionValidator,
+    DotnetFindPathSettingFound,
+    DotnetFindPathLookupSetting,
+    DotnetFindPathDidNotMeetCondition,
+    DotnetFindPathMetCondition,
+    DotnetFindPathCommandInvoked,
 } from 'vscode-dotnet-runtime-library';
 import { dotnetCoreAcquisitionExtensionId } from './DotnetCoreAcquisitionId';
 import { InstallTrackerSingleton } from 'vscode-dotnet-runtime-library/dist/Acquisition/InstallTrackerSingleton';
@@ -87,6 +97,7 @@ namespace commandKeys {
     export const acquireGlobalSDK = 'acquireGlobalSDK';
     export const acquireStatus = 'acquireStatus';
     export const uninstall = 'uninstall';
+    export const findPath = 'findPath';
     export const uninstallPublic = 'uninstallPublic'
     export const uninstallAll = 'uninstallAll';
     export const listVersions = 'listVersions';
@@ -432,6 +443,95 @@ export function activate(vsCodeContext: vscode.ExtensionContext, extensionContex
         return uninstall(commandContext);
     });
 
+    /**
+     * @param commandContext The context of the request to find the dotnet path.
+     * We wrap an AcquisitionContext which must include the version, requestingExtensionId, architecture of .NET desired, and mode.
+     * The architecture should be of the node format ('x64', 'x86', 'arm64', etc.)
+     *
+     * @returns the path to the dotnet executable, if one can be found. This should be the true path to the executable. undefined if none can be found.
+     *
+     * @remarks Priority Order for path lookup:
+     * VSCode Setting -> PATH -> Realpath of PATH -> DOTNET_ROOT (Emulation DOTNET_ROOT if set first)
+     *
+     * This accounts for pmc installs, snap installs, bash configurations, and other non-standard installations such as homebrew.
+     */
+    const dotnetFindPathRegistration = vscode.commands.registerCommand(`${commandPrefix}.${commandKeys.findPath}`, async (commandContext : IDotnetFindPathContext) =>
+    {
+        globalEventStream.post(new DotnetFindPathCommandInvoked(`The find path command was invoked.`, commandContext));
+
+        if(!commandContext.acquireContext.mode || !commandContext.acquireContext.requestingExtensionId || !commandContext.acquireContext.version || !commandContext.acquireContext.architecture)
+        {
+            throw new EventCancellationError('BadContextualFindPathError', `The find path request was missing required information: a mode, version, architecture, and requestingExtensionId.`);
+        }
+
+        globalEventStream.post(new DotnetFindPathLookupSetting(`Looking up vscode setting.`));
+        const workerContext = getAcquisitionWorkerContext(commandContext.acquireContext.mode, commandContext.acquireContext);
+        const existingPath = await resolveExistingPathIfExists(existingPathConfigWorker, commandContext.acquireContext, workerContext, utilContext, commandContext.versionSpecRequirement);
+
+        if(existingPath)
+        {
+            globalEventStream.post(new DotnetFindPathSettingFound(`Found vscode setting.`));
+            outputChannel.show(true);
+            return existingPath;
+        }
+
+        const validator = new DotnetConditionValidator(workerContext, utilContext);
+        const finder = new DotnetPathFinder(workerContext, utilContext);
+
+        const dotnetsOnPATH = await finder.findRawPathEnvironmentSetting();
+        for(const dotnetPath of dotnetsOnPATH ?? [])
+        {
+            const validatedPATH = await getPathIfValid(dotnetPath, validator, commandContext);
+            if(validatedPATH)
+            {
+                outputChannel.show(true);
+                return validatedPATH;
+            }
+        }
+
+        const dotnetsOnRealPATH = await finder.findRealPathEnvironmentSetting();
+        for(const dotnetPath of dotnetsOnRealPATH ?? [])
+        {
+            const validatedRealPATH = await getPathIfValid(dotnetPath, validator, commandContext);
+            if(validatedRealPATH)
+            {
+                outputChannel.show(true);
+                return validatedRealPATH;
+            }
+        }
+
+        const dotnetOnROOT = await finder.findDotnetRootPath(commandContext.acquireContext.architecture);
+        const validatedRoot = await getPathIfValid(dotnetOnROOT, validator, commandContext);
+        if(validatedRoot)
+        {
+            outputChannel.show(true);
+
+            return validatedRoot;
+        }
+
+        outputChannel.show(true);
+        return undefined;
+    });
+
+    async function getPathIfValid(path : string | undefined, validator : IDotnetConditionValidator, commandContext : IDotnetFindPathContext) : Promise<string | undefined>
+    {
+        if(path)
+        {
+            const validated = await validator.dotnetMeetsRequirement(path, commandContext);
+            if(validated)
+            {
+                globalEventStream.post(new DotnetFindPathMetCondition(`${path} met the conditions.`));
+                return path;
+            }
+            else
+            {
+                globalEventStream.post(new DotnetFindPathDidNotMeetCondition(`${path} did NOT satisfy the conditions.`));
+            }
+        }
+
+        return undefined;
+    }
+
     async function uninstall(commandContext: IDotnetAcquireContext | undefined, force = false) : Promise<string>
     {
         let result = '1';
@@ -515,11 +615,11 @@ export function activate(vsCodeContext: vscode.ExtensionContext, extensionContex
 
     // Helper Functions
     async function resolveExistingPathIfExists(configResolver : ExtensionConfigurationWorker, commandContext : IDotnetAcquireContext,
-        workerContext : IAcquisitionWorkerContext, utilityContext : IUtilityContext) : Promise<IDotnetAcquireResult | null>
+        workerContext : IAcquisitionWorkerContext, utilityContext : IUtilityContext, requirement? : DotnetVersionSpecRequirement) : Promise<IDotnetAcquireResult | null>
     {
         const existingPathResolver = new ExistingPathResolver(workerContext, utilityContext);
 
-        const existingPath = await existingPathResolver.resolveExistingPath(configResolver.getAllPathConfigurationValues(), commandContext.requestingExtensionId, displayWorker);
+        const existingPath = await existingPathResolver.resolveExistingPath(configResolver.getAllPathConfigurationValues(), commandContext.requestingExtensionId, displayWorker, requirement);
         if (existingPath) {
             globalEventStream.post(new DotnetExistingPathResolutionCompleted(existingPath.dotnetPath));
             return new Promise((resolve) => {
@@ -663,6 +763,7 @@ We will try to install .NET, but are unlikely to be able to connect to the serve
         dotnetAcquireStatusRegistration,
         dotnetAcquireGlobalSDKRegistration,
         acquireGlobalSDKPublicRegistration,
+        dotnetFindPathRegistration,
         dotnetListVersionsRegistration,
         dotnetRecommendedVersionRegistration,
         dotnetUninstallRegistration,