-
Notifications
You must be signed in to change notification settings - Fork 28.6k
/
extensionsWorkbenchService.ts
2883 lines (2578 loc) · 117 KB
/
extensionsWorkbenchService.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import * as nls from 'vs/nls';
import * as semver from 'vs/base/common/semver/semver';
import { Event, Emitter } from 'vs/base/common/event';
import { firstOrDefault, index } from 'vs/base/common/arrays';
import { CancelablePromise, Promises, ThrottledDelayer, createCancelablePromise } from 'vs/base/common/async';
import { CancellationError, isCancellationError } from 'vs/base/common/errors';
import { Disposable, MutableDisposable, toDisposable } from 'vs/base/common/lifecycle';
import { IPager, singlePagePager } from 'vs/base/common/paging';
import { ITelemetryService } from 'vs/platform/telemetry/common/telemetry';
import {
IExtensionGalleryService, ILocalExtension, IGalleryExtension, IQueryOptions,
InstallExtensionEvent, DidUninstallExtensionEvent, InstallOperation, WEB_EXTENSION_TAG, InstallExtensionResult,
IExtensionsControlManifest, IExtensionInfo, IExtensionQueryOptions, IDeprecationInfo, isTargetPlatformCompatible, InstallExtensionInfo, EXTENSION_IDENTIFIER_REGEX,
InstallOptions, IProductVersion,
UninstallExtensionInfo
} from 'vs/platform/extensionManagement/common/extensionManagement';
import { IWorkbenchExtensionEnablementService, EnablementState, IExtensionManagementServerService, IExtensionManagementServer, IWorkbenchExtensionManagementService, DefaultIconPath, IResourceExtension, extensionsConfigurationNodeBase } from 'vs/workbench/services/extensionManagement/common/extensionManagement';
import { getGalleryExtensionTelemetryData, getLocalExtensionTelemetryData, areSameExtensions, groupByExtension, getGalleryExtensionId } from 'vs/platform/extensionManagement/common/extensionManagementUtil';
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
import { IHostService } from 'vs/workbench/services/host/browser/host';
import { URI } from 'vs/base/common/uri';
import { IExtension, ExtensionState, IExtensionsWorkbenchService, AutoUpdateConfigurationKey, AutoCheckUpdatesConfigurationKey, HasOutdatedExtensionsContext, AutoUpdateConfigurationValue, InstallExtensionOptions, ExtensionRuntimeState, ExtensionRuntimeActionType, AutoRestartConfigurationKey } from 'vs/workbench/contrib/extensions/common/extensions';
import { IEditorService, SIDE_GROUP, ACTIVE_GROUP } from 'vs/workbench/services/editor/common/editorService';
import { IURLService, IURLHandler, IOpenURLOptions } from 'vs/platform/url/common/url';
import { ExtensionsInput, IExtensionEditorOptions } from 'vs/workbench/contrib/extensions/common/extensionsInput';
import { ILogService } from 'vs/platform/log/common/log';
import { IProgressOptions, IProgressService, ProgressLocation } from 'vs/platform/progress/common/progress';
import { INotificationService, NotificationPriority, Severity } from 'vs/platform/notification/common/notification';
import * as resources from 'vs/base/common/resources';
import { CancellationToken } from 'vs/base/common/cancellation';
import { IStorageService, StorageScope, StorageTarget } from 'vs/platform/storage/common/storage';
import { IFileService } from 'vs/platform/files/common/files';
import { IExtensionManifest, ExtensionType, IExtension as IPlatformExtension, TargetPlatform, ExtensionIdentifier, IExtensionIdentifier, IExtensionDescription, isApplicationScopedExtension } from 'vs/platform/extensions/common/extensions';
import { ILanguageService } from 'vs/editor/common/languages/language';
import { IProductService } from 'vs/platform/product/common/productService';
import { FileAccess } from 'vs/base/common/network';
import { IIgnoredExtensionsManagementService } from 'vs/platform/userDataSync/common/ignoredExtensions';
import { IUserDataAutoSyncService, IUserDataSyncEnablementService, SyncResource } from 'vs/platform/userDataSync/common/userDataSync';
import { IContextKey, IContextKeyService } from 'vs/platform/contextkey/common/contextkey';
import { isBoolean, isDefined, isString, isUndefined } from 'vs/base/common/types';
import { IExtensionManifestPropertiesService } from 'vs/workbench/services/extensions/common/extensionManifestPropertiesService';
import { IExtensionService, IExtensionsStatus, toExtension, toExtensionDescription } from 'vs/workbench/services/extensions/common/extensions';
import { isWeb, language } from 'vs/base/common/platform';
import { getLocale } from 'vs/platform/languagePacks/common/languagePacks';
import { ILocaleService } from 'vs/workbench/services/localization/common/locale';
import { TelemetryTrustedValue } from 'vs/platform/telemetry/common/telemetryUtils';
import { ILifecycleService, LifecyclePhase } from 'vs/workbench/services/lifecycle/common/lifecycle';
import { IUserDataProfileService } from 'vs/workbench/services/userDataProfile/common/userDataProfile';
import { mainWindow } from 'vs/base/browser/window';
import { IDialogService, IPromptButton } from 'vs/platform/dialogs/common/dialogs';
import { IUpdateService, StateType } from 'vs/platform/update/common/update';
import { isEngineValid } from 'vs/platform/extensions/common/extensionValidator';
import { IUriIdentityService } from 'vs/platform/uriIdentity/common/uriIdentity';
import { IWorkspaceContextService } from 'vs/platform/workspace/common/workspace';
import { ShowCurrentReleaseNotesActionId } from 'vs/workbench/contrib/update/common/update';
import { Registry } from 'vs/platform/registry/common/platform';
import { IConfigurationRegistry, Extensions as ConfigurationExtensions } from 'vs/platform/configuration/common/configurationRegistry';
interface IExtensionStateProvider<T> {
(extension: Extension): T;
}
interface InstalledExtensionsEvent {
readonly extensionIds: TelemetryTrustedValue<string>;
readonly count: number;
}
type ExtensionsLoadClassification = {
owner: 'digitarald';
comment: 'Helps to understand which extensions are the most actively used.';
readonly extensionIds: { classification: 'PublicNonPersonalData'; purpose: 'FeatureInsight'; comment: 'The list of extension ids that are installed.' };
readonly count: { classification: 'PublicNonPersonalData'; purpose: 'FeatureInsight'; comment: 'The number of extensions that are installed.' };
};
export class Extension implements IExtension {
public enablementState: EnablementState = EnablementState.EnabledGlobally;
private galleryResourcesCache = new Map<string, any>();
constructor(
private stateProvider: IExtensionStateProvider<ExtensionState>,
private runtimeStateProvider: IExtensionStateProvider<ExtensionRuntimeState | undefined>,
public readonly server: IExtensionManagementServer | undefined,
public local: ILocalExtension | undefined,
private _gallery: IGalleryExtension | undefined,
private readonly resourceExtensionInfo: { resourceExtension: IResourceExtension; isWorkspaceScoped: boolean } | undefined,
@IExtensionGalleryService private readonly galleryService: IExtensionGalleryService,
@ITelemetryService private readonly telemetryService: ITelemetryService,
@ILogService private readonly logService: ILogService,
@IFileService private readonly fileService: IFileService,
@IProductService private readonly productService: IProductService
) {
}
get resourceExtension(): IResourceExtension | undefined {
if (this.resourceExtensionInfo) {
return this.resourceExtensionInfo.resourceExtension;
}
if (this.local?.isWorkspaceScoped) {
return {
type: 'resource',
identifier: this.local.identifier,
location: this.local.location,
manifest: this.local.manifest,
changelogUri: this.local.changelogUrl,
readmeUri: this.local.readmeUrl,
};
}
return undefined;
}
get gallery(): IGalleryExtension | undefined {
return this._gallery;
}
set gallery(gallery: IGalleryExtension | undefined) {
this._gallery = gallery;
this.galleryResourcesCache.clear();
}
get type(): ExtensionType {
return this.local ? this.local.type : ExtensionType.User;
}
get isBuiltin(): boolean {
return this.local ? this.local.isBuiltin : false;
}
get isWorkspaceScoped(): boolean {
if (this.local) {
return this.local.isWorkspaceScoped;
}
if (this.resourceExtensionInfo) {
return this.resourceExtensionInfo.isWorkspaceScoped;
}
return false;
}
get name(): string {
if (this.gallery) {
return this.gallery.name;
}
return this.getManifestFromLocalOrResource()?.name ?? '';
}
get displayName(): string {
if (this.gallery) {
return this.gallery.displayName || this.gallery.name;
}
return this.getManifestFromLocalOrResource()?.displayName ?? this.name;
}
get identifier(): IExtensionIdentifier {
if (this.gallery) {
return this.gallery.identifier;
}
if (this.resourceExtension) {
return this.resourceExtension.identifier;
}
return this.local!.identifier;
}
get uuid(): string | undefined {
return this.gallery ? this.gallery.identifier.uuid : this.local?.identifier.uuid;
}
get publisher(): string {
if (this.gallery) {
return this.gallery.publisher;
}
return this.getManifestFromLocalOrResource()?.publisher ?? '';
}
get publisherDisplayName(): string {
if (this.gallery) {
return this.gallery.publisherDisplayName || this.gallery.publisher;
}
if (this.local?.publisherDisplayName) {
return this.local.publisherDisplayName;
}
return this.publisher;
}
get publisherUrl(): URI | undefined {
if (!this.productService.extensionsGallery || !this.gallery) {
return undefined;
}
return resources.joinPath(URI.parse(this.productService.extensionsGallery.publisherUrl), this.publisher);
}
get publisherDomain(): { link: string; verified: boolean } | undefined {
return this.gallery?.publisherDomain;
}
get publisherSponsorLink(): URI | undefined {
return this.gallery?.publisherSponsorLink ? URI.parse(this.gallery.publisherSponsorLink) : undefined;
}
get version(): string {
return this.local ? this.local.manifest.version : this.latestVersion;
}
get pinned(): boolean {
return !!this.local?.pinned;
}
get latestVersion(): string {
return this.gallery ? this.gallery.version : this.getManifestFromLocalOrResource()?.version ?? '';
}
get description(): string {
return this.gallery ? this.gallery.description : this.getManifestFromLocalOrResource()?.description ?? '';
}
get url(): string | undefined {
if (!this.productService.extensionsGallery || !this.gallery) {
return undefined;
}
return `${this.productService.extensionsGallery.itemUrl}?itemName=${this.publisher}.${this.name}`;
}
get iconUrl(): string {
return this.galleryIconUrl || this.resourceExtensionIconUrl || this.localIconUrl || this.defaultIconUrl;
}
get iconUrlFallback(): string {
return this.galleryIconUrlFallback || this.resourceExtensionIconUrl || this.localIconUrl || this.defaultIconUrl;
}
private get localIconUrl(): string | null {
if (this.local && this.local.manifest.icon) {
return FileAccess.uriToBrowserUri(resources.joinPath(this.local.location, this.local.manifest.icon)).toString(true);
}
return null;
}
private get resourceExtensionIconUrl(): string | null {
if (this.resourceExtension?.manifest.icon) {
return FileAccess.uriToBrowserUri(resources.joinPath(this.resourceExtension.location, this.resourceExtension.manifest.icon)).toString(true);
}
return null;
}
private get galleryIconUrl(): string | null {
return this.gallery?.assets.icon ? this.gallery.assets.icon.uri : null;
}
private get galleryIconUrlFallback(): string | null {
return this.gallery?.assets.icon ? this.gallery.assets.icon.fallbackUri : null;
}
private get defaultIconUrl(): string {
if (this.type === ExtensionType.System && this.local) {
if (this.local.manifest && this.local.manifest.contributes) {
if (Array.isArray(this.local.manifest.contributes.themes) && this.local.manifest.contributes.themes.length) {
return FileAccess.asBrowserUri('vs/workbench/contrib/extensions/browser/media/theme-icon.png').toString(true);
}
if (Array.isArray(this.local.manifest.contributes.grammars) && this.local.manifest.contributes.grammars.length) {
return FileAccess.asBrowserUri('vs/workbench/contrib/extensions/browser/media/language-icon.svg').toString(true);
}
}
}
return DefaultIconPath;
}
get repository(): string | undefined {
return this.gallery && this.gallery.assets.repository ? this.gallery.assets.repository.uri : undefined;
}
get licenseUrl(): string | undefined {
return this.gallery && this.gallery.assets.license ? this.gallery.assets.license.uri : undefined;
}
get supportUrl(): string | undefined {
return this.gallery && this.gallery.supportLink ? this.gallery.supportLink : undefined;
}
get state(): ExtensionState {
return this.stateProvider(this);
}
public isMalicious: boolean = false;
public deprecationInfo: IDeprecationInfo | undefined;
get installCount(): number | undefined {
return this.gallery ? this.gallery.installCount : undefined;
}
get rating(): number | undefined {
return this.gallery ? this.gallery.rating : undefined;
}
get ratingCount(): number | undefined {
return this.gallery ? this.gallery.ratingCount : undefined;
}
get outdated(): boolean {
try {
if (!this.gallery || !this.local) {
return false;
}
// Do not allow updating system extensions in stable
if (this.type === ExtensionType.System && this.productService.quality === 'stable') {
return false;
}
if (!this.local.preRelease && this.gallery.properties.isPreReleaseVersion) {
return false;
}
if (semver.gt(this.latestVersion, this.version)) {
return true;
}
if (this.outdatedTargetPlatform) {
return true;
}
} catch (error) {
/* Ignore */
}
return false;
}
get outdatedTargetPlatform(): boolean {
return !!this.local && !!this.gallery
&& ![TargetPlatform.UNDEFINED, TargetPlatform.WEB].includes(this.local.targetPlatform)
&& this.gallery.properties.targetPlatform !== TargetPlatform.WEB
&& this.local.targetPlatform !== this.gallery.properties.targetPlatform
&& semver.eq(this.latestVersion, this.version);
}
get runtimeState(): ExtensionRuntimeState | undefined {
return this.runtimeStateProvider(this);
}
get telemetryData(): any {
const { local, gallery } = this;
if (gallery) {
return getGalleryExtensionTelemetryData(gallery);
} else if (local) {
return getLocalExtensionTelemetryData(local);
} else {
return {};
}
}
get preview(): boolean {
return this.local?.manifest.preview ?? this.gallery?.preview ?? false;
}
get preRelease(): boolean {
return !!this.local?.preRelease;
}
get isPreReleaseVersion(): boolean {
if (this.local) {
return this.local.isPreReleaseVersion;
}
return !!this.gallery?.properties.isPreReleaseVersion;
}
private _extensionEnabledWithPreRelease: boolean | undefined;
get hasPreReleaseVersion(): boolean {
return !!this.gallery?.hasPreReleaseVersion || !!this.local?.hasPreReleaseVersion || !!this._extensionEnabledWithPreRelease;
}
get hasReleaseVersion(): boolean {
return !!this.resourceExtension || !!this.gallery?.hasReleaseVersion;
}
private getLocal(): ILocalExtension | undefined {
return this.local && !this.outdated ? this.local : undefined;
}
async getManifest(token: CancellationToken): Promise<IExtensionManifest | null> {
const local = this.getLocal();
if (local) {
return local.manifest;
}
if (this.gallery) {
return this.getGalleryManifest(token);
}
if (this.resourceExtension) {
return this.resourceExtension.manifest;
}
return null;
}
async getGalleryManifest(token: CancellationToken = CancellationToken.None): Promise<IExtensionManifest | null> {
if (this.gallery) {
let cache = this.galleryResourcesCache.get('manifest');
if (!cache) {
if (this.gallery.assets.manifest) {
this.galleryResourcesCache.set('manifest', cache = this.galleryService.getManifest(this.gallery, token)
.catch(e => {
this.galleryResourcesCache.delete('manifest');
throw e;
}));
} else {
this.logService.error(nls.localize('Manifest is not found', "Manifest is not found"), this.identifier.id);
}
}
return cache;
}
return null;
}
hasReadme(): boolean {
if (this.local && this.local.readmeUrl) {
return true;
}
if (this.gallery && this.gallery.assets.readme) {
return true;
}
if (this.resourceExtension?.readmeUri) {
return true;
}
return this.type === ExtensionType.System;
}
async getReadme(token: CancellationToken): Promise<string> {
const local = this.getLocal();
if (local?.readmeUrl) {
const content = await this.fileService.readFile(local.readmeUrl);
return content.value.toString();
}
if (this.gallery) {
if (this.gallery.assets.readme) {
return this.galleryService.getReadme(this.gallery, token);
}
this.telemetryService.publicLog('extensions:NotFoundReadMe', this.telemetryData);
}
if (this.type === ExtensionType.System) {
return Promise.resolve(`# ${this.displayName || this.name}
**Notice:** This extension is bundled with Visual Studio Code. It can be disabled but not uninstalled.
## Features
${this.description}
`);
}
if (this.resourceExtension?.readmeUri) {
const content = await this.fileService.readFile(this.resourceExtension?.readmeUri);
return content.value.toString();
}
return Promise.reject(new Error('not available'));
}
hasChangelog(): boolean {
if (this.local && this.local.changelogUrl) {
return true;
}
if (this.gallery && this.gallery.assets.changelog) {
return true;
}
return this.type === ExtensionType.System;
}
async getChangelog(token: CancellationToken): Promise<string> {
const local = this.getLocal();
if (local?.changelogUrl) {
const content = await this.fileService.readFile(local.changelogUrl);
return content.value.toString();
}
if (this.gallery?.assets.changelog) {
return this.galleryService.getChangelog(this.gallery, token);
}
if (this.type === ExtensionType.System) {
return Promise.resolve(`Please check the [VS Code Release Notes](command:${ShowCurrentReleaseNotesActionId}) for changes to the built-in extensions.`);
}
return Promise.reject(new Error('not available'));
}
get categories(): readonly string[] {
const { local, gallery, resourceExtension } = this;
if (local && local.manifest.categories && !this.outdated) {
return local.manifest.categories;
}
if (gallery) {
return gallery.categories;
}
if (resourceExtension) {
return resourceExtension.manifest.categories ?? [];
}
return [];
}
get tags(): readonly string[] {
const { gallery } = this;
if (gallery) {
return gallery.tags.filter(tag => !tag.startsWith('_'));
}
return [];
}
get dependencies(): string[] {
const { local, gallery, resourceExtension } = this;
if (local && local.manifest.extensionDependencies && !this.outdated) {
return local.manifest.extensionDependencies;
}
if (gallery) {
return gallery.properties.dependencies || [];
}
if (resourceExtension) {
return resourceExtension.manifest.extensionDependencies || [];
}
return [];
}
get extensionPack(): string[] {
const { local, gallery, resourceExtension } = this;
if (local && local.manifest.extensionPack && !this.outdated) {
return local.manifest.extensionPack;
}
if (gallery) {
return gallery.properties.extensionPack || [];
}
if (resourceExtension) {
return resourceExtension.manifest.extensionPack || [];
}
return [];
}
setExtensionsControlManifest(extensionsControlManifest: IExtensionsControlManifest): void {
this.isMalicious = extensionsControlManifest.malicious.some(identifier => areSameExtensions(this.identifier, identifier));
this.deprecationInfo = extensionsControlManifest.deprecated ? extensionsControlManifest.deprecated[this.identifier.id.toLowerCase()] : undefined;
this._extensionEnabledWithPreRelease = extensionsControlManifest?.extensionsEnabledWithPreRelease?.includes(this.identifier.id.toLowerCase());
}
private getManifestFromLocalOrResource(): IExtensionManifest | null {
if (this.local) {
return this.local.manifest;
}
if (this.resourceExtension) {
return this.resourceExtension.manifest;
}
return null;
}
}
const EXTENSIONS_AUTO_UPDATE_KEY = 'extensions.autoUpdate';
const EXTENSIONS_DONOT_AUTO_UPDATE_KEY = 'extensions.donotAutoUpdate';
class Extensions extends Disposable {
private readonly _onChange = this._register(new Emitter<{ extension: Extension; operation?: InstallOperation } | undefined>());
get onChange() { return this._onChange.event; }
private readonly _onReset = this._register(new Emitter<void>());
get onReset() { return this._onReset.event; }
private installing: Extension[] = [];
private uninstalling: Extension[] = [];
private installed: Extension[] = [];
constructor(
readonly server: IExtensionManagementServer,
private readonly stateProvider: IExtensionStateProvider<ExtensionState>,
private readonly runtimeStateProvider: IExtensionStateProvider<ExtensionRuntimeState | undefined>,
private readonly isWorkspaceServer: boolean,
@IExtensionGalleryService private readonly galleryService: IExtensionGalleryService,
@IWorkbenchExtensionEnablementService private readonly extensionEnablementService: IWorkbenchExtensionEnablementService,
@IWorkbenchExtensionManagementService private readonly workbenchExtensionManagementService: IWorkbenchExtensionManagementService,
@IUserDataProfileService private readonly userDataProfileService: IUserDataProfileService,
@ITelemetryService private readonly telemetryService: ITelemetryService,
@IInstantiationService private readonly instantiationService: IInstantiationService
) {
super();
this._register(server.extensionManagementService.onInstallExtension(e => this.onInstallExtension(e)));
this._register(server.extensionManagementService.onDidInstallExtensions(e => this.onDidInstallExtensions(e)));
this._register(server.extensionManagementService.onUninstallExtension(e => this.onUninstallExtension(e.identifier)));
this._register(server.extensionManagementService.onDidUninstallExtension(e => this.onDidUninstallExtension(e)));
this._register(server.extensionManagementService.onDidUpdateExtensionMetadata(e => this.onDidUpdateExtensionMetadata(e.local)));
this._register(server.extensionManagementService.onDidChangeProfile(() => this.reset()));
this._register(extensionEnablementService.onEnablementChanged(e => this.onEnablementChanged(e)));
this._register(Event.any(this.onChange, this.onReset)(() => this._local = undefined));
if (this.isWorkspaceServer) {
this._register(this.workbenchExtensionManagementService.onInstallExtension(e => {
if (e.workspaceScoped) {
this.onInstallExtension(e);
}
}));
this._register(this.workbenchExtensionManagementService.onDidInstallExtensions(e => {
const result = e.filter(e => e.workspaceScoped);
if (result.length) {
this.onDidInstallExtensions(result);
}
}));
this._register(this.workbenchExtensionManagementService.onUninstallExtension(e => {
if (e.workspaceScoped) {
this.onUninstallExtension(e.identifier);
}
}));
this._register(this.workbenchExtensionManagementService.onDidUninstallExtension(e => {
if (e.workspaceScoped) {
this.onDidUninstallExtension(e);
}
}));
}
}
private _local: IExtension[] | undefined;
get local(): IExtension[] {
if (!this._local) {
this._local = [];
for (const extension of this.installed) {
this._local.push(extension);
}
for (const extension of this.installing) {
if (!this.installed.some(installed => areSameExtensions(installed.identifier, extension.identifier))) {
this._local.push(extension);
}
}
}
return this._local;
}
async queryInstalled(productVersion: IProductVersion): Promise<IExtension[]> {
await this.fetchInstalledExtensions(productVersion);
this._onChange.fire(undefined);
return this.local;
}
async syncInstalledExtensionsWithGallery(galleryExtensions: IGalleryExtension[], productVersion: IProductVersion): Promise<void> {
const extensions = await this.mapInstalledExtensionWithCompatibleGalleryExtension(galleryExtensions, productVersion);
for (const [extension, gallery] of extensions) {
// update metadata of the extension if it does not exist
if (extension.local && !extension.local.identifier.uuid) {
extension.local = await this.updateMetadata(extension.local, gallery);
}
if (!extension.gallery || extension.gallery.version !== gallery.version || extension.gallery.properties.targetPlatform !== gallery.properties.targetPlatform) {
extension.gallery = gallery;
this._onChange.fire({ extension });
}
}
}
private async mapInstalledExtensionWithCompatibleGalleryExtension(galleryExtensions: IGalleryExtension[], productVersion: IProductVersion): Promise<[Extension, IGalleryExtension][]> {
const mappedExtensions = this.mapInstalledExtensionWithGalleryExtension(galleryExtensions);
const targetPlatform = await this.server.extensionManagementService.getTargetPlatform();
const compatibleGalleryExtensions: IGalleryExtension[] = [];
const compatibleGalleryExtensionsToFetch: IExtensionInfo[] = [];
await Promise.allSettled(mappedExtensions.map(async ([extension, gallery]) => {
if (extension.local) {
if (await this.galleryService.isExtensionCompatible(gallery, extension.local.preRelease, targetPlatform, productVersion)) {
compatibleGalleryExtensions.push(gallery);
} else {
compatibleGalleryExtensionsToFetch.push({ ...extension.local.identifier, preRelease: extension.local.preRelease });
}
}
}));
if (compatibleGalleryExtensionsToFetch.length) {
const result = await this.galleryService.getExtensions(compatibleGalleryExtensionsToFetch, { targetPlatform, compatible: true, queryAllVersions: true, productVersion }, CancellationToken.None);
compatibleGalleryExtensions.push(...result);
}
return this.mapInstalledExtensionWithGalleryExtension(compatibleGalleryExtensions);
}
private mapInstalledExtensionWithGalleryExtension(galleryExtensions: IGalleryExtension[]): [Extension, IGalleryExtension][] {
const mappedExtensions: [Extension, IGalleryExtension][] = [];
const byUUID = new Map<string, IGalleryExtension>(), byID = new Map<string, IGalleryExtension>();
for (const gallery of galleryExtensions) {
byUUID.set(gallery.identifier.uuid, gallery);
byID.set(gallery.identifier.id.toLowerCase(), gallery);
}
for (const installed of this.installed) {
if (installed.uuid) {
const gallery = byUUID.get(installed.uuid);
if (gallery) {
mappedExtensions.push([installed, gallery]);
continue;
}
}
if (installed.local?.source !== 'resource') {
const gallery = byID.get(installed.identifier.id.toLowerCase());
if (gallery) {
mappedExtensions.push([installed, gallery]);
}
}
}
return mappedExtensions;
}
private async updateMetadata(localExtension: ILocalExtension, gallery: IGalleryExtension): Promise<ILocalExtension> {
let isPreReleaseVersion = false;
if (localExtension.manifest.version !== gallery.version) {
type GalleryServiceMatchInstalledExtensionClassification = {
owner: 'sandy081';
comment: 'Report when a request is made to update metadata of an installed extension';
};
this.telemetryService.publicLog2<{}, GalleryServiceMatchInstalledExtensionClassification>('galleryService:updateMetadata');
const galleryWithLocalVersion: IGalleryExtension | undefined = (await this.galleryService.getExtensions([{ ...localExtension.identifier, version: localExtension.manifest.version }], CancellationToken.None))[0];
isPreReleaseVersion = !!galleryWithLocalVersion?.properties?.isPreReleaseVersion;
}
return this.server.extensionManagementService.updateMetadata(localExtension, { id: gallery.identifier.uuid, publisherDisplayName: gallery.publisherDisplayName, publisherId: gallery.publisherId, isPreReleaseVersion }, this.userDataProfileService.currentProfile.extensionsResource);
}
canInstall(galleryExtension: IGalleryExtension): Promise<boolean> {
return this.server.extensionManagementService.canInstall(galleryExtension);
}
private onInstallExtension(event: InstallExtensionEvent): void {
const { source } = event;
if (source && !URI.isUri(source)) {
const extension = this.installed.find(e => areSameExtensions(e.identifier, source.identifier))
?? this.instantiationService.createInstance(Extension, this.stateProvider, this.runtimeStateProvider, this.server, undefined, source, undefined);
this.installing.push(extension);
this._onChange.fire({ extension });
}
}
private async fetchInstalledExtensions(productVersion?: IProductVersion): Promise<void> {
const extensionsControlManifest = await this.server.extensionManagementService.getExtensionsControlManifest();
const all = await this.server.extensionManagementService.getInstalled(undefined, undefined, productVersion);
if (this.isWorkspaceServer) {
all.push(...await this.workbenchExtensionManagementService.getInstalledWorkspaceExtensions(true));
}
// dedup workspace, user and system extensions by giving priority to workspace first and then to user extension.
const installed = groupByExtension(all, r => r.identifier).reduce((result, extensions) => {
if (extensions.length === 1) {
result.push(extensions[0]);
} else {
let workspaceExtension: ILocalExtension | undefined,
userExtension: ILocalExtension | undefined,
systemExtension: ILocalExtension | undefined;
for (const extension of extensions) {
if (extension.isWorkspaceScoped) {
workspaceExtension = extension;
} else if (extension.type === ExtensionType.User) {
userExtension = extension;
} else {
systemExtension = extension;
}
}
const extension = workspaceExtension ?? userExtension ?? systemExtension;
if (extension) {
result.push(extension);
}
}
return result;
}, []);
const byId = index(this.installed, e => e.local ? e.local.identifier.id : e.identifier.id);
this.installed = installed.map(local => {
const extension = byId[local.identifier.id] || this.instantiationService.createInstance(Extension, this.stateProvider, this.runtimeStateProvider, this.server, local, undefined, undefined);
extension.local = local;
extension.enablementState = this.extensionEnablementService.getEnablementState(local);
extension.setExtensionsControlManifest(extensionsControlManifest);
return extension;
});
}
private async reset(): Promise<void> {
this.installed = [];
this.installing = [];
this.uninstalling = [];
await this.fetchInstalledExtensions();
this._onReset.fire();
}
private async onDidInstallExtensions(results: readonly InstallExtensionResult[]): Promise<void> {
for (const event of results) {
const { local, source } = event;
const gallery = source && !URI.isUri(source) ? source : undefined;
const location = source && URI.isUri(source) ? source : undefined;
const installingExtension = gallery ? this.installing.filter(e => areSameExtensions(e.identifier, gallery.identifier))[0] : null;
this.installing = installingExtension ? this.installing.filter(e => e !== installingExtension) : this.installing;
let extension: Extension | undefined = installingExtension ? installingExtension
: (location || local) ? this.instantiationService.createInstance(Extension, this.stateProvider, this.runtimeStateProvider, this.server, local, undefined, undefined)
: undefined;
if (extension) {
if (local) {
const installed = this.installed.filter(e => areSameExtensions(e.identifier, extension!.identifier))[0];
if (installed) {
extension = installed;
} else {
this.installed.push(extension);
}
extension.local = local;
if (!extension.gallery) {
extension.gallery = gallery;
}
extension.setExtensionsControlManifest(await this.server.extensionManagementService.getExtensionsControlManifest());
extension.enablementState = this.extensionEnablementService.getEnablementState(local);
}
}
this._onChange.fire(!local || !extension ? undefined : { extension, operation: event.operation });
if (extension && extension.local && !extension.gallery && extension.local.source !== 'resource') {
await this.syncInstalledExtensionWithGallery(extension);
}
}
}
private async onDidUpdateExtensionMetadata(local: ILocalExtension): Promise<void> {
const extension = this.installed.find(e => areSameExtensions(e.identifier, local.identifier));
if (extension?.local) {
const hasChanged = extension.local.pinned !== local.pinned
|| extension.local.preRelease !== local.preRelease;
extension.local = local;
if (hasChanged) {
this._onChange.fire({ extension });
}
}
}
private async syncInstalledExtensionWithGallery(extension: Extension): Promise<void> {
if (!this.galleryService.isEnabled()) {
return;
}
type GalleryServiceMatchInstalledExtensionClassification = {
owner: 'sandy081';
comment: 'Report when a request is made to match installed extension with gallery';
};
this.telemetryService.publicLog2<{}, GalleryServiceMatchInstalledExtensionClassification>('galleryService:matchInstalledExtension');
const [compatible] = await this.galleryService.getExtensions([{ ...extension.identifier, preRelease: extension.local?.preRelease }], { compatible: true, targetPlatform: await this.server.extensionManagementService.getTargetPlatform() }, CancellationToken.None);
if (compatible) {
extension.gallery = compatible;
this._onChange.fire({ extension });
}
}
private onUninstallExtension(identifier: IExtensionIdentifier): void {
const extension = this.installed.filter(e => areSameExtensions(e.identifier, identifier))[0];
if (extension) {
const uninstalling = this.uninstalling.filter(e => areSameExtensions(e.identifier, identifier))[0] || extension;
this.uninstalling = [uninstalling, ...this.uninstalling.filter(e => !areSameExtensions(e.identifier, identifier))];
this._onChange.fire(uninstalling ? { extension: uninstalling } : undefined);
}
}
private onDidUninstallExtension({ identifier, error }: DidUninstallExtensionEvent): void {
const uninstalled = this.uninstalling.find(e => areSameExtensions(e.identifier, identifier)) || this.installed.find(e => areSameExtensions(e.identifier, identifier));
this.uninstalling = this.uninstalling.filter(e => !areSameExtensions(e.identifier, identifier));
if (!error) {
this.installed = this.installed.filter(e => !areSameExtensions(e.identifier, identifier));
}
if (uninstalled) {
this._onChange.fire({ extension: uninstalled });
}
}
private onEnablementChanged(platformExtensions: readonly IPlatformExtension[]) {
const extensions = this.local.filter(e => platformExtensions.some(p => areSameExtensions(e.identifier, p.identifier)));
for (const extension of extensions) {
if (extension.local) {
const enablementState = this.extensionEnablementService.getEnablementState(extension.local);
if (enablementState !== extension.enablementState) {
(extension as Extension).enablementState = enablementState;
this._onChange.fire({ extension: extension as Extension });
}
}
}
}
getExtensionState(extension: Extension): ExtensionState {
if (extension.gallery && this.installing.some(e => !!e.gallery && areSameExtensions(e.gallery.identifier, extension.gallery!.identifier))) {
return ExtensionState.Installing;
}
if (this.uninstalling.some(e => areSameExtensions(e.identifier, extension.identifier))) {
return ExtensionState.Uninstalling;
}
const local = this.installed.filter(e => e === extension || (e.gallery && extension.gallery && areSameExtensions(e.gallery.identifier, extension.gallery.identifier)))[0];
return local ? ExtensionState.Installed : ExtensionState.Uninstalled;
}
}
export class ExtensionsWorkbenchService extends Disposable implements IExtensionsWorkbenchService, IURLHandler {
private static readonly UpdatesCheckInterval = 1000 * 60 * 60 * 12; // 12 hours
declare readonly _serviceBrand: undefined;
private hasOutdatedExtensionsContextKey: IContextKey<boolean>;
private readonly localExtensions: Extensions | null = null;
private readonly remoteExtensions: Extensions | null = null;
private readonly webExtensions: Extensions | null = null;
private readonly extensionsServers: Extensions[] = [];
private updatesCheckDelayer: ThrottledDelayer<void>;
private autoUpdateDelayer: ThrottledDelayer<void>;
private readonly _onChange: Emitter<IExtension | undefined> = new Emitter<IExtension | undefined>();
get onChange(): Event<IExtension | undefined> { return this._onChange.event; }
private readonly _onReset = new Emitter<void>();
get onReset() { return this._onReset.event; }
readonly preferPreReleases = this.productService.quality !== 'stable';
private installing: IExtension[] = [];
private tasksInProgress: CancelablePromise<any>[] = [];
readonly whenInitialized: Promise<void>;
constructor(
@IInstantiationService private readonly instantiationService: IInstantiationService,
@IEditorService private readonly editorService: IEditorService,
@IWorkbenchExtensionManagementService private readonly extensionManagementService: IWorkbenchExtensionManagementService,
@IExtensionGalleryService private readonly galleryService: IExtensionGalleryService,
@IConfigurationService private readonly configurationService: IConfigurationService,
@ITelemetryService private readonly telemetryService: ITelemetryService,
@INotificationService private readonly notificationService: INotificationService,
@IURLService urlService: IURLService,
@IWorkbenchExtensionEnablementService private readonly extensionEnablementService: IWorkbenchExtensionEnablementService,
@IHostService private readonly hostService: IHostService,
@IProgressService private readonly progressService: IProgressService,
@IExtensionManagementServerService private readonly extensionManagementServerService: IExtensionManagementServerService,
@ILanguageService private readonly languageService: ILanguageService,
@IIgnoredExtensionsManagementService private readonly extensionsSyncManagementService: IIgnoredExtensionsManagementService,
@IUserDataAutoSyncService private readonly userDataAutoSyncService: IUserDataAutoSyncService,
@IProductService private readonly productService: IProductService,
@IContextKeyService contextKeyService: IContextKeyService,
@IExtensionManifestPropertiesService private readonly extensionManifestPropertiesService: IExtensionManifestPropertiesService,
@ILogService private readonly logService: ILogService,
@IExtensionService private readonly extensionService: IExtensionService,
@ILocaleService private readonly localeService: ILocaleService,
@ILifecycleService private readonly lifecycleService: ILifecycleService,
@IFileService private readonly fileService: IFileService,
@IUserDataProfileService private readonly userDataProfileService: IUserDataProfileService,
@IStorageService private readonly storageService: IStorageService,
@IDialogService private readonly dialogService: IDialogService,
@IUserDataSyncEnablementService private readonly userDataSyncEnablementService: IUserDataSyncEnablementService,
@IUpdateService private readonly updateService: IUpdateService,
@IUriIdentityService private readonly uriIdentityService: IUriIdentityService,
@IWorkspaceContextService private readonly workspaceContextService: IWorkspaceContextService,
) {
super();
const preferPreReleasesValue = configurationService.getValue('_extensions.preferPreReleases');
if (!isUndefined(preferPreReleasesValue)) {
this.preferPreReleases = !!preferPreReleasesValue;
}
this.hasOutdatedExtensionsContextKey = HasOutdatedExtensionsContext.bindTo(contextKeyService);
if (extensionManagementServerService.localExtensionManagementServer) {
this.localExtensions = this._register(instantiationService.createInstance(Extensions,
extensionManagementServerService.localExtensionManagementServer,
ext => this.getExtensionState(ext),
ext => this.getRuntimeState(ext),
!extensionManagementServerService.remoteExtensionManagementServer
));
this._register(this.localExtensions.onChange(e => this.onDidChangeExtensions(e?.extension)));
this._register(this.localExtensions.onReset(e => this.reset()));
this.extensionsServers.push(this.localExtensions);
}
if (extensionManagementServerService.remoteExtensionManagementServer) {
this.remoteExtensions = this._register(instantiationService.createInstance(Extensions,
extensionManagementServerService.remoteExtensionManagementServer,
ext => this.getExtensionState(ext),
ext => this.getRuntimeState(ext),
true
));
this._register(this.remoteExtensions.onChange(e => this.onDidChangeExtensions(e?.extension)));
this._register(this.remoteExtensions.onReset(e => this.reset()));
this.extensionsServers.push(this.remoteExtensions);
}
if (extensionManagementServerService.webExtensionManagementServer) {
this.webExtensions = this._register(instantiationService.createInstance(Extensions,
extensionManagementServerService.webExtensionManagementServer,
ext => this.getExtensionState(ext),
ext => this.getRuntimeState(ext),
!(extensionManagementServerService.remoteExtensionManagementServer || extensionManagementServerService.localExtensionManagementServer)
));
this._register(this.webExtensions.onChange(e => this.onDidChangeExtensions(e?.extension)));
this._register(this.webExtensions.onReset(e => this.reset()));
this.extensionsServers.push(this.webExtensions);
}
this.updatesCheckDelayer = new ThrottledDelayer<void>(ExtensionsWorkbenchService.UpdatesCheckInterval);
this.autoUpdateDelayer = new ThrottledDelayer<void>(1000);
this._register(toDisposable(() => {
this.updatesCheckDelayer.cancel();
this.autoUpdateDelayer.cancel();
}));
urlService.registerHandler(this);
if (this.productService.quality !== 'stable') {