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.

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

Fix extension gallery fail when no network #195925

Merged
merged 1 commit into from Oct 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 8 additions & 14 deletions src/vs/workbench/contrib/preferences/browser/settingsEditor2.ts
Expand Up @@ -1291,27 +1291,21 @@ export class SettingsEditor2 extends EditorPane {
}

const additionalGroups: ISettingsGroup[] = [];
const toggleData = await getExperimentalExtensionToggleData(this.workbenchAssignmentService, this.environmentService, this.productService);
if (this.extensionGalleryService.isEnabled() && toggleData && groups.filter(g => g.extensionInfo).length) {
const toggleData = await getExperimentalExtensionToggleData(this.extensionGalleryService, this.workbenchAssignmentService, this.environmentService, this.productService);
if (toggleData && groups.filter(g => g.extensionInfo).length) {
for (const key in toggleData.settingsEditorRecommendedExtensions) {
const extensionId = key;
// Recommend prerelease if not on Stable.
const isStable = this.productService.quality === 'stable';
const [extension] = await this.extensionGalleryService.getExtensions([{ id: extensionId, preRelease: !isStable }], CancellationToken.None);
if (!extension) {
continue;
}

let groupTitle: string | undefined;
const extension = toggleData.recommendedExtensionsGalleryInfo[key];
const manifest = await this.extensionGalleryService.getManifest(extension, CancellationToken.None);
const contributesConfiguration = manifest?.contributes?.configuration;

let groupTitle: string | undefined;
if (!Array.isArray(contributesConfiguration)) {
groupTitle = contributesConfiguration?.title;
} else if (contributesConfiguration.length === 1) {
groupTitle = contributesConfiguration[0].title;
}

const extensionName = extension?.displayName ?? extension?.name ?? extensionId;
const extensionName = extension?.displayName ?? extension?.name ?? extension.identifier.id;
const settingKey = `${key}.manageExtension`;
const setting: ISetting = {
range: nullRange,
Expand All @@ -1325,7 +1319,7 @@ export class SettingsEditor2 extends EditorPane {
title: extensionName,
scope: ConfigurationScope.WINDOW,
type: 'null',
displayExtensionId: extensionId,
displayExtensionId: extension.identifier.id,
prereleaseExtensionId: key,
stableExtensionId: key,
extensionGroupTitle: groupTitle ?? extensionName
Expand All @@ -1339,7 +1333,7 @@ export class SettingsEditor2 extends EditorPane {

resolvedSettingsRoot.children!.push(await createTocTreeForExtensionSettings(this.extensionService, groups.filter(g => g.extensionInfo)));

const commonlyUsedDataToUse = await getCommonlyUsedData(this.workbenchAssignmentService, this.environmentService, this.productService);
const commonlyUsedDataToUse = getCommonlyUsedData(toggleData);
const commonlyUsed = resolveSettingsTree(commonlyUsedDataToUse, groups, this.logService);
resolvedSettingsRoot.children!.unshift(commonlyUsed.tree);

Expand Down
11 changes: 4 additions & 7 deletions src/vs/workbench/contrib/preferences/browser/settingsLayout.ts
Expand Up @@ -4,10 +4,8 @@
*--------------------------------------------------------------------------------------------*/

import { localize } from 'vs/nls';
import { IEnvironmentService } from 'vs/platform/environment/common/environment';
import { IProductService } from 'vs/platform/product/common/productService';
import { getExperimentalExtensionToggleData } from 'vs/workbench/contrib/preferences/common/preferences';
import { IWorkbenchAssignmentService } from 'vs/workbench/services/assignment/common/assignmentService';
import { ExtensionToggleData } from 'vs/workbench/contrib/preferences/common/preferences';

export interface ITOCEntry<T> {
id: string;
label: string;
Expand All @@ -31,12 +29,11 @@ const defaultCommonlyUsedSettings: string[] = [
'workbench.editor.enablePreview'
];

export async function getCommonlyUsedData(workbenchAssignmentService: IWorkbenchAssignmentService, environmentService: IEnvironmentService, productService: IProductService): Promise<ITOCEntry<string>> {
const toggleData = await getExperimentalExtensionToggleData(workbenchAssignmentService, environmentService, productService);
export function getCommonlyUsedData(toggleData: ExtensionToggleData | undefined): ITOCEntry<string> {
return {
id: 'commonlyUsed',
label: localize('commonlyUsed', "Commonly Used"),
settings: toggleData ? toggleData.commonlyUsed : defaultCommonlyUsedSettings
settings: toggleData?.commonlyUsed ?? defaultCommonlyUsedSettings
};
}

Expand Down
30 changes: 27 additions & 3 deletions src/vs/workbench/contrib/preferences/common/preferences.ts
Expand Up @@ -8,6 +8,7 @@ import { IStringDictionary } from 'vs/base/common/collections';
import { IExtensionRecommendations } from 'vs/base/common/product';
import { RawContextKey } from 'vs/platform/contextkey/common/contextkey';
import { IEnvironmentService } from 'vs/platform/environment/common/environment';
import { IExtensionGalleryService, IGalleryExtension } from 'vs/platform/extensionManagement/common/extensionManagement';
import { createDecorator } from 'vs/platform/instantiation/common/instantiation';
import { IProductService } from 'vs/platform/product/common/productService';
import { IWorkbenchAssignmentService } from 'vs/workbench/services/assignment/common/assignmentService';
Expand Down Expand Up @@ -95,33 +96,56 @@ export const ENABLE_LANGUAGE_FILTER = true;

export const ENABLE_EXTENSION_TOGGLE_SETTINGS = true;

type ExtensionToggleData = {
export type ExtensionToggleData = {
settingsEditorRecommendedExtensions: IStringDictionary<IExtensionRecommendations>;
recommendedExtensionsGalleryInfo: IStringDictionary<IGalleryExtension>;
commonlyUsed: string[];
};

let cachedExtensionToggleData: ExtensionToggleData | undefined;

export async function getExperimentalExtensionToggleData(workbenchAssignmentService: IWorkbenchAssignmentService, environmentService: IEnvironmentService, productService: IProductService): Promise<ExtensionToggleData | undefined> {
export async function getExperimentalExtensionToggleData(extensionGalleryService: IExtensionGalleryService, workbenchAssignmentService: IWorkbenchAssignmentService, environmentService: IEnvironmentService, productService: IProductService): Promise<ExtensionToggleData | undefined> {
if (!ENABLE_EXTENSION_TOGGLE_SETTINGS) {
return undefined;
}

if (!extensionGalleryService.isEnabled()) {
return undefined;
}

if (cachedExtensionToggleData) {
return cachedExtensionToggleData;
}

const isTreatment = await workbenchAssignmentService.getTreatment<boolean>('ExtensionToggleSettings');
if ((isTreatment || !environmentService.isBuilt) && productService.extensionRecommendations && productService.commonlyUsedSettings) {
const settingsEditorRecommendedExtensions: Record<string, IExtensionRecommendations> = {};
const settingsEditorRecommendedExtensions: IStringDictionary<IExtensionRecommendations> = {};
Object.keys(productService.extensionRecommendations).forEach(extensionId => {
const extensionInfo = productService.extensionRecommendations![extensionId];
if (extensionInfo.onSettingsEditorOpen) {
settingsEditorRecommendedExtensions[extensionId] = extensionInfo;
}
});

const recommendedExtensionsGalleryInfo: IStringDictionary<IGalleryExtension> = {};
for (const key in settingsEditorRecommendedExtensions) {
const extensionId = key;
// Recommend prerelease if not on Stable.
const isStable = productService.quality === 'stable';
try {
const [extension] = await extensionGalleryService.getExtensions([{ id: extensionId, preRelease: !isStable }], CancellationToken.None);
if (extension) {
recommendedExtensionsGalleryInfo[key] = extension;
}
} catch (e) {
// Network connection fail. Return nothing rather than partial data.
return undefined;
}
}

cachedExtensionToggleData = {
settingsEditorRecommendedExtensions,
recommendedExtensionsGalleryInfo,
commonlyUsed: productService.commonlyUsedSettings
};
return cachedExtensionToggleData;
Expand Down