tunnelHost.contribution.ts

/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

import { Codicon } from '../../../../base/common/codicons.js';
import { Disposable } from '../../../../base/common/lifecycle.js';
import { localize, localize2 } from '../../../../nls.js';
import { Action2, MenuId, registerAction2 } from '../../../../platform/actions/common/actions.js';
import { IActionViewItemService } from '../../../../platform/actions/browser/actionViewItemService.js';
import { ConfigurationScope, Extensions as ConfigurationExtensions, IConfigurationRegistry } from '../../../../platform/configuration/common/configurationRegistry.js';
import { ContextKeyExpr, IContextKey, IContextKeyService, RawContextKey } from '../../../../platform/contextkey/common/contextkey.js';
import { InstantiationType, registerSingleton } from '../../../../platform/instantiation/common/extensions.js';
import { ServicesAccessor } from '../../../../platform/instantiation/common/instantiation.js';
import { INotificationService, Severity } from '../../../../platform/notification/common/notification.js';
import { Registry } from '../../../../platform/registry/common/platform.js';
import { IWorkbenchContribution, registerWorkbenchContribution2, WorkbenchPhase } from '../../../../workbench/common/contributions.js';
import { IOutputService } from '../../../../workbench/services/output/common/output.js';
import { ChatContextKeys } from '../../../../workbench/contrib/chat/common/actions/chatContextKeys.js';
import { ChatAgentLocation } from '../../../../workbench/contrib/chat/common/constants.js';
import { ITunnelHostService } from '../common/tunnelHost.js';
import { TUNNEL_HOST_LOG_ID } from '../../../../platform/agentHost/common/tunnelAgentHost.js';
import { CONFIGURATION_KEY_MICROSOFT_AUTH, SHOW_TUNNEL_HOST_OUTPUT_ID, TunnelHostService } from './tunnelHostService.js';
import { ToggleRemoteConnectionsActionViewItem } from './toggleRemoteConnectionsActionViewItem.js';

const TUNNEL_HOST_SHARING_KEY = 'tunnelHostSharing';
const TUNNEL_HOST_SHARING_CONTEXT = new RawContextKey<boolean>(TUNNEL_HOST_SHARING_KEY, false);
const TOGGLE_SHARING_ID = 'sessions.tunnelHost.toggleSharing';

const CATEGORY = localize2('tunnelHost.category', 'Remote Connections');

// Register the renderer-side service
registerSingleton(ITunnelHostService, TunnelHostService, InstantiationType.Delayed);

/**
 * Contribution that manages the tunnel host sharing context key
 * and registers the toggle action in the sessions titlebar.
 */
class TunnelHostContribution extends Disposable implements IWorkbenchContribution {

	static readonly ID = 'workbench.contrib.tunnelHost';

	private readonly _sharingContext: IContextKey<boolean>;

	constructor(
		@IContextKeyService contextKeyService: IContextKeyService,
		@ITunnelHostService tunnelHostService: ITunnelHostService,
		@IActionViewItemService actionViewItemService: IActionViewItemService,
	) {
		super();

		this._sharingContext = TUNNEL_HOST_SHARING_CONTEXT.bindTo(contextKeyService);

		// Keep context key in sync with service state
		this._register(tunnelHostService.onDidChangeStatus(() => {
			this._sharingContext.set(tunnelHostService.isSharing);
		}));

		// Register custom action view item with pulse, hover, and toast
		this._register(actionViewItemService.register(
			MenuId.ChatInputSecondary,
			TOGGLE_SHARING_ID,
			(action, _options, instaService) => instaService.createInstance(ToggleRemoteConnectionsActionViewItem, action),
			tunnelHostService.onDidChangeStatus,
		));
	}
}

// Register the toggle action
registerAction2(class ToggleRemoteConnectionsAction extends Action2 {
	constructor() {
		super({
			id: TOGGLE_SHARING_ID,
			title: localize2("toggleSharing", "Allow Remote Connections"),
			category: CATEGORY,
			icon: Codicon.radioTower,
			toggled: ContextKeyExpr.equals(TUNNEL_HOST_SHARING_KEY, true),
			menu: {
				id: MenuId.ChatInputSecondary,
				order: 10,
				group: 'navigation',
				when: ContextKeyExpr.and(
					ChatContextKeys.enabled,
					ChatContextKeys.location.isEqualTo(ChatAgentLocation.Chat),
					ChatContextKeys.inQuickChat.negate(),
					ContextKeyExpr.regex(ChatContextKeys.lockedCodingAgentId.key, /^agent-host-/),
				)
			}
		});
	}

	async run(accessor: ServicesAccessor): Promise<void> {
		const tunnelHostService = accessor.get(ITunnelHostService);
		const notificationService = accessor.get(INotificationService);

		try {
			if (tunnelHostService.isSharing) {
				await tunnelHostService.stopSharing();
			} else {
				await tunnelHostService.startSharing();
			}
		} catch (err) {
			notificationService.notify({
				severity: Severity.Error,
				message: localize('tunnelHost.error', "Failed to toggle remote connections: {0}", String(err)),
			});
		}
	}
});

// Register the show output action
registerAction2(class ShowTunnelHostOutputAction extends Action2 {
	constructor() {
		super({
			id: SHOW_TUNNEL_HOST_OUTPUT_ID,
			title: localize2('showTunnelHostOutput', "Show Remote Connections Output"),
			category: CATEGORY,
		});
	}

	async run(accessor: ServicesAccessor): Promise<void> {
		const outputService = accessor.get(IOutputService);
		await outputService.showChannel(TUNNEL_HOST_LOG_ID);
	}
});

registerWorkbenchContribution2(TunnelHostContribution.ID, TunnelHostContribution, WorkbenchPhase.AfterRestored);

Registry.as<IConfigurationRegistry>(ConfigurationExtensions.Configuration).registerConfiguration({
	type: 'object',
	properties: {
		[CONFIGURATION_KEY_MICROSOFT_AUTH]: {
			description: localize('tunnelHost.enableMicrosoftAuth', "Enable Microsoft account authentication for agent host tunnels. When disabled, only GitHub authentication is used."),
			type: 'boolean',
			scope: ConfigurationScope.APPLICATION,
			default: false,
			tags: ['usesOnlineServices'],
		},
	}
});