Utilize absolute runtime paths in language extensions

extensions/positron-python/src/client/positron/runtime.ts

@@ -3,11 +3,9 @@
  *  Licensed under the Elastic License 2.0. See LICENSE.txt for license information.
  *--------------------------------------------------------------------------------------------*/
 
-// eslint-disable-next-line import/no-unresolved
 import * as positron from 'positron';
 import * as vscode from 'vscode';
 import * as fs from 'fs-extra';
-import * as os from 'os';
 import * as path from 'path';
 import * as crypto from 'crypto';
 
@@ -250,13 +248,7 @@ export async function createPythonRuntimeMetadata(
     digest.update(pythonVersion);
     const runtimeId = digest.digest('hex').substring(0, 32);
 
-    // Create the runtime path.
-    // TODO@softwarenerd - We will need to update this for Windows.
-    const homedir = os.homedir();
-    const runtimePath =
-        os.platform() !== 'win32' && interpreter.path.startsWith(homedir)
-            ? path.join('~', interpreter.path.substring(homedir.length))
-            : interpreter.path;
+    const runtimePath = interpreter.path;
 
     // Save the ID of the Python environment for use when creating the language
     // runtime session.

extensions/positron-r/src/provider.ts

@@ -642,11 +642,7 @@ export async function makeMetadata(
 	const homedir = os.homedir();
 	const isUserInstallation = rInst.binpath.startsWith(homedir);
 
-	// Create the runtime path.
-	// TODO@softwarenerd - We will need to update this for Windows.
-	const runtimePath = os.platform() !== 'win32' && isUserInstallation ?
-		path.join('~', rInst.binpath.substring(homedir.length)) :
-		rInst.binpath;
+	const runtimePath = rInst.binpath;
 
 	// Create the Rscript path.
 	// The Rscript path is the same as the R binary path, but with the 'R' or 'R.exe' executable

extensions/positron-r/src/runtime-quickpick.ts

@@ -3,6 +3,8 @@
  *  Licensed under the Elastic License 2.0. See LICENSE.txt for license information.
  *--------------------------------------------------------------------------------------------*/
 
+import * as os from 'os';
+import * as path from 'path';
 import * as positron from 'positron';
 import * as vscode from 'vscode';
 import { rRuntimeDiscoverer, RRuntimeSource } from './provider';
@@ -18,7 +20,11 @@ class RuntimeQuickPickItem implements vscode.QuickPickItem {
 		public runtimeMetadata: positron.LanguageRuntimeMetadata,
 	) {
 		this.label = runtimeMetadata.runtimeName;
-		this.description = runtimeMetadata.runtimePath;
+		const homedir = os.homedir();
+		this.description =
+			os.platform() !== 'win32' && runtimeMetadata.runtimePath.startsWith(homedir)
+				? path.join('~', runtimeMetadata.runtimePath.substring(homedir.length))
+				: runtimeMetadata.runtimePath;
 		this.runtime = runtimeMetadata;
 	}
 }

src/positron-dts/positron.d.ts

@@ -646,7 +646,11 @@ declare module 'positron' {
 	 * before the runtime is started.
 	 */
 	export interface LanguageRuntimeMetadata {
-		/** The path to the runtime. */
+		/**
+		 * The absolute path to the runtime executable. Always a fully-expanded
+		 * path suitable for use with execFile or equivalent; never contains ~
+		 * or other shorthand.
+		 */
 		runtimePath: string;
 
 		/** A unique identifier for this runtime; takes the form of a GUID */

src/vs/workbench/browser/positronNewFolderFlow/utilities/interpreterDropDownUtils.ts

@@ -6,7 +6,7 @@
 import { DropDownListBoxEntry } from '../../positronComponents/dropDownListBox/dropDownListBox.js';
 import { DropDownListBoxItem } from '../../positronComponents/dropDownListBox/dropDownListBoxItem.js';
 import { DropDownListBoxSeparator } from '../../positronComponents/dropDownListBox/dropDownListBoxSeparator.js';
-import { ILanguageRuntimeMetadata } from '../../../services/languageRuntime/common/languageRuntimeService.js';
+import { getRuntimeDisplayPath, ILanguageRuntimeMetadata } from '../../../services/languageRuntime/common/languageRuntimeService.js';
 
 /**
  * InterpreterInfo interface.
@@ -52,7 +52,7 @@ export const interpretersToDropdownItems = (
 							runtimeId: runtime.runtimeId,
 							languageName: runtime.languageName,
 							languageVersion: runtime.languageVersion,
-							runtimePath: runtime.runtimePath,
+							runtimePath: getRuntimeDisplayPath(runtime),
 							runtimeSource: runtime.runtimeSource,
 						},
 					})

src/vs/workbench/contrib/chat/browser/actions/chatRuntimeSessions.ts

@@ -9,7 +9,7 @@ import { URI } from '../../../../../base/common/uri.js';
 import { localize } from '../../../../../nls.js';
 import { ServicesAccessor } from '../../../../../platform/instantiation/common/instantiation.js';
 import { IQuickInputService, IQuickPickItem, QuickPickItem } from '../../../../../platform/quickinput/common/quickInput.js';
-import { RuntimeState } from '../../../../services/languageRuntime/common/languageRuntimeService.js';
+import { getRuntimeDisplayPath, RuntimeState } from '../../../../services/languageRuntime/common/languageRuntimeService.js';
 import { IRuntimeSessionService } from '../../../../services/runtimeSession/common/runtimeSessionService.js';
 import { IChatWidget } from '../chat.js';
 
@@ -77,7 +77,7 @@ export async function showRuntimeSessionsPick(accessor: ServicesAccessor, _widge
 		return {
 			id: session.sessionId,
 			label,
-			detail: session.runtimeMetadata.runtimePath,
+			detail: getRuntimeDisplayPath(session.runtimeMetadata),
 			iconPath: {
 				dark: URI.parse(`data:image/svg+xml;base64, ${session.runtimeMetadata.base64EncodedIconSvg}`),
 			},

src/vs/workbench/contrib/languageRuntime/browser/languageRuntimeActions.ts

@@ -13,7 +13,7 @@ import { IQuickInputService, IQuickPickItem, QuickPickItem } from '../../../../p
 import { IKeybindingRule, KeybindingWeight } from '../../../../platform/keybinding/common/keybindingsRegistry.js';
 import { LANGUAGE_RUNTIME_ACTION_CATEGORY } from '../common/languageRuntime.js';
 import { IPositronConsoleService, POSITRON_CONSOLE_VIEW_ID } from '../../../services/positronConsole/browser/interfaces/positronConsoleService.js';
-import { ILanguageRuntimeMetadata, ILanguageRuntimeService, IRuntimePickerContribution, IRuntimePickerItem, LanguageRuntimeSessionMode, RuntimeCodeExecutionMode, RuntimeErrorBehavior, RuntimeStartupPhase, RuntimeState } from '../../../services/languageRuntime/common/languageRuntimeService.js';
+import { getRuntimeDisplayPath, ILanguageRuntimeMetadata, ILanguageRuntimeService, IRuntimePickerContribution, IRuntimePickerItem, LanguageRuntimeSessionMode, RuntimeCodeExecutionMode, RuntimeErrorBehavior, RuntimeStartupPhase, RuntimeState } from '../../../services/languageRuntime/common/languageRuntimeService.js';
 import { ILanguageRuntimeSession, IRuntimeClientInstance, IRuntimeSessionService, RuntimeClientType, RuntimeStartMode } from '../../../services/runtimeSession/common/runtimeSessionService.js';
 import { INotificationService } from '../../../../platform/notification/common/notification.js';
 import { ILanguageService } from '../../../../editor/common/languages/language.js';
@@ -213,7 +213,7 @@ export const selectLanguageRuntimeSession = async (
 		.map(session => ({
 			id: session.sessionId,
 			label: session.dynState.sessionName,
-			detail: session.runtimeMetadata.runtimePath,
+			detail: getRuntimeDisplayPath(session.runtimeMetadata),
 			description: session.sessionId === currentForegroundSession?.sessionId
 				? localize('positron.languageRuntime.currentlySelected', 'Currently Selected')
 				: undefined,
@@ -242,7 +242,7 @@ export const selectLanguageRuntimeSession = async (
 			.map(session => ({
 				id: session.sessionId,
 				label: getSessionDisplayNameWithRuntime(session),
-				detail: session.runtimeMetadata.runtimePath,
+				detail: getRuntimeDisplayPath(session.runtimeMetadata),
 				description: session.sessionId === currentForegroundSession?.sessionId
 					? localize('positron.languageRuntime.currentlySelected', 'Currently Selected')
 					: undefined,
@@ -264,7 +264,7 @@ export const selectLanguageRuntimeSession = async (
 			.map(session => ({
 				id: session.sessionId,
 				label: getSessionDisplayNameWithRuntime(session),
-				detail: session.runtimeMetadata.runtimePath,
+				detail: getRuntimeDisplayPath(session.runtimeMetadata),
 				description: session.sessionId === currentForegroundSession?.sessionId
 					? localize('positron.languageRuntime.currentlySelected', 'Currently Selected')
 					: undefined,
@@ -474,7 +474,7 @@ export const selectNewLanguageRuntime = async (
 				items.push({
 					id: runtime.runtimeId,
 					label: runtime.runtimeName,
-					detail: runtime.runtimePath,
+					detail: getRuntimeDisplayPath(runtime),
 					iconPath: {
 						dark: URI.parse(`data:image/svg+xml;base64, ${runtime.base64EncodedIconSvg}`),
 					},
@@ -540,7 +540,7 @@ export const selectNewLanguageRuntime = async (
 						items.push({
 							id: runtime.runtimeId,
 							label: runtime.runtimeName,
-							detail: runtime.runtimePath,
+							detail: getRuntimeDisplayPath(runtime),
 							iconPath: {
 								dark: URI.parse(`data:image/svg+xml;base64, ${runtime.base64EncodedIconSvg}`),
 							},
@@ -899,7 +899,7 @@ export function registerLanguageRuntimeActions() {
 			const runtimeQuickPickItems = runtimes.map<LanguageRuntimeQuickPickItem>(runtime => ({
 				id: runtime.runtimeId,
 				label: `${runtime.languageName}: ${runtime.runtimeName}`,
-				description: runtime.runtimePath,
+				description: getRuntimeDisplayPath(runtime),
 				runtime
 			} satisfies LanguageRuntimeQuickPickItem));
 

src/vs/workbench/contrib/languageRuntime/test/browser/languageRuntimeActions.vitest.ts

@@ -87,12 +87,15 @@ describe('selectNewLanguageRuntime', () => {
 		await vi.waitFor(() => expect(pick.show).toHaveBeenCalled());
 	}
 
-	function registerRuntime(metadata: ILanguageRuntimeMetadata): ILanguageRuntimeMetadata {
-		ctx.disposables.add(ctx.get(ILanguageRuntimeService).registerRuntime(metadata));
+	async function registerRuntime(metadata: ILanguageRuntimeMetadata): Promise<ILanguageRuntimeMetadata> {
+		const runtimeService = ctx.get(ILanguageRuntimeService);
+		ctx.disposables.add(runtimeService.registerRuntime(metadata));
 		if (!preferredByLanguage.has(metadata.languageId)) {
 			preferredByLanguage.set(metadata.languageId, metadata);
 		}
-		return metadata;
+		// registerRuntime enriches the metadata into a new object (e.g. adds
+		// runtimeDisplayPath); return the stored instance the picker resolves to.
+		return runtimeService.getRegisteredRuntime(metadata.runtimeId) ?? metadata;
 	}
 
 	function pickItemById(id: string): IQuickPickItem | undefined {
@@ -124,7 +127,7 @@ describe('selectNewLanguageRuntime', () => {
 		});
 
 		it('resolves to the selected runtime metadata', async () => {
-			const py = registerRuntime(makeRuntime({ runtimeId: 'py-1' }));
+			const py = await registerRuntime(makeRuntime({ runtimeId: 'py-1' }));
 			const promise = runPicker();
 			await waitUntilOpened();
 			const item = pickItemById('py-1')!;
@@ -150,8 +153,8 @@ describe('selectNewLanguageRuntime', () => {
 
 	describe('options.languageId', () => {
 		it('filters runtimes to the given languageId', async () => {
-			registerRuntime(makeRuntime({ runtimeId: 'py-1', languageId: 'python', languageName: 'Python' }));
-			registerRuntime(makeRuntime({ runtimeId: 'r-1', languageId: 'r', languageName: 'R', runtimeName: 'R 4.4' }));
+			await registerRuntime(makeRuntime({ runtimeId: 'py-1', languageId: 'python', languageName: 'Python' }));
+			await registerRuntime(makeRuntime({ runtimeId: 'r-1', languageId: 'r', languageName: 'R', runtimeName: 'R 4.4' }));
 
 			const promise = runPicker({ languageId: 'python' });
 			await waitUntilOpened();
@@ -165,7 +168,7 @@ describe('selectNewLanguageRuntime', () => {
 		});
 
 		it('passes languageId through to getPickerContributions', async () => {
-			registerRuntime(makeRuntime({ runtimeId: 'py-1' }));
+			await registerRuntime(makeRuntime({ runtimeId: 'py-1' }));
 			const spy = vi.spyOn(ctx.get(ILanguageRuntimeService), 'getPickerContributions');
 			const promise = runPicker({ languageId: 'python' });
 			await waitUntilOpened();
@@ -177,8 +180,8 @@ describe('selectNewLanguageRuntime', () => {
 
 	describe('options.currentRuntimeId', () => {
 		it('pre-focuses the matching item via activeItems', async () => {
-			registerRuntime(makeRuntime({ runtimeId: 'py-1' }));
-			registerRuntime(makeRuntime({ runtimeId: 'py-2', languageVersion: '3.10.0', runtimeName: 'Python 3.10' }));
+			await registerRuntime(makeRuntime({ runtimeId: 'py-1' }));
+			await registerRuntime(makeRuntime({ runtimeId: 'py-2', languageVersion: '3.10.0', runtimeName: 'Python 3.10' }));
 
 			const promise = runPicker({ currentRuntimeId: 'py-2' });
 			await waitUntilOpened();
@@ -189,7 +192,7 @@ describe('selectNewLanguageRuntime', () => {
 		});
 
 		it('leaves activeItems untouched when no item matches the id', async () => {
-			registerRuntime(makeRuntime({ runtimeId: 'py-1' }));
+			await registerRuntime(makeRuntime({ runtimeId: 'py-1' }));
 			const promise = runPicker({ currentRuntimeId: 'unknown-id' });
 			await waitUntilOpened();
 			expect(pick.activeItems).toEqual([]);
@@ -200,8 +203,8 @@ describe('selectNewLanguageRuntime', () => {
 
 	describe('item structure', () => {
 		it('groups Suggested + per-environment-type runtimes with separators', async () => {
-			registerRuntime(makeRuntime({ runtimeId: 'py-system', runtimeSource: 'System', runtimeName: 'Python (System)' }));
-			registerRuntime(makeRuntime({ runtimeId: 'py-conda', runtimeSource: 'Conda', runtimeName: 'Python (Conda)' }));
+			await registerRuntime(makeRuntime({ runtimeId: 'py-system', runtimeSource: 'System', runtimeName: 'Python (System)' }));
+			await registerRuntime(makeRuntime({ runtimeId: 'py-conda', runtimeSource: 'Conda', runtimeName: 'Python (Conda)' }));
 
 			const promise = runPicker();
 			await waitUntilOpened();
@@ -223,9 +226,9 @@ describe('selectNewLanguageRuntime', () => {
 		});
 
 		it('sorts within an env type by version descending, unsupported runtimes last', async () => {
-			registerRuntime(makeRuntime({ runtimeId: 'py-310', languageVersion: '3.10.0', runtimeName: 'Python 3.10' }));
-			registerRuntime(makeRuntime({ runtimeId: 'py-312', languageVersion: '3.12.0', runtimeName: 'Python 3.12' }));
-			registerRuntime(makeRuntime({
+			await registerRuntime(makeRuntime({ runtimeId: 'py-310', languageVersion: '3.10.0', runtimeName: 'Python 3.10' }));
+			await registerRuntime(makeRuntime({ runtimeId: 'py-312', languageVersion: '3.12.0', runtimeName: 'Python 3.12' }));
+			await registerRuntime(makeRuntime({
 				runtimeId: 'py-old', languageVersion: '3.8.0', runtimeName: 'Python 3.8 (unsupported)',
 				extraRuntimeData: { supported: false },
 			}));
@@ -246,21 +249,21 @@ describe('selectNewLanguageRuntime', () => {
 
 	describe('reactive rebuild', () => {
 		it('rebuilds when onDidRegisterRuntime fires mid-pick', async () => {
-			registerRuntime(makeRuntime({ runtimeId: 'py-1' }));
+			await registerRuntime(makeRuntime({ runtimeId: 'py-1' }));
 			const promise = runPicker();
 			await waitUntilOpened();
 			expect(pickItemById('py-1')).toBeDefined();
 			expect(pickItemById('py-2')).toBeUndefined();
 
-			registerRuntime(makeRuntime({ runtimeId: 'py-2', languageVersion: '3.10.0' }));
+			await registerRuntime(makeRuntime({ runtimeId: 'py-2', languageVersion: '3.10.0' }));
 			expect(pickItemById('py-2')).toBeDefined();
 			pick.cancel(QuickInputHideReason.Gesture);
 			await promise;
 		});
 
 		it('rebuilds when onDidUnregisterRuntime fires mid-pick', async () => {
-			registerRuntime(makeRuntime({ runtimeId: 'py-1' }));
-			registerRuntime(makeRuntime({ runtimeId: 'py-2', languageVersion: '3.10.0' }));
+			await registerRuntime(makeRuntime({ runtimeId: 'py-1' }));
+			await registerRuntime(makeRuntime({ runtimeId: 'py-2', languageVersion: '3.10.0' }));
 			const promise = runPicker();
 			await waitUntilOpened();
 			expect(pickItemById('py-1')).toBeDefined();
@@ -276,13 +279,13 @@ describe('selectNewLanguageRuntime', () => {
 		});
 
 		it('preserves the previously focused item across rebuilds', async () => {
-			registerRuntime(makeRuntime({ runtimeId: 'py-1' }));
-			registerRuntime(makeRuntime({ runtimeId: 'py-2', languageVersion: '3.10.0' }));
+			await registerRuntime(makeRuntime({ runtimeId: 'py-1' }));
+			await registerRuntime(makeRuntime({ runtimeId: 'py-2', languageVersion: '3.10.0' }));
 			const promise = runPicker({ currentRuntimeId: 'py-2' });
 			await waitUntilOpened();
 			expect(pick.activeItems[0].id).toBe('py-2');
 
-			registerRuntime(makeRuntime({ runtimeId: 'py-3', languageVersion: '3.13.0' }));
+			await registerRuntime(makeRuntime({ runtimeId: 'py-3', languageVersion: '3.13.0' }));
 			expect(pick.activeItems[0].id).toBe('py-2');
 			pick.cancel(QuickInputHideReason.Gesture);
 			await promise;
@@ -291,7 +294,7 @@ describe('selectNewLanguageRuntime', () => {
 
 	describe('startup phase', () => {
 		it('re-fetches contributions when phase transitions to Complete', async () => {
-			registerRuntime(makeRuntime({ runtimeId: 'py-1' }));
+			await registerRuntime(makeRuntime({ runtimeId: 'py-1' }));
 			const runtimeService = ctx.get(ILanguageRuntimeService);
 			runtimeService.setStartupPhase(RuntimeStartupPhase.Discovering);
 
@@ -344,7 +347,7 @@ describe('selectNewLanguageRuntime', () => {
 		it('shows a busy spinner and discovering placeholder while phase is not Complete', async () => {
 			const runtimeService = ctx.get(ILanguageRuntimeService);
 			runtimeService.setStartupPhase(RuntimeStartupPhase.Discovering);
-			registerRuntime(makeRuntime({ runtimeId: 'py-1' }));
+			await registerRuntime(makeRuntime({ runtimeId: 'py-1' }));
 
 			const promise = runPicker();
 			await waitUntilOpened();
@@ -372,7 +375,7 @@ describe('selectNewLanguageRuntime', () => {
 		});
 
 		it('does not show a spinner when discovery is already complete on open', async () => {
-			registerRuntime(makeRuntime({ runtimeId: 'py-1' }));
+			await registerRuntime(makeRuntime({ runtimeId: 'py-1' }));
 			const promise = runPicker();
 			await waitUntilOpened();
 			expect(pick.busy).toBe(false);
@@ -384,7 +387,7 @@ describe('selectNewLanguageRuntime', () => {
 
 		it('toggles the spinner back on when phase leaves Complete while the picker is open', async () => {
 			const runtimeService = ctx.get(ILanguageRuntimeService);
-			registerRuntime(makeRuntime({ runtimeId: 'py-1' }));
+			await registerRuntime(makeRuntime({ runtimeId: 'py-1' }));
 			// beforeEach leaves the phase at Complete.
 			const promise = runPicker();
 			await waitUntilOpened();
@@ -487,7 +490,9 @@ describe('selectNewLanguageRuntime', () => {
 			const installItem = await waitForItemByLabel('Install Python via uv');
 			pick.accept(installItem);
 
-			await expect(promise).resolves.toEqual(installedRuntime);
+			// The picker resolves to the enriched, registered instance.
+			const result = await promise;
+			expect(result).toEqual(runtimeService.getRegisteredRuntime(installedRuntime.runtimeId));
 			expect(contribution.onSelect).toHaveBeenCalledWith('install-uv');
 			expect(rediscoverAllRuntimes).toHaveBeenCalledWith(/* quiet */ true);
 		});

src/vs/workbench/contrib/positronAssistant/test/browser/positronAssistantService.vitest.ts

@@ -66,7 +66,7 @@ describe('PositronAssistantService', () => {
 		ctx.instantiationService.stub(IPositronPlotsService, ctx.disposables.add(createTestPlotsServiceWithPlots()));
 
 		// Create test runtime sessions
-		const runtime = createTestLanguageRuntimeMetadata(ctx.instantiationService, ctx.disposables);
+		const runtime = await createTestLanguageRuntimeMetadata(ctx.instantiationService, ctx.disposables);
 		testConsoleSession = await startTestLanguageRuntimeSession(
 			ctx.instantiationService,
 			ctx.disposables,