mirror of
https://github.com/microsoft/vscode.git
synced 2025-12-26 13:19:42 +00:00
4a69a71065
* Added telemetry command * Initial Build support * Added build logic for telemetry * Linux Builds * Windows builds sort of work * Remove arm telemetry extraction * Remove alpine telemetry extraction * Remove accidental s * More try catch
338 lines
15 KiB
TypeScript
338 lines
15 KiB
TypeScript
/*---------------------------------------------------------------------------------------------
|
|
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
* Licensed under the MIT License. See License.txt in the project root for license information.
|
|
*--------------------------------------------------------------------------------------------*/
|
|
|
|
import { localize } from 'vs/nls';
|
|
import product from 'vs/platform/product/node/product';
|
|
import pkg from 'vs/platform/product/node/package';
|
|
import * as path from 'vs/base/common/path';
|
|
import * as semver from 'semver';
|
|
|
|
import { ServiceCollection } from 'vs/platform/instantiation/common/serviceCollection';
|
|
import { SyncDescriptor } from 'vs/platform/instantiation/common/descriptors';
|
|
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
|
|
import { InstantiationService } from 'vs/platform/instantiation/common/instantiationService';
|
|
import { IEnvironmentService, ParsedArgs } from 'vs/platform/environment/common/environment';
|
|
import { EnvironmentService } from 'vs/platform/environment/node/environmentService';
|
|
import { IExtensionManagementService, IExtensionGalleryService, IGalleryExtension, ILocalExtension } from 'vs/platform/extensionManagement/common/extensionManagement';
|
|
import { ExtensionManagementService } from 'vs/platform/extensionManagement/node/extensionManagementService';
|
|
import { ExtensionGalleryService } from 'vs/platform/extensionManagement/node/extensionGalleryService';
|
|
import { ITelemetryService } from 'vs/platform/telemetry/common/telemetry';
|
|
import { combinedAppender, NullTelemetryService } from 'vs/platform/telemetry/common/telemetryUtils';
|
|
import { TelemetryService, ITelemetryServiceConfig } from 'vs/platform/telemetry/common/telemetryService';
|
|
import { resolveCommonProperties } from 'vs/platform/telemetry/node/commonProperties';
|
|
import { IRequestService } from 'vs/platform/request/node/request';
|
|
import { RequestService } from 'vs/platform/request/node/requestService';
|
|
import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
|
|
import { ConfigurationService } from 'vs/platform/configuration/node/configurationService';
|
|
import { AppInsightsAppender } from 'vs/platform/telemetry/node/appInsightsAppender';
|
|
import { mkdirp, writeFile } from 'vs/base/node/pfs';
|
|
import { getBaseLabel } from 'vs/base/common/labels';
|
|
import { IStateService } from 'vs/platform/state/common/state';
|
|
import { StateService } from 'vs/platform/state/node/stateService';
|
|
import { ILogService, getLogLevel } from 'vs/platform/log/common/log';
|
|
import { isPromiseCanceledError } from 'vs/base/common/errors';
|
|
import { areSameExtensions, adoptToGalleryExtensionId, getGalleryExtensionId } from 'vs/platform/extensionManagement/common/extensionManagementUtil';
|
|
import { URI } from 'vs/base/common/uri';
|
|
import { getManifest } from 'vs/platform/extensionManagement/node/extensionManagementUtil';
|
|
import { IExtensionManifest, ExtensionType, isLanguagePackExtension } from 'vs/platform/extensions/common/extensions';
|
|
import { CancellationToken } from 'vs/base/common/cancellation';
|
|
import { LocalizationsService } from 'vs/platform/localizations/node/localizations';
|
|
import { Schemas } from 'vs/base/common/network';
|
|
import { SpdLogService } from 'vs/platform/log/node/spdlogService';
|
|
import { buildTelemetryMessage } from 'vs/platform/environment/node/argv';
|
|
|
|
const notFound = (id: string) => localize('notFound', "Extension '{0}' not found.", id);
|
|
const notInstalled = (id: string) => localize('notInstalled', "Extension '{0}' is not installed.", id);
|
|
const useId = localize('useId', "Make sure you use the full extension ID, including the publisher, e.g.: {0}", 'ms-vscode.csharp');
|
|
|
|
function getId(manifest: IExtensionManifest, withVersion?: boolean): string {
|
|
if (withVersion) {
|
|
return `${manifest.publisher}.${manifest.name}@${manifest.version}`;
|
|
} else {
|
|
return `${manifest.publisher}.${manifest.name}`;
|
|
}
|
|
}
|
|
|
|
const EXTENSION_ID_REGEX = /^([^.]+\..+)@(\d+\.\d+\.\d+(-.*)?)$/;
|
|
|
|
export function getIdAndVersion(id: string): [string, string | undefined] {
|
|
const matches = EXTENSION_ID_REGEX.exec(id);
|
|
if (matches && matches[1]) {
|
|
return [adoptToGalleryExtensionId(matches[1]), matches[2]];
|
|
}
|
|
return [adoptToGalleryExtensionId(id), undefined];
|
|
}
|
|
|
|
|
|
export class Main {
|
|
|
|
constructor(
|
|
@IInstantiationService private readonly instantiationService: IInstantiationService,
|
|
@IEnvironmentService private readonly environmentService: IEnvironmentService,
|
|
@IExtensionManagementService private readonly extensionManagementService: IExtensionManagementService,
|
|
@IExtensionGalleryService private readonly extensionGalleryService: IExtensionGalleryService
|
|
) { }
|
|
|
|
async run(argv: ParsedArgs): Promise<void> {
|
|
if (argv['install-source']) {
|
|
await this.setInstallSource(argv['install-source']);
|
|
|
|
} else if (argv['list-extensions']) {
|
|
await this.listExtensions(!!argv['show-versions']);
|
|
|
|
} else if (argv['install-extension']) {
|
|
const arg = argv['install-extension'];
|
|
const args: string[] = typeof arg === 'string' ? [arg] : arg;
|
|
await this.installExtensions(args, argv['force']);
|
|
|
|
} else if (argv['uninstall-extension']) {
|
|
const arg = argv['uninstall-extension'];
|
|
const ids: string[] = typeof arg === 'string' ? [arg] : arg;
|
|
await this.uninstallExtension(ids);
|
|
} else if (argv['locate-extension']) {
|
|
const arg = argv['locate-extension'];
|
|
const ids: string[] = typeof arg === 'string' ? [arg] : arg;
|
|
await this.locateExtension(ids);
|
|
} else if (argv['telemetry']) {
|
|
console.log(buildTelemetryMessage(this.environmentService.appRoot, this.environmentService.extensionsPath));
|
|
}
|
|
}
|
|
|
|
private setInstallSource(installSource: string): Promise<void> {
|
|
return writeFile(this.environmentService.installSourcePath, installSource.slice(0, 30));
|
|
}
|
|
|
|
private async listExtensions(showVersions: boolean): Promise<void> {
|
|
const extensions = await this.extensionManagementService.getInstalled(ExtensionType.User);
|
|
extensions.forEach(e => console.log(getId(e.manifest, showVersions)));
|
|
}
|
|
|
|
private async installExtensions(extensions: string[], force: boolean): Promise<void> {
|
|
const failed: string[] = [];
|
|
const installedExtensionsManifests: IExtensionManifest[] = [];
|
|
if (extensions.length) {
|
|
console.log(localize('installingExtensions', "Installing extensions..."));
|
|
}
|
|
|
|
for (const extension of extensions) {
|
|
try {
|
|
const manifest = await this.installExtension(extension, force);
|
|
if (manifest) {
|
|
installedExtensionsManifests.push(manifest);
|
|
}
|
|
} catch (err) {
|
|
console.error(err.message || err.stack || err);
|
|
failed.push(extension);
|
|
}
|
|
}
|
|
if (installedExtensionsManifests.some(manifest => isLanguagePackExtension(manifest))) {
|
|
await this.updateLocalizationsCache();
|
|
}
|
|
return failed.length ? Promise.reject(localize('installation failed', "Failed Installing Extensions: {0}", failed.join(', '))) : Promise.resolve();
|
|
}
|
|
|
|
private async installExtension(extension: string, force: boolean): Promise<IExtensionManifest | null> {
|
|
if (/\.vsix$/i.test(extension)) {
|
|
extension = path.isAbsolute(extension) ? extension : path.join(process.cwd(), extension);
|
|
|
|
const manifest = await getManifest(extension);
|
|
const valid = await this.validate(manifest, force);
|
|
|
|
if (valid) {
|
|
return this.extensionManagementService.install(URI.file(extension)).then(id => {
|
|
console.log(localize('successVsixInstall', "Extension '{0}' was successfully installed.", getBaseLabel(extension)));
|
|
return manifest;
|
|
}, error => {
|
|
if (isPromiseCanceledError(error)) {
|
|
console.log(localize('cancelVsixInstall', "Cancelled installing extension '{0}'.", getBaseLabel(extension)));
|
|
return null;
|
|
} else {
|
|
return Promise.reject(error);
|
|
}
|
|
});
|
|
}
|
|
return null;
|
|
}
|
|
|
|
const [id, version] = getIdAndVersion(extension);
|
|
return this.extensionManagementService.getInstalled(ExtensionType.User)
|
|
.then(installed => this.extensionGalleryService.getCompatibleExtension({ id }, version)
|
|
.then<IGalleryExtension>(null, err => {
|
|
if (err.responseText) {
|
|
try {
|
|
const response = JSON.parse(err.responseText);
|
|
return Promise.reject(response.message);
|
|
} catch (e) {
|
|
// noop
|
|
}
|
|
}
|
|
return Promise.reject(err);
|
|
})
|
|
.then(async extension => {
|
|
if (!extension) {
|
|
return Promise.reject(new Error(`${notFound(version ? `${id}@${version}` : id)}\n${useId}`));
|
|
}
|
|
|
|
const manifest = await this.extensionGalleryService.getManifest(extension, CancellationToken.None);
|
|
const [installedExtension] = installed.filter(e => areSameExtensions(e.identifier, { id }));
|
|
if (installedExtension) {
|
|
if (extension.version === installedExtension.manifest.version) {
|
|
console.log(localize('alreadyInstalled', "Extension '{0}' is already installed.", version ? `${id}@${version}` : id));
|
|
return Promise.resolve(null);
|
|
}
|
|
if (!version && !force) {
|
|
console.log(localize('forceUpdate', "Extension '{0}' v{1} is already installed, but a newer version {2} is available in the marketplace. Use '--force' option to update to newer version.", id, installedExtension.manifest.version, extension.version));
|
|
return Promise.resolve(null);
|
|
}
|
|
console.log(localize('updateMessage', "Updating the extension '{0}' to the version {1}", id, extension.version));
|
|
}
|
|
await this.installFromGallery(id, extension);
|
|
return manifest;
|
|
}));
|
|
}
|
|
|
|
private async validate(manifest: IExtensionManifest, force: boolean): Promise<boolean> {
|
|
if (!manifest) {
|
|
throw new Error('Invalid vsix');
|
|
}
|
|
|
|
const extensionIdentifier = { id: getGalleryExtensionId(manifest.publisher, manifest.name) };
|
|
const installedExtensions = await this.extensionManagementService.getInstalled(ExtensionType.User);
|
|
const newer = installedExtensions.filter(local => areSameExtensions(extensionIdentifier, local.identifier) && semver.gt(local.manifest.version, manifest.version))[0];
|
|
|
|
if (newer && !force) {
|
|
console.log(localize('forceDowngrade', "A newer version of extension '{0}' v{1} is already installed. Use '--force' option to downgrade to older version.", newer.identifier.id, newer.manifest.version, manifest.version));
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
private async installFromGallery(id: string, extension: IGalleryExtension): Promise<void> {
|
|
console.log(localize('installing', "Installing extension '{0}' v{1}...", id, extension.version));
|
|
|
|
try {
|
|
await this.extensionManagementService.installFromGallery(extension);
|
|
console.log(localize('successInstall', "Extension '{0}' v{1} was successfully installed.", id, extension.version));
|
|
} catch (error) {
|
|
if (isPromiseCanceledError(error)) {
|
|
console.log(localize('cancelVsixInstall', "Cancelled installing extension '{0}'.", id));
|
|
} else {
|
|
throw error;
|
|
}
|
|
}
|
|
}
|
|
|
|
private async uninstallExtension(extensions: string[]): Promise<void> {
|
|
async function getExtensionId(extensionDescription: string): Promise<string> {
|
|
if (!/\.vsix$/i.test(extensionDescription)) {
|
|
return extensionDescription;
|
|
}
|
|
|
|
const zipPath = path.isAbsolute(extensionDescription) ? extensionDescription : path.join(process.cwd(), extensionDescription);
|
|
const manifest = await getManifest(zipPath);
|
|
return getId(manifest);
|
|
}
|
|
|
|
const uninstalledExtensions: ILocalExtension[] = [];
|
|
for (const extension of extensions) {
|
|
const id = await getExtensionId(extension);
|
|
const installed = await this.extensionManagementService.getInstalled(ExtensionType.User);
|
|
const [extensionToUninstall] = installed.filter(e => areSameExtensions(e.identifier, { id }));
|
|
if (!extensionToUninstall) {
|
|
return Promise.reject(new Error(`${notInstalled(id)}\n${useId}`));
|
|
}
|
|
console.log(localize('uninstalling', "Uninstalling {0}...", id));
|
|
await this.extensionManagementService.uninstall(extensionToUninstall, true);
|
|
uninstalledExtensions.push(extensionToUninstall);
|
|
console.log(localize('successUninstall', "Extension '{0}' was successfully uninstalled!", id));
|
|
}
|
|
|
|
if (uninstalledExtensions.some(e => isLanguagePackExtension(e.manifest))) {
|
|
await this.updateLocalizationsCache();
|
|
}
|
|
}
|
|
|
|
private async locateExtension(extensions: string[]): Promise<void> {
|
|
const installed = await this.extensionManagementService.getInstalled();
|
|
extensions.forEach(e => {
|
|
installed.forEach(i => {
|
|
if (i.identifier.id === e) {
|
|
if (i.location.scheme === Schemas.file) {
|
|
console.log(i.location.fsPath);
|
|
return;
|
|
}
|
|
}
|
|
});
|
|
});
|
|
}
|
|
|
|
private async updateLocalizationsCache(): Promise<void> {
|
|
const localizationService = this.instantiationService.createInstance(LocalizationsService);
|
|
await localizationService.update();
|
|
localizationService.dispose();
|
|
}
|
|
}
|
|
|
|
const eventPrefix = 'monacoworkbench';
|
|
|
|
export async function main(argv: ParsedArgs): Promise<void> {
|
|
const services = new ServiceCollection();
|
|
|
|
const environmentService = new EnvironmentService(argv, process.execPath);
|
|
const logService: ILogService = new SpdLogService('cli', environmentService.logsPath, getLogLevel(environmentService));
|
|
process.once('exit', () => logService.dispose());
|
|
logService.info('main', argv);
|
|
|
|
await Promise.all([environmentService.appSettingsHome.fsPath, environmentService.extensionsPath].map(p => mkdirp(p)));
|
|
|
|
const configurationService = new ConfigurationService(environmentService.settingsResource);
|
|
await configurationService.initialize();
|
|
|
|
services.set(IEnvironmentService, environmentService);
|
|
services.set(ILogService, logService);
|
|
services.set(IConfigurationService, configurationService);
|
|
services.set(IStateService, new SyncDescriptor(StateService));
|
|
|
|
const instantiationService: IInstantiationService = new InstantiationService(services);
|
|
|
|
return instantiationService.invokeFunction(accessor => {
|
|
const envService = accessor.get(IEnvironmentService);
|
|
const stateService = accessor.get(IStateService);
|
|
|
|
const { appRoot, extensionsPath, extensionDevelopmentLocationURI: extensionDevelopmentLocationURI, isBuilt, installSourcePath } = envService;
|
|
|
|
const services = new ServiceCollection();
|
|
services.set(IRequestService, new SyncDescriptor(RequestService));
|
|
services.set(IExtensionManagementService, new SyncDescriptor(ExtensionManagementService));
|
|
services.set(IExtensionGalleryService, new SyncDescriptor(ExtensionGalleryService));
|
|
|
|
const appenders: AppInsightsAppender[] = [];
|
|
if (isBuilt && !extensionDevelopmentLocationURI && !envService.args['disable-telemetry'] && product.enableTelemetry) {
|
|
|
|
if (product.aiConfig && product.aiConfig.asimovKey) {
|
|
appenders.push(new AppInsightsAppender(eventPrefix, null, product.aiConfig.asimovKey, logService));
|
|
}
|
|
|
|
const config: ITelemetryServiceConfig = {
|
|
appender: combinedAppender(...appenders),
|
|
commonProperties: resolveCommonProperties(product.commit, pkg.version, stateService.getItem('telemetry.machineId'), installSourcePath),
|
|
piiPaths: [appRoot, extensionsPath]
|
|
};
|
|
|
|
services.set(ITelemetryService, new SyncDescriptor(TelemetryService, [config]));
|
|
} else {
|
|
services.set(ITelemetryService, NullTelemetryService);
|
|
}
|
|
|
|
const instantiationService2 = instantiationService.createChild(services);
|
|
const main = instantiationService2.createInstance(Main);
|
|
|
|
return main.run(argv).then(() => {
|
|
// Dispose the AI adapter so that remaining data gets flushed.
|
|
return combinedAppender(...appenders).dispose();
|
|
});
|
|
});
|
|
} |