forked from facebookarchive/atom-ide-ui
-
Notifications
You must be signed in to change notification settings - Fork 0
/
FeatureLoader.js
610 lines (547 loc) · 20.3 KB
/
FeatureLoader.js
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
/**
* Copyright (c) 2017-present, Facebook, Inc.
* All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree. An additional grant
* of patent rights can be found in the PATENTS file in the same directory.
*
* @flow
* @format
*/
/* global localStorage */
import invariant from 'assert';
import idx from 'idx';
import {observableFromSubscribeFunction} from 'nuclide-commons/event';
import UniversalDisposable from 'nuclide-commons/UniversalDisposable';
import nullthrows from 'nullthrows';
import activateExperimentalPackages from './experimental-packages/activatePackages';
import nuclideConfig from './nuclide-config';
import featureConfig from './feature-config';
import path from 'path'; // eslint-disable-line nuclide-internal/prefer-nuclide-uri
import {MultiMap, setIntersect, setUnion} from 'nuclide-commons/collection';
import {Observable} from 'rxjs';
type FeaturePkg = {
name: string,
atomConfig?: Object,
consumedServices?: Object,
description?: string,
displayName?: string,
nuclide?: {
config?: Object,
},
providedServices?: Object,
featureGroups?: Array<string>,
};
export type Feature = {
path: string,
pkg: FeaturePkg,
};
type FeatureLoaderParams = {
path: string,
features: Array<Feature>,
featureGroups?: {
[string]: Array<string>,
},
};
type UseFeatureRules = {
[name: string]: 'always' | 'never' | 'default',
};
const ALWAYS_ENABLED = 'always';
const NEVER_ENABLED = 'never';
const DEFAULT = 'default';
const {devMode} = atom.getLoadSettings();
export const REQUIRED_FEATURE_GROUP = 'nuclide-required';
export const INITIAL_FEATURE_GROUP = 'nuclide-core';
export default class FeatureLoader {
_activationDisposable: ?UniversalDisposable;
_loadDisposable: UniversalDisposable;
_config: ?Object;
_features: Array<Feature>;
_featureBeingActivated: ?Feature;
_featureBeingDeactivated: ?Feature;
_featureGroups: MultiMap<string, Feature>;
_deferringFeatureActivation: boolean = true;
_pkgName: string;
_path: string;
_currentlyActiveFeatures: Set<Feature> = new Set();
constructor({features, path: _path, featureGroups}: FeatureLoaderParams) {
this._path = _path;
this._features = reorderFeatures(features);
this._loadDisposable = new UniversalDisposable();
this._pkgName = packageNameFromPath(this._path);
this._featureGroups = groupFeatures(
this._features,
featureGroups == null ? {} : featureGroups,
);
}
// Build the config. Should occur with root package's load
load(): void {
invariant(!this._loadDisposable.disposed);
patchPackageManager();
// Add a dummy deserializer. This forces Atom to load Nuclide's main module
// (this file) when the package is loaded, which is super important because
// this module loads all of the Nuclide features. We could accomplish the same
// thing by unsetting [the local storage value][1] that Atom uses to indicate
// whether the main module load can be deferred, however, that would mean that
// (for a brief time, at least), the flag would be set. If there were an error
// during that time and we never got a chance to unset the flag, Nuclide
// features would never load again!
//
// [1] https://github.com/atom/atom/blob/v1.9.8/src/package.coffee#L442
this._loadDisposable.add(
atom.deserializers.add({
name: `${this._pkgName}.ForceMainModuleLoad`,
deserialize() {},
}),
);
featureConfig.setPackageName(this._pkgName);
nuclideConfig.setPackageName(this._pkgName);
//
// Build the "config" object. This determines the config defaults and
// it's what is shown by the Settings view. It includes:
// (1) An entry to enable/disable each feature - called "${pkgName}.use.*".
// (2) Each feature's merged config.
//
// https://atom.io/docs/api/latest/Config
//
this._config = buildConfig(this._features);
// Load enabled features. This needs to be done during Atom's load phase to
// make sure that deserializers are registered, etc.
// https://github.com/atom/atom/blob/v1.1.0/src/atom-environment.coffee#L625-L631
// https://atom.io/docs/api/latest/PackageManager
const featuresToLoad = this.getEnabledFeatures();
this._loadDisposable.add(
// Nesting loads within loads leads to reverse activation order- that is, if
// the root package loads feature packages, then the feature package activations will
// happen before the root package's. So we wait until the root package is done loading,
// but before it activates, to load the features.
didLoadPackage(this._pkgName).subscribe(() => {
// Load "regular" feature packages.
featuresToLoad.forEach(feature => {
atom.packages.loadPackage(feature.path);
});
}),
// Load "experimental" format packages.
didLoadPackage(this._pkgName)
.switchMap(() =>
Observable.create(
() =>
new UniversalDisposable(
activateExperimentalPackages([...featuresToLoad]),
),
),
)
.subscribe(),
);
const featureNames = new Set(
this._features.map(feature => feature.pkg.name),
);
// Ensure that the root package is initialized before all of its features. This is important
// because the root package defines the config for all managed features and we need to make
// sure that it's present before they're initialized (i.e. before their deserializers are
// called).
// $FlowIssue: Need to upstream this.
const onWillInitializePackageDisposable = atom.packages.onWillInitializePackage(
pack => {
if (featureNames.has(pack.name)) {
onWillInitializePackageDisposable.dispose();
const rootPackage = atom.packages.getLoadedPackage(this._pkgName);
nullthrows(rootPackage).initializeIfNeeded();
}
},
);
this._loadDisposable.add(onWillInitializePackageDisposable);
// Clean up when the package is unloaded.
this._loadDisposable.add(
atom.packages.onDidUnloadPackage(pack => {
if (pack.name === this._pkgName) {
this._loadDisposable.dispose();
}
}),
);
}
activate(): void {
invariant(this._activationDisposable == null);
const rootPackage = atom.packages.getLoadedPackage(this._pkgName);
invariant(rootPackage != null);
// This is a failsafe in case the `.ForceMainModuleLoad` deserializer
// defined above does not register in time, or if the defer key has been set
// w/o our knowledge. This can happen during OSS upgrades.
localStorage.removeItem(
rootPackage.getCanDeferMainModuleRequireStorageKey(),
);
this.updateActiveFeatures();
// Watch things that should trigger reevaluation of active features. Note that we do this
// *after* the initial `updateActiveFeatures()` call because that could trigger one of these
// events.
this._activationDisposable = new UniversalDisposable(
atom.config.onDidChange(this.getUseKeyPath(), () => {
this.updateActiveFeatures();
}),
atom.config.onDidChange(this.getEnabledFeatureGroupsKeyPath(), () => {
this.updateActiveFeatures();
}),
Observable.merge(didAddFirstPath, didAddFirstTextEditor)
.take(1)
.subscribe(() => {
// Hopefully we've opened a project so we don't have to load all the features.
this._deferringFeatureActivation = false;
this.updateActiveFeatures();
}),
);
}
updateActiveFeatures() {
// `updateActiveFeatures()` can't be called recursively. If it is, just warn and bail.
if (this._featureBeingActivated != null) {
// eslint-disable-next-line no-console
console.warn(
`Activating ${this._featureBeingActivated.pkg.name} caused a` +
' reevaluation of active features.',
);
return;
}
if (this._featureBeingDeactivated != null) {
// eslint-disable-next-line no-console
console.warn(
`Deactivating ${this._featureBeingDeactivated.pkg.name} caused a` +
' reevaluation of active features.',
);
return;
}
this.updateActiveFeaturesNow();
}
/**
* Enable and disable the correct features according to the current configuration.
*/
updateActiveFeaturesNow() {
const enabledFeatures = this.getEnabledFeatures();
const featuresToActivate = setUnion(
this._featureGroups.get(REQUIRED_FEATURE_GROUP),
this._deferringFeatureActivation
? setIntersect(
enabledFeatures,
this._featureGroups.get(INITIAL_FEATURE_GROUP),
)
: enabledFeatures,
);
// Enable all packages in featuresToActivate but not in currentState.
// Disable all packages not in featuresToActivate but in currentState.
for (const feature of featuresToActivate) {
if (!this._currentlyActiveFeatures.has(feature)) {
this._featureBeingActivated = feature;
atom.packages.activatePackage(feature.path);
this._featureBeingActivated = null;
}
}
for (const feature of this._currentlyActiveFeatures) {
if (!featuresToActivate.has(feature)) {
this._featureBeingDeactivated = feature;
safeDeactivate(feature);
this._featureBeingDeactivated = null;
}
}
this._currentlyActiveFeatures = featuresToActivate;
}
deactivate(): void {
invariant(
this._activationDisposable && !this._activationDisposable.disposed,
);
this._currentlyActiveFeatures.forEach(feature => {
// Deactivate the package, but don't serialize. That needs to be done in a separate phase so that
// we don't end up disconnecting a service and then serializing the disconnected state.
safeDeactivate(feature, true);
});
this._currentlyActiveFeatures = new Set();
invariant(this._activationDisposable); // reasserting for flow
this._activationDisposable.dispose();
this._activationDisposable = null;
}
/**
* Determine which features are enabled based on the current state of the configuration. This set
* is then used to load and activate the features.
*/
getEnabledFeatures(): Set<Feature> {
// we know enabledFeatureGroups must be ?Array, and useFeatureRules must be ?UseFeatureRules,
// since it's in our schema. However, flow thinks it's a mixed type, since it doesn't know about
// the schema enforcements.
const useFeatureRules: ?UseFeatureRules = (atom.config.get(
this.getUseKeyPath(),
): any);
const enabledFeatureGroups: ?Array<string> = (atom.config.get(
this.getEnabledFeatureGroupsKeyPath(),
): any);
const featuresInEnabledGroups =
enabledFeatureGroups == null
? new Set(this._features) // If featuregroups is undefined, assume all features should be enabled.
: setUnion(
...enabledFeatureGroups.map(featureGroup =>
this._featureGroups.get(featureGroup),
),
);
const requiredFeatures =
this._featureGroups.get(REQUIRED_FEATURE_GROUP) || new Set();
// If a feature is "always enabled", it should be on whether or not a feature-group includes it.
// If a feature is "default", it should be on if and only if a feature-group includes it.
return new Set(
this._features.filter(feature => {
const featureName = packageNameFromPath(feature.path);
const rawRule = idx(useFeatureRules, _ => _[featureName]);
const rule =
rawRule == null ? getFeatureDefaultValue(feature) : rawRule;
return (
rule === ALWAYS_ENABLED ||
rule === true ||
(featuresInEnabledGroups.has(feature) && rule === DEFAULT) ||
requiredFeatures.has(feature)
);
}),
);
}
getConfig(): Object {
invariant(this._config != null);
return this._config;
}
serialize(): void {
// When the root package is serialized, all of its features need to be serialized. This is an abuse of
// `serialize()` since we're using it to do side effects instead of returning the serialization,
// but it ensures that serialization of the Atom packages happens at the right point in the
// package lifecycle. Unfortunately, it also means that Nuclide features will be serialized twice
// on deactivation.
this._features.forEach(safeSerialize);
}
getUseKeyPath(): string {
return `${this._pkgName}.use`;
}
getEnabledFeatureGroupsKeyPath(): string {
return `${this._pkgName}.enabledFeatureGroups`;
}
}
function safeDeactivate(
feature: Feature,
suppressSerialization: boolean = false,
) {
const name = packageNameFromPath(feature.path);
try {
const pack = atom.packages.getLoadedPackage(name);
if (pack != null) {
atom.packages.deactivatePackage(name, suppressSerialization);
}
} catch (err) {
// eslint-disable-next-line no-console
console.error(`Error deactivating "${name}": ${err.message}`);
}
}
function getFeatureDefaultValue(feature: Feature): string {
const name = packageNameFromPath(feature.path);
return name.startsWith('sample-') || name.startsWith('fb-sample-')
? NEVER_ENABLED
: DEFAULT;
}
function safeSerialize(feature: Feature) {
const name = packageNameFromPath(feature.path);
try {
const pack = atom.packages.getActivePackage(name);
if (pack != null) {
// Serialize the package
atom.packages.serializePackage(pack);
}
} catch (err) {
// eslint-disable-next-line no-console
console.error(`Error serializing "${name}": ${err.message}`);
}
}
// this could be inlined into its use above, but this makes the intent more
// explicit, and unifies it in the case this ever needs to change.
function packageNameFromPath(pkgPath: string): string {
return path.basename(pkgPath);
}
function packageIsRepositoryProvider(pkg: FeaturePkg): boolean {
return Boolean(idx(pkg, _ => _.providedServices['atom.repository-provider']));
}
function buildConfig(features: Array<Feature>): Object {
const config = {
use: {
title: 'Enabled Features',
description: 'Enable and disable individual features',
type: 'object',
collapsed: true,
properties: {},
},
};
features.forEach(feature => {
const featurePkg = feature.pkg;
const name = packageNameFromPath(feature.path);
const setting = {
title:
featurePkg.displayName == null
? `Enable the "${name}" feature`
: `Enable ${featurePkg.displayName}`,
description: featurePkg.description || '',
type: 'string',
enum: [
{value: ALWAYS_ENABLED, description: 'Always enabled'},
{value: NEVER_ENABLED, description: 'Never enabled'},
{
value: DEFAULT,
description: 'Only when in an enabled package group',
},
],
default: getFeatureDefaultValue(feature),
};
if (devMode) {
if (featurePkg.providedServices) {
const provides = Object.keys(featurePkg.providedServices).join(', ');
setting.description += `<br/>**Provides:** _${provides}_`;
}
if (featurePkg.consumedServices) {
const consumes = Object.keys(featurePkg.consumedServices).join(', ');
setting.description += `<br/>**Consumes:** _${consumes}_`;
}
}
config.use.properties[name] = setting;
// Merge in the feature's config
const featurePkgConfig =
featurePkg.atomConfig ||
(featurePkg.nuclide && featurePkg.nuclide.config);
if (featurePkgConfig) {
config[name] = {
type: 'object',
title: featurePkg.displayName,
description: featurePkg.description,
collapsed: true,
properties: {},
};
Object.keys(featurePkgConfig).forEach(key => {
config[name].properties[key] = {
...featurePkgConfig[key],
title: featurePkgConfig[key].title || key,
};
});
}
});
return config;
}
/**
* Hack time!! Atom's repository APIs are synchronous. Any package that tries to use them before
* we've had a chance to provide our implementation are going to get wrong answers. The correct
* thing to do would be to always go through an async API that awaits until
* `atom.packages.onDidActivateInitialPackages()` completes. However, we have some legacy sync
* codepaths that make that difficult. As a temporary (I hope) workaround, we prioritize
* activation of the features that provide this service.
*/
function reorderFeatures(features_: Array<Feature>): Array<Feature> {
const features = features_.slice();
const originalOrder = new Map(features.map((feature, i) => [feature, i]));
features.sort((a, b) => {
const aIsRepoProvider = packageIsRepositoryProvider(a.pkg);
const bIsRepoProvider = packageIsRepositoryProvider(b.pkg);
if (aIsRepoProvider !== bIsRepoProvider) {
return aIsRepoProvider ? -1 : 1;
}
const aIndex = nullthrows(originalOrder.get(a));
const bIndex = nullthrows(originalOrder.get(b));
return aIndex - bIndex;
});
return features;
}
/**
* Construct a map whose keys are feature group names and values are sets of features belonging to
* the group.
*/
function groupFeatures(
features: Array<Feature>,
rawFeatureGroups: {
[string]: Array<string>,
},
): MultiMap<string, Feature> {
const namesToFeatures = new Map();
features.forEach(feature => {
namesToFeatures.set(path.basename(feature.path), feature);
});
const featureGroups = new MultiMap();
for (const key of Object.keys(rawFeatureGroups)) {
if (Array.isArray(rawFeatureGroups[key])) {
const featuresForKey = rawFeatureGroups[key]
.map(featureName => namesToFeatures.get(featureName))
.filter(Boolean);
if (featuresForKey != null) {
featureGroups.set(key, featuresForKey);
}
}
}
return featureGroups;
}
/**
* Patch the package manager and packages to (1) implement `onWillInitializePackage` and (2) call
* `registerConfigSchemaFromMainModule()` when a package is initialized (to guarantee its config
* schema is ready when its deserializers are called). This should be removed once these changes
* are upstreamed.
*/
function patchPackageManager(): void {
if (
(atom.packages: any).onWillInitializePackage == null &&
!(atom.packages: any).__onWillInitializePackagePatched
) {
(atom.packages: any).onWillInitializePackage = function(callback) {
(atom.packages: any).__onWillInitializePackagePatched = true;
return this.emitter.on('will-initialize-package', callback);
};
}
if (!(atom.packages: any).__packageLookupPatched) {
(atom.packages: any).__packageLookupPatched = true;
const loadPackage = atom.packages.loadPackage;
(atom.packages: any).loadPackage = function(nameOrPath, ...args) {
const pack = loadPackage.call(this, nameOrPath, ...args);
if (pack == null) {
return null;
}
patchPackage(pack);
return pack;
};
const getLoadedPackage = atom.packages.getLoadedPackage;
(atom.packages: any).getLoadedPackage = function(name, ...args) {
const pack = getLoadedPackage.call(this, name, ...args);
if (pack == null) {
return null;
}
patchPackage(pack);
return pack;
};
}
}
function patchPackage(pack): void {
if ((pack: any).__initializeIfNeededPatched) {
return;
}
(pack: any).__initializeIfNeededPatched = true;
const initializeIfNeeded = (pack: any).initializeIfNeeded;
(pack: any).initializeIfNeeded = function() {
if (this.mainInitialized) {
return;
}
if ((atom.packages: any).__onWillInitializePackagePatched) {
// If we didn't apply our patch for this, Atom is already dispatching the event.
atom.packages.emitter.emit('will-initialize-package', pack);
}
this.registerConfigSchemaFromMainModule();
return initializeIfNeeded.call(this);
};
}
const didLoadPackage = (pkgName: string) =>
observableFromSubscribeFunction(cb => atom.packages.onDidLoadPackage(cb))
.startWith(null)
.filter(() => atom.packages.getLoadedPackage(pkgName) != null)
.take(1);
const didAddFirstPath = observableFromSubscribeFunction(cb =>
atom.project.onDidChangePaths(cb),
)
.startWith(null)
.filter(() => atom.project.getDirectories().length > 0)
.take(1);
const didAddFirstTextEditor = observableFromSubscribeFunction(cb =>
atom.workspace.getCenter().onDidAddTextEditor(cb),
)
.startWith(null)
.filter(() => atom.workspace.getCenter().getTextEditors().length > 0)
.take(1);