Add remote.defaultExtensions (microsoft#243400)

* add remote.defaultExtensions

* some nice suggestions

Author: joshspicer

src/vs/platform/remote/common/remote.ts

@@ -0,0 +1,6 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+export const REMOTE_DEFAULT_EXTENSIONS = 'remote.defaultExtensions';

src/vs/workbench/contrib/extensions/electron-sandbox/extensions.contribution.ts

@@ -23,7 +23,7 @@ import { DebugExtensionHostAction, DebugExtensionsContribution } from './debugEx
 import { ExtensionHostProfileService } from './extensionProfileService.js';
 import { CleanUpExtensionsFolderAction, OpenExtensionsFolderAction } from './extensionsActions.js';
 import { ExtensionsAutoProfiler } from './extensionsAutoProfiler.js';
-import { InstallFailedRemoteExtensionsContribution, RemoteExtensionsInitializerContribution } from './remoteExtensionsInit.js';
+import { InstallRemoteExtensionsContribution, RemoteExtensionsInitializerContribution } from './remoteExtensionsInit.js';
 import { IExtensionHostProfileService, OpenExtensionHostProfileACtion, RuntimeExtensionsEditor, SaveExtensionHostProfileAction, StartExtensionHostProfileAction, StopExtensionHostProfileAction } from './runtimeExtensionsEditor.js';
 
 // Singletons
@@ -71,7 +71,7 @@ const workbenchRegistry = Registry.as<IWorkbenchContributionsRegistry>(Workbench
 workbenchRegistry.registerWorkbenchContribution(ExtensionsContributions, LifecyclePhase.Restored);
 workbenchRegistry.registerWorkbenchContribution(ExtensionsAutoProfiler, LifecyclePhase.Eventually);
 workbenchRegistry.registerWorkbenchContribution(RemoteExtensionsInitializerContribution, LifecyclePhase.Restored);
-workbenchRegistry.registerWorkbenchContribution(InstallFailedRemoteExtensionsContribution, LifecyclePhase.Restored);
+workbenchRegistry.registerWorkbenchContribution(InstallRemoteExtensionsContribution, LifecyclePhase.Restored);
 workbenchRegistry.registerWorkbenchContribution(DebugExtensionsContribution, LifecyclePhase.Restored);
 
 // Register Commands

src/vs/workbench/contrib/extensions/electron-sandbox/remoteExtensionsInit.ts

@@ -4,13 +4,16 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { CancellationToken } from '../../../../base/common/cancellation.js';
+import { IConfigurationService } from '../../../../platform/configuration/common/configuration.js';
 import { IEnvironmentService } from '../../../../platform/environment/common/environment.js';
 import { EXTENSION_INSTALL_SKIP_PUBLISHER_TRUST_CONTEXT, IExtensionGalleryService, IExtensionManagementService, InstallExtensionInfo } from '../../../../platform/extensionManagement/common/extensionManagement.js';
 import { areSameExtensions } from '../../../../platform/extensionManagement/common/extensionManagementUtil.js';
 import { IFileService } from '../../../../platform/files/common/files.js';
 import { IInstantiationService } from '../../../../platform/instantiation/common/instantiation.js';
 import { ServiceCollection } from '../../../../platform/instantiation/common/serviceCollection.js';
 import { ILogService } from '../../../../platform/log/common/log.js';
+import { IProductService } from '../../../../platform/product/common/productService.js';
+import { REMOTE_DEFAULT_EXTENSIONS } from '../../../../platform/remote/common/remote.js';
 import { IRemoteAuthorityResolverService } from '../../../../platform/remote/common/remoteAuthorityResolver.js';
 import { IRemoteExtensionsScannerService } from '../../../../platform/remote/common/remoteExtensionsScanner.js';
 import { IStorageService, IS_NEW_KEY, StorageScope, StorageTarget } from '../../../../platform/storage/common/storage.js';
@@ -26,17 +29,74 @@ import { IExtensionManagementServerService } from '../../../services/extensionMa
 import { IExtensionManifestPropertiesService } from '../../../services/extensions/common/extensionManifestPropertiesService.js';
 import { IRemoteAgentService } from '../../../services/remote/common/remoteAgentService.js';
 
-export class InstallFailedRemoteExtensionsContribution implements IWorkbenchContribution {
+export class InstallRemoteExtensionsContribution implements IWorkbenchContribution {
 	constructor(
 		@IRemoteAgentService private readonly remoteAgentService: IRemoteAgentService,
 		@IRemoteExtensionsScannerService private readonly remoteExtensionsScannerService: IRemoteExtensionsScannerService,
 		@IExtensionGalleryService private readonly extensionGalleryService: IExtensionGalleryService,
 		@IExtensionManagementServerService private readonly extensionManagementServerService: IExtensionManagementServerService,
-		@ILogService private readonly logService: ILogService
+		@ILogService private readonly logService: ILogService,
+		@IConfigurationService private readonly configurationService: IConfigurationService,
+		@IProductService private readonly productService: IProductService,
 	) {
+		this.installDefaultRemoteExtensions();
 		this.installFailedRemoteExtensions();
 	}
 
+	private async installDefaultRemoteExtensions(): Promise<void> {
+		if (!this.remoteAgentService.getConnection()) {
+			return;
+		}
+
+		if (!this.extensionManagementServerService.remoteExtensionManagementServer) {
+			this.logService.error('No remote extension management server available');
+			return;
+		}
+
+		const settingValue = this.configurationService.getValue<string[]>(REMOTE_DEFAULT_EXTENSIONS);
+		if (!settingValue?.length) {
+			return;
+		}
+
+		this.logService.info(`Installing '${settingValue.length}' default remote extensions`);
+
+		const preferPrerelease = this.productService.quality !== 'stable';
+		const galleryExtensions = await this.extensionGalleryService.getExtensions(settingValue.map((id) => ({ id })), CancellationToken.None);
+		const alreadyInstalledExtensions = await this.extensionManagementServerService.remoteExtensionManagementServer.extensionManagementService.getInstalled();
+
+		const prereleaseExtensionInfo: InstallExtensionInfo[] = [];
+		const extensionInfo: InstallExtensionInfo[] = [];
+		for (const id of settingValue) {
+			const alreadyInstalled = alreadyInstalledExtensions.some(e => areSameExtensions(e.identifier, { id }));
+			if (alreadyInstalled) {
+				this.logService.trace(`Default remote extension '${id}' is already installed`);
+				continue;
+			}
+
+			const extension = galleryExtensions.find(e => areSameExtensions(e.identifier, { id }));
+			if (!extension) {
+				this.logService.warn(`Default remote extension '${id}' is not found`);
+				continue;
+			}
+
+			const installPreReleaseVersion = preferPrerelease && extension.hasPreReleaseVersion;
+			(installPreReleaseVersion ? prereleaseExtensionInfo : extensionInfo).push({
+				extension, options: { installPreReleaseVersion },
+			});
+		}
+
+		// Install pre-release extensions first to avoid a situation where:
+		// An extension without a pre-release (A) is installed first and depends on an extension that has a pre-release version (B)
+		// If this happens, the extension A may result in the installation of the stable version of B
+		// A real life example of this is GitHub.copilot and GitHub.copilot-chat
+		if (prereleaseExtensionInfo.length) {
+			await Promise.allSettled(prereleaseExtensionInfo.map(e => this.extensionManagementServerService.remoteExtensionManagementServer!.extensionManagementService.installFromGallery(e.extension, e.options)));
+		}
+		if (extensionInfo.length) {
+			await Promise.allSettled(extensionInfo.map(e => this.extensionManagementServerService.remoteExtensionManagementServer!.extensionManagementService.installFromGallery(e.extension, e.options)));
+		}
+	}
+
 	private async installFailedRemoteExtensions(): Promise<void> {
 		if (!this.remoteAgentService.getConnection()) {
 			return;

src/vs/workbench/contrib/remote/common/remote.contribution.ts

@@ -26,6 +26,10 @@ import { PersistentConnection } from '../../../../platform/remote/common/remoteA
 import { IDownloadService } from '../../../../platform/download/common/download.js';
 import { DownloadServiceChannel } from '../../../../platform/download/common/downloadIpc.js';
 import { RemoteLoggerChannelClient } from '../../../../platform/log/common/logIpc.js';
+import { REMOTE_DEFAULT_EXTENSIONS } from '../../../../platform/remote/common/remote.js';
+
+
+const EXTENSION_IDENTIFIER_PATTERN = '([a-z0-9A-Z][a-z0-9-A-Z]*)\\.([a-z0-9A-Z][a-z0-9-A-Z]*)$';
 
 export class LabelContribution implements IWorkbenchContribution {
 
@@ -205,7 +209,7 @@ Registry.as<IConfigurationRegistry>(ConfigurationExtensions.Configuration)
 				type: 'object',
 				markdownDescription: localize('remote.extensionKind', "Override the kind of an extension. `ui` extensions are installed and run on the local machine while `workspace` extensions are run on the remote. By overriding an extension's default kind using this setting, you specify if that extension should be installed and enabled locally or remotely."),
 				patternProperties: {
-					'([a-z0-9A-Z][a-z0-9-A-Z]*)\\.([a-z0-9A-Z][a-z0-9-A-Z]*)$': {
+					[EXTENSION_IDENTIFIER_PATTERN]: {
 						oneOf: [{ type: 'array', items: extensionKindSchema }, extensionKindSchema],
 						default: ['ui'],
 					},
@@ -355,6 +359,19 @@ Registry.as<IConfigurationRegistry>(ConfigurationExtensions.Configuration)
 				enum: ['localhost', 'allInterfaces'],
 				default: 'localhost',
 				description: localize('remote.localPortHost', "Specifies the local host name that will be used for port forwarding.")
+			},
+			[REMOTE_DEFAULT_EXTENSIONS]: {
+				type: 'array',
+				markdownDescription: localize('remote.defaultExtensions.markdownDescription', 'List of extensions to install automatically on all remotes.'),
+				default: [
+					'GitHub.copilot',
+					'GitHub.copilot-chat'
+				],
+				items: {
+					type: 'string',
+					pattern: EXTENSION_IDENTIFIER_PATTERN,
+					patternErrorMessage: localize('remote.defaultExtensions.invalidFormat', 'Extension identifier must be in format "publisher.name".')
+				},
 			}
 		}
 	});