/
index.ts
477 lines (410 loc) · 13.6 KB
/
index.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
/*-----------------------------------------------------------------------------
| Copyright (c) Jupyter Development Team.
| Distributed under the terms of the Modified BSD License.
|----------------------------------------------------------------------------*/
import {
ILayoutRestorer,
IRouter,
JupyterFrontEnd,
JupyterFrontEndPlugin
} from '@jupyterlab/application';
import {
Dialog,
ICommandPalette,
ISplashScreen,
IWindowResolver,
WindowResolver,
Printing
} from '@jupyterlab/apputils';
import { IStateDB, StateDB, URLExt } from '@jupyterlab/coreutils';
import { defaultIconRegistry } from '@jupyterlab/ui-components';
import { PromiseDelegate } from '@lumino/coreutils';
import { DisposableDelegate } from '@lumino/disposable';
import { Debouncer, Throttler } from '@lumino/polling';
import { Palette } from './palette';
import { settingsPlugin } from './settingsplugin';
import { themesPlugin, themesPaletteMenuPlugin } from './themeplugins';
/**
* The interval in milliseconds before recover options appear during splash.
*/
const SPLASH_RECOVER_TIMEOUT = 12000;
/**
* The command IDs used by the apputils plugin.
*/
namespace CommandIDs {
export const loadState = 'apputils:load-statedb';
export const print = 'apputils:print';
export const reset = 'apputils:reset';
export const resetOnLoad = 'apputils:reset-on-load';
}
/**
* The default command palette extension.
*/
const palette: JupyterFrontEndPlugin<ICommandPalette> = {
activate: Palette.activate,
id: '@jupyterlab/apputils-extension:palette',
provides: ICommandPalette,
autoStart: true
};
/**
* The default command palette's restoration extension.
*
* #### Notes
* The command palette's restoration logic is handled separately from the
* command palette provider extension because the layout restorer dependency
* causes the command palette to be unavailable to other extensions earlier
* in the application load cycle.
*/
const paletteRestorer: JupyterFrontEndPlugin<void> = {
activate: Palette.restore,
id: '@jupyterlab/apputils-extension:palette-restorer',
requires: [ILayoutRestorer],
autoStart: true
};
/**
* The default window name resolver provider.
*/
const resolver: JupyterFrontEndPlugin<IWindowResolver> = {
id: '@jupyterlab/apputils-extension:resolver',
autoStart: true,
provides: IWindowResolver,
requires: [JupyterFrontEnd.IPaths, IRouter],
activate: async (
_: JupyterFrontEnd,
paths: JupyterFrontEnd.IPaths,
router: IRouter
) => {
const { hash, path, search } = router.current;
const query = URLExt.queryStringToObject(search || '');
const solver = new WindowResolver();
const { urls } = paths;
const match = path.match(new RegExp(`^${urls.workspaces}\/([^?\/]+)`));
const workspace = (match && decodeURIComponent(match[1])) || '';
const candidate = Private.candidate(paths, workspace);
const rest = workspace
? path.replace(new RegExp(`^${urls.workspaces}\/${workspace}`), '')
: path.replace(new RegExp(`^${urls.app}\/?`), '');
try {
await solver.resolve(candidate);
return solver;
} catch (error) {
// Window resolution has failed so the URL must change. Return a promise
// that never resolves to prevent the application from loading plugins
// that rely on `IWindowResolver`.
return new Promise<IWindowResolver>(() => {
const { base, workspaces } = paths.urls;
const pool =
'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789';
const random = pool[Math.floor(Math.random() * pool.length)];
const path = URLExt.join(base, workspaces, `auto-${random}`, rest);
// Clone the originally requested workspace after redirecting.
query['clone'] = workspace;
const url = path + URLExt.objectToQueryString(query) + (hash || '');
router.navigate(url, { hard: true });
});
}
}
};
/**
* The default splash screen provider.
*/
const splash: JupyterFrontEndPlugin<ISplashScreen> = {
id: '@jupyterlab/apputils-extension:splash',
autoStart: true,
provides: ISplashScreen,
activate: app => {
const { commands, restored } = app;
// Create splash element and populate it.
const splash = document.createElement('div');
const galaxy = document.createElement('div');
const logo = document.createElement('div');
splash.id = 'jupyterlab-splash';
galaxy.id = 'galaxy';
logo.id = 'main-logo';
defaultIconRegistry.icon({
name: 'jupyter-favicon',
container: logo,
center: true,
kind: 'splash'
});
galaxy.appendChild(logo);
['1', '2', '3'].forEach(id => {
const moon = document.createElement('div');
const planet = document.createElement('div');
moon.id = `moon${id}`;
moon.className = 'moon orbit';
planet.id = `planet${id}`;
planet.className = 'planet';
moon.appendChild(planet);
galaxy.appendChild(moon);
});
splash.appendChild(galaxy);
// Create debounced recovery dialog function.
let dialog: Dialog<any>;
const recovery = new Throttler(async () => {
if (dialog) {
return;
}
dialog = new Dialog({
title: 'Loading...',
body: `The loading screen is taking a long time.
Would you like to clear the workspace or keep waiting?`,
buttons: [
Dialog.cancelButton({ label: 'Keep Waiting' }),
Dialog.warnButton({ label: 'Clear Workspace' })
]
});
try {
const result = await dialog.launch();
dialog.dispose();
dialog = null;
if (result.button.accept && commands.hasCommand(CommandIDs.reset)) {
return commands.execute(CommandIDs.reset);
}
// Re-invoke the recovery timer in the next frame.
requestAnimationFrame(() => {
// Because recovery can be stopped, handle invocation rejection.
void recovery.invoke().catch(_ => undefined);
});
} catch (error) {
/* no-op */
}
}, SPLASH_RECOVER_TIMEOUT);
// Return ISplashScreen.
let splashCount = 0;
return {
show: (light = true) => {
splash.classList.remove('splash-fade');
splash.classList.toggle('light', light);
splash.classList.toggle('dark', !light);
splashCount++;
document.body.appendChild(splash);
// Because recovery can be stopped, handle invocation rejection.
void recovery.invoke().catch(_ => undefined);
return new DisposableDelegate(async () => {
await restored;
if (--splashCount === 0) {
void recovery.stop();
if (dialog) {
dialog.dispose();
dialog = null;
}
splash.classList.add('splash-fade');
window.setTimeout(() => {
document.body.removeChild(splash);
}, 200);
}
});
}
};
}
};
const print: JupyterFrontEndPlugin<void> = {
id: '@jupyterlab/apputils-extension:print',
autoStart: true,
activate: (app: JupyterFrontEnd) => {
app.commands.addCommand(CommandIDs.print, {
label: 'Print...',
isEnabled: () => {
const widget = app.shell.currentWidget;
return Printing.getPrintFunction(widget) !== null;
},
execute: async () => {
const widget = app.shell.currentWidget;
const printFunction = Printing.getPrintFunction(widget);
if (printFunction) {
await printFunction();
}
}
});
}
};
/**
* The default state database for storing application state.
*
* #### Notes
* If this extension is loaded with a window resolver, it will automatically add
* state management commands, URL support for `clone` and `reset`, and workspace
* auto-saving. Otherwise, it will return a simple in-memory state database.
*/
const state: JupyterFrontEndPlugin<IStateDB> = {
id: '@jupyterlab/apputils-extension:state',
autoStart: true,
provides: IStateDB,
requires: [JupyterFrontEnd.IPaths, IRouter],
optional: [ISplashScreen, IWindowResolver],
activate: (
app: JupyterFrontEnd,
paths: JupyterFrontEnd.IPaths,
router: IRouter,
splash: ISplashScreen | null,
resolver: IWindowResolver | null
) => {
if (resolver === null) {
return new StateDB();
}
let resolved = false;
const { commands, serviceManager } = app;
const { workspaces } = serviceManager;
const workspace = resolver.name;
const transform = new PromiseDelegate<StateDB.DataTransform>();
const db = new StateDB({ transform: transform.promise });
const save = new Debouncer(async () => {
const id = workspace;
const metadata = { id };
const data = await db.toJSON();
await workspaces.save(id, { data, metadata });
});
// Any time the local state database changes, save the workspace.
db.changed.connect(() => void save.invoke(), db);
commands.addCommand(CommandIDs.loadState, {
execute: async (args: IRouter.ILocation) => {
// Since the command can be executed an arbitrary number of times, make
// sure it is safe to call multiple times.
if (resolved) {
return;
}
const { hash, path, search } = args;
const { urls } = paths;
const query = URLExt.queryStringToObject(search || '');
const clone =
typeof query['clone'] === 'string'
? query['clone'] === ''
? URLExt.join(urls.base, urls.app)
: URLExt.join(urls.base, urls.workspaces, query['clone'])
: null;
const source = clone || workspace || null;
if (source === null) {
console.error(`${CommandIDs.loadState} cannot load null workspace.`);
return;
}
try {
const saved = await workspaces.fetch(source);
// If this command is called after a reset, the state database
// will already be resolved.
if (!resolved) {
resolved = true;
transform.resolve({ type: 'overwrite', contents: saved.data });
}
} catch ({ message }) {
console.log(`Fetching workspace "${workspace}" failed.`, message);
// If the workspace does not exist, cancel the data transformation
// and save a workspace with the current user state data.
if (!resolved) {
resolved = true;
transform.resolve({ type: 'cancel', contents: null });
}
}
if (source === clone) {
// Maintain the query string parameters but remove `clone`.
delete query['clone'];
const url = path + URLExt.objectToQueryString(query) + hash;
const cloned = save.invoke().then(() => router.stop);
// After the state has been cloned, navigate to the URL.
void cloned.then(() => {
router.navigate(url);
});
return cloned;
}
// After the state database has finished loading, save it.
await save.invoke();
}
});
commands.addCommand(CommandIDs.reset, {
label: 'Reset Application State',
execute: async () => {
await db.clear();
await save.invoke();
router.reload();
}
});
commands.addCommand(CommandIDs.resetOnLoad, {
execute: (args: IRouter.ILocation) => {
const { hash, path, search } = args;
const query = URLExt.queryStringToObject(search || '');
const reset = 'reset' in query;
const clone = 'clone' in query;
if (!reset) {
return;
}
// If a splash provider exists, launch the splash screen.
const loading = splash
? splash.show()
: new DisposableDelegate(() => undefined);
// If the state database has already been resolved, resetting is
// impossible without reloading.
if (resolved) {
return router.reload();
}
// Empty the state database.
resolved = true;
transform.resolve({ type: 'clear', contents: null });
// Maintain the query string parameters but remove `reset`.
delete query['reset'];
const url = path + URLExt.objectToQueryString(query) + hash;
const cleared = db
.clear()
.then(() => save.invoke())
.then(() => router.stop);
// After the state has been reset, navigate to the URL.
if (clone) {
void cleared.then(() => {
router.navigate(url, { hard: true });
});
} else {
void cleared.then(() => {
router.navigate(url);
loading.dispose();
});
}
return cleared;
}
});
router.register({
command: CommandIDs.loadState,
pattern: /.?/,
rank: 30 // High priority: 30:100.
});
router.register({
command: CommandIDs.resetOnLoad,
pattern: /(\?reset|\&reset)($|&)/,
rank: 20 // High priority: 20:100.
});
return db;
}
};
/**
* Export the plugins as default.
*/
const plugins: JupyterFrontEndPlugin<any>[] = [
palette,
paletteRestorer,
print,
resolver,
settingsPlugin,
state,
splash,
themesPlugin,
themesPaletteMenuPlugin
];
export default plugins;
/**
* The namespace for module private data.
*/
namespace Private {
/**
* Generate a workspace name candidate.
*
* @param workspace - A potential workspace name parsed from the URL.
*
* @returns A workspace name candidate.
*/
export function candidate(
{ urls }: JupyterFrontEnd.IPaths,
workspace = ''
): string {
return workspace
? URLExt.join(urls.workspaces, workspace)
: URLExt.join(urls.app);
}
}