Skip to content

also store extension manifests when storing extensions #166237

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

Merged
sandy081 merged 1 commit into from
Nov 14, 2022
Merged

also store extension manifests when storing extensions #166237

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 72 additions & 53 deletions src/vs/workbench/services/extensionManagement/browser/webExtensionsScannerService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ interface IStoredWebExtension {
readonly identifier: IExtensionIdentifier;
readonly version: string;
readonly location: UriComponents;
readonly manifest?: string;
readonly readmeUri?: UriComponents;
readonly changelogUri?: UriComponents;
// deprecated in favor of packageNLSUris & fallbackPackageNLSUri
Expand All @@ -71,6 +72,7 @@ interface IWebExtension {
identifier: IExtensionIdentifier;
version: string;
location: URI;
manifest?: IExtensionManifest;
readmeUri?: URI;
changelogUri?: URI;
// deprecated in favor of packageNLSUris & fallbackPackageNLSUri
Expand Down Expand Up @@ -425,16 +427,12 @@ export class WebExtensionsScannerService extends Disposable implements IWebExten
}

async scanExtensionManifest(extensionLocation: URI): Promise<IExtensionManifest | null> {
const packageJSONUri = joinPath(extensionLocation, 'package.json');
try {
const content = await this.extensionResourceLoaderService.readExtensionResource(packageJSONUri);
if (content) {
return JSON.parse(content);
}
return await this.getExtensionManifest(extensionLocation);
} catch (error) {
this.logService.warn(`Error while fetching package.json from ${packageJSONUri.toString()}`, getErrorMessage(error));
this.logService.warn(`Error while fetching manifest from ${extensionLocation.toString()}`, getErrorMessage(error));
return null;
}
return null;
}

async addExtensionFromGallery(galleryExtension: IGalleryExtension, metadata: Metadata, profileLocation: URI): Promise<IScannedExtension> {
Expand Down Expand Up @@ -593,18 +591,13 @@ export class WebExtensionsScannerService extends Disposable implements IWebExten
}

private async toWebExtension(extensionLocation: URI, identifier?: IExtensionIdentifier, packageNLSUris?: Map<string, URI>, bundleNLSUris?: Map<string, URI>, fallbackPackageNLSUri?: URI | null, readmeUri?: URI, changelogUri?: URI, metadata?: Metadata): Promise<IWebExtension> {
let packageJSONContent;
let manifest: IExtensionManifest;
try {
packageJSONContent = await this.extensionResourceLoaderService.readExtensionResource(joinPath(extensionLocation, 'package.json'));
manifest = await this.getExtensionManifest(extensionLocation);
} catch (error) {
throw new Error(`Cannot find the package.json from the location '${extensionLocation.toString()}'. ${getErrorMessage(error)}`);
throw new Error(`Error while fetching manifest from the location '${extensionLocation.toString()}'. ${getErrorMessage(error)}`);
}

if (!packageJSONContent) {
throw new Error(`Error while fetching package.json for extension '${extensionLocation.toString()}'. Server returned no content`);
}

const manifest = JSON.parse(packageJSONContent);
if (!this.extensionManifestPropertiesService.canExecuteOnWeb(manifest)) {
throw new Error(localize('not a web extension', "Cannot add '{0}' because this extension is not a web extension.", manifest.displayName || manifest.name));
}
Expand All @@ -618,7 +611,7 @@ export class WebExtensionsScannerService extends Disposable implements IWebExten
}
}

if (bundleNLSUris === undefined) {
if (bundleNLSUris === undefined && manifest.browser) {
const englishStringsUri = joinPath(
this.uriIdentityService.extUri.dirname(joinPath(extensionLocation, manifest.browser)),
'nls.metadata.json'
Expand All @@ -637,6 +630,7 @@ export class WebExtensionsScannerService extends Disposable implements IWebExten
identifier: { id: getGalleryExtensionId(manifest.publisher, manifest.name), uuid: identifier?.uuid },
version: manifest.version,
location: extensionLocation,
manifest,
readmeUri,
changelogUri,
packageNLSUris,
Expand All @@ -647,25 +641,14 @@ export class WebExtensionsScannerService extends Disposable implements IWebExten
}

private async toScannedExtension(webExtension: IWebExtension, isBuiltin: boolean, type: ExtensionType = ExtensionType.User): Promise<IScannedExtension> {
const url = joinPath(webExtension.location, 'package.json');

const validations: [Severity, string][] = [];
let content: string | undefined;
try {
content = await this.extensionResourceLoaderService.readExtensionResource(url);
if (!content) {
validations.push([Severity.Error, `Error while fetching package.json from the location '${url}'. Server returned no content`]);
}
} catch (error) {
validations.push([Severity.Error, `Error while fetching package.json from the location '${url}'. ${getErrorMessage(error)}`]);
}
let manifest: IExtensionManifest | undefined = webExtension.manifest;

let manifest: IExtensionManifest | null = null;
if (content) {
if (!manifest) {
try {
manifest = JSON.parse(content);
manifest = await this.getExtensionManifest(webExtension.location);
} catch (error) {
validations.push([Severity.Error, `Error while parsing package.json. ${getErrorMessage(error)}`]);
validations.push([Severity.Error, `Error while fetching manifest from the location '${webExtension.location}'. ${getErrorMessage(error)}`]);
}
}

Expand Down Expand Up @@ -764,6 +747,12 @@ export class WebExtensionsScannerService extends Disposable implements IWebExten
return this._migratePackageNLSUrisPromise;
}

private async getExtensionManifest(location: URI): Promise<IExtensionManifest> {
const url = joinPath(location, 'package.json');
const content = await this.extensionResourceLoaderService.readExtensionResource(url);
return JSON.parse(content);
}

private async readInstalledExtensions(profileLocation: URI): Promise<IWebExtension[]> {
if (this.uriIdentityService.extUri.isEqual(profileLocation, this.userDataProfilesService.defaultProfile.extensionsResource)) {
await this.migratePackageNLSUris();
Expand Down Expand Up @@ -817,6 +806,7 @@ export class WebExtensionsScannerService extends Disposable implements IWebExten
identifier: e.identifier,
version: e.version,
location: URI.revive(e.location),
manifest: e.manifest ? JSON.parse(e.manifest) : undefined,
readmeUri: URI.revive(e.readmeUri),
changelogUri: URI.revive(e.changelogUri),
packageNLSUris,
Expand All @@ -825,6 +815,13 @@ export class WebExtensionsScannerService extends Disposable implements IWebExten
metadata: e.metadata,
});
}

try {
webExtensions = await this.migrateWebExtensions(webExtensions, file);
} catch (error) {
this.logService.error(`Error while migrating scanned extensions in ${file.toString()}`, getErrorMessage(error));
}

} catch (error) {
/* Ignore */
if ((<FileOperationError>error).fileOperationResult !== FileOperationResult.FILE_NOT_FOUND) {
Expand All @@ -834,37 +831,59 @@ export class WebExtensionsScannerService extends Disposable implements IWebExten

// Update
if (updateFn) {
webExtensions = updateFn(webExtensions);
function toStringDictionary(dictionary: Map<string, URI> | undefined): IStringDictionary<UriComponents> | undefined {
if (!dictionary) {
return undefined;
}
const result: IStringDictionary<UriComponents> = Object.create(null);
dictionary.forEach((value, key) => result[key] = value.toJSON());
return result;
}
const storedWebExtensions: IStoredWebExtension[] = webExtensions.map(e => ({
identifier: e.identifier,
version: e.version,
location: e.location.toJSON(),
readmeUri: e.readmeUri?.toJSON(),
changelogUri: e.changelogUri?.toJSON(),
packageNLSUris: toStringDictionary(e.packageNLSUris),
fallbackPackageNLSUri: e.fallbackPackageNLSUri?.toJSON(),
metadata: e.metadata
}));
await this.fileService.writeFile(file, VSBuffer.fromString(JSON.stringify(storedWebExtensions)));
await this.storeWebExtensions(webExtensions = updateFn(webExtensions), file);
}

return webExtensions;
});
}

private async migrateWebExtensions(webExtensions: IWebExtension[], file: URI): Promise<IWebExtension[]> {
let update = false;
webExtensions = await Promise.all(webExtensions.map(async webExtension => {
if (!webExtension.manifest) {
try {
webExtension.manifest = await this.getExtensionManifest(webExtension.location);
update = true;
} catch (error) {
this.logService.error(`Error while updating manifest of an extension in ${file.toString()}`, webExtension.identifier.id, getErrorMessage(error));
}
}
return webExtension;
}));
if (update) {
await this.storeWebExtensions(webExtensions, file);
}
return webExtensions;
}

private async storeWebExtensions(webExtensions: IWebExtension[], file: URI): Promise<void> {
function toStringDictionary(dictionary: Map<string, URI> | undefined): IStringDictionary<UriComponents> | undefined {
if (!dictionary) {
return undefined;
}
const result: IStringDictionary<UriComponents> = Object.create(null);
dictionary.forEach((value, key) => result[key] = value.toJSON());
return result;
}
const storedWebExtensions: IStoredWebExtension[] = webExtensions.map(e => ({
identifier: e.identifier,
version: e.version,
manifest: e.manifest ? JSON.stringify(e.manifest) : undefined,
location: e.location.toJSON(),
readmeUri: e.readmeUri?.toJSON(),
changelogUri: e.changelogUri?.toJSON(),
packageNLSUris: toStringDictionary(e.packageNLSUris),
fallbackPackageNLSUri: e.fallbackPackageNLSUri?.toJSON(),
metadata: e.metadata
}));
await this.fileService.writeFile(file, VSBuffer.fromString(JSON.stringify(storedWebExtensions)));
}

private getResourceAccessQueue(file: URI): Queue<IWebExtension[]> {
let resourceQueue = this.resourcesAccessQueueMap.get(file);
if (!resourceQueue) {
resourceQueue = new Queue<IWebExtension[]>();
this.resourcesAccessQueueMap.set(file, resourceQueue);
this.resourcesAccessQueueMap.set(file, resourceQueue = new Queue<IWebExtension[]>());
}
return resourceQueue;
}
Expand Down