@theia/notebook 1.53.0-next.4 → 1.53.0-next.55

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (99) hide show
  1. package/README.md +30 -30
  2. package/lib/browser/contributions/cell-operations.d.ts.map +1 -1
  3. package/lib/browser/contributions/cell-operations.js +8 -1
  4. package/lib/browser/contributions/cell-operations.js.map +1 -1
  5. package/lib/browser/contributions/notebook-actions-contribution.d.ts +1 -0
  6. package/lib/browser/contributions/notebook-actions-contribution.d.ts.map +1 -1
  7. package/lib/browser/contributions/notebook-actions-contribution.js +31 -6
  8. package/lib/browser/contributions/notebook-actions-contribution.js.map +1 -1
  9. package/lib/browser/contributions/notebook-cell-actions-contribution.d.ts +4 -0
  10. package/lib/browser/contributions/notebook-cell-actions-contribution.d.ts.map +1 -1
  11. package/lib/browser/contributions/notebook-cell-actions-contribution.js +49 -12
  12. package/lib/browser/contributions/notebook-cell-actions-contribution.js.map +1 -1
  13. package/lib/browser/contributions/notebook-status-bar-contribution.d.ts +14 -0
  14. package/lib/browser/contributions/notebook-status-bar-contribution.d.ts.map +1 -0
  15. package/lib/browser/contributions/notebook-status-bar-contribution.js +75 -0
  16. package/lib/browser/contributions/notebook-status-bar-contribution.js.map +1 -0
  17. package/lib/browser/notebook-editor-widget.d.ts.map +1 -1
  18. package/lib/browser/notebook-editor-widget.js +3 -5
  19. package/lib/browser/notebook-editor-widget.js.map +1 -1
  20. package/lib/browser/notebook-frontend-module.d.ts.map +1 -1
  21. package/lib/browser/notebook-frontend-module.js +3 -0
  22. package/lib/browser/notebook-frontend-module.js.map +1 -1
  23. package/lib/browser/notebook-open-handler.d.ts +3 -2
  24. package/lib/browser/notebook-open-handler.d.ts.map +1 -1
  25. package/lib/browser/notebook-open-handler.js +12 -5
  26. package/lib/browser/notebook-open-handler.js.map +1 -1
  27. package/lib/browser/service/notebook-options.d.ts +1 -0
  28. package/lib/browser/service/notebook-options.d.ts.map +1 -1
  29. package/lib/browser/service/notebook-options.js +1 -0
  30. package/lib/browser/service/notebook-options.js.map +1 -1
  31. package/lib/browser/service/notebook-service.d.ts +1 -0
  32. package/lib/browser/service/notebook-service.d.ts.map +1 -1
  33. package/lib/browser/service/notebook-service.js +7 -0
  34. package/lib/browser/service/notebook-service.js.map +1 -1
  35. package/lib/browser/view/notebook-cell-editor.d.ts +1 -0
  36. package/lib/browser/view/notebook-cell-editor.d.ts.map +1 -1
  37. package/lib/browser/view/notebook-cell-editor.js +30 -16
  38. package/lib/browser/view/notebook-cell-editor.js.map +1 -1
  39. package/lib/browser/view/notebook-cell-list-view.d.ts +7 -4
  40. package/lib/browser/view/notebook-cell-list-view.d.ts.map +1 -1
  41. package/lib/browser/view/notebook-cell-list-view.js +39 -29
  42. package/lib/browser/view/notebook-cell-list-view.js.map +1 -1
  43. package/lib/browser/view-model/notebook-cell-model.d.ts +3 -0
  44. package/lib/browser/view-model/notebook-cell-model.d.ts.map +1 -1
  45. package/lib/browser/view-model/notebook-cell-model.js +5 -0
  46. package/lib/browser/view-model/notebook-cell-model.js.map +1 -1
  47. package/package.json +8 -8
  48. package/src/browser/contributions/cell-operations.ts +44 -39
  49. package/src/browser/contributions/notebook-actions-contribution.ts +379 -351
  50. package/src/browser/contributions/notebook-cell-actions-contribution.ts +525 -485
  51. package/src/browser/contributions/notebook-color-contribution.ts +268 -268
  52. package/src/browser/contributions/notebook-context-keys.ts +113 -113
  53. package/src/browser/contributions/notebook-label-provider-contribution.ts +85 -85
  54. package/src/browser/contributions/notebook-outline-contribution.ts +114 -114
  55. package/src/browser/contributions/notebook-output-action-contribution.ts +82 -82
  56. package/src/browser/contributions/notebook-preferences.ts +92 -92
  57. package/src/browser/contributions/notebook-status-bar-contribution.ts +77 -0
  58. package/src/browser/contributions/notebook-undo-redo-handler.ts +41 -41
  59. package/src/browser/index.ts +27 -27
  60. package/src/browser/notebook-cell-resource-resolver.ts +130 -130
  61. package/src/browser/notebook-editor-widget-factory.ts +82 -82
  62. package/src/browser/notebook-editor-widget.tsx +330 -331
  63. package/src/browser/notebook-frontend-module.ts +119 -115
  64. package/src/browser/notebook-open-handler.ts +120 -114
  65. package/src/browser/notebook-output-utils.ts +119 -119
  66. package/src/browser/notebook-renderer-registry.ts +85 -85
  67. package/src/browser/notebook-type-registry.ts +54 -54
  68. package/src/browser/notebook-types.ts +186 -186
  69. package/src/browser/renderers/cell-output-webview.ts +33 -33
  70. package/src/browser/service/notebook-clipboard-service.ts +43 -43
  71. package/src/browser/service/notebook-context-manager.ts +162 -162
  72. package/src/browser/service/notebook-editor-widget-service.ts +101 -101
  73. package/src/browser/service/notebook-execution-service.ts +139 -139
  74. package/src/browser/service/notebook-execution-state-service.ts +311 -311
  75. package/src/browser/service/notebook-kernel-history-service.ts +124 -124
  76. package/src/browser/service/notebook-kernel-quick-pick-service.ts +479 -479
  77. package/src/browser/service/notebook-kernel-service.ts +357 -357
  78. package/src/browser/service/notebook-model-resolver-service.ts +160 -160
  79. package/src/browser/service/notebook-monaco-text-model-service.ts +48 -48
  80. package/src/browser/service/notebook-options.ts +155 -154
  81. package/src/browser/service/notebook-renderer-messaging-service.ts +121 -121
  82. package/src/browser/service/notebook-service.ts +215 -209
  83. package/src/browser/style/index.css +483 -467
  84. package/src/browser/view/notebook-cell-editor.tsx +263 -247
  85. package/src/browser/view/notebook-cell-list-view.tsx +279 -259
  86. package/src/browser/view/notebook-cell-toolbar-factory.tsx +102 -102
  87. package/src/browser/view/notebook-cell-toolbar.tsx +74 -74
  88. package/src/browser/view/notebook-code-cell-view.tsx +350 -350
  89. package/src/browser/view/notebook-find-widget.tsx +335 -335
  90. package/src/browser/view/notebook-main-toolbar.tsx +235 -235
  91. package/src/browser/view/notebook-markdown-cell-view.tsx +208 -208
  92. package/src/browser/view/notebook-viewport-service.ts +61 -61
  93. package/src/browser/view-model/notebook-cell-model.ts +473 -466
  94. package/src/browser/view-model/notebook-cell-output-model.ts +100 -100
  95. package/src/browser/view-model/notebook-model.ts +550 -550
  96. package/src/common/index.ts +18 -18
  97. package/src/common/notebook-common.ts +337 -337
  98. package/src/common/notebook-protocol.ts +35 -35
  99. package/src/common/notebook-range.ts +30 -30
@@ -1,357 +1,357 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2023 TypeFox and others.
3
- //
4
- // This program and the accompanying materials are made available under the
5
- // terms of the Eclipse Public License v. 2.0 which is available at
6
- // http://www.eclipse.org/legal/epl-2.0.
7
- //
8
- // This Source Code may also be made available under the following Secondary
9
- // Licenses when the conditions for such availability set forth in the Eclipse
10
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
- // with the GNU Classpath Exception which is available at
12
- // https://www.gnu.org/software/classpath/license.html.
13
- //
14
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
- // *****************************************************************************
16
- /*---------------------------------------------------------------------------------------------
17
- * Copyright (c) Microsoft Corporation. All rights reserved.
18
- * Licensed under the MIT License. See License.txt in the project root for license information.
19
- *--------------------------------------------------------------------------------------------*/
20
-
21
- import { Command, CommandService, Disposable, Emitter, Event, URI } from '@theia/core';
22
- import { inject, injectable, postConstruct } from '@theia/core/shared/inversify';
23
- import { StorageService } from '@theia/core/lib/browser';
24
- import { NotebookKernelSourceAction } from '../../common';
25
- import { NotebookModel } from '../view-model/notebook-model';
26
- import { NotebookService } from './notebook-service';
27
-
28
- export interface SelectedNotebookKernelChangeEvent {
29
- notebook: URI;
30
- oldKernel: string | undefined;
31
- newKernel: string | undefined;
32
- }
33
-
34
- export interface NotebookKernelMatchResult {
35
- readonly selected: NotebookKernel | undefined;
36
- readonly suggestions: NotebookKernel[];
37
- readonly all: NotebookKernel[];
38
- readonly hidden: NotebookKernel[];
39
- }
40
-
41
- export interface NotebookKernelChangeEvent {
42
- label?: true;
43
- description?: true;
44
- detail?: true;
45
- supportedLanguages?: true;
46
- hasExecutionOrder?: true;
47
- hasInterruptHandler?: true;
48
- }
49
-
50
- export interface NotebookKernel {
51
- readonly id: string;
52
- readonly viewType: string;
53
- readonly onDidChange: Event<Readonly<NotebookKernelChangeEvent>>;
54
- // ID of the extension providing this kernel
55
- readonly extensionId: string;
56
-
57
- readonly localResourceRoot: URI;
58
- readonly preloadUris: URI[];
59
- readonly preloadProvides: string[];
60
-
61
- readonly handle: number;
62
- label: string;
63
- description?: string;
64
- detail?: string;
65
- supportedLanguages: string[];
66
- implementsInterrupt?: boolean;
67
- implementsExecutionOrder?: boolean;
68
-
69
- executeNotebookCellsRequest(uri: URI, cellHandles: number[]): Promise<void>;
70
- cancelNotebookCellExecution(uri: URI, cellHandles: number[]): Promise<void>;
71
- }
72
-
73
- export const enum ProxyKernelState {
74
- Disconnected = 1,
75
- Connected = 2,
76
- Initializing = 3
77
- }
78
-
79
- export interface INotebookProxyKernelChangeEvent extends NotebookKernelChangeEvent {
80
- connectionState?: true;
81
- }
82
-
83
- export interface NotebookTextModelLike { uri: URI; viewType: string }
84
-
85
- class KernelInfo {
86
-
87
- protected static instanceCounter = 0;
88
-
89
- score: number;
90
- readonly kernel: NotebookKernel;
91
- readonly handle: number;
92
-
93
- constructor(kernel: NotebookKernel) {
94
- this.kernel = kernel;
95
- this.score = -1;
96
- this.handle = KernelInfo.instanceCounter++;
97
- }
98
- }
99
-
100
- export interface NotebookSourceActionChangeEvent {
101
- notebook?: URI;
102
- viewType: string;
103
- }
104
-
105
- export interface KernelSourceActionProvider {
106
- readonly viewType: string;
107
- onDidChangeSourceActions?: Event<void>;
108
- provideKernelSourceActions(): Promise<NotebookKernelSourceAction[]>;
109
- }
110
-
111
- export class SourceCommand implements Disposable {
112
- execution: Promise<void> | undefined;
113
- protected readonly onDidChangeStateEmitter = new Emitter<void>();
114
- readonly onDidChangeState = this.onDidChangeStateEmitter.event;
115
-
116
- constructor(
117
- readonly command: Command,
118
- readonly model: NotebookTextModelLike,
119
- ) { }
120
-
121
- async run(commandService: CommandService): Promise<void> {
122
- if (this.execution) {
123
- return this.execution;
124
- }
125
-
126
- this.execution = this.runCommand(commandService);
127
- this.onDidChangeStateEmitter.fire();
128
- await this.execution;
129
- this.execution = undefined;
130
- this.onDidChangeStateEmitter.fire();
131
- }
132
-
133
- protected async runCommand(commandService: CommandService): Promise<void> {
134
- try {
135
- await commandService.executeCommand(this.command.id, {
136
- uri: this.model.uri,
137
- });
138
-
139
- } catch (error) {
140
- console.warn(`Kernel source command failed: ${error}`);
141
- }
142
- }
143
-
144
- dispose(): void {
145
- this.onDidChangeStateEmitter.dispose();
146
- }
147
-
148
- }
149
-
150
- const NOTEBOOK_KERNEL_BINDING_STORAGE_KEY = 'notebook.kernel.bindings';
151
- @injectable()
152
- export class NotebookKernelService {
153
-
154
- @inject(NotebookService)
155
- protected notebookService: NotebookService;
156
-
157
- @inject(StorageService)
158
- protected storageService: StorageService;
159
-
160
- protected readonly kernels = new Map<string, KernelInfo>();
161
-
162
- protected notebookBindings: Record<string, string> = {};
163
-
164
- protected readonly kernelDetectionTasks = new Map<string, string[]>();
165
- protected readonly onDidChangeKernelDetectionTasksEmitter = new Emitter<string>();
166
- readonly onDidChangeKernelDetectionTasks = this.onDidChangeKernelDetectionTasksEmitter.event;
167
-
168
- protected readonly onDidChangeSourceActionsEmitter = new Emitter<NotebookSourceActionChangeEvent>();
169
- protected readonly kernelSourceActionProviders = new Map<string, KernelSourceActionProvider[]>();
170
- readonly onDidChangeSourceActions: Event<NotebookSourceActionChangeEvent> = this.onDidChangeSourceActionsEmitter.event;
171
-
172
- protected readonly onDidAddKernelEmitter = new Emitter<NotebookKernel>();
173
- readonly onDidAddKernel: Event<NotebookKernel> = this.onDidAddKernelEmitter.event;
174
-
175
- protected readonly onDidRemoveKernelEmitter = new Emitter<NotebookKernel>();
176
- readonly onDidRemoveKernel: Event<NotebookKernel> = this.onDidRemoveKernelEmitter.event;
177
-
178
- protected readonly onDidChangeSelectedNotebookKernelBindingEmitter = new Emitter<SelectedNotebookKernelChangeEvent>();
179
- readonly onDidChangeSelectedKernel: Event<SelectedNotebookKernelChangeEvent> = this.onDidChangeSelectedNotebookKernelBindingEmitter.event;
180
-
181
- protected readonly onDidChangeNotebookAffinityEmitter = new Emitter<void>();
182
- readonly onDidChangeNotebookAffinity: Event<void> = this.onDidChangeNotebookAffinityEmitter.event;
183
-
184
- @postConstruct()
185
- init(): void {
186
- this.notebookService.onDidAddNotebookDocument(model => this.tryAutoBindNotebook(model));
187
- this.storageService.getData(NOTEBOOK_KERNEL_BINDING_STORAGE_KEY).then((value: Record<string, string> | undefined) => {
188
- if (value) {
189
- this.notebookBindings = value;
190
- }
191
- });
192
- }
193
-
194
- registerKernel(kernel: NotebookKernel): Disposable {
195
- if (this.kernels.has(kernel.id)) {
196
- throw new Error(`Notebook Controller with id '${kernel.id}' already exists`);
197
- }
198
-
199
- this.kernels.set(kernel.id, new KernelInfo(kernel));
200
- this.onDidAddKernelEmitter.fire(kernel);
201
-
202
- // auto associate the new kernel to existing notebooks it was
203
- // associated to in the past.
204
- for (const notebook of this.notebookService.getNotebookModels()) {
205
- this.tryAutoBindNotebook(notebook, kernel);
206
- }
207
-
208
- return Disposable.create(() => {
209
- if (this.kernels.delete(kernel.id)) {
210
- this.onDidRemoveKernelEmitter.fire(kernel);
211
- }
212
- });
213
- }
214
-
215
- /**
216
- * Helps to find the best matching kernel for a notebook.
217
- * @param notebook notebook to get the matching kernel for
218
- * @returns and object containing:
219
- * all kernels sorted to match the notebook best first (affinity ascending, score descending, label))
220
- * the selected kernel (if any)
221
- * specific suggested kernels (if any)
222
- * hidden kernels (if any)
223
- */
224
- getMatchingKernel(notebook: NotebookTextModelLike): NotebookKernelMatchResult {
225
- const kernels: { kernel: NotebookKernel; instanceAffinity: number; score: number }[] = [];
226
- for (const info of this.kernels.values()) {
227
- const score = NotebookKernelService.score(info.kernel, notebook);
228
- if (score) {
229
- kernels.push({
230
- score,
231
- kernel: info.kernel,
232
- instanceAffinity: 1 /* vscode.NotebookControllerPriority.Default */,
233
- });
234
- }
235
- }
236
-
237
- kernels
238
- .sort((a, b) => b.instanceAffinity - a.instanceAffinity || a.score - b.score || a.kernel.label.localeCompare(b.kernel.label));
239
- const all = kernels.map(obj => obj.kernel);
240
-
241
- // bound kernel
242
- const selected = this.getSelectedNotebookKernel(notebook);
243
- const suggestions = kernels.filter(item => item.instanceAffinity > 1).map(item => item.kernel); // TODO implement notebookAffinity
244
- const hidden = kernels.filter(item => item.instanceAffinity < 0).map(item => item.kernel);
245
- return { all, selected, suggestions, hidden };
246
-
247
- }
248
-
249
- getSelectedNotebookKernel(notebook: NotebookTextModelLike): NotebookKernel | undefined {
250
- const selectedId = this.notebookBindings[`${notebook.viewType}/${notebook.uri}`];
251
- return selectedId ? this.kernels.get(selectedId)?.kernel : undefined;
252
- }
253
-
254
- selectKernelForNotebook(kernel: NotebookKernel | undefined, notebook: NotebookTextModelLike): void {
255
- const key = `${notebook.viewType}/${notebook.uri}`;
256
- const oldKernel = this.notebookBindings[key];
257
- if (oldKernel !== kernel?.id) {
258
- if (kernel) {
259
- this.notebookBindings[key] = kernel.id;
260
- } else {
261
- delete this.notebookBindings[key];
262
- }
263
- this.storageService.setData(NOTEBOOK_KERNEL_BINDING_STORAGE_KEY, this.notebookBindings);
264
- this.onDidChangeSelectedNotebookKernelBindingEmitter.fire({ notebook: notebook.uri, oldKernel, newKernel: kernel?.id });
265
- }
266
- }
267
-
268
- getSelectedOrSuggestedKernel(notebook: NotebookModel): NotebookKernel | undefined {
269
- const info = this.getMatchingKernel(notebook);
270
- if (info.selected) {
271
- return info.selected;
272
- }
273
-
274
- return info.all.length === 1 ? info.all[0] : undefined;
275
- }
276
-
277
- getKernel(id: string): NotebookKernel | undefined {
278
- return this.kernels.get(id)?.kernel;
279
- }
280
-
281
- protected static score(kernel: NotebookKernel, notebook: NotebookTextModelLike): number {
282
- if (kernel.viewType === notebook.viewType) {
283
- return 10;
284
- } else if (kernel.viewType === '*') {
285
- return 5;
286
- } else {
287
- return 0;
288
- }
289
- }
290
-
291
- protected tryAutoBindNotebook(notebook: NotebookModel, onlyThisKernel?: NotebookKernel): void {
292
-
293
- const id = this.notebookBindings[`${notebook.viewType}/${notebook.uri}`];
294
- if (!id) {
295
- // no kernel associated
296
- return;
297
- }
298
- const existingKernel = this.kernels.get(id);
299
- if (!existingKernel || !NotebookKernelService.score(existingKernel.kernel, notebook)) {
300
- // associated kernel not known, not matching
301
- return;
302
- }
303
- if (!onlyThisKernel || existingKernel.kernel === onlyThisKernel) {
304
- this.onDidChangeSelectedNotebookKernelBindingEmitter.fire({ notebook: notebook.uri, oldKernel: undefined, newKernel: existingKernel.kernel.id });
305
- }
306
- }
307
-
308
- registerNotebookKernelDetectionTask(notebookType: string): Disposable {
309
- const all = this.kernelDetectionTasks.get(notebookType) ?? [];
310
- all.push(notebookType);
311
- this.kernelDetectionTasks.set(notebookType, all);
312
- this.onDidChangeKernelDetectionTasksEmitter.fire(notebookType);
313
- return Disposable.create(() => {
314
- const allTasks = this.kernelDetectionTasks.get(notebookType) ?? [];
315
- const taskIndex = allTasks.indexOf(notebookType);
316
- if (taskIndex >= 0) {
317
- allTasks.splice(taskIndex, 1);
318
- this.kernelDetectionTasks.set(notebookType, allTasks);
319
- this.onDidChangeKernelDetectionTasksEmitter.fire(notebookType);
320
- }
321
- });
322
- }
323
-
324
- getKernelDetectionTasks(notebook: NotebookTextModelLike): string[] {
325
- return this.kernelDetectionTasks.get(notebook.viewType) ?? [];
326
- }
327
-
328
- registerKernelSourceActionProvider(viewType: string, provider: KernelSourceActionProvider): Disposable {
329
- const providers = this.kernelSourceActionProviders.get(viewType) ?? [];
330
- providers.push(provider);
331
- this.kernelSourceActionProviders.set(viewType, providers);
332
- this.onDidChangeSourceActionsEmitter.fire({ viewType: viewType });
333
-
334
- const eventEmitterDisposable = provider.onDidChangeSourceActions?.(() => {
335
- this.onDidChangeSourceActionsEmitter.fire({ viewType: viewType });
336
- });
337
-
338
- return Disposable.create(() => {
339
- const sourceProviders = this.kernelSourceActionProviders.get(viewType) ?? [];
340
- const providerIndex = sourceProviders.indexOf(provider);
341
- if (providerIndex >= 0) {
342
- sourceProviders.splice(providerIndex, 1);
343
- this.kernelSourceActionProviders.set(viewType, sourceProviders);
344
- }
345
-
346
- eventEmitterDisposable?.dispose();
347
- });
348
- }
349
-
350
- async getKernelSourceActionsFromProviders(notebook: NotebookTextModelLike): Promise<NotebookKernelSourceAction[]> {
351
- const viewType = notebook.viewType;
352
- const providers = this.kernelSourceActionProviders.get(viewType) ?? [];
353
- const promises = providers.map(provider => provider.provideKernelSourceActions());
354
- const allActions = await Promise.all(promises);
355
- return allActions.flat();
356
- }
357
- }
1
+ // *****************************************************************************
2
+ // Copyright (C) 2023 TypeFox and others.
3
+ //
4
+ // This program and the accompanying materials are made available under the
5
+ // terms of the Eclipse Public License v. 2.0 which is available at
6
+ // http://www.eclipse.org/legal/epl-2.0.
7
+ //
8
+ // This Source Code may also be made available under the following Secondary
9
+ // Licenses when the conditions for such availability set forth in the Eclipse
10
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
+ // with the GNU Classpath Exception which is available at
12
+ // https://www.gnu.org/software/classpath/license.html.
13
+ //
14
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+ /*---------------------------------------------------------------------------------------------
17
+ * Copyright (c) Microsoft Corporation. All rights reserved.
18
+ * Licensed under the MIT License. See License.txt in the project root for license information.
19
+ *--------------------------------------------------------------------------------------------*/
20
+
21
+ import { Command, CommandService, Disposable, Emitter, Event, URI } from '@theia/core';
22
+ import { inject, injectable, postConstruct } from '@theia/core/shared/inversify';
23
+ import { StorageService } from '@theia/core/lib/browser';
24
+ import { NotebookKernelSourceAction } from '../../common';
25
+ import { NotebookModel } from '../view-model/notebook-model';
26
+ import { NotebookService } from './notebook-service';
27
+
28
+ export interface SelectedNotebookKernelChangeEvent {
29
+ notebook: URI;
30
+ oldKernel: string | undefined;
31
+ newKernel: string | undefined;
32
+ }
33
+
34
+ export interface NotebookKernelMatchResult {
35
+ readonly selected: NotebookKernel | undefined;
36
+ readonly suggestions: NotebookKernel[];
37
+ readonly all: NotebookKernel[];
38
+ readonly hidden: NotebookKernel[];
39
+ }
40
+
41
+ export interface NotebookKernelChangeEvent {
42
+ label?: true;
43
+ description?: true;
44
+ detail?: true;
45
+ supportedLanguages?: true;
46
+ hasExecutionOrder?: true;
47
+ hasInterruptHandler?: true;
48
+ }
49
+
50
+ export interface NotebookKernel {
51
+ readonly id: string;
52
+ readonly viewType: string;
53
+ readonly onDidChange: Event<Readonly<NotebookKernelChangeEvent>>;
54
+ // ID of the extension providing this kernel
55
+ readonly extensionId: string;
56
+
57
+ readonly localResourceRoot: URI;
58
+ readonly preloadUris: URI[];
59
+ readonly preloadProvides: string[];
60
+
61
+ readonly handle: number;
62
+ label: string;
63
+ description?: string;
64
+ detail?: string;
65
+ supportedLanguages: string[];
66
+ implementsInterrupt?: boolean;
67
+ implementsExecutionOrder?: boolean;
68
+
69
+ executeNotebookCellsRequest(uri: URI, cellHandles: number[]): Promise<void>;
70
+ cancelNotebookCellExecution(uri: URI, cellHandles: number[]): Promise<void>;
71
+ }
72
+
73
+ export const enum ProxyKernelState {
74
+ Disconnected = 1,
75
+ Connected = 2,
76
+ Initializing = 3
77
+ }
78
+
79
+ export interface INotebookProxyKernelChangeEvent extends NotebookKernelChangeEvent {
80
+ connectionState?: true;
81
+ }
82
+
83
+ export interface NotebookTextModelLike { uri: URI; viewType: string }
84
+
85
+ class KernelInfo {
86
+
87
+ protected static instanceCounter = 0;
88
+
89
+ score: number;
90
+ readonly kernel: NotebookKernel;
91
+ readonly handle: number;
92
+
93
+ constructor(kernel: NotebookKernel) {
94
+ this.kernel = kernel;
95
+ this.score = -1;
96
+ this.handle = KernelInfo.instanceCounter++;
97
+ }
98
+ }
99
+
100
+ export interface NotebookSourceActionChangeEvent {
101
+ notebook?: URI;
102
+ viewType: string;
103
+ }
104
+
105
+ export interface KernelSourceActionProvider {
106
+ readonly viewType: string;
107
+ onDidChangeSourceActions?: Event<void>;
108
+ provideKernelSourceActions(): Promise<NotebookKernelSourceAction[]>;
109
+ }
110
+
111
+ export class SourceCommand implements Disposable {
112
+ execution: Promise<void> | undefined;
113
+ protected readonly onDidChangeStateEmitter = new Emitter<void>();
114
+ readonly onDidChangeState = this.onDidChangeStateEmitter.event;
115
+
116
+ constructor(
117
+ readonly command: Command,
118
+ readonly model: NotebookTextModelLike,
119
+ ) { }
120
+
121
+ async run(commandService: CommandService): Promise<void> {
122
+ if (this.execution) {
123
+ return this.execution;
124
+ }
125
+
126
+ this.execution = this.runCommand(commandService);
127
+ this.onDidChangeStateEmitter.fire();
128
+ await this.execution;
129
+ this.execution = undefined;
130
+ this.onDidChangeStateEmitter.fire();
131
+ }
132
+
133
+ protected async runCommand(commandService: CommandService): Promise<void> {
134
+ try {
135
+ await commandService.executeCommand(this.command.id, {
136
+ uri: this.model.uri,
137
+ });
138
+
139
+ } catch (error) {
140
+ console.warn(`Kernel source command failed: ${error}`);
141
+ }
142
+ }
143
+
144
+ dispose(): void {
145
+ this.onDidChangeStateEmitter.dispose();
146
+ }
147
+
148
+ }
149
+
150
+ const NOTEBOOK_KERNEL_BINDING_STORAGE_KEY = 'notebook.kernel.bindings';
151
+ @injectable()
152
+ export class NotebookKernelService {
153
+
154
+ @inject(NotebookService)
155
+ protected notebookService: NotebookService;
156
+
157
+ @inject(StorageService)
158
+ protected storageService: StorageService;
159
+
160
+ protected readonly kernels = new Map<string, KernelInfo>();
161
+
162
+ protected notebookBindings: Record<string, string> = {};
163
+
164
+ protected readonly kernelDetectionTasks = new Map<string, string[]>();
165
+ protected readonly onDidChangeKernelDetectionTasksEmitter = new Emitter<string>();
166
+ readonly onDidChangeKernelDetectionTasks = this.onDidChangeKernelDetectionTasksEmitter.event;
167
+
168
+ protected readonly onDidChangeSourceActionsEmitter = new Emitter<NotebookSourceActionChangeEvent>();
169
+ protected readonly kernelSourceActionProviders = new Map<string, KernelSourceActionProvider[]>();
170
+ readonly onDidChangeSourceActions: Event<NotebookSourceActionChangeEvent> = this.onDidChangeSourceActionsEmitter.event;
171
+
172
+ protected readonly onDidAddKernelEmitter = new Emitter<NotebookKernel>();
173
+ readonly onDidAddKernel: Event<NotebookKernel> = this.onDidAddKernelEmitter.event;
174
+
175
+ protected readonly onDidRemoveKernelEmitter = new Emitter<NotebookKernel>();
176
+ readonly onDidRemoveKernel: Event<NotebookKernel> = this.onDidRemoveKernelEmitter.event;
177
+
178
+ protected readonly onDidChangeSelectedNotebookKernelBindingEmitter = new Emitter<SelectedNotebookKernelChangeEvent>();
179
+ readonly onDidChangeSelectedKernel: Event<SelectedNotebookKernelChangeEvent> = this.onDidChangeSelectedNotebookKernelBindingEmitter.event;
180
+
181
+ protected readonly onDidChangeNotebookAffinityEmitter = new Emitter<void>();
182
+ readonly onDidChangeNotebookAffinity: Event<void> = this.onDidChangeNotebookAffinityEmitter.event;
183
+
184
+ @postConstruct()
185
+ init(): void {
186
+ this.notebookService.onDidAddNotebookDocument(model => this.tryAutoBindNotebook(model));
187
+ this.storageService.getData(NOTEBOOK_KERNEL_BINDING_STORAGE_KEY).then((value: Record<string, string> | undefined) => {
188
+ if (value) {
189
+ this.notebookBindings = value;
190
+ }
191
+ });
192
+ }
193
+
194
+ registerKernel(kernel: NotebookKernel): Disposable {
195
+ if (this.kernels.has(kernel.id)) {
196
+ throw new Error(`Notebook Controller with id '${kernel.id}' already exists`);
197
+ }
198
+
199
+ this.kernels.set(kernel.id, new KernelInfo(kernel));
200
+ this.onDidAddKernelEmitter.fire(kernel);
201
+
202
+ // auto associate the new kernel to existing notebooks it was
203
+ // associated to in the past.
204
+ for (const notebook of this.notebookService.getNotebookModels()) {
205
+ this.tryAutoBindNotebook(notebook, kernel);
206
+ }
207
+
208
+ return Disposable.create(() => {
209
+ if (this.kernels.delete(kernel.id)) {
210
+ this.onDidRemoveKernelEmitter.fire(kernel);
211
+ }
212
+ });
213
+ }
214
+
215
+ /**
216
+ * Helps to find the best matching kernel for a notebook.
217
+ * @param notebook notebook to get the matching kernel for
218
+ * @returns and object containing:
219
+ * all kernels sorted to match the notebook best first (affinity ascending, score descending, label))
220
+ * the selected kernel (if any)
221
+ * specific suggested kernels (if any)
222
+ * hidden kernels (if any)
223
+ */
224
+ getMatchingKernel(notebook: NotebookTextModelLike): NotebookKernelMatchResult {
225
+ const kernels: { kernel: NotebookKernel; instanceAffinity: number; score: number }[] = [];
226
+ for (const info of this.kernels.values()) {
227
+ const score = NotebookKernelService.score(info.kernel, notebook);
228
+ if (score) {
229
+ kernels.push({
230
+ score,
231
+ kernel: info.kernel,
232
+ instanceAffinity: 1 /* vscode.NotebookControllerPriority.Default */,
233
+ });
234
+ }
235
+ }
236
+
237
+ kernels
238
+ .sort((a, b) => b.instanceAffinity - a.instanceAffinity || a.score - b.score || a.kernel.label.localeCompare(b.kernel.label));
239
+ const all = kernels.map(obj => obj.kernel);
240
+
241
+ // bound kernel
242
+ const selected = this.getSelectedNotebookKernel(notebook);
243
+ const suggestions = kernels.filter(item => item.instanceAffinity > 1).map(item => item.kernel); // TODO implement notebookAffinity
244
+ const hidden = kernels.filter(item => item.instanceAffinity < 0).map(item => item.kernel);
245
+ return { all, selected, suggestions, hidden };
246
+
247
+ }
248
+
249
+ getSelectedNotebookKernel(notebook: NotebookTextModelLike): NotebookKernel | undefined {
250
+ const selectedId = this.notebookBindings[`${notebook.viewType}/${notebook.uri}`];
251
+ return selectedId ? this.kernels.get(selectedId)?.kernel : undefined;
252
+ }
253
+
254
+ selectKernelForNotebook(kernel: NotebookKernel | undefined, notebook: NotebookTextModelLike): void {
255
+ const key = `${notebook.viewType}/${notebook.uri}`;
256
+ const oldKernel = this.notebookBindings[key];
257
+ if (oldKernel !== kernel?.id) {
258
+ if (kernel) {
259
+ this.notebookBindings[key] = kernel.id;
260
+ } else {
261
+ delete this.notebookBindings[key];
262
+ }
263
+ this.storageService.setData(NOTEBOOK_KERNEL_BINDING_STORAGE_KEY, this.notebookBindings);
264
+ this.onDidChangeSelectedNotebookKernelBindingEmitter.fire({ notebook: notebook.uri, oldKernel, newKernel: kernel?.id });
265
+ }
266
+ }
267
+
268
+ getSelectedOrSuggestedKernel(notebook: NotebookModel): NotebookKernel | undefined {
269
+ const info = this.getMatchingKernel(notebook);
270
+ if (info.selected) {
271
+ return info.selected;
272
+ }
273
+
274
+ return info.all.length === 1 ? info.all[0] : undefined;
275
+ }
276
+
277
+ getKernel(id: string): NotebookKernel | undefined {
278
+ return this.kernels.get(id)?.kernel;
279
+ }
280
+
281
+ protected static score(kernel: NotebookKernel, notebook: NotebookTextModelLike): number {
282
+ if (kernel.viewType === notebook.viewType) {
283
+ return 10;
284
+ } else if (kernel.viewType === '*') {
285
+ return 5;
286
+ } else {
287
+ return 0;
288
+ }
289
+ }
290
+
291
+ protected tryAutoBindNotebook(notebook: NotebookModel, onlyThisKernel?: NotebookKernel): void {
292
+
293
+ const id = this.notebookBindings[`${notebook.viewType}/${notebook.uri}`];
294
+ if (!id) {
295
+ // no kernel associated
296
+ return;
297
+ }
298
+ const existingKernel = this.kernels.get(id);
299
+ if (!existingKernel || !NotebookKernelService.score(existingKernel.kernel, notebook)) {
300
+ // associated kernel not known, not matching
301
+ return;
302
+ }
303
+ if (!onlyThisKernel || existingKernel.kernel === onlyThisKernel) {
304
+ this.onDidChangeSelectedNotebookKernelBindingEmitter.fire({ notebook: notebook.uri, oldKernel: undefined, newKernel: existingKernel.kernel.id });
305
+ }
306
+ }
307
+
308
+ registerNotebookKernelDetectionTask(notebookType: string): Disposable {
309
+ const all = this.kernelDetectionTasks.get(notebookType) ?? [];
310
+ all.push(notebookType);
311
+ this.kernelDetectionTasks.set(notebookType, all);
312
+ this.onDidChangeKernelDetectionTasksEmitter.fire(notebookType);
313
+ return Disposable.create(() => {
314
+ const allTasks = this.kernelDetectionTasks.get(notebookType) ?? [];
315
+ const taskIndex = allTasks.indexOf(notebookType);
316
+ if (taskIndex >= 0) {
317
+ allTasks.splice(taskIndex, 1);
318
+ this.kernelDetectionTasks.set(notebookType, allTasks);
319
+ this.onDidChangeKernelDetectionTasksEmitter.fire(notebookType);
320
+ }
321
+ });
322
+ }
323
+
324
+ getKernelDetectionTasks(notebook: NotebookTextModelLike): string[] {
325
+ return this.kernelDetectionTasks.get(notebook.viewType) ?? [];
326
+ }
327
+
328
+ registerKernelSourceActionProvider(viewType: string, provider: KernelSourceActionProvider): Disposable {
329
+ const providers = this.kernelSourceActionProviders.get(viewType) ?? [];
330
+ providers.push(provider);
331
+ this.kernelSourceActionProviders.set(viewType, providers);
332
+ this.onDidChangeSourceActionsEmitter.fire({ viewType: viewType });
333
+
334
+ const eventEmitterDisposable = provider.onDidChangeSourceActions?.(() => {
335
+ this.onDidChangeSourceActionsEmitter.fire({ viewType: viewType });
336
+ });
337
+
338
+ return Disposable.create(() => {
339
+ const sourceProviders = this.kernelSourceActionProviders.get(viewType) ?? [];
340
+ const providerIndex = sourceProviders.indexOf(provider);
341
+ if (providerIndex >= 0) {
342
+ sourceProviders.splice(providerIndex, 1);
343
+ this.kernelSourceActionProviders.set(viewType, sourceProviders);
344
+ }
345
+
346
+ eventEmitterDisposable?.dispose();
347
+ });
348
+ }
349
+
350
+ async getKernelSourceActionsFromProviders(notebook: NotebookTextModelLike): Promise<NotebookKernelSourceAction[]> {
351
+ const viewType = notebook.viewType;
352
+ const providers = this.kernelSourceActionProviders.get(viewType) ?? [];
353
+ const promises = providers.map(provider => provider.provideKernelSourceActions());
354
+ const allActions = await Promise.all(promises);
355
+ return allActions.flat();
356
+ }
357
+ }