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
|
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import * as DOM from 'vs/base/browser/dom';
import { IListRenderer, IListVirtualDelegate } from 'vs/base/browser/ui/list/list';
import { VSBuffer } from 'vs/base/common/buffer';
import { NotImplementedError } from 'vs/base/common/errors';
import { Emitter, Event } from 'vs/base/common/event';
import { DisposableStore } from 'vs/base/common/lifecycle';
import { Mimes } from 'vs/base/common/mime';
import { URI } from 'vs/base/common/uri';
import { mock } from 'vs/base/test/common/mock';
import { ILanguageConfigurationService } from 'vs/editor/common/languages/languageConfigurationRegistry';
import { ILanguageService } from 'vs/editor/common/languages/language';
import { LanguageService } from 'vs/editor/common/services/languageService';
import { IModelService } from 'vs/editor/common/services/model';
import { ModelService } from 'vs/editor/common/services/modelService';
import { ITextModelService } from 'vs/editor/common/services/resolverService';
import { TestLanguageConfigurationService } from 'vs/editor/test/common/modes/testLanguageConfigurationService';
import { IClipboardService } from 'vs/platform/clipboard/common/clipboardService';
import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
import { TestConfigurationService } from 'vs/platform/configuration/test/common/testConfigurationService';
import { ContextKeyService } from 'vs/platform/contextkey/browser/contextKeyService';
import { IContextKeyService } from 'vs/platform/contextkey/common/contextkey';
import { TestInstantiationService } from 'vs/platform/instantiation/test/common/instantiationServiceMock';
import { ILayoutService } from 'vs/platform/layout/browser/layoutService';
import { IListService, ListService } from 'vs/platform/list/browser/listService';
import { ILogService, NullLogService } from 'vs/platform/log/common/log';
import { IStorageService } from 'vs/platform/storage/common/storage';
import { IThemeService } from 'vs/platform/theme/common/themeService';
import { TestThemeService } from 'vs/platform/theme/test/common/testThemeService';
import { IUndoRedoService } from 'vs/platform/undoRedo/common/undoRedo';
import { UndoRedoService } from 'vs/platform/undoRedo/common/undoRedoService';
import { IWorkspaceTrustRequestService } from 'vs/platform/workspace/common/workspaceTrust';
import { EditorInput } from 'vs/workbench/common/editor/editorInput';
import { EditorModel } from 'vs/workbench/common/editor/editorModel';
import { CellFindMatchWithIndex, IActiveNotebookEditorDelegate, ICellViewModel, INotebookEditorDelegate } from 'vs/workbench/contrib/notebook/browser/notebookBrowser';
import { ListViewInfoAccessor, NotebookCellList } from 'vs/workbench/contrib/notebook/browser/view/notebookCellList';
import { NotebookEventDispatcher } from 'vs/workbench/contrib/notebook/browser/viewModel/eventDispatcher';
import { CellViewModel, NotebookViewModel } from 'vs/workbench/contrib/notebook/browser/viewModel/notebookViewModelImpl';
import { ViewContext } from 'vs/workbench/contrib/notebook/browser/viewModel/viewContext';
import { NotebookCellTextModel } from 'vs/workbench/contrib/notebook/common/model/notebookCellTextModel';
import { NotebookTextModel } from 'vs/workbench/contrib/notebook/common/model/notebookTextModel';
import { CellKind, CellUri, INotebookDiffEditorModel, INotebookEditorModel, INotebookSearchOptions, IOutputDto, IResolvedNotebookEditorModel, NotebookCellExecutionState, NotebookCellMetadata, SelectionStateType } from 'vs/workbench/contrib/notebook/common/notebookCommon';
import { ICellExecuteUpdate, ICellExecutionComplete, ICellExecutionStateChangedEvent, INotebookCellExecution, INotebookExecutionStateService, INotebookFailStateChangedEvent } from 'vs/workbench/contrib/notebook/common/notebookExecutionStateService';
import { NotebookOptions } from 'vs/workbench/contrib/notebook/common/notebookOptions';
import { ICellRange } from 'vs/workbench/contrib/notebook/common/notebookRange';
import { TextModelResolverService } from 'vs/workbench/services/textmodelResolver/common/textModelResolverService';
import { TestWorkspaceTrustRequestService } from 'vs/workbench/services/workspaces/test/common/testWorkspaceTrustService';
import { TestLayoutService } from 'vs/workbench/test/browser/workbenchTestServices';
import { TestStorageService } from 'vs/workbench/test/common/workbenchTestServices';
import { ResourceMap } from 'vs/base/common/map';
import { TestClipboardService } from 'vs/platform/clipboard/test/common/testClipboardService';
import { IWorkingCopySaveEvent } from 'vs/workbench/services/workingCopy/common/workingCopy';
export class TestCell extends NotebookCellTextModel {
constructor(
public viewType: string,
handle: number,
public source: string,
language: string,
cellKind: CellKind,
outputs: IOutputDto[],
languageService: ILanguageService,
) {
super(CellUri.generate(URI.parse('test:///fake/notebook'), handle), handle, source, language, Mimes.text, cellKind, outputs, undefined, undefined, undefined, { transientCellMetadata: {}, transientDocumentMetadata: {}, transientOutputs: false }, languageService);
}
}
export class NotebookEditorTestModel extends EditorModel implements INotebookEditorModel {
private _dirty = false;
protected readonly _onDidSave = this._register(new Emitter<IWorkingCopySaveEvent>());
readonly onDidSave = this._onDidSave.event;
protected readonly _onDidChangeDirty = this._register(new Emitter<void>());
readonly onDidChangeDirty = this._onDidChangeDirty.event;
readonly onDidChangeOrphaned = Event.None;
readonly onDidChangeReadonly = Event.None;
private readonly _onDidChangeContent = this._register(new Emitter<void>());
readonly onDidChangeContent: Event<void> = this._onDidChangeContent.event;
get viewType() {
return this._notebook.viewType;
}
get resource() {
return this._notebook.uri;
}
get notebook(): NotebookTextModel {
return this._notebook;
}
constructor(
private _notebook: NotebookTextModel
) {
super();
if (_notebook && _notebook.onDidChangeContent) {
this._register(_notebook.onDidChangeContent(() => {
this._dirty = true;
this._onDidChangeDirty.fire();
this._onDidChangeContent.fire();
}));
}
}
isReadonly(): boolean {
return false;
}
isOrphaned(): boolean {
return false;
}
hasAssociatedFilePath(): boolean {
return false;
}
isDirty() {
return this._dirty;
}
getNotebook(): NotebookTextModel {
return this._notebook;
}
async load(): Promise<IResolvedNotebookEditorModel> {
return this;
}
async save(): Promise<boolean> {
if (this._notebook) {
this._dirty = false;
this._onDidChangeDirty.fire();
this._onDidSave.fire({});
// todo, flush all states
return true;
}
return false;
}
saveAs(): Promise<EditorInput | undefined> {
throw new NotImplementedError();
}
revert(): Promise<void> {
throw new NotImplementedError();
}
}
export function setupInstantiationService(disposables = new DisposableStore()) {
const instantiationService = new TestInstantiationService();
instantiationService.stub(ILanguageService, disposables.add(new LanguageService()));
instantiationService.stub(IUndoRedoService, instantiationService.createInstance(UndoRedoService));
instantiationService.stub(IConfigurationService, new TestConfigurationService());
instantiationService.stub(IThemeService, new TestThemeService());
instantiationService.stub(ILanguageConfigurationService, new TestLanguageConfigurationService());
instantiationService.stub(IModelService, instantiationService.createInstance(ModelService));
instantiationService.stub(ITextModelService, <ITextModelService>instantiationService.createInstance(TextModelResolverService));
instantiationService.stub(IContextKeyService, instantiationService.createInstance(ContextKeyService));
instantiationService.stub(IListService, instantiationService.createInstance(ListService));
instantiationService.stub(ILayoutService, new TestLayoutService());
instantiationService.stub(ILogService, new NullLogService());
instantiationService.stub(IClipboardService, TestClipboardService);
instantiationService.stub(IStorageService, new TestStorageService());
instantiationService.stub(IWorkspaceTrustRequestService, new TestWorkspaceTrustRequestService(true));
instantiationService.stub(INotebookExecutionStateService, new TestNotebookExecutionStateService());
return instantiationService;
}
function _createTestNotebookEditor(instantiationService: TestInstantiationService, cells: [source: string, lang: string, kind: CellKind, output?: IOutputDto[], metadata?: NotebookCellMetadata][]): { editor: IActiveNotebookEditorDelegate; viewModel: NotebookViewModel } {
const viewType = 'notebook';
const notebook = instantiationService.createInstance(NotebookTextModel, viewType, URI.parse('test'), cells.map(cell => {
return {
source: cell[0],
language: cell[1],
cellKind: cell[2],
outputs: cell[3] ?? [],
metadata: cell[4]
};
}), {}, { transientCellMetadata: {}, transientDocumentMetadata: {}, transientOutputs: false });
const model = new NotebookEditorTestModel(notebook);
const notebookOptions = new NotebookOptions(instantiationService.get(IConfigurationService), instantiationService.get(INotebookExecutionStateService));
const viewContext = new ViewContext(notebookOptions, new NotebookEventDispatcher());
const viewModel: NotebookViewModel = instantiationService.createInstance(NotebookViewModel, viewType, model.notebook, viewContext, null, { isReadOnly: false });
const cellList = createNotebookCellList(instantiationService, viewContext);
cellList.attachViewModel(viewModel);
const listViewInfoAccessor = new ListViewInfoAccessor(cellList);
const notebookEditor: IActiveNotebookEditorDelegate = new class extends mock<IActiveNotebookEditorDelegate>() {
override dispose() {
viewModel.dispose();
}
override notebookOptions = notebookOptions;
override onDidChangeModel: Event<NotebookTextModel | undefined> = new Emitter<NotebookTextModel | undefined>().event;
override _getViewModel(): NotebookViewModel {
return viewModel;
}
override textModel = viewModel.notebookDocument;
override hasModel(): this is IActiveNotebookEditorDelegate {
return !!viewModel;
}
override getLength() { return viewModel.length; }
override getFocus() { return viewModel.getFocus(); }
override getSelections() { return viewModel.getSelections(); }
override setFocus(focus: ICellRange) {
viewModel.updateSelectionsState({
kind: SelectionStateType.Index,
focus: focus,
selections: viewModel.getSelections()
});
}
override setSelections(selections: ICellRange[]) {
viewModel.updateSelectionsState({
kind: SelectionStateType.Index,
focus: viewModel.getFocus(),
selections: selections
});
}
override getViewIndexByModelIndex(index: number) { return listViewInfoAccessor.getViewIndex(viewModel.viewCells[index]); }
override getCellRangeFromViewRange(startIndex: number, endIndex: number) { return listViewInfoAccessor.getCellRangeFromViewRange(startIndex, endIndex); }
override revealCellRangeInView() { }
override setHiddenAreas(_ranges: ICellRange[]): boolean {
return cellList.setHiddenAreas(_ranges, true);
}
override getActiveCell() {
const elements = cellList.getFocusedElements();
if (elements && elements.length) {
return elements[0];
}
return undefined;
}
override hasOutputTextSelection() {
return false;
}
override changeModelDecorations() { return null; }
override focusElement() { }
override setCellEditorSelection() { }
override async revealRangeInCenterIfOutsideViewportAsync() { }
override async layoutNotebookCell() { }
override async removeInset() { }
override async focusNotebookCell() { }
override cellAt(index: number) { return viewModel.cellAt(index)!; }
override getCellIndex(cell: ICellViewModel) { return viewModel.getCellIndex(cell); }
override getCellsInRange(range?: ICellRange) { return viewModel.getCellsInRange(range); }
override getNextVisibleCellIndex(index: number) { return viewModel.getNextVisibleCellIndex(index); }
getControl() { return this; }
override get onDidChangeSelection() { return viewModel.onDidChangeSelection as Event<any>; }
override get onDidChangeOptions() { return viewModel.onDidChangeOptions; }
override get onDidChangeViewCells() { return viewModel.onDidChangeViewCells; }
override async find(query: string, options: INotebookSearchOptions): Promise<CellFindMatchWithIndex[]> {
const findMatches = viewModel.find(query, options).filter(match => match.matches.length > 0);
return findMatches;
}
override deltaCellDecorations() { return []; }
};
return { editor: notebookEditor, viewModel };
}
export function createTestNotebookEditor(instantiationService: TestInstantiationService, cells: [source: string, lang: string, kind: CellKind, output?: IOutputDto[], metadata?: NotebookCellMetadata][]): { editor: INotebookEditorDelegate; viewModel: NotebookViewModel } {
return _createTestNotebookEditor(instantiationService, cells);
}
export async function withTestNotebookDiffModel<R = any>(originalCells: [source: string, lang: string, kind: CellKind, output?: IOutputDto[], metadata?: NotebookCellMetadata][], modifiedCells: [source: string, lang: string, kind: CellKind, output?: IOutputDto[], metadata?: NotebookCellMetadata][], callback: (diffModel: INotebookDiffEditorModel, accessor: TestInstantiationService) => Promise<R> | R): Promise<R> {
const disposables = new DisposableStore();
const instantiationService = setupInstantiationService(disposables);
const originalNotebook = createTestNotebookEditor(instantiationService, originalCells);
const modifiedNotebook = createTestNotebookEditor(instantiationService, modifiedCells);
const originalResource = new class extends mock<IResolvedNotebookEditorModel>() {
override get notebook() {
return originalNotebook.viewModel.notebookDocument;
}
};
const modifiedResource = new class extends mock<IResolvedNotebookEditorModel>() {
override get notebook() {
return modifiedNotebook.viewModel.notebookDocument;
}
};
const model = new class extends mock<INotebookDiffEditorModel>() {
override get original() {
return originalResource;
}
override get modified() {
return modifiedResource;
}
};
const res = await callback(model, instantiationService);
if (res instanceof Promise) {
res.finally(() => {
originalNotebook.editor.dispose();
originalNotebook.viewModel.dispose();
modifiedNotebook.editor.dispose();
modifiedNotebook.viewModel.dispose();
disposables.dispose();
});
} else {
originalNotebook.editor.dispose();
originalNotebook.viewModel.dispose();
modifiedNotebook.editor.dispose();
modifiedNotebook.viewModel.dispose();
disposables.dispose();
}
return res;
}
export async function withTestNotebook<R = any>(cells: [source: string, lang: string, kind: CellKind, output?: IOutputDto[], metadata?: NotebookCellMetadata][], callback: (editor: IActiveNotebookEditorDelegate, viewModel: NotebookViewModel, accessor: TestInstantiationService) => Promise<R> | R, accessor?: TestInstantiationService): Promise<R> {
const disposables = new DisposableStore();
const instantiationService = accessor ?? setupInstantiationService(disposables);
const notebookEditor = _createTestNotebookEditor(instantiationService, cells);
const res = await callback(notebookEditor.editor, notebookEditor.viewModel, instantiationService);
if (res instanceof Promise) {
res.finally(() => {
notebookEditor.editor.dispose();
notebookEditor.viewModel.dispose();
disposables.dispose();
});
} else {
notebookEditor.editor.dispose();
notebookEditor.viewModel.dispose();
disposables.dispose();
}
return res;
}
export function createNotebookCellList(instantiationService: TestInstantiationService, viewContext?: ViewContext) {
const delegate: IListVirtualDelegate<CellViewModel> = {
getHeight(element: CellViewModel) { return element.getHeight(17); },
getTemplateId() { return 'template'; }
};
const renderer: IListRenderer<number, void> = {
templateId: 'template',
renderTemplate() { },
renderElement() { },
disposeTemplate() { }
};
const cellList: NotebookCellList = instantiationService.createInstance(
NotebookCellList,
'NotebookCellList',
DOM.$('container'),
DOM.$('body'),
viewContext ?? new ViewContext(new NotebookOptions(instantiationService.get(IConfigurationService), instantiationService.get(INotebookExecutionStateService)), new NotebookEventDispatcher()),
delegate,
[renderer],
instantiationService.get<IContextKeyService>(IContextKeyService),
{
supportDynamicHeights: true,
multipleSelectionSupport: true,
focusNextPreviousDelegate: {
onFocusNext: (applyFocusNext: () => void) => { applyFocusNext(); },
onFocusPrevious: (applyFocusPrevious: () => void) => { applyFocusPrevious(); },
}
}
);
return cellList;
}
export function valueBytesFromString(value: string): VSBuffer {
return VSBuffer.fromString(value);
}
class TestCellExecution implements INotebookCellExecution {
constructor(
readonly notebook: URI,
readonly cellHandle: number,
private onComplete: () => void,
) { }
readonly state: NotebookCellExecutionState = NotebookCellExecutionState.Unconfirmed;
readonly didPause: boolean = false;
readonly isPaused: boolean = false;
confirm(): void {
}
update(updates: ICellExecuteUpdate[]): void {
}
complete(complete: ICellExecutionComplete): void {
this.onComplete();
}
}
class TestNotebookExecutionStateService implements INotebookExecutionStateService {
getLastFailedCellForNotebook(notebook: URI): number | undefined {
return;
}
_serviceBrand: undefined;
private _executions = new ResourceMap<INotebookCellExecution>();
onDidChangeCellExecution = new Emitter<ICellExecutionStateChangedEvent>().event;
onDidChangeLastRunFailState = new Emitter<INotebookFailStateChangedEvent>().event;
forceCancelNotebookExecutions(notebookUri: URI): void {
}
getCellExecutionStatesForNotebook(notebook: URI): INotebookCellExecution[] {
return [];
}
getCellExecution(cellUri: URI): INotebookCellExecution | undefined {
return this._executions.get(cellUri);
}
createCellExecution(notebook: URI, cellHandle: number): INotebookCellExecution {
const onComplete = () => this._executions.delete(CellUri.generate(notebook, cellHandle));
const exe = new TestCellExecution(notebook, cellHandle, onComplete);
this._executions.set(CellUri.generate(notebook, cellHandle), exe);
return exe;
}
}
|