development/vscode
development/vscode
1
0
Fork 0
mirror of https://github.com/Microsoft/vscode synced 2024-08-27 13:00:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Make window indicator menu contribution point stable. Fixes #121180

Browse source
This commit is contained in:
Martin Aeschlimann 2021-04-22 21:54:33 +02:00
parent 2f077172cb
commit 214a1581b7
No known key found for this signature in database
GPG key ID: 2609A01E695523E3
4 changed files with 44 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
extensions/vscode-test-resolver/package.json
View file

@ -80,31 +80,31 @@
"when": "remoteName == test"
}
],
"statusBar/windowIndicator": [
"statusBar/remoteIndicator": [
{
"command": "vscode-testresolver.newWindow",
"when": "!remoteName",
"group": "9_local_testresolver@2"
"group": "remote_9_test_1_local@2"
},
{
"command": "vscode-testresolver.showLog",
"when": "remoteName == test",
"group": "1_remote_testresolver_open@3"
"group": "remote_9_test_1_open@3"
},
{
"command": "vscode-testresolver.newWindow",
"when": "remoteName == test",
"group": "1_remote_testresolver_open@1"
"group": "remote_9_test_1_open@1"
},
{
"command": "vscode-testresolver.openTunnel",
"when": "remoteName == test",
"group": "1_remote_testresolver_open@4"
"group": "remote_9_test_2_more@4"
},
{
"command": "vscode-testresolver.startRemoteServer",
"when": "remoteName == test",
"group": "1_remote_testresolver_open@5"
"group": "remote_9_test_2_more@5"
}
]
},

1
src/vs/platform/actions/common/actions.ts
View file

@ -123,6 +123,7 @@ export class MenuId {
static readonly SCMTitle = new MenuId('SCMTitle');
static readonly SearchContext = new MenuId('SearchContext');
static readonly StatusBarWindowIndicatorMenu = new MenuId('StatusBarWindowIndicatorMenu');
static readonly StatusBarRemoteIndicatorMenu = new MenuId('StatusBarRemoteIndicatorMenu');
static readonly TestItem = new MenuId('TestItem');
static readonly TouchBarContext = new MenuId('TouchBarContext');
static readonly TitleBarContext = new MenuId('TitleBarContext');

6
src/vs/workbench/api/common/menusExtensionPoint.ts
View file

@ -138,6 +138,12 @@ const apiMenus: IAPIMenu[] = [
proposed: true,
supportsSubmenus: false
},
{
key: 'statusBar/remoteIndicator',
id: MenuId.StatusBarRemoteIndicatorMenu,
description: localize('menus.statusBarRemoteIndicator', "The remote indicator menu in the status bar"),
supportsSubmenus: false
},
{
key: 'view/title',
id: MenuId.ViewTitle,

41
src/vs/workbench/contrib/remote/browser/remoteIndicator.ts
View file

@ -27,6 +27,7 @@ import { truncate } from 'vs/base/common/strings';
import { IWorkspaceContextService } from 'vs/platform/workspace/common/workspace';
import { getVirtualWorkspaceLocation } from 'vs/platform/remote/common/remoteHosts';
import { getCodiconAriaLabel } from 'vs/base/common/codicons';
import { ILogService } from 'vs/platform/log/common/log';
export class RemoteStatusIndicator extends Disposable implements IWorkbenchContribution {
@ -38,13 +39,17 @@ export class RemoteStatusIndicator extends Disposable implements IWorkbenchContr
private remoteStatusEntry: IStatusbarEntryAccessor | undefined;
private readonly remoteMenu = this._register(this.menuService.createMenu(MenuId.StatusBarWindowIndicatorMenu, this.contextKeyService));
private readonly windowIndicatorMenu = this._register(this.menuService.createMenu(MenuId.StatusBarWindowIndicatorMenu, this.contextKeyService)); // to be removed once migration completed
private readonly remoteIndicatorMenu = this._register(this.menuService.createMenu(MenuId.StatusBarRemoteIndicatorMenu, this.contextKeyService));
private hasRemoteActions = false;
private readonly remoteAuthority = this.environmentService.remoteAuthority;
private connectionState: 'initializing' | 'connected' | 'reconnecting' | 'disconnected' | undefined = undefined;
private readonly connectionStateContextKey = new RawContextKey<'' | 'initializing' | 'disconnected' | 'connected'>('remoteConnectionState', '').bindTo(this.contextKeyService);
private loggedInvalidGroupNames: { [group: string]: boolean } = Object.create(null);
constructor(
@IStatusbarService private readonly statusbarService: IStatusbarService,
@IWorkbenchEnvironmentService private readonly environmentService: IWorkbenchEnvironmentService,
@ -57,7 +62,8 @@ export class RemoteStatusIndicator extends Disposable implements IWorkbenchContr
@IRemoteAgentService private readonly remoteAgentService: IRemoteAgentService,
@IRemoteAuthorityResolverService private readonly remoteAuthorityResolverService: IRemoteAuthorityResolverService,
@IHostService private readonly hostService: IHostService,
@IWorkspaceContextService private readonly workspaceContextService: IWorkspaceContextService
@IWorkspaceContextService private readonly workspaceContextService: IWorkspaceContextService,
@ILogService private readonly logService: ILogService
) {
super();
@ -88,7 +94,7 @@ export class RemoteStatusIndicator extends Disposable implements IWorkbenchContr
f1: true,
});
}
run = () => that.showRemoteMenu(that.remoteMenu);
run = () => that.showRemoteMenu(that.remoteIndicatorMenu, that.windowIndicatorMenu);
});
// Close Remote Connection
@ -119,7 +125,7 @@ export class RemoteStatusIndicator extends Disposable implements IWorkbenchContr
private registerListeners(): void {
// Menu changes
this._register(this.remoteMenu.onDidChange(() => this.updateRemoteActions()));
this._register(this.windowIndicatorMenu.onDidChange(() => this.updateRemoteActions()));
// Update indicator when formatter changes as it may have an impact on the remote label
this._register(this.labelService.onDidChangeFormatters(() => this.updateRemoteStatusIndicator()));
@ -192,7 +198,7 @@ export class RemoteStatusIndicator extends Disposable implements IWorkbenchContr
}
private updateRemoteActions() {
const newHasWindowActions = this.remoteMenu.getActions().length > 0;
const newHasWindowActions = this.windowIndicatorMenu.getActions().length > 0;
if (newHasWindowActions !== this.hasRemoteActions) {
this.hasRemoteActions = newHasWindowActions;
@ -236,7 +242,7 @@ export class RemoteStatusIndicator extends Disposable implements IWorkbenchContr
}
// Remote actions: offer menu
if (this.remoteMenu.getActions().length > 0) {
if (this.windowIndicatorMenu.getActions().length > 0) {
this.renderRemoteStatusIndicator(`$(remote)`, nls.localize('noHost.tooltip', "Open a Remote Window"));
return;
}
@ -257,7 +263,7 @@ export class RemoteStatusIndicator extends Disposable implements IWorkbenchContr
private renderRemoteStatusIndicator(text: string, tooltip?: string, command?: string, showProgress?: boolean): void {
const name = nls.localize('remoteHost', "Remote Host");
if (typeof command !== 'string' && this.remoteMenu.getActions().length > 0) {
if (typeof command !== 'string' && this.windowIndicatorMenu.getActions().length > 0) {
command = RemoteStatusIndicator.REMOTE_ACTIONS_COMMAND_ID;
}
@ -279,7 +285,7 @@ export class RemoteStatusIndicator extends Disposable implements IWorkbenchContr
}
}
private showRemoteMenu(menu: IMenu) {
private showRemoteMenu(menu: IMenu, legacyMenu: IMenu) {
const getCategoryLabel = (action: MenuItemAction) => {
if (action.item.category) {
return typeof action.item.category === 'string' ? action.item.category : action.item.category.value;
@ -287,13 +293,25 @@ export class RemoteStatusIndicator extends Disposable implements IWorkbenchContr
return undefined;
};
const validatedGroup = (group: string) => {
if (!group.match(/^(remote|virtualfs)_(\d)_(([a-z][a-z0-9+\-.]*)_(.*))$/)) {
if (!this.loggedInvalidGroupNames[group]) {
this.loggedInvalidGroupNames[group] = true;
this.logService.warn(`Invalid group name used in "statusBar/remoteIndicator" menu contribution: ${group}. Entries ignored. Expected format: 'remote_$ORDER_$REMOTENAME_$GROUPING or 'virtualfs_$ORDER_$FILESCHEME_$GROUPING.`);
}
return false;
}
return true;
};
const computeItems = () => {
const actions = menu.getActions();
const actionGroups = menu.getActions().filter(a => validatedGroup(a[0])).concat(legacyMenu.getActions());
const items: (IQuickPickItem | IQuickPickSeparator)[] = [];
let lastCategoryName: string | undefined = undefined;
for (let actionGroup of actions) {
for (let actionGroup of actionGroups) {
let hasGroupCategory = false;
for (let action of actionGroup[1]) {
if (action instanceof MenuItemAction) {
@ -342,6 +360,9 @@ export class RemoteStatusIndicator extends Disposable implements IWorkbenchContr
quickPick.hide();
}));
// refresh the items when actions change
const legacyItemUpdater = legacyMenu.onDidChange(() => quickPick.items = computeItems());
quickPick.onDidHide(legacyItemUpdater.dispose);
const itemUpdater = menu.onDidChange(() => quickPick.items = computeItems());
quickPick.onDidHide(itemUpdater.dispose);