Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update remote help if installed extensions change #182233

Merged
merged 1 commit into from May 11, 2023
Merged

Update remote help if installed extensions change #182233

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
149 changes: 77 additions & 72 deletions src/vs/workbench/contrib/remote/browser/remote.ts
View file
Open in desktop
Expand Up @@ -45,7 +45,7 @@ import { IListVirtualDelegate } from 'vs/base/browser/ui/list/list';
import { ITreeRenderer, ITreeNode, IAsyncDataSource } from 'vs/base/browser/ui/tree/tree';
import { WorkbenchAsyncDataTree } from 'vs/platform/list/browser/listService';
import { IKeybindingService } from 'vs/platform/keybinding/common/keybinding';
import { Event } from 'vs/base/common/event';
import { Event, Emitter } from 'vs/base/common/event';
import { ExtensionsRegistry, IExtensionPointUser } from 'vs/workbench/services/extensions/common/extensionsRegistry';
import { SyncDescriptor } from 'vs/platform/instantiation/common/descriptors';
import * as icons from 'vs/workbench/contrib/remote/browser/remoteIcons';
Expand Down Expand Up @@ -115,6 +115,7 @@ const remoteHelpExtPoint = ExtensionsRegistry.registerExtensionPoint<HelpInforma
});

interface IViewModel {
onDidChangeHelpInformation: Event<void>;
helpInformation: HelpInformation[];
}

Expand Down Expand Up @@ -173,105 +174,106 @@ interface IHelpItem {
icon: ThemeIcon;
iconClasses: string[];
label: string;
values: HelpItemValue[];
handleClick(): Promise<void>;
}

class HelpModel {
items: IHelpItem[] | undefined;

constructor(
viewModel: IViewModel,
openerService: IOpenerService,
quickInputService: IQuickInputService,
commandService: ICommandService,
remoteExplorerService: IRemoteExplorerService,
environmentService: IWorkbenchEnvironmentService,
workspaceContextService: IWorkspaceContextService,
walkthroughsService: IWalkthroughsService
private viewModel: IViewModel,
private openerService: IOpenerService,
private quickInputService: IQuickInputService,
private commandService: ICommandService,
private remoteExplorerService: IRemoteExplorerService,
private environmentService: IWorkbenchEnvironmentService,
private workspaceContextService: IWorkspaceContextService,
private walkthroughsService: IWalkthroughsService
) {
this.updateItems();
viewModel.onDidChangeHelpInformation(() => this.updateItems());
}

private createHelpItemValue(info: HelpInformation, infoKey: Exclude<keyof HelpInformation, 'extensionDescription' | 'remoteName' | 'virtualWorkspace'>) {
return new HelpItemValue(this.commandService,
this.walkthroughsService,
info.extensionDescription,
(typeof info.remoteName === 'string') ? [info.remoteName] : info.remoteName,
info.virtualWorkspace,
info[infoKey]);
}

private updateItems() {
const helpItems: IHelpItem[] = [];
const getStarted = viewModel.helpInformation.filter(info => info.getStarted);

const getStarted = this.viewModel.helpInformation.filter(info => info.getStarted);
if (getStarted.length) {
helpItems.push(new GetStartedHelpItem(
const helpItemValues = getStarted.map((info: HelpInformation) => this.createHelpItemValue(info, 'getStarted'));
const getStartedHelpItem = this.items?.find(item => item.icon === icons.getStartedIcon) ?? new GetStartedHelpItem(
icons.getStartedIcon,
nls.localize('remote.help.getStarted', "Get Started"),
getStarted.map((info: HelpInformation) => (new HelpItemValue(commandService,
walkthroughsService,
info.extensionDescription,
(typeof info.remoteName === 'string') ? [info.remoteName] : info.remoteName,
info.virtualWorkspace,
info.getStarted)
)),
quickInputService,
environmentService,
openerService,
remoteExplorerService,
workspaceContextService,
commandService
));
helpItemValues,
this.quickInputService,
this.environmentService,
this.openerService,
this.remoteExplorerService,
this.workspaceContextService,
this.commandService
);
getStartedHelpItem.values = helpItemValues;
helpItems.push(getStartedHelpItem);
}

const documentation = viewModel.helpInformation.filter(info => info.documentation);

const documentation = this.viewModel.helpInformation.filter(info => info.documentation);
if (documentation.length) {
helpItems.push(new HelpItem(
const helpItemValues = documentation.map((info: HelpInformation) => this.createHelpItemValue(info, 'documentation'));
const documentationHelpItem = this.items?.find(item => item.icon === icons.documentationIcon) ?? new HelpItem(
icons.documentationIcon,
nls.localize('remote.help.documentation', "Read Documentation"),
documentation.map((info: HelpInformation) => (new HelpItemValue(commandService,
walkthroughsService,
info.extensionDescription,
(typeof info.remoteName === 'string') ? [info.remoteName] : info.remoteName,
info.virtualWorkspace,
info.documentation!)
)),
quickInputService,
environmentService,
openerService,
remoteExplorerService,
workspaceContextService
));
helpItemValues,
this.quickInputService,
this.environmentService,
this.openerService,
this.remoteExplorerService,
this.workspaceContextService
);
documentationHelpItem.values = helpItemValues;
helpItems.push(documentationHelpItem);
}

const issues = viewModel.helpInformation.filter(info => info.issues);

const issues = this.viewModel.helpInformation.filter(info => info.issues);
if (issues.length) {
helpItems.push(new HelpItem(
const helpItemValues = issues.map((info: HelpInformation) => this.createHelpItemValue(info, 'issues'));
const reviewIssuesHelpItem = this.items?.find(item => item.icon === icons.reviewIssuesIcon) ?? new HelpItem(
icons.reviewIssuesIcon,
nls.localize('remote.help.issues', "Review Issues"),
issues.map((info: HelpInformation) => (new HelpItemValue(commandService,
walkthroughsService,
info.extensionDescription,
(typeof info.remoteName === 'string') ? [info.remoteName] : info.remoteName,
info.virtualWorkspace,
info.issues!)
)),
quickInputService,
environmentService,
openerService,
remoteExplorerService,
workspaceContextService
));
helpItemValues,
this.quickInputService,
this.environmentService,
this.openerService,
this.remoteExplorerService,
this.workspaceContextService
);
reviewIssuesHelpItem.values = helpItemValues;
helpItems.push(reviewIssuesHelpItem);
}

if (helpItems.length) {
helpItems.push(new IssueReporterItem(
const helpItemValues = this.viewModel.helpInformation.map(info => this.createHelpItemValue(info, 'reportIssue'));
const issueReporterItem = this.items?.find(item => item.icon === icons.reportIssuesIcon) ?? new IssueReporterItem(
icons.reportIssuesIcon,
nls.localize('remote.help.report', "Report Issue"),
viewModel.helpInformation.map(info => (new HelpItemValue(commandService,
walkthroughsService,
info.extensionDescription,
(typeof info.remoteName === 'string') ? [info.remoteName] : info.remoteName,
info.virtualWorkspace,
info.reportIssue
))),
quickInputService,
environmentService,
commandService,
openerService,
remoteExplorerService,
workspaceContextService
));
helpItemValues,
this.quickInputService,
this.environmentService,
this.commandService,
this.openerService,
this.remoteExplorerService,
this.workspaceContextService
);
issueReporterItem.values = helpItemValues;
helpItems.push(issueReporterItem);
}

if (helpItems.length) {
Expand Down Expand Up @@ -579,6 +581,8 @@ class HelpPanelDescriptor implements IViewDescriptor {
class RemoteViewPaneContainer extends FilterViewPaneContainer implements IViewModel {
private helpPanelDescriptor = new HelpPanelDescriptor(this);
helpInformation: HelpInformation[] = [];
private _onDidChangeHelpInformation = new Emitter<void>();
public onDidChangeHelpInformation: Event<void> = this._onDidChangeHelpInformation.event;
private hasSetSwitchForConnection: boolean = false;

constructor(
Expand All @@ -604,6 +608,7 @@ class RemoteViewPaneContainer extends FilterViewPaneContainer implements IViewMo
}

this.helpInformation = helpInformation;
this._onDidChangeHelpInformation.fire();

const viewsRegistry = Registry.as<IViewsRegistry>(Extensions.ViewsRegistry);
if (this.helpInformation.length) {
Expand Down