forked from jupyterlab/jupyterlab
/
ensure-repo.ts
370 lines (326 loc) · 10.7 KB
/
ensure-repo.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
/*-----------------------------------------------------------------------------
| Copyright (c) Jupyter Development Team.
| Distributed under the terms of the Modified BSD License.
|----------------------------------------------------------------------------*/
/**
* Ensure the integrity of the packages in the repo.
*
* Ensure the core package version dependencies match everywhere.
* Ensure imported packages match dependencies.
* Ensure a consistent version of all packages.
* Manage the metapackage meta package.
*/
import * as path from 'path';
import * as utils from './utils';
import { ensurePackage, IEnsurePackageOptions } from './ensure-package';
type Dict<T> = { [key: string]: T };
// Data to ignore.
let MISSING: Dict<string[]> = {
'@jupyterlab/buildutils': ['path'],
'@jupyterlab/vega4-extension': ['vega-embed'],
'@jupyterlab/vega5-extension': ['vega-embed']
};
let UNUSED: Dict<string[]> = {
'@jupyterlab/apputils': ['@types/react'],
'@jupyterlab/application': ['font-awesome'],
'@jupyterlab/apputils-extension': ['es6-promise'],
'@jupyterlab/services': ['node-fetch', 'ws'],
'@jupyterlab/testutils': ['node-fetch', 'identity-obj-proxy'],
'@jupyterlab/test-csvviewer': ['csv-spectrum'],
'@jupyterlab/vega4-extension': ['vega', 'vega-lite'],
'@jupyterlab/vega5-extension': ['vega', 'vega-lite'],
'@jupyterlab/ui-components': ['@blueprintjs/icons']
};
// Packages that are allowed to have differing versions
let DIFFERENT_VERSIONS: Array<string> = ['vega-lite', 'vega', 'vega-embed'];
let SKIP_CSS: Dict<string[]> = {
'@jupyterlab/application': ['@jupyterlab/rendermime'],
'@jupyterlab/application-extension': ['@jupyterlab/apputils'],
'@jupyterlab/completer': ['@jupyterlab/codeeditor'],
'@jupyterlab/docmanager': ['@jupyterlab/statusbar'], // Statusbar styles should not be used by status reporters
'@jupyterlab/docregistry': [
'@jupyterlab/codeeditor', // Only used for model
'@jupyterlab/codemirror', // Only used for Mode.findByFileName
'@jupyterlab/rendermime' // Only used for model
],
'@jupyterlab/documentsearch': [
'@jupyterlab/cells',
'@jupyterlab/codeeditor',
'@jupyterlab/codemirror',
'@jupyterlab/fileeditor',
'@jupyterlab/notebook'
],
'@jupyterlab/filebrowser': ['@jupyterlab/statusbar'],
'@jupyterlab/fileeditor': ['@jupyterlab/statusbar'],
'@jupyterlab/help-extension': ['@jupyterlab/application'],
'@jupyterlab/shortcuts-extension': ['@jupyterlab/application'],
'@jupyterlab/tabmanager-extension': ['@jupyterlab/application'],
'@jupyterlab/theme-dark-extension': [
'@jupyterlab/application',
'@jupyterlab/apputils'
],
'@jupyterlab/theme-light-extension': [
'@jupyterlab/application',
'@jupyterlab/apputils'
],
'@jupyterlab/ui-extension': ['@blueprintjs/icons']
};
let pkgData: Dict<any> = {};
let pkgPaths: Dict<string> = {};
let pkgNames: Dict<string> = {};
let depCache: Dict<string> = {};
let locals: Dict<string> = {};
/**
* Ensure the metapackage package.
*
* @returns An array of messages for changes.
*/
function ensureMetaPackage(): string[] {
let basePath = path.resolve('.');
let mpPath = path.join(basePath, 'packages', 'metapackage');
let mpJson = path.join(mpPath, 'package.json');
let mpData = utils.readJSONFile(mpJson);
let messages: string[] = [];
let seen: Dict<boolean> = {};
utils.getCorePaths().forEach(pkgPath => {
if (path.resolve(pkgPath) === path.resolve(mpPath)) {
return;
}
let name = pkgNames[pkgPath];
if (!name) {
return;
}
seen[name] = true;
let data = pkgData[name];
let valid = true;
// Ensure it is a dependency.
if (!mpData.dependencies[name]) {
valid = false;
mpData.dependencies[name] = '^' + data.version;
}
if (!valid) {
messages.push(`Updated: ${name}`);
}
});
// Make sure there are no extra deps.
Object.keys(mpData.dependencies).forEach(name => {
if (!(name in seen)) {
messages.push(`Removing dependency: ${name}`);
delete mpData.dependencies[name];
}
});
// Write the files.
if (messages.length > 0) {
utils.writePackageData(mpJson, mpData);
}
// Update the global data.
pkgData[mpData.name] = mpData;
return messages;
}
/**
* Ensure the jupyterlab application package.
*/
function ensureJupyterlab(): string[] {
let basePath = path.resolve('.');
let corePath = path.join(basePath, 'dev_mode', 'package.json');
let corePackage = utils.readJSONFile(corePath);
corePackage.jupyterlab.extensions = {};
corePackage.jupyterlab.mimeExtensions = {};
corePackage.jupyterlab.linkedPackages = {};
corePackage.dependencies = {};
let singletonPackages = corePackage.jupyterlab.singletonPackages;
let vendorPackages = corePackage.jupyterlab.vendor;
utils.getCorePaths().forEach(pkgPath => {
let dataPath = path.join(pkgPath, 'package.json');
let data: any;
try {
data = utils.readJSONFile(dataPath);
} catch (e) {
return;
}
// Determine whether to include the package.
if (!data.jupyterlab) {
return;
}
// Skip if explicitly marked as not a core dep.
if (
'coreDependency' in data.jupyterlab &&
!data.jupyterlab.coreDependency
) {
return;
}
// Skip if it is not marked as an extension or a core dep.
if (
!data.jupyterlab.coreDependency &&
!data.jupyterlab.extension &&
!data.jupyterlab.mimeExtension
) {
return;
}
// Make sure it is included as a dependency.
corePackage.dependencies[data.name] = '^' + String(data.version);
let relativePath = `../packages/${path.basename(pkgPath)}`;
corePackage.jupyterlab.linkedPackages[data.name] = relativePath;
// Add its dependencies to the core dependencies if they are in the
// singleton packages or vendor packages.
let deps = data.dependencies || {};
for (let dep in deps) {
if (singletonPackages.indexOf(dep) !== -1) {
corePackage.dependencies[dep] = deps[dep];
}
if (vendorPackages.indexOf(dep) !== -1) {
corePackage.dependencies[dep] = deps[dep];
}
}
let jlab = data.jupyterlab;
if (!jlab) {
return;
}
// Handle extensions.
['extension', 'mimeExtension'].forEach(item => {
let ext = jlab[item];
if (ext === true) {
ext = '';
}
if (typeof ext !== 'string') {
return;
}
corePackage.jupyterlab[item + 's'][data.name] = ext;
});
});
// Write the package.json back to disk.
if (utils.writePackageData(corePath, corePackage)) {
return ['Updated dev mode'];
}
return [];
}
/**
* Ensure the repo integrity.
*/
export async function ensureIntegrity(): Promise<boolean> {
let messages: Dict<string[]> = {};
// Pick up all the package versions.
let paths = utils.getLernaPaths();
// These two are not part of the workspaces but should be kept
// in sync.
paths.push('./jupyterlab/tests/mock_packages/extension');
paths.push('./jupyterlab/tests/mock_packages/mimeextension');
const cssImports: Dict<Array<string>> = {};
// Get the package graph.
const graph = utils.getPackageGraph();
// Gather all of our package data and other metadata.
paths.forEach(pkgPath => {
// Read in the package.json.
let data: any;
try {
data = utils.readJSONFile(path.join(pkgPath, 'package.json'));
} catch (e) {
console.error(e);
return;
}
pkgData[data.name] = data;
pkgPaths[data.name] = pkgPath;
pkgNames[pkgPath] = data.name;
locals[data.name] = pkgPath;
});
// Build up an ordered list of CSS imports for each local package.
Object.keys(locals).forEach(name => {
const data = pkgData[name];
const deps: Dict<string> = data.dependencies || {};
const skip = SKIP_CSS[name] || [];
const cssData: Dict<Array<string>> = {};
if (data.jupyterlab && data.jupyterlab.extraStyles) {
Object.keys(data.jupyterlab.extraStyles).forEach(depName => {
cssData[depName] = data.jupyterlab.extraStyles[depName];
});
}
Object.keys(deps).forEach(depName => {
// Bail for skipped imports and known extra styles.
if (skip.indexOf(depName) !== -1 || depName in cssData) {
return;
}
const depData = graph.getNodeData(depName);
if (depData.style) {
cssData[depName] = [depData.style];
}
});
// Get our CSS imports in dependency order.
cssImports[name] = [];
graph.dependenciesOf(name).forEach(depName => {
if (depName in cssData) {
cssData[depName].forEach(cssPath => {
cssImports[name].push(`${depName}/${cssPath}`);
});
}
});
});
// Update the metapackage.
let pkgMessages = ensureMetaPackage();
if (pkgMessages.length > 0) {
let pkgName = '@jupyterlab/metapackage';
if (!messages[pkgName]) {
messages[pkgName] = [];
}
messages[pkgName] = messages[pkgName].concat(pkgMessages);
}
// Validate each package.
for (let name in locals) {
let unused = UNUSED[name] || [];
// Allow jest-junit to be unused in the test suite.
if (name.indexOf('@jupyterlab/test-') === 0) {
unused.push('jest-junit');
}
let options: IEnsurePackageOptions = {
pkgPath: pkgPaths[name],
data: pkgData[name],
depCache,
missing: MISSING[name],
unused,
locals,
cssImports: cssImports[name],
differentVersions: DIFFERENT_VERSIONS
};
if (name === '@jupyterlab/metapackage') {
options.noUnused = false;
}
let pkgMessages = await ensurePackage(options);
if (pkgMessages.length > 0) {
messages[name] = pkgMessages;
}
}
// Handle the top level package.
let corePath = path.resolve('.', 'package.json');
let coreData: any = utils.readJSONFile(corePath);
if (utils.writePackageData(corePath, coreData)) {
messages['top'] = ['Update package.json'];
}
// Handle the JupyterLab application top package.
pkgMessages = ensureJupyterlab();
if (pkgMessages.length > 0) {
let pkgName = '@jupyterlab/application-top';
if (!messages[pkgName]) {
messages[pkgName] = [];
}
messages[pkgName] = messages[pkgName].concat(pkgMessages);
}
// Handle any messages.
if (Object.keys(messages).length > 0) {
console.log(JSON.stringify(messages, null, 2));
if ('--force' in process.argv) {
console.log(
'\n\nPlease run `jlpm run integrity` locally and commit the changes'
);
process.exit(1);
}
utils.run('jlpm install');
console.log('\n\nMade integrity changes!');
console.log('Please commit the changes by running:');
console.log('git commit -a -m "Package integrity updates"');
return false;
}
console.log('Repo integrity verified!');
return true;
}
if (require.main === module) {
void ensureIntegrity();
}