/*--------------------------------------------------------------------------------------------- * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. See License.txt in the project root for license information. *--------------------------------------------------------------------------------------------*/ import 'mocha'; import * as assert from 'assert'; import * as vscode from 'vscode'; import { createRandomFile, asPromise, disposeAll, closeAllEditors, revertAllDirty, saveAllEditors, assertNoRpc } from '../utils'; // Since `workbench.action.splitEditor` command does await properly // Notebook editor/document events are not guaranteed to be sent to the ext host when promise resolves // The workaround here is waiting for the first visible notebook editor change event. async function splitEditor() { const once = asPromise(vscode.window.onDidChangeVisibleNotebookEditors); await vscode.commands.executeCommand('workbench.action.splitEditor'); await once; } async function saveFileAndCloseAll(resource: vscode.Uri) { const documentClosed = new Promise((resolve, _reject) => { const d = vscode.notebook.onDidCloseNotebookDocument(e => { if (e.uri.toString() === resource.toString()) { d.dispose(); resolve(); } }); }); await vscode.commands.executeCommand('workbench.action.files.save'); await closeAllEditors(); await documentClosed; } async function saveAllFilesAndCloseAll(resource: vscode.Uri | undefined) { const documentClosed = new Promise((resolve, _reject) => { if (!resource) { return resolve(); } const d = vscode.notebook.onDidCloseNotebookDocument(e => { if (e.uri.toString() === resource.toString()) { d.dispose(); resolve(); } }); }); await vscode.commands.executeCommand('workbench.action.files.saveAll'); await closeAllEditors(); await documentClosed; } async function withEvent(event: vscode.Event, callback: (e: Promise) => Promise) { const e = asPromise(event); await callback(e); } const kernel1 = new class implements vscode.NotebookKernel { readonly id = 'mainKernel'; readonly label = 'Notebook Test Kernel'; readonly isPreferred = true; readonly supportedLanguages = ['typescript', 'javascript']; async executeCellsRequest(document: vscode.NotebookDocument, ranges: vscode.NotebookCellRange[]) { if (ranges.length > 1 || ranges[0].start + 1 < ranges[0].end) { // Keeping same behavior... if the full notebook is executed, just execute the first cell const task = vscode.notebook.createNotebookCellExecutionTask(document.uri, 0, 'mainKernel'); if (!task) { return; } task.start(); await task.replaceOutput(new vscode.NotebookCellOutput([ new vscode.NotebookCellOutputItem('text/plain', ['my output'], undefined) ])); task.end({ success: true }); return; } for (let range of ranges) { for (let i = range.start; i < range.end; i++) { await this.runCell(document, i); } } } private async runCell(document: vscode.NotebookDocument, idx: number) { const task = vscode.notebook.createNotebookCellExecutionTask(document.uri, idx, 'mainKernel'); if (!task) { return; } task.start(); task.executionOrder = 1; if (document.uri.path.endsWith('customRenderer.vsctestnb')) { await task.replaceOutput([new vscode.NotebookCellOutput([ new vscode.NotebookCellOutputItem('text/custom', ['test'], undefined) ])]); return; } await task.replaceOutput([new vscode.NotebookCellOutput([ new vscode.NotebookCellOutputItem('text/plain', ['my output'], undefined) ])]); task.end({ success: true }); } }; const kernel2 = new class implements vscode.NotebookKernel { readonly id = 'secondaryKernel'; readonly label = 'Notebook Secondary Test Kernel'; readonly isPreferred = false; readonly supportedLanguages = ['typescript', 'javascript']; async executeCellsRequest(document: vscode.NotebookDocument, ranges: vscode.NotebookCellRange[]) { if (ranges.length > 1 || ranges[0].start + 1 < ranges[0].end) { // Keeping same behavior... if the full notebook is executed, just execute the first cell const task = vscode.notebook.createNotebookCellExecutionTask(document.uri, 0, 'secondaryKernel'); if (!task) { return; } task.start(); await task.replaceOutput([new vscode.NotebookCellOutput([ new vscode.NotebookCellOutputItem('text/plain', ['my second output'], undefined) ])]); task.end({ success: true }); return; } for (let range of ranges) { for (let i = range.start; i < range.end; i++) { await this.runCell(document, i); } } } private async runCell(document: vscode.NotebookDocument, idx: number) { const task = vscode.notebook.createNotebookCellExecutionTask(document.uri, idx, 'mainKernel'); if (!task) { return; } task.start(); if (document.uri.path.endsWith('customRenderer.vsctestnb')) { task.replaceOutput([new vscode.NotebookCellOutput([ new vscode.NotebookCellOutputItem('text/custom', ['test 2'], undefined) ])]); task.end({ success: true }); return; } await task.replaceOutput([new vscode.NotebookCellOutput([ new vscode.NotebookCellOutputItem('text/plain', ['my second output'], undefined) ])]); task.end({ success: true }); } }; class KernelProvider implements vscode.NotebookKernelProvider { private _onDidChangeKernels = new vscode.EventEmitter(); onDidChangeKernels = this._onDidChangeKernels.event; private _hasKernels = true; private readonly _kernels: vscode.NotebookKernel[] = [kernel1, kernel2]; addKernel(kernel: vscode.NotebookKernel): void { this._kernels.push(kernel); this._onDidChangeKernels.fire(undefined); } provideKernels(): vscode.ProviderResult { return this._hasKernels ? this._kernels : []; } setHasKernels(hasKernels: boolean): void { this._hasKernels = hasKernels; this._onDidChangeKernels.fire(undefined); } } let currentKernelProvider: KernelProvider; suite('Notebook API tests', function () { const testDisposables: vscode.Disposable[] = []; const suiteDisposables: vscode.Disposable[] = []; suiteTeardown(async function () { assertNoRpc(); await revertAllDirty(); await closeAllEditors(); disposeAll(suiteDisposables); suiteDisposables.length = 0; }); suiteSetup(function () { suiteDisposables.push(vscode.notebook.registerNotebookContentProvider('notebookCoreTest', { openNotebook: async (_resource: vscode.Uri): Promise => { if (/.*empty\-.*\.vsctestnb$/.test(_resource.path)) { return { metadata: new vscode.NotebookDocumentMetadata(), cells: [] }; } const dto: vscode.NotebookData = { metadata: new vscode.NotebookDocumentMetadata().with({ custom: { testMetadata: false } }), cells: [ { source: 'test', language: 'typescript', kind: vscode.NotebookCellKind.Code, outputs: [], metadata: new vscode.NotebookCellMetadata().with({ custom: { testCellMetadata: 123 } }), latestExecutionSummary: { duration: 25 } }, { source: 'test2', language: 'typescript', kind: vscode.NotebookCellKind.Code, outputs: [ new vscode.NotebookCellOutput([ new vscode.NotebookCellOutputItem('text/plain', 'Hello World', { testOutputItemMetadata: true }) ], { testOutputMetadata: true }) ], latestExecutionSummary: { executionOrder: 5, success: true }, metadata: new vscode.NotebookCellMetadata().with({ custom: { testCellMetadata: 456 } }) } ] }; return dto; }, resolveNotebook: async (_document: vscode.NotebookDocument) => { return; }, saveNotebook: async (_document: vscode.NotebookDocument, _cancellation: vscode.CancellationToken) => { return; }, saveNotebookAs: async (_targetResource: vscode.Uri, _document: vscode.NotebookDocument, _cancellation: vscode.CancellationToken) => { return; }, backupNotebook: async (_document: vscode.NotebookDocument, _context: vscode.NotebookDocumentBackupContext, _cancellation: vscode.CancellationToken) => { return { id: '1', delete: () => { } }; } })); }); setup(() => { currentKernelProvider = new KernelProvider(); testDisposables.push(vscode.notebook.registerNotebookKernelProvider({ filenamePattern: '*.vsctestnb' }, currentKernelProvider)); }); teardown(() => { disposeAll(testDisposables); testDisposables.length = 0; }); test('shared document in notebook editors', async function () { const resource = await createRandomFile(undefined, undefined, '.vsctestnb'); let counter = 0; const disposables: vscode.Disposable[] = []; disposables.push(vscode.notebook.onDidOpenNotebookDocument(() => { counter++; })); disposables.push(vscode.notebook.onDidCloseNotebookDocument(() => { counter--; })); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); assert.strictEqual(counter, 1); await splitEditor(); assert.strictEqual(counter, 1); await closeAllEditors(); assert.strictEqual(counter, 0); disposables.forEach(d => d.dispose()); }); test('editor open/close event', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); const firstEditorOpen = asPromise(vscode.window.onDidChangeVisibleNotebookEditors); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); await firstEditorOpen; const firstEditorClose = asPromise(vscode.window.onDidChangeVisibleNotebookEditors); await closeAllEditors(); await firstEditorClose; }); test('editor open/close event 2', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); let count = 0; const disposables: vscode.Disposable[] = []; disposables.push(vscode.window.onDidChangeVisibleNotebookEditors(() => { count = vscode.window.visibleNotebookEditors.length; })); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); assert.strictEqual(count, 1); await splitEditor(); assert.strictEqual(count, 2); await closeAllEditors(); assert.strictEqual(count, 0); }); test('editor editing event 2', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); const cellsChangeEvent = asPromise(vscode.notebook.onDidChangeNotebookCells); await vscode.commands.executeCommand('notebook.cell.insertCodeCellBelow'); const cellChangeEventRet = await cellsChangeEvent; assert.strictEqual(cellChangeEventRet.document, vscode.window.activeNotebookEditor?.document); assert.strictEqual(cellChangeEventRet.changes.length, 1); assert.deepStrictEqual(cellChangeEventRet.changes[0], { start: 1, deletedCount: 0, deletedItems: [], items: [ vscode.window.activeNotebookEditor!.document.cells[1] ] }); const moveCellEvent = asPromise(vscode.notebook.onDidChangeNotebookCells); await vscode.commands.executeCommand('notebook.cell.moveUp'); await moveCellEvent; const cellOutputChange = asPromise(vscode.notebook.onDidChangeCellOutputs); await vscode.commands.executeCommand('notebook.cell.execute'); const cellOutputsAddedRet = await cellOutputChange; assert.deepStrictEqual(cellOutputsAddedRet, { document: vscode.window.activeNotebookEditor!.document, cells: [vscode.window.activeNotebookEditor!.document.cells[0]] }); assert.strictEqual(cellOutputsAddedRet.cells[0].outputs.length, 1); const cellOutputClear = asPromise(vscode.notebook.onDidChangeCellOutputs); await vscode.commands.executeCommand('notebook.cell.clearOutputs'); const cellOutputsCleardRet = await cellOutputClear; assert.deepStrictEqual(cellOutputsCleardRet, { document: vscode.window.activeNotebookEditor!.document, cells: [vscode.window.activeNotebookEditor!.document.cells[0]] }); assert.strictEqual(cellOutputsAddedRet.cells[0].outputs.length, 0); // const cellChangeLanguage = getEventOncePromise(vscode.notebook.onDidChangeCellLanguage); // await vscode.commands.executeCommand('notebook.cell.changeToMarkdown'); // const cellChangeLanguageRet = await cellChangeLanguage; // assert.deepStrictEqual(cellChangeLanguageRet, { // document: vscode.window.activeNotebookEditor!.document, // cells: vscode.window.activeNotebookEditor!.document.cells[0], // language: 'markdown' // }); await saveAllFilesAndCloseAll(undefined); }); test('editor move cell event', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); await vscode.commands.executeCommand('notebook.cell.insertCodeCellBelow'); await vscode.commands.executeCommand('notebook.cell.insertCodeCellAbove'); await vscode.commands.executeCommand('notebook.focusTop'); const activeCell = vscode.window.activeNotebookEditor!.selection; assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.indexOf(activeCell!), 0); const moveChange = asPromise(vscode.notebook.onDidChangeNotebookCells); await vscode.commands.executeCommand('notebook.cell.moveDown'); await moveChange; await saveAllEditors(); await closeAllEditors(); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); const firstEditor = vscode.window.activeNotebookEditor; assert.strictEqual(firstEditor?.document.cells.length, 2); await saveAllFilesAndCloseAll(undefined); }); test('notebook editor active/visible', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); const firstEditor = vscode.window.activeNotebookEditor; assert.strictEqual(firstEditor && vscode.window.visibleNotebookEditors.indexOf(firstEditor) >= 0, true); await splitEditor(); const secondEditor = vscode.window.activeNotebookEditor; assert.strictEqual(secondEditor && vscode.window.visibleNotebookEditors.indexOf(secondEditor) >= 0, true); assert.notStrictEqual(firstEditor, secondEditor); assert.strictEqual(firstEditor && vscode.window.visibleNotebookEditors.indexOf(firstEditor) >= 0, true); assert.strictEqual(vscode.window.visibleNotebookEditors.length, 2); const untitledEditorChange = asPromise(vscode.window.onDidChangeActiveNotebookEditor); await vscode.commands.executeCommand('workbench.action.files.newUntitledFile'); await untitledEditorChange; assert.strictEqual(firstEditor && vscode.window.visibleNotebookEditors.indexOf(firstEditor) >= 0, true); assert.notStrictEqual(firstEditor, vscode.window.activeNotebookEditor); assert.strictEqual(secondEditor && vscode.window.visibleNotebookEditors.indexOf(secondEditor) < 0, true); assert.notStrictEqual(secondEditor, vscode.window.activeNotebookEditor); assert.strictEqual(vscode.window.visibleNotebookEditors.length, 1); const activeEditorClose = asPromise(vscode.window.onDidChangeActiveNotebookEditor); await vscode.commands.executeCommand('workbench.action.closeActiveEditor'); await activeEditorClose; assert.strictEqual(secondEditor, vscode.window.activeNotebookEditor); assert.strictEqual(vscode.window.visibleNotebookEditors.length, 2); assert.strictEqual(secondEditor && vscode.window.visibleNotebookEditors.indexOf(secondEditor) >= 0, true); await saveAllFilesAndCloseAll(undefined); }); test('notebook active editor change', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); const firstEditorOpen = asPromise(vscode.window.onDidChangeActiveNotebookEditor); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); await firstEditorOpen; const firstEditorDeactivate = asPromise(vscode.window.onDidChangeActiveNotebookEditor); await vscode.commands.executeCommand('workbench.action.splitEditor'); await firstEditorDeactivate; await saveFileAndCloseAll(resource); }); test('edit API (replaceMetadata)', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); await vscode.window.activeNotebookEditor!.edit(editBuilder => { editBuilder.replaceCellMetadata(0, new vscode.NotebookCellMetadata().with({ inputCollapsed: true })); }); const document = vscode.window.activeNotebookEditor?.document!; assert.strictEqual(document.cells.length, 2); assert.strictEqual(document.cells[0].metadata.inputCollapsed, true); assert.strictEqual(document.isDirty, true); await saveFileAndCloseAll(resource); }); test('edit API (replaceMetadata, event)', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); const event = asPromise(vscode.notebook.onDidChangeCellMetadata); await vscode.window.activeNotebookEditor!.edit(editBuilder => { editBuilder.replaceCellMetadata(0, new vscode.NotebookCellMetadata().with({ inputCollapsed: true })); }); const data = await event; assert.strictEqual(data.document, vscode.window.activeNotebookEditor?.document); assert.strictEqual(data.cell.metadata.inputCollapsed, true); assert.strictEqual(data.document.isDirty, true); await saveFileAndCloseAll(resource); }); test('edit API batch edits', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); const cellsChangeEvent = asPromise(vscode.notebook.onDidChangeNotebookCells); const cellMetadataChangeEvent = asPromise(vscode.notebook.onDidChangeCellMetadata); const version = vscode.window.activeNotebookEditor!.document.version; await vscode.window.activeNotebookEditor!.edit(editBuilder => { editBuilder.replaceCells(1, 0, [{ kind: vscode.NotebookCellKind.Code, language: 'javascript', source: 'test 2', outputs: [], metadata: undefined }]); editBuilder.replaceCellMetadata(0, new vscode.NotebookCellMetadata().with({ breakpointMargin: false })); }); await cellsChangeEvent; await cellMetadataChangeEvent; assert.strictEqual(version + 1, vscode.window.activeNotebookEditor!.document.version); await saveAllFilesAndCloseAll(resource); }); test('edit API batch edits undo/redo', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); const cellsChangeEvent = asPromise(vscode.notebook.onDidChangeNotebookCells); const cellMetadataChangeEvent = asPromise(vscode.notebook.onDidChangeCellMetadata); const version = vscode.window.activeNotebookEditor!.document.version; await vscode.window.activeNotebookEditor!.edit(editBuilder => { editBuilder.replaceCells(1, 0, [{ kind: vscode.NotebookCellKind.Code, language: 'javascript', source: 'test 2', outputs: [], metadata: undefined }]); editBuilder.replaceCellMetadata(0, new vscode.NotebookCellMetadata().with({ breakpointMargin: false })); }); await cellsChangeEvent; await cellMetadataChangeEvent; assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.length, 3); assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells[0]?.metadata?.breakpointMargin, false); assert.strictEqual(version + 1, vscode.window.activeNotebookEditor!.document.version); await vscode.commands.executeCommand('undo'); assert.strictEqual(version + 2, vscode.window.activeNotebookEditor!.document.version); assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells[0]?.metadata?.breakpointMargin, undefined); assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.length, 2); await saveAllFilesAndCloseAll(resource); }); test('initialzation should not emit cell change events.', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); let count = 0; const disposables: vscode.Disposable[] = []; disposables.push(vscode.notebook.onDidChangeNotebookCells(() => { count++; })); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); assert.strictEqual(count, 0); disposables.forEach(d => d.dispose()); await saveFileAndCloseAll(resource); }); // }); // suite('notebook workflow', () => { test('notebook open', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); assert.strictEqual(vscode.window.activeNotebookEditor !== undefined, true, 'notebook first'); assert.strictEqual(vscode.window.activeNotebookEditor!.selection?.document.getText(), 'test'); assert.strictEqual(vscode.window.activeNotebookEditor!.selection?.document.languageId, 'typescript'); const secondCell = vscode.window.activeNotebookEditor!.document.cells[1]; assert.strictEqual(secondCell!.outputs.length, 1); assert.deepStrictEqual(secondCell!.outputs[0].metadata, { testOutputMetadata: true }); assert.strictEqual(secondCell!.outputs[0].outputs.length, 1); assert.strictEqual(secondCell!.outputs[0].outputs[0].mime, 'text/plain'); assert.strictEqual(secondCell!.outputs[0].outputs[0].value, 'Hello World'); assert.deepStrictEqual(secondCell!.outputs[0].outputs[0].metadata, { testOutputItemMetadata: true }); assert.strictEqual(secondCell!.latestExecutionSummary?.executionOrder, 5); assert.strictEqual(secondCell!.latestExecutionSummary?.success, true); await vscode.commands.executeCommand('notebook.cell.insertCodeCellBelow'); assert.strictEqual(vscode.window.activeNotebookEditor!.selection?.document.getText(), ''); await vscode.commands.executeCommand('notebook.cell.insertCodeCellAbove'); const activeCell = vscode.window.activeNotebookEditor!.selection; assert.notEqual(vscode.window.activeNotebookEditor!.selection, undefined); assert.strictEqual(activeCell!.document.getText(), ''); assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.length, 4); assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.indexOf(activeCell!), 1); await vscode.commands.executeCommand('workbench.action.files.save'); await vscode.commands.executeCommand('workbench.action.closeActiveEditor'); }); test('notebook cell actions', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); assert.strictEqual(vscode.window.activeNotebookEditor !== undefined, true, 'notebook first'); assert.strictEqual(vscode.window.activeNotebookEditor!.selection?.document.getText(), 'test'); assert.strictEqual(vscode.window.activeNotebookEditor!.selection?.document.languageId, 'typescript'); // ---- insert cell below and focus ---- // await vscode.commands.executeCommand('notebook.cell.insertCodeCellBelow'); assert.strictEqual(vscode.window.activeNotebookEditor!.selection?.document.getText(), ''); // ---- insert cell above and focus ---- // await vscode.commands.executeCommand('notebook.cell.insertCodeCellAbove'); let activeCell = vscode.window.activeNotebookEditor!.selection; assert.notEqual(vscode.window.activeNotebookEditor!.selection, undefined); assert.strictEqual(activeCell!.document.getText(), ''); assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.length, 4); assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.indexOf(activeCell!), 1); // ---- focus bottom ---- // await vscode.commands.executeCommand('notebook.focusBottom'); activeCell = vscode.window.activeNotebookEditor!.selection; assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.indexOf(activeCell!), 3); // ---- focus top and then copy down ---- // await vscode.commands.executeCommand('notebook.focusTop'); activeCell = vscode.window.activeNotebookEditor!.selection; assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.indexOf(activeCell!), 0); await vscode.commands.executeCommand('notebook.cell.copyDown'); activeCell = vscode.window.activeNotebookEditor!.selection; assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.indexOf(activeCell!), 1); assert.strictEqual(activeCell?.document.getText(), 'test'); await vscode.commands.executeCommand('notebook.cell.delete'); activeCell = vscode.window.activeNotebookEditor!.selection; assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.indexOf(activeCell!), 1); assert.strictEqual(activeCell?.document.getText(), ''); // ---- focus top and then copy up ---- // await vscode.commands.executeCommand('notebook.focusTop'); await vscode.commands.executeCommand('notebook.cell.copyUp'); assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.length, 5); assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells[0].document.getText(), 'test'); assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells[1].document.getText(), 'test'); assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells[2].document.getText(), ''); assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells[3].document.getText(), ''); activeCell = vscode.window.activeNotebookEditor!.selection; assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.indexOf(activeCell!), 0); // ---- move up and down ---- // await vscode.commands.executeCommand('notebook.cell.moveDown'); assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.indexOf(vscode.window.activeNotebookEditor!.selection!), 1, `first move down, active cell ${vscode.window.activeNotebookEditor!.selection!.document.uri.toString()}, ${vscode.window.activeNotebookEditor!.selection!.document.getText()}`); // await vscode.commands.executeCommand('notebook.cell.moveDown'); // activeCell = vscode.window.activeNotebookEditor!.selection; // assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.indexOf(activeCell!), 2, // `second move down, active cell ${vscode.window.activeNotebookEditor!.selection!.uri.toString()}, ${vscode.window.activeNotebookEditor!.selection!.document.getText()}`); // assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells[0].document.getText(), 'test'); // assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells[1].document.getText(), ''); // assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells[2].document.getText(), 'test'); // assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells[3].document.getText(), ''); // ---- ---- // await vscode.commands.executeCommand('workbench.action.files.save'); await vscode.commands.executeCommand('workbench.action.closeActiveEditor'); }); test('notebook join cells', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); assert.strictEqual(vscode.window.activeNotebookEditor !== undefined, true, 'notebook first'); assert.strictEqual(vscode.window.activeNotebookEditor!.selection?.document.getText(), 'test'); assert.strictEqual(vscode.window.activeNotebookEditor!.selection?.document.languageId, 'typescript'); await vscode.commands.executeCommand('notebook.cell.insertCodeCellBelow'); assert.strictEqual(vscode.window.activeNotebookEditor!.selection?.document.getText(), ''); const edit = new vscode.WorkspaceEdit(); edit.insert(vscode.window.activeNotebookEditor!.selection!.document.uri, new vscode.Position(0, 0), 'var abc = 0;'); await vscode.workspace.applyEdit(edit); const cellsChangeEvent = asPromise(vscode.notebook.onDidChangeNotebookCells); await vscode.commands.executeCommand('notebook.cell.joinAbove'); await cellsChangeEvent; assert.deepStrictEqual(vscode.window.activeNotebookEditor!.selection?.document.getText().split(/\r\n|\r|\n/), ['test', 'var abc = 0;']); await vscode.commands.executeCommand('workbench.action.files.save'); await vscode.commands.executeCommand('workbench.action.closeActiveEditor'); }); test('move cells will not recreate cells in ExtHost', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); await vscode.commands.executeCommand('notebook.cell.insertCodeCellBelow'); await vscode.commands.executeCommand('notebook.cell.insertCodeCellAbove'); await vscode.commands.executeCommand('notebook.focusTop'); const activeCell = vscode.window.activeNotebookEditor!.selection; assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.indexOf(activeCell!), 0); await vscode.commands.executeCommand('notebook.cell.moveDown'); await vscode.commands.executeCommand('notebook.cell.moveDown'); const newActiveCell = vscode.window.activeNotebookEditor!.selection; assert.deepStrictEqual(activeCell, newActiveCell); await saveFileAndCloseAll(resource); }); test('document runnable based on kernel count', async () => { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); assert.strictEqual(vscode.window.activeNotebookEditor !== undefined, true, 'notebook first'); const editor = vscode.window.activeNotebookEditor!; const cell = editor.document.cells[0]; assert.strictEqual(cell.outputs.length, 0); currentKernelProvider.setHasKernels(false); await vscode.commands.executeCommand('notebook.execute'); assert.strictEqual(cell.outputs.length, 0, 'should not execute'); // not runnable, didn't work currentKernelProvider.setHasKernels(true); await withEvent(vscode.notebook.onDidChangeCellOutputs, async (event) => { await vscode.commands.executeCommand('notebook.execute'); await event; assert.strictEqual(cell.outputs.length, 1, 'should execute'); // runnable, it worked }); await saveAllFilesAndCloseAll(undefined); }); // TODO@rebornix this is wrong, `await vscode.commands.executeCommand('notebook.execute');` doesn't wait until the workspace edit is applied test.skip('cell execute command takes arguments', async () => { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); assert.strictEqual(vscode.window.activeNotebookEditor !== undefined, true, 'notebook first'); const editor = vscode.window.activeNotebookEditor!; const cell = editor.document.cells[0]; await vscode.commands.executeCommand('notebook.execute'); assert.strictEqual(cell.outputs.length, 0, 'should not execute'); // not runnable, didn't work await saveAllFilesAndCloseAll(undefined); }); test('cell execute command takes arguments 2', async () => { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); assert.strictEqual(vscode.window.activeNotebookEditor !== undefined, true, 'notebook first'); const editor = vscode.window.activeNotebookEditor!; const cell = editor.document.cells[0]; await withEvent(vscode.notebook.onDidChangeCellOutputs, async (event) => { await vscode.commands.executeCommand('notebook.execute'); await event; assert.strictEqual(cell.outputs.length, 1, 'should execute'); // runnable, it worked }); await withEvent(vscode.notebook.onDidChangeCellOutputs, async event => { await vscode.commands.executeCommand('notebook.cell.clearOutputs'); await event; assert.strictEqual(cell.outputs.length, 0, 'should clear'); }); const secondResource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', secondResource, 'notebookCoreTest'); await withEvent(vscode.notebook.onDidChangeCellOutputs, async (event) => { await vscode.commands.executeCommand('notebook.cell.execute', { start: 0, end: 1 }, resource); await event; assert.strictEqual(cell.outputs.length, 1, 'should execute'); // runnable, it worked assert.strictEqual(vscode.window.activeNotebookEditor?.document.uri.fsPath, secondResource.fsPath); }); await saveAllFilesAndCloseAll(undefined); }); test('document execute command takes arguments', async () => { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); assert.strictEqual(vscode.window.activeNotebookEditor !== undefined, true, 'notebook first'); const editor = vscode.window.activeNotebookEditor!; const cell = editor.document.cells[0]; await withEvent(vscode.notebook.onDidChangeCellOutputs, async (event) => { await vscode.commands.executeCommand('notebook.execute'); await event; assert.strictEqual(cell.outputs.length, 1, 'should execute'); // runnable, it worked }); const clearChangeEvent = asPromise(vscode.notebook.onDidChangeCellOutputs); await vscode.commands.executeCommand('notebook.cell.clearOutputs'); await clearChangeEvent; assert.strictEqual(cell.outputs.length, 0, 'should clear'); const secondResource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', secondResource, 'notebookCoreTest'); await withEvent(vscode.notebook.onDidChangeCellOutputs, async (event) => { await vscode.commands.executeCommand('notebook.execute', resource); await event; assert.strictEqual(cell.outputs.length, 1, 'should execute'); // runnable, it worked assert.strictEqual(vscode.window.activeNotebookEditor?.document.uri.fsPath, secondResource.fsPath); }); await saveAllFilesAndCloseAll(undefined); }); test('cell execute and select kernel', async () => { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); assert.strictEqual(vscode.window.activeNotebookEditor !== undefined, true, 'notebook first'); const editor = vscode.window.activeNotebookEditor!; const cell = editor.document.cells[0]; vscode.commands.executeCommand('notebook.cell.execute'); await withEvent(vscode.notebook.onDidChangeCellOutputs, async (event) => { await event; assert.strictEqual(cell.outputs.length, 1, 'should execute'); // runnable, it worked assert.strictEqual(cell.outputs[0].outputs.length, 1); assert.strictEqual(cell.outputs[0].outputs[0].mime, 'text/plain'); assert.deepStrictEqual(cell.outputs[0].outputs[0].value, [ 'my output' ]); }); await vscode.commands.executeCommand('notebook.selectKernel', { extension: 'vscode.vscode-api-tests', id: 'secondaryKernel' }); vscode.commands.executeCommand('notebook.cell.execute'); await withEvent(vscode.notebook.onDidChangeCellOutputs, async (event) => { await event; assert.strictEqual(cell.outputs.length, 1, 'should execute'); // runnable, it worked assert.strictEqual(cell.outputs[0].outputs.length, 1); assert.strictEqual(cell.outputs[0].outputs[0].mime, 'text/plain'); assert.deepStrictEqual(cell.outputs[0].outputs[0].value, [ 'my second output' ]); }); await saveAllFilesAndCloseAll(undefined); }); test('set outputs on cancel', async () => { const cancelableKernel = new class implements vscode.NotebookKernel { readonly id = 'cancelableKernel'; readonly label = 'Notebook Cancelable Test Kernel'; readonly isPreferred = false; readonly supportedLanguages = ['typescript', 'javascript']; async executeCellsRequest(document: vscode.NotebookDocument, ranges: vscode.NotebookCellRange[]) { const idx = ranges[0].start; const task = vscode.notebook.createNotebookCellExecutionTask(document.uri, idx, 'cancelableKernel'); if (!task) { return; } task.start(); task.token.onCancellationRequested(async () => { await task.replaceOutput([new vscode.NotebookCellOutput([ new vscode.NotebookCellOutputItem('text/plain', ['Canceled'], undefined) ])]); task.end({}); }); } }; currentKernelProvider.addKernel(cancelableKernel); const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); const editor = vscode.window.activeNotebookEditor!; const cell = editor.document.cells[0]; await vscode.commands.executeCommand('notebook.selectKernel', { extension: 'vscode.vscode-api-tests', id: cancelableKernel.id }); await withEvent(vscode.notebook.onDidChangeCellOutputs, async (event) => { await vscode.commands.executeCommand('notebook.cell.execute'); await vscode.commands.executeCommand('notebook.cell.cancelExecution'); await event; assert.strictEqual(cell.outputs.length, 1, 'should execute'); // runnable, it worked assert.strictEqual(cell.outputs[0].outputs.length, 1); assert.strictEqual(cell.outputs[0].outputs[0].mime, 'text/plain'); assert.deepStrictEqual(cell.outputs[0].outputs[0].value, [ 'Canceled' ]); }); await saveAllFilesAndCloseAll(undefined); }); test('set outputs on interrupt', async () => { const interruptableKernel = new class implements vscode.NotebookKernel { readonly id = 'interruptableKernel'; readonly label = 'Notebook Interruptable Test Kernel'; readonly isPreferred = false; readonly supportedLanguages = ['typescript', 'javascript']; private _task: vscode.NotebookCellExecutionTask | undefined; async executeCellsRequest(document: vscode.NotebookDocument, ranges: vscode.NotebookCellRange[]) { const idx = ranges[0].start; this._task = vscode.notebook.createNotebookCellExecutionTask(document.uri, idx, 'interruptableKernel'); if (!this._task) { return; } this._task.start(); } async interrupt(_document: vscode.NotebookDocument) { await this._task!.replaceOutput([new vscode.NotebookCellOutput([ new vscode.NotebookCellOutputItem('text/plain', ['Interrupted'], undefined) ])]); this._task!.end({}); } }; currentKernelProvider.addKernel(interruptableKernel); const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); const editor = vscode.window.activeNotebookEditor!; const cell = editor.document.cells[0]; await vscode.commands.executeCommand('notebook.selectKernel', { extension: 'vscode.vscode-api-tests', id: interruptableKernel.id }); await withEvent(vscode.notebook.onDidChangeCellOutputs, async (event) => { await vscode.commands.executeCommand('notebook.cell.execute'); await vscode.commands.executeCommand('notebook.cell.cancelExecution'); await event; assert.strictEqual(cell.outputs.length, 1, 'should execute'); // runnable, it worked assert.strictEqual(cell.outputs[0].outputs.length, 1); assert.strictEqual(cell.outputs[0].outputs[0].mime, 'text/plain'); assert.deepStrictEqual(cell.outputs[0].outputs[0].value, [ 'Interrupted' ]); }); await saveAllFilesAndCloseAll(undefined); }); test('onDidChangeCellExecutionState is fired', async () => { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); const editor = vscode.window.activeNotebookEditor!; const cell = editor.document.cells[0]; vscode.commands.executeCommand('notebook.cell.execute'); let eventCount = 0; let resolve: () => void; const p = new Promise(r => resolve = r); const listener = vscode.notebook.onDidChangeCellExecutionState(e => { if (eventCount === 0) { assert.strictEqual(e.executionState, vscode.NotebookCellExecutionState.Pending, 'should be set to Pending'); } else if (eventCount === 1) { assert.strictEqual(e.executionState, vscode.NotebookCellExecutionState.Executing, 'should be set to Executing'); assert.strictEqual(cell.outputs.length, 0, 'no outputs yet: ' + JSON.stringify(cell.outputs[0])); } else if (eventCount === 2) { assert.strictEqual(e.executionState, vscode.NotebookCellExecutionState.Idle, 'should be set to Idle'); assert.strictEqual(cell.outputs.length, 1, 'should have an output'); resolve(); } eventCount++; }); await p; listener.dispose(); await saveAllFilesAndCloseAll(undefined); }); // suite('notebook dirty state', () => { test('notebook open', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); assert.strictEqual(vscode.window.activeNotebookEditor !== undefined, true, 'notebook first'); assert.strictEqual(vscode.window.activeNotebookEditor!.selection?.document.getText(), 'test'); assert.strictEqual(vscode.window.activeNotebookEditor!.selection?.document.languageId, 'typescript'); await vscode.commands.executeCommand('notebook.cell.insertCodeCellBelow'); assert.strictEqual(vscode.window.activeNotebookEditor!.selection?.document.getText(), ''); await vscode.commands.executeCommand('notebook.cell.insertCodeCellAbove'); const activeCell = vscode.window.activeNotebookEditor!.selection; assert.notStrictEqual(vscode.window.activeNotebookEditor!.selection, undefined); assert.strictEqual(activeCell!.document.getText(), ''); assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.length, 4); assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.indexOf(activeCell!), 1); await withEvent(vscode.workspace.onDidChangeTextDocument, async event => { const edit = new vscode.WorkspaceEdit(); edit.insert(activeCell!.document.uri, new vscode.Position(0, 0), 'var abc = 0;'); await vscode.workspace.applyEdit(edit); await event; assert.strictEqual(vscode.window.activeNotebookEditor !== undefined, true); assert.strictEqual(vscode.window.activeNotebookEditor?.selection !== undefined, true); assert.deepStrictEqual(vscode.window.activeNotebookEditor?.document.cells[1], vscode.window.activeNotebookEditor?.selection); assert.strictEqual(vscode.window.activeNotebookEditor?.selection?.document.getText(), 'var abc = 0;'); }); await saveFileAndCloseAll(resource); }); // }); // suite('notebook undo redo', () => { test('notebook open', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); assert.strictEqual(vscode.window.activeNotebookEditor !== undefined, true, 'notebook first'); assert.strictEqual(vscode.window.activeNotebookEditor!.selection?.document.getText(), 'test'); assert.strictEqual(vscode.window.activeNotebookEditor!.selection?.document.languageId, 'typescript'); await vscode.commands.executeCommand('notebook.cell.insertCodeCellBelow'); assert.strictEqual(vscode.window.activeNotebookEditor!.selection?.document.getText(), ''); await vscode.commands.executeCommand('notebook.cell.insertCodeCellAbove'); const activeCell = vscode.window.activeNotebookEditor!.selection; assert.notStrictEqual(vscode.window.activeNotebookEditor!.selection, undefined); assert.strictEqual(activeCell!.document.getText(), ''); assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.length, 4); assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.indexOf(activeCell!), 1); // modify the second cell, delete it const edit = new vscode.WorkspaceEdit(); edit.insert(vscode.window.activeNotebookEditor!.selection!.document.uri, new vscode.Position(0, 0), 'var abc = 0;'); await vscode.workspace.applyEdit(edit); await vscode.commands.executeCommand('notebook.cell.delete'); assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.length, 3); assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.indexOf(vscode.window.activeNotebookEditor!.selection!), 1); // undo should bring back the deleted cell, and revert to previous content and selection await vscode.commands.executeCommand('undo'); assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.length, 4); assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.indexOf(vscode.window.activeNotebookEditor!.selection!), 1); assert.strictEqual(vscode.window.activeNotebookEditor?.selection?.document.getText(), 'var abc = 0;'); // redo // await vscode.commands.executeCommand('notebook.redo'); // assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.length, 2); // assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.indexOf(vscode.window.activeNotebookEditor!.selection!), 1); // assert.strictEqual(vscode.window.activeNotebookEditor?.selection?.document.getText(), 'test'); await saveFileAndCloseAll(resource); }); test('multiple tabs: dirty + clean', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); await vscode.commands.executeCommand('notebook.cell.insertCodeCellBelow'); assert.strictEqual(vscode.window.activeNotebookEditor!.selection?.document.getText(), ''); await vscode.commands.executeCommand('notebook.cell.insertCodeCellAbove'); const edit = new vscode.WorkspaceEdit(); edit.insert(vscode.window.activeNotebookEditor!.selection!.document.uri, new vscode.Position(0, 0), 'var abc = 0;'); await vscode.workspace.applyEdit(edit); const secondResource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', secondResource, 'notebookCoreTest'); await vscode.commands.executeCommand('workbench.action.closeActiveEditor'); // make sure that the previous dirty editor is still restored in the extension host and no data loss assert.strictEqual(vscode.window.activeNotebookEditor !== undefined, true); assert.strictEqual(vscode.window.activeNotebookEditor?.selection !== undefined, true); assert.deepStrictEqual(vscode.window.activeNotebookEditor?.document.cells[1], vscode.window.activeNotebookEditor?.selection); assert.deepStrictEqual(vscode.window.activeNotebookEditor?.document.cells.length, 4); assert.strictEqual(vscode.window.activeNotebookEditor?.selection?.document.getText(), 'var abc = 0;'); await saveFileAndCloseAll(resource); }); test('multiple tabs: two dirty tabs and switching', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); await vscode.commands.executeCommand('notebook.cell.insertCodeCellBelow'); assert.strictEqual(vscode.window.activeNotebookEditor!.selection?.document.getText(), ''); await vscode.commands.executeCommand('notebook.cell.insertCodeCellAbove'); const edit = new vscode.WorkspaceEdit(); edit.insert(vscode.window.activeNotebookEditor!.selection!.document.uri, new vscode.Position(0, 0), 'var abc = 0;'); await vscode.workspace.applyEdit(edit); const secondResource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', secondResource, 'notebookCoreTest'); await vscode.commands.executeCommand('notebook.cell.insertCodeCellBelow'); assert.strictEqual(vscode.window.activeNotebookEditor!.selection?.document.getText(), ''); // switch to the first editor await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); assert.strictEqual(vscode.window.activeNotebookEditor !== undefined, true); assert.strictEqual(vscode.window.activeNotebookEditor?.selection !== undefined, true); assert.deepStrictEqual(vscode.window.activeNotebookEditor?.document.cells[1], vscode.window.activeNotebookEditor?.selection); assert.deepStrictEqual(vscode.window.activeNotebookEditor?.document.cells.length, 4); assert.strictEqual(vscode.window.activeNotebookEditor?.selection?.document.getText(), 'var abc = 0;'); // switch to the second editor await vscode.commands.executeCommand('vscode.openWith', secondResource, 'notebookCoreTest'); assert.strictEqual(vscode.window.activeNotebookEditor !== undefined, true); assert.strictEqual(vscode.window.activeNotebookEditor?.selection !== undefined, true); assert.deepStrictEqual(vscode.window.activeNotebookEditor?.document.cells[1], vscode.window.activeNotebookEditor?.selection); assert.deepStrictEqual(vscode.window.activeNotebookEditor?.document.cells.length, 3); assert.strictEqual(vscode.window.activeNotebookEditor?.selection?.document.getText(), ''); await saveAllFilesAndCloseAll(secondResource); }); test.skip('multiple tabs: different editors with same document', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); const firstNotebookEditor = vscode.window.activeNotebookEditor; assert.strictEqual(firstNotebookEditor !== undefined, true, 'notebook first'); assert.strictEqual(firstNotebookEditor!.selection?.document.getText(), 'test'); assert.strictEqual(firstNotebookEditor!.selection?.document.languageId, 'typescript'); await splitEditor(); const secondNotebookEditor = vscode.window.activeNotebookEditor; assert.strictEqual(secondNotebookEditor !== undefined, true, 'notebook first'); assert.strictEqual(secondNotebookEditor!.selection?.document.getText(), 'test'); assert.strictEqual(secondNotebookEditor!.selection?.document.languageId, 'typescript'); assert.notEqual(firstNotebookEditor, secondNotebookEditor); assert.strictEqual(firstNotebookEditor?.document, secondNotebookEditor?.document, 'split notebook editors share the same document'); await saveAllFilesAndCloseAll(resource); }); test('custom metadata should be supported', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); assert.strictEqual(vscode.window.activeNotebookEditor !== undefined, true, 'notebook first'); assert.strictEqual(vscode.window.activeNotebookEditor!.document.metadata.custom!['testMetadata'] as boolean, false); assert.strictEqual(vscode.window.activeNotebookEditor!.selection?.metadata.custom!['testCellMetadata'] as number, 123); assert.strictEqual(vscode.window.activeNotebookEditor!.selection?.document.languageId, 'typescript'); await saveFileAndCloseAll(resource); }); // TODO@rebornix skip as it crashes the process all the time test.skip('custom metadata should be supported 2', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); assert.strictEqual(vscode.window.activeNotebookEditor !== undefined, true, 'notebook first'); assert.strictEqual(vscode.window.activeNotebookEditor!.document.metadata.custom!['testMetadata'] as boolean, false); assert.strictEqual(vscode.window.activeNotebookEditor!.selection?.metadata.custom!['testCellMetadata'] as number, 123); assert.strictEqual(vscode.window.activeNotebookEditor!.selection?.document.languageId, 'typescript'); // TODO see #101462 // await vscode.commands.executeCommand('notebook.cell.copyDown'); // const activeCell = vscode.window.activeNotebookEditor!.selection; // assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.indexOf(activeCell!), 1); // assert.strictEqual(activeCell?.metadata.custom!['testCellMetadata'] as number, 123); await saveFileAndCloseAll(resource); }); test('#106657. Opening a notebook from markers view is broken ', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); const document = vscode.window.activeNotebookEditor?.document!; const [cell] = document.cells; await saveAllFilesAndCloseAll(document.uri); assert.strictEqual(vscode.window.activeNotebookEditor, undefined); // opening a cell-uri opens a notebook editor await vscode.commands.executeCommand('vscode.open', cell.document.uri, vscode.ViewColumn.Active); assert.strictEqual(!!vscode.window.activeNotebookEditor, true); assert.strictEqual(vscode.window.activeNotebookEditor!.document.uri.toString(), resource.toString()); }); test.skip('Cannot open notebook from cell-uri with vscode.open-command', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); const document = vscode.window.activeNotebookEditor?.document!; const [cell] = document.cells; await saveAllFilesAndCloseAll(document.uri); assert.strictEqual(vscode.window.activeNotebookEditor, undefined); // BUG is that the editor opener (https://github.com/microsoft/vscode/blob/8e7877bdc442f1e83a7fec51920d82b696139129/src/vs/editor/browser/services/openerService.ts#L69) // removes the fragment if it matches something numeric. For notebooks that's not wanted... await vscode.commands.executeCommand('vscode.open', cell.document.uri); assert.strictEqual(vscode.window.activeNotebookEditor!.document.uri.toString(), resource.toString()); }); test('#97830, #97764. Support switch to other editor types', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); await vscode.commands.executeCommand('notebook.cell.insertCodeCellBelow'); const edit = new vscode.WorkspaceEdit(); edit.insert(vscode.window.activeNotebookEditor!.selection!.document.uri, new vscode.Position(0, 0), 'var abc = 0;'); await vscode.workspace.applyEdit(edit); assert.strictEqual(vscode.window.activeNotebookEditor !== undefined, true, 'notebook first'); assert.strictEqual(vscode.window.activeNotebookEditor!.selection?.document.getText(), 'var abc = 0;'); // no kernel -> no default language // assert.strictEqual(vscode.window.activeNotebookEditor!.kernel, undefined); assert.strictEqual(vscode.window.activeNotebookEditor!.selection?.document.languageId, 'typescript'); await vscode.commands.executeCommand('vscode.openWith', resource, 'default'); assert.strictEqual(vscode.window.activeTextEditor?.document.uri.path, resource.path); await closeAllEditors(); }); // open text editor, pin, and then open a notebook test('#96105 - dirty editors', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'default'); const edit = new vscode.WorkspaceEdit(); edit.insert(resource, new vscode.Position(0, 0), 'var abc = 0;'); await vscode.workspace.applyEdit(edit); // now it's dirty, open the resource with notebook editor should open a new one await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); assert.notEqual(vscode.window.activeNotebookEditor, undefined, 'notebook first'); // assert.notEqual(vscode.window.activeTextEditor, undefined); await closeAllEditors(); }); test('#102411 - untitled notebook creation failed', async function () { await vscode.commands.executeCommand('workbench.action.files.newUntitledFile', { viewType: 'notebookCoreTest' }); assert.notEqual(vscode.window.activeNotebookEditor, undefined, 'untitled notebook editor is not undefined'); await closeAllEditors(); }); test('#102423 - copy/paste shares the same text buffer', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); let activeCell = vscode.window.activeNotebookEditor!.selection; assert.strictEqual(activeCell?.document.getText(), 'test'); await vscode.commands.executeCommand('notebook.cell.copyDown'); await vscode.commands.executeCommand('notebook.cell.edit'); activeCell = vscode.window.activeNotebookEditor!.selection; assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.indexOf(activeCell!), 1); assert.strictEqual(activeCell?.document.getText(), 'test'); const edit = new vscode.WorkspaceEdit(); edit.insert(vscode.window.activeNotebookEditor!.selection!.document.uri, new vscode.Position(0, 0), 'var abc = 0;'); await vscode.workspace.applyEdit(edit); assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells.length, 3); assert.notEqual(vscode.window.activeNotebookEditor!.document.cells[0].document.getText(), vscode.window.activeNotebookEditor!.document.cells[1].document.getText()); await closeAllEditors(); }); test('#116598, output items change event.', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); const edit = new vscode.WorkspaceEdit(); edit.appendNotebookCellOutput(resource, 0, [new vscode.NotebookCellOutput([ new vscode.NotebookCellOutputItem('application/foo', 'bar'), new vscode.NotebookCellOutputItem('application/json', { data: true }, { metadata: true }), ])]); await vscode.workspace.applyEdit(edit); assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells[0].outputs.length, 1); assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells[0].outputs[0].outputs.length, 2); const appendEdit = new vscode.WorkspaceEdit(); const newItem = new vscode.NotebookCellOutputItem('text/plain', '1'); appendEdit.appendNotebookCellOutputItems( resource, 0, vscode.window.activeNotebookEditor!.document.cells[0].outputs[0].id, [newItem] ); await vscode.workspace.applyEdit(appendEdit); assert.strictEqual(vscode.window.activeNotebookEditor!.document.cells[0].outputs[0].outputs.length, 3); assert.deepStrictEqual(vscode.window.activeNotebookEditor!.document.cells[0].outputs[0].outputs[2], newItem); }); test('#115855 onDidSaveNotebookDocument', async function () { const resource = await createRandomFile(undefined, undefined, '.vsctestnb'); const notebook = await vscode.notebook.openNotebookDocument(resource); const editor = await vscode.window.showNotebookDocument(notebook); const cellsChangeEvent = asPromise(vscode.notebook.onDidChangeNotebookCells); await editor.edit(editBuilder => { editBuilder.replaceCells(1, 0, [{ kind: vscode.NotebookCellKind.Code, language: 'javascript', source: 'test 2', outputs: [], metadata: undefined }]); }); const cellChangeEventRet = await cellsChangeEvent; assert.strictEqual(cellChangeEventRet.document === notebook, true); assert.strictEqual(cellChangeEventRet.document.isDirty, true); const saveEvent = asPromise(vscode.notebook.onDidSaveNotebookDocument); await notebook.save(); await saveEvent; assert.strictEqual(notebook.isDirty, false); }); test('#116808, active kernel should not be undefined', async function () { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); await withEvent(vscode.notebook.onDidChangeActiveNotebookKernel, async event => { await event; assert.notStrictEqual(vscode.window.activeNotebookEditor?.kernel, undefined); assert.strictEqual(vscode.window.activeNotebookEditor?.kernel?.id, 'mainKernel'); }); await saveAllFilesAndCloseAll(resource); }); test('Output changes are applied once the promise resolves', async function () { const verifyOutputSyncKernel = new class implements vscode.NotebookKernel { readonly id = 'verifyOutputSyncKernel'; readonly label = ''; readonly isPreferred = false; readonly supportedLanguages = ['typescript', 'javascript']; async executeCellsRequest(document: vscode.NotebookDocument, ranges: vscode.NotebookCellRange[]) { const idx = ranges[0].start; const task = vscode.notebook.createNotebookCellExecutionTask(document.uri, idx, this.id); if (!task) { return; } task.start(); await task.replaceOutput([new vscode.NotebookCellOutput([ new vscode.NotebookCellOutputItem('text/plain', ['Some output'], undefined) ])]); assert.strictEqual(document.cells[0].outputs.length, 1); assert.deepStrictEqual(document.cells[0].outputs[0].outputs[0].value, ['Some output']); task.end({}); } }; currentKernelProvider.addKernel(verifyOutputSyncKernel); const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); await vscode.commands.executeCommand('notebook.selectKernel', { extension: 'vscode.vscode-api-tests', id: verifyOutputSyncKernel.id }); await vscode.commands.executeCommand('notebook.cell.execute'); await saveAllFilesAndCloseAll(undefined); }); test('latestExecutionSummary', async () => { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); const editor = vscode.window.activeNotebookEditor!; const cell = editor.document.cells[0]; assert.strictEqual(cell.latestExecutionSummary?.success, undefined); assert.strictEqual(cell.latestExecutionSummary?.executionOrder, undefined); await vscode.commands.executeCommand('notebook.cell.execute'); assert.strictEqual(cell.outputs.length, 1, 'should execute'); assert.ok(cell.latestExecutionSummary); assert.strictEqual(cell.latestExecutionSummary!.success, true); assert.strictEqual(typeof cell.latestExecutionSummary!.executionOrder, 'number'); await saveAllFilesAndCloseAll(undefined); }); test('initialize latestExecutionSummary', async () => { const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); const editor = vscode.window.activeNotebookEditor!; const cell = editor.document.cells[0]; assert.strictEqual(cell.latestExecutionSummary?.success, undefined); assert.strictEqual(cell.latestExecutionSummary?.duration, 25); await saveAllFilesAndCloseAll(undefined); }); test('Throws errors for invalid execution tasks', async function () { let missedError: string | undefined; const invalidKernel = new class implements vscode.NotebookKernel { readonly id = 'invalidKernel'; readonly label = ''; readonly isPreferred = false; readonly supportedLanguages = ['typescript', 'javascript']; async executeCellsRequest(document: vscode.NotebookDocument, _ranges: vscode.NotebookCellRange[]) { try { vscode.notebook.createNotebookCellExecutionTask(document.uri, 1000, this.id); missedError = 'Expected to throw for invalid index'; return; } catch (e) { } try { vscode.notebook.createNotebookCellExecutionTask(vscode.Uri.file('slkdf'), 0, this.id); missedError = 'Expected to throw for invalid uri'; return; } catch (e) { } } }; currentKernelProvider.addKernel(invalidKernel); const resource = await createRandomFile('', undefined, '.vsctestnb'); await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); await vscode.commands.executeCommand('notebook.selectKernel', { extension: 'vscode.vscode-api-tests', id: invalidKernel.id }); await vscode.commands.executeCommand('notebook.cell.execute'); assert.strictEqual(missedError, undefined, missedError); await saveAllFilesAndCloseAll(undefined); }); // }); // suite('webview', () => { // for web, `asWebUri` gets `https`? // test('asWebviewUri', async function () { // if (vscode.env.uiKind === vscode.UIKind.Web) { // return; // } // const resource = await createRandomFile('', undefined, '.vsctestnb'); // await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); // assert.strictEqual(vscode.window.activeNotebookEditor !== undefined, true, 'notebook first'); // const uri = vscode.window.activeNotebookEditor!.asWebviewUri(vscode.Uri.file('./hello.png')); // assert.strictEqual(uri.scheme, 'vscode-webview-resource'); // await closeAllEditors(); // }); // 404 on web // test('custom renderer message', async function () { // if (vscode.env.uiKind === vscode.UIKind.Web) { // return; // } // const resource = vscode.Uri.file(join(vscode.workspace.rootPath || '', './customRenderer.vsctestnb')); // await vscode.commands.executeCommand('vscode.openWith', resource, 'notebookCoreTest'); // const editor = vscode.window.activeNotebookEditor; // const promise = new Promise(resolve => { // const messageEmitter = editor?.onDidReceiveMessage(e => { // if (e.type === 'custom_renderer_initialize') { // resolve(); // messageEmitter?.dispose(); // } // }); // }); // await vscode.commands.executeCommand('notebook.cell.execute'); // await promise; // await closeAllEditors(); // }); });