@sussudio/platform
Version:
Internal APIs for VS Code's service injection the base services.
235 lines (234 loc) • 9.58 kB
JavaScript
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
var __decorate =
(this && this.__decorate) ||
function (decorators, target, key, desc) {
var c = arguments.length,
r = c < 3 ? target : desc === null ? (desc = Object.getOwnPropertyDescriptor(target, key)) : desc,
d;
if (typeof Reflect === 'object' && typeof Reflect.decorate === 'function')
r = Reflect.decorate(decorators, target, key, desc);
else
for (var i = decorators.length - 1; i >= 0; i--)
if ((d = decorators[i])) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
return c > 3 && r && Object.defineProperty(target, key, r), r;
};
var __param =
(this && this.__param) ||
function (paramIndex, decorator) {
return function (target, key) {
decorator(target, key, paramIndex);
};
};
import { createDecorator } from '../../instantiation/common/instantiation.mjs';
import { Emitter } from '@sussudio/base/common/event.mjs';
import { Disposable } from '@sussudio/base/common/lifecycle.mjs';
import { IStorageService } from '../../storage/common/storage.mjs';
import { adoptToGalleryExtensionId, areSameExtensions, getExtensionId } from './extensionManagementUtil.mjs';
import { IProductService } from '../../product/common/productService.mjs';
import { distinct } from '@sussudio/base/common/arrays.mjs';
import { ILogService } from '../../log/common/log.mjs';
import { isString } from '@sussudio/base/common/types.mjs';
export const IExtensionStorageService = createDecorator('IExtensionStorageService');
const EXTENSION_KEYS_ID_VERSION_REGEX = /^extensionKeys\/([^.]+\..+)@(\d+\.\d+\.\d+(-.*)?)$/;
let ExtensionStorageService = class ExtensionStorageService extends Disposable {
storageService;
productService;
logService;
_serviceBrand;
static LARGE_STATE_WARNING_THRESHOLD = 512 * 1024;
static toKey(extension) {
return `extensionKeys/${adoptToGalleryExtensionId(extension.id)}@${extension.version}`;
}
static fromKey(key) {
const matches = EXTENSION_KEYS_ID_VERSION_REGEX.exec(key);
if (matches && matches[1]) {
return { id: matches[1], version: matches[2] };
}
return undefined;
}
/* TODO @sandy081: This has to be done across all profiles */
static async removeOutdatedExtensionVersions(extensionManagementService, storageService) {
const extensions = await extensionManagementService.getInstalled();
const extensionVersionsToRemove = [];
for (const [id, versions] of ExtensionStorageService.readAllExtensionsWithKeysForSync(storageService)) {
const extensionVersion = extensions.find((e) => areSameExtensions(e.identifier, { id }))?.manifest.version;
for (const version of versions) {
if (extensionVersion !== version) {
extensionVersionsToRemove.push(ExtensionStorageService.toKey({ id, version }));
}
}
}
for (const key of extensionVersionsToRemove) {
storageService.remove(key, 0 /* StorageScope.PROFILE */);
}
}
static readAllExtensionsWithKeysForSync(storageService) {
const extensionsWithKeysForSync = new Map();
const keys = storageService.keys(0 /* StorageScope.PROFILE */, 1 /* StorageTarget.MACHINE */);
for (const key of keys) {
const extensionIdWithVersion = ExtensionStorageService.fromKey(key);
if (extensionIdWithVersion) {
let versions = extensionsWithKeysForSync.get(extensionIdWithVersion.id.toLowerCase());
if (!versions) {
extensionsWithKeysForSync.set(extensionIdWithVersion.id.toLowerCase(), (versions = []));
}
versions.push(extensionIdWithVersion.version);
}
}
return extensionsWithKeysForSync;
}
_onDidChangeExtensionStorageToSync = this._register(new Emitter());
onDidChangeExtensionStorageToSync = this._onDidChangeExtensionStorageToSync.event;
extensionsWithKeysForSync;
constructor(storageService, productService, logService) {
super();
this.storageService = storageService;
this.productService = productService;
this.logService = logService;
this.extensionsWithKeysForSync = ExtensionStorageService.readAllExtensionsWithKeysForSync(storageService);
this._register(this.storageService.onDidChangeValue((e) => this.onDidChangeStorageValue(e)));
}
onDidChangeStorageValue(e) {
if (e.scope !== 0 /* StorageScope.PROFILE */) {
return;
}
// State of extension with keys for sync has changed
if (this.extensionsWithKeysForSync.has(e.key.toLowerCase())) {
this._onDidChangeExtensionStorageToSync.fire();
return;
}
// Keys for sync of an extension has changed
const extensionIdWithVersion = ExtensionStorageService.fromKey(e.key);
if (extensionIdWithVersion) {
if (this.storageService.get(e.key, 0 /* StorageScope.PROFILE */) === undefined) {
this.extensionsWithKeysForSync.delete(extensionIdWithVersion.id.toLowerCase());
} else {
let versions = this.extensionsWithKeysForSync.get(extensionIdWithVersion.id.toLowerCase());
if (!versions) {
this.extensionsWithKeysForSync.set(extensionIdWithVersion.id.toLowerCase(), (versions = []));
}
versions.push(extensionIdWithVersion.version);
this._onDidChangeExtensionStorageToSync.fire();
}
return;
}
}
getExtensionId(extension) {
if (isString(extension)) {
return extension;
}
const publisher = extension.manifest ? extension.manifest.publisher : extension.publisher;
const name = extension.manifest ? extension.manifest.name : extension.name;
return getExtensionId(publisher, name);
}
getExtensionState(extension, global) {
const extensionId = this.getExtensionId(extension);
const jsonValue = this.getExtensionStateRaw(extension, global);
if (jsonValue) {
try {
return JSON.parse(jsonValue);
} catch (error) {
// Do not fail this call but log it for diagnostics
// https://github.com/microsoft/vscode/issues/132777
this.logService.error(
`[mainThreadStorage] unexpected error parsing storage contents (extensionId: ${extensionId}, global: ${global}): ${error}`,
);
}
}
return undefined;
}
getExtensionStateRaw(extension, global) {
const extensionId = this.getExtensionId(extension);
const rawState = this.storageService.get(
extensionId,
global ? 0 /* StorageScope.PROFILE */ : 1 /* StorageScope.WORKSPACE */,
);
if (rawState && rawState?.length > ExtensionStorageService.LARGE_STATE_WARNING_THRESHOLD) {
this.logService.warn(
`[mainThreadStorage] large extension state detected (extensionId: ${extensionId}, global: ${global}): ${
rawState.length / 1024
}kb. Consider to use 'storageUri' or 'globalStorageUri' to store this data on disk instead.`,
);
}
return rawState;
}
setExtensionState(extension, state, global) {
const extensionId = this.getExtensionId(extension);
if (state === undefined) {
this.storageService.remove(extensionId, global ? 0 /* StorageScope.PROFILE */ : 1 /* StorageScope.WORKSPACE */);
} else {
this.storageService.store(
extensionId,
JSON.stringify(state),
global ? 0 /* StorageScope.PROFILE */ : 1 /* StorageScope.WORKSPACE */,
1 /* StorageTarget.MACHINE */,
);
}
}
setKeysForSync(extensionIdWithVersion, keys) {
this.storageService.store(
ExtensionStorageService.toKey(extensionIdWithVersion),
JSON.stringify(keys),
0 /* StorageScope.PROFILE */,
1 /* StorageTarget.MACHINE */,
);
}
getKeysForSync(extensionIdWithVersion) {
const extensionKeysForSyncFromProduct =
this.productService.extensionSyncedKeys?.[extensionIdWithVersion.id.toLowerCase()];
const extensionKeysForSyncFromStorageValue = this.storageService.get(
ExtensionStorageService.toKey(extensionIdWithVersion),
0 /* StorageScope.PROFILE */,
);
const extensionKeysForSyncFromStorage = extensionKeysForSyncFromStorageValue
? JSON.parse(extensionKeysForSyncFromStorageValue)
: undefined;
return extensionKeysForSyncFromStorage && extensionKeysForSyncFromProduct
? distinct([...extensionKeysForSyncFromStorage, ...extensionKeysForSyncFromProduct])
: extensionKeysForSyncFromStorage || extensionKeysForSyncFromProduct;
}
addToMigrationList(from, to) {
if (from !== to) {
// remove the duplicates
const migrationList = this.migrationList.filter((entry) => !entry.includes(from) && !entry.includes(to));
migrationList.push([from, to]);
this.migrationList = migrationList;
}
}
getSourceExtensionToMigrate(toExtensionId) {
const entry = this.migrationList.find(([, to]) => toExtensionId === to);
return entry ? entry[0] : undefined;
}
get migrationList() {
const value = this.storageService.get('extensionStorage.migrationList', -1 /* StorageScope.APPLICATION */, '[]');
try {
const migrationList = JSON.parse(value);
if (Array.isArray(migrationList)) {
return migrationList;
}
} catch (error) {
/* ignore */
}
return [];
}
set migrationList(migrationList) {
if (migrationList.length) {
this.storageService.store(
'extensionStorage.migrationList',
JSON.stringify(migrationList),
-1 /* StorageScope.APPLICATION */,
1 /* StorageTarget.MACHINE */,
);
} else {
this.storageService.remove('extensionStorage.migrationList', -1 /* StorageScope.APPLICATION */);
}
}
};
ExtensionStorageService = __decorate(
[__param(0, IStorageService), __param(1, IProductService), __param(2, ILogService)],
ExtensionStorageService,
);
export { ExtensionStorageService };