mirror of
https://github.com/microsoft/vscode.git
synced 2026-04-20 16:49:06 +01:00
846 lines
34 KiB
TypeScript
846 lines
34 KiB
TypeScript
/*---------------------------------------------------------------------------------------------
|
|
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
* Licensed under the MIT License. See License.txt in the project root for license information.
|
|
*--------------------------------------------------------------------------------------------*/
|
|
|
|
import * as assert from 'assert';
|
|
import 'mocha';
|
|
import { TextDecoder, TextEncoder } from 'util';
|
|
import * as vscode from 'vscode';
|
|
import { asPromise, assertNoRpc, closeAllEditors, createRandomFile, disposeAll, revertAllDirty, saveAllEditors } from '../utils';
|
|
|
|
async function createRandomNotebookFile() {
|
|
return createRandomFile('', undefined, '.vsctestnb');
|
|
}
|
|
|
|
async function openRandomNotebookDocument() {
|
|
const uri = await createRandomNotebookFile();
|
|
return vscode.workspace.openNotebookDocument(uri);
|
|
}
|
|
|
|
export async function saveAllFilesAndCloseAll() {
|
|
await saveAllEditors();
|
|
await closeAllEditors();
|
|
}
|
|
|
|
async function withEvent<T>(event: vscode.Event<T>, callback: (e: Promise<T>) => Promise<void>) {
|
|
const e = asPromise<T>(event);
|
|
await callback(e);
|
|
}
|
|
|
|
|
|
function sleep(ms: number): Promise<void> {
|
|
return new Promise(resolve => {
|
|
setTimeout(resolve, ms);
|
|
});
|
|
}
|
|
|
|
export class Kernel {
|
|
|
|
readonly controller: vscode.NotebookController;
|
|
|
|
readonly associatedNotebooks = new Set<string>();
|
|
|
|
constructor(id: string, label: string, viewType: string = 'notebookCoreTest') {
|
|
this.controller = vscode.notebooks.createNotebookController(id, viewType, label);
|
|
this.controller.executeHandler = this._execute.bind(this);
|
|
this.controller.supportsExecutionOrder = true;
|
|
this.controller.supportedLanguages = ['typescript', 'javascript'];
|
|
this.controller.onDidChangeSelectedNotebooks(e => {
|
|
if (e.selected) {
|
|
this.associatedNotebooks.add(e.notebook.uri.toString());
|
|
} else {
|
|
this.associatedNotebooks.delete(e.notebook.uri.toString());
|
|
}
|
|
});
|
|
}
|
|
|
|
protected async _execute(cells: vscode.NotebookCell[]): Promise<void> {
|
|
for (const cell of cells) {
|
|
await this._runCell(cell);
|
|
}
|
|
}
|
|
|
|
protected async _runCell(cell: vscode.NotebookCell) {
|
|
// create a single output with exec order 1 and output is plain/text
|
|
// of either the cell itself or (iff empty) the cell's document's uri
|
|
const task = this.controller.createNotebookCellExecution(cell);
|
|
task.start(Date.now());
|
|
task.executionOrder = 1;
|
|
await sleep(10); // Force to be take some time
|
|
await task.replaceOutput([new vscode.NotebookCellOutput([
|
|
vscode.NotebookCellOutputItem.text(cell.document.getText() || cell.document.uri.toString(), 'text/plain')
|
|
])]);
|
|
task.end(true);
|
|
}
|
|
}
|
|
|
|
|
|
function getFocusedCell(editor?: vscode.NotebookEditor) {
|
|
return editor ? editor.notebook.cellAt(editor.selections[0].start) : undefined;
|
|
}
|
|
|
|
async function assertKernel(kernel: Kernel, notebook: vscode.NotebookDocument): Promise<void> {
|
|
const success = await vscode.commands.executeCommand('notebook.selectKernel', {
|
|
extension: 'vscode.vscode-api-tests',
|
|
id: kernel.controller.id
|
|
});
|
|
assert.ok(success, `expected selected kernel to be ${kernel.controller.id}`);
|
|
assert.ok(kernel.associatedNotebooks.has(notebook.uri.toString()));
|
|
}
|
|
|
|
const apiTestContentProvider: vscode.NotebookContentProvider = {
|
|
openNotebook: async (resource: vscode.Uri): Promise<vscode.NotebookData> => {
|
|
if (/.*empty\-.*\.vsctestnb$/.test(resource.path)) {
|
|
return {
|
|
metadata: {},
|
|
cells: []
|
|
};
|
|
}
|
|
|
|
const dto: vscode.NotebookData = {
|
|
metadata: { custom: { testMetadata: false } },
|
|
cells: [
|
|
{
|
|
value: 'test',
|
|
languageId: 'typescript',
|
|
kind: vscode.NotebookCellKind.Code,
|
|
outputs: [],
|
|
metadata: { custom: { testCellMetadata: 123 } },
|
|
executionSummary: { timing: { startTime: 10, endTime: 20 } }
|
|
},
|
|
{
|
|
value: 'test2',
|
|
languageId: 'typescript',
|
|
kind: vscode.NotebookCellKind.Code,
|
|
outputs: [
|
|
new vscode.NotebookCellOutput([
|
|
vscode.NotebookCellOutputItem.text('Hello World', 'text/plain')
|
|
],
|
|
{
|
|
testOutputMetadata: true,
|
|
['text/plain']: { testOutputItemMetadata: true }
|
|
})
|
|
],
|
|
executionSummary: { executionOrder: 5, success: true },
|
|
metadata: { custom: { testCellMetadata: 456 } }
|
|
}
|
|
]
|
|
};
|
|
return dto;
|
|
},
|
|
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: () => { }
|
|
};
|
|
}
|
|
};
|
|
|
|
(vscode.env.uiKind === vscode.UIKind.Web ? suite.skip : 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.workspace.registerNotebookContentProvider('notebookCoreTest', apiTestContentProvider));
|
|
});
|
|
|
|
let defaultKernel: Kernel;
|
|
|
|
setup(async function () {
|
|
// there should be ONE default kernel in this suite
|
|
defaultKernel = new Kernel('mainKernel', 'Notebook Default Kernel');
|
|
testDisposables.push(defaultKernel.controller);
|
|
await saveAllFilesAndCloseAll();
|
|
});
|
|
|
|
teardown(async function () {
|
|
disposeAll(testDisposables);
|
|
testDisposables.length = 0;
|
|
await saveAllFilesAndCloseAll();
|
|
});
|
|
|
|
test('edit API batch edits', async function () {
|
|
const notebook = await openRandomNotebookDocument();
|
|
|
|
const edit = new vscode.WorkspaceEdit();
|
|
const metdataEdit = vscode.NotebookEdit.updateNotebookMetadata({ ...notebook.metadata, custom: { ...(notebook.metadata.custom || {}), extraNotebookMetadata: true } });
|
|
edit.set(notebook.uri, [metdataEdit]);
|
|
const success = await vscode.workspace.applyEdit(edit);
|
|
assert.equal(success, true);
|
|
assert.ok(notebook.metadata.custom.extraNotebookMetadata, `Test metadata not found`);
|
|
});
|
|
|
|
test('notebook open', async function () {
|
|
const notebook = await openRandomNotebookDocument();
|
|
const editor = await vscode.window.showNotebookDocument(notebook);
|
|
assert.strictEqual(vscode.window.activeNotebookEditor === editor, true, 'notebook first');
|
|
assert.strictEqual(getFocusedCell(editor)?.document.getText(), 'test');
|
|
assert.strictEqual(getFocusedCell(editor)?.document.languageId, 'typescript');
|
|
|
|
const secondCell = editor.notebook.cellAt(1);
|
|
assert.strictEqual(secondCell.outputs.length, 1);
|
|
assert.deepStrictEqual(secondCell.outputs[0].metadata, { testOutputMetadata: true, ['text/plain']: { testOutputItemMetadata: true } });
|
|
assert.strictEqual(secondCell.outputs[0].items.length, 1);
|
|
assert.strictEqual(secondCell.outputs[0].items[0].mime, 'text/plain');
|
|
assert.strictEqual(new TextDecoder().decode(secondCell.outputs[0].items[0].data), 'Hello World');
|
|
assert.strictEqual(secondCell.executionSummary?.executionOrder, 5);
|
|
assert.strictEqual(secondCell.executionSummary?.success, true);
|
|
});
|
|
|
|
test('notebook cell actions', async function () {
|
|
const notebook = await openRandomNotebookDocument();
|
|
const editor = await vscode.window.showNotebookDocument(notebook);
|
|
assert.strictEqual(vscode.window.activeNotebookEditor !== undefined, true, 'notebook first');
|
|
assert.strictEqual(vscode.window.activeNotebookEditor === editor, true, 'notebook first');
|
|
assert.strictEqual(getFocusedCell(editor)?.document.getText(), 'test');
|
|
assert.strictEqual(getFocusedCell(editor)?.document.languageId, 'typescript');
|
|
|
|
let activeCell = getFocusedCell(editor);
|
|
|
|
// ---- focus top and then copy down ---- //
|
|
await vscode.commands.executeCommand('notebook.focusTop');
|
|
activeCell = getFocusedCell(editor);
|
|
assert.strictEqual(editor.notebook.getCells().indexOf(activeCell!), 0);
|
|
|
|
await vscode.commands.executeCommand('notebook.cell.copyDown');
|
|
activeCell = getFocusedCell(editor);
|
|
assert.strictEqual(editor.notebook.getCells().indexOf(activeCell!), 1);
|
|
assert.strictEqual(activeCell?.document.getText(), 'test');
|
|
|
|
// delete focused cell
|
|
{
|
|
const focusedCell = getFocusedCell(editor);
|
|
assert.strictEqual(focusedCell !== undefined, true);
|
|
const edit = new vscode.WorkspaceEdit();
|
|
edit.replaceNotebookCells(focusedCell!.notebook.uri, new vscode.NotebookRange(focusedCell!.index, focusedCell!.index + 1), []);
|
|
await vscode.workspace.applyEdit(edit);
|
|
}
|
|
|
|
activeCell = getFocusedCell(editor);
|
|
assert.strictEqual(editor.notebook.getCells().indexOf(activeCell!), 1);
|
|
assert.strictEqual(activeCell?.document.getText(), 'test2');
|
|
|
|
// ---- focus top and then copy up ---- //
|
|
await vscode.commands.executeCommand('notebook.focusTop');
|
|
await vscode.commands.executeCommand('notebook.cell.copyUp');
|
|
assert.strictEqual(editor.notebook.cellCount, 3);
|
|
assert.strictEqual(editor.notebook.cellAt(0).document.getText(), 'test');
|
|
assert.strictEqual(editor.notebook.cellAt(1).document.getText(), 'test');
|
|
assert.strictEqual(editor.notebook.cellAt(2).document.getText(), 'test2');
|
|
activeCell = getFocusedCell(editor);
|
|
assert.strictEqual(editor.notebook.getCells().indexOf(activeCell!), 0);
|
|
|
|
await vscode.commands.executeCommand('workbench.action.files.save');
|
|
await vscode.commands.executeCommand('workbench.action.closeActiveEditor');
|
|
});
|
|
|
|
// 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 notebook = await openRandomNotebookDocument();
|
|
await vscode.window.showNotebookDocument(notebook);
|
|
assert.strictEqual(vscode.window.activeNotebookEditor !== undefined, true, 'notebook first');
|
|
const editor = vscode.window.activeNotebookEditor!;
|
|
const cell = editor.notebook.cellAt(0);
|
|
|
|
await vscode.commands.executeCommand('notebook.execute');
|
|
assert.strictEqual(cell.outputs.length, 0, 'should not execute'); // not runnable, didn't work
|
|
});
|
|
|
|
test('cell execute command takes arguments 2', async () => {
|
|
const notebook = await openRandomNotebookDocument();
|
|
await vscode.window.showNotebookDocument(notebook);
|
|
assert.strictEqual(vscode.window.activeNotebookEditor !== undefined, true, 'notebook first');
|
|
const editor = vscode.window.activeNotebookEditor!;
|
|
const cell = editor.notebook.cellAt(0);
|
|
|
|
await withEvent(vscode.workspace.onDidChangeNotebookDocument, async (event) => {
|
|
await vscode.commands.executeCommand('notebook.execute');
|
|
await event;
|
|
assert.strictEqual(cell.outputs.length, 1, 'should execute'); // runnable, it worked
|
|
});
|
|
|
|
await withEvent(vscode.workspace.onDidChangeNotebookDocument, async event => {
|
|
await vscode.commands.executeCommand('notebook.cell.clearOutputs');
|
|
await event;
|
|
assert.strictEqual(cell.outputs.length, 0, 'should clear');
|
|
});
|
|
|
|
const secondResource = await createRandomNotebookFile();
|
|
await vscode.commands.executeCommand('vscode.openWith', secondResource, 'notebookCoreTest');
|
|
|
|
await withEvent<vscode.NotebookDocumentChangeEvent>(vscode.workspace.onDidChangeNotebookDocument, async (event) => {
|
|
await vscode.commands.executeCommand('notebook.cell.execute', { start: 0, end: 1 }, notebook.uri);
|
|
await event;
|
|
assert.strictEqual(cell.outputs.length, 1, 'should execute'); // runnable, it worked
|
|
assert.strictEqual(vscode.window.activeNotebookEditor?.notebook.uri.fsPath, secondResource.fsPath);
|
|
});
|
|
});
|
|
|
|
// #126371
|
|
test.skip('cell execute command takes arguments ICellRange[]', async () => {
|
|
const notebook = await openRandomNotebookDocument();
|
|
await vscode.window.showNotebookDocument(notebook);
|
|
|
|
vscode.commands.executeCommand('notebook.cell.execute', { ranges: [{ start: 0, end: 1 }, { start: 1, end: 2 }] });
|
|
let firstCellExecuted = false;
|
|
let secondCellExecuted = false;
|
|
let resolve: () => void;
|
|
const p = new Promise<void>(r => resolve = r);
|
|
const listener = vscode.workspace.onDidChangeNotebookDocument(e => {
|
|
e.cellChanges.forEach(change => {
|
|
if (change.cell.index === 0) {
|
|
firstCellExecuted = true;
|
|
}
|
|
|
|
if (change.cell.index === 1) {
|
|
secondCellExecuted = true;
|
|
}
|
|
});
|
|
|
|
if (firstCellExecuted && secondCellExecuted) {
|
|
resolve();
|
|
}
|
|
});
|
|
|
|
await p;
|
|
listener.dispose();
|
|
await saveAllFilesAndCloseAll();
|
|
});
|
|
|
|
test('document execute command takes arguments', async () => {
|
|
const notebook = await openRandomNotebookDocument();
|
|
await vscode.window.showNotebookDocument(notebook);
|
|
assert.strictEqual(vscode.window.activeNotebookEditor !== undefined, true, 'notebook first');
|
|
const editor = vscode.window.activeNotebookEditor!;
|
|
const cell = editor.notebook.cellAt(0);
|
|
|
|
await withEvent<vscode.NotebookDocumentChangeEvent>(vscode.workspace.onDidChangeNotebookDocument, async (event) => {
|
|
await vscode.commands.executeCommand('notebook.execute', notebook.uri);
|
|
await event;
|
|
assert.strictEqual(cell.outputs.length, 1, 'should execute'); // runnable, it worked
|
|
});
|
|
});
|
|
|
|
test('cell execute and select kernel', async function () {
|
|
const notebook = await openRandomNotebookDocument();
|
|
const editor = await vscode.window.showNotebookDocument(notebook);
|
|
assert.strictEqual(vscode.window.activeNotebookEditor === editor, true, 'notebook first');
|
|
|
|
const cell = editor.notebook.cellAt(0);
|
|
|
|
const alternativeKernel = new class extends Kernel {
|
|
constructor() {
|
|
super('secondaryKernel', 'Notebook Secondary Test Kernel');
|
|
this.controller.supportsExecutionOrder = false;
|
|
}
|
|
|
|
override async _runCell(cell: vscode.NotebookCell) {
|
|
const task = this.controller.createNotebookCellExecution(cell);
|
|
task.start();
|
|
await task.replaceOutput([new vscode.NotebookCellOutput([
|
|
vscode.NotebookCellOutputItem.text('my second output', 'text/plain')
|
|
])]);
|
|
task.end(true);
|
|
}
|
|
};
|
|
testDisposables.push(alternativeKernel.controller);
|
|
|
|
await withEvent<vscode.NotebookDocumentChangeEvent>(vscode.workspace.onDidChangeNotebookDocument, async (event) => {
|
|
await assertKernel(defaultKernel, notebook);
|
|
await vscode.commands.executeCommand('notebook.cell.execute');
|
|
await event;
|
|
assert.strictEqual(cell.outputs.length, 1, 'should execute'); // runnable, it worked
|
|
assert.strictEqual(cell.outputs[0].items.length, 1);
|
|
assert.strictEqual(cell.outputs[0].items[0].mime, 'text/plain');
|
|
assert.deepStrictEqual(new TextDecoder().decode(cell.outputs[0].items[0].data), cell.document.getText());
|
|
});
|
|
|
|
await withEvent<vscode.NotebookDocumentChangeEvent>(vscode.workspace.onDidChangeNotebookDocument, async (event) => {
|
|
await assertKernel(alternativeKernel, notebook);
|
|
await vscode.commands.executeCommand('notebook.cell.execute');
|
|
await event;
|
|
assert.strictEqual(cell.outputs.length, 1, 'should execute'); // runnable, it worked
|
|
assert.strictEqual(cell.outputs[0].items.length, 1);
|
|
assert.strictEqual(cell.outputs[0].items[0].mime, 'text/plain');
|
|
assert.deepStrictEqual(new TextDecoder().decode(cell.outputs[0].items[0].data), 'my second output');
|
|
});
|
|
});
|
|
|
|
test.skip('onDidChangeCellExecutionState is fired', async () => { // TODO@rebornix https://github.com/microsoft/vscode/issues/139350
|
|
const notebook = await openRandomNotebookDocument();
|
|
const editor = await vscode.window.showNotebookDocument(notebook);
|
|
const cell = editor.notebook.cellAt(0);
|
|
|
|
vscode.commands.executeCommand('notebook.cell.execute');
|
|
let eventCount = 0;
|
|
let resolve: () => void;
|
|
const p = new Promise<void>(r => resolve = r);
|
|
const listener = vscode.notebooks.onDidChangeNotebookCellExecutionState(e => {
|
|
if (eventCount === 0) {
|
|
assert.strictEqual(e.state, vscode.NotebookCellExecutionState.Pending, 'should be set to Pending');
|
|
} else if (eventCount === 1) {
|
|
assert.strictEqual(e.state, 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.state, vscode.NotebookCellExecutionState.Idle, 'should be set to Idle');
|
|
assert.strictEqual(cell.outputs.length, 1, 'should have an output');
|
|
resolve();
|
|
}
|
|
|
|
eventCount++;
|
|
});
|
|
|
|
await p;
|
|
listener.dispose();
|
|
});
|
|
|
|
test('multiple tabs: different editors with same document', async function () {
|
|
|
|
const notebook = await openRandomNotebookDocument();
|
|
const firstNotebookEditor = await vscode.window.showNotebookDocument(notebook, { viewColumn: vscode.ViewColumn.One });
|
|
assert.ok(firstNotebookEditor === vscode.window.activeNotebookEditor);
|
|
|
|
assert.strictEqual(firstNotebookEditor !== undefined, true, 'notebook first');
|
|
assert.strictEqual(getFocusedCell(vscode.window.activeNotebookEditor!)?.document.getText(), 'test');
|
|
assert.strictEqual(getFocusedCell(vscode.window.activeNotebookEditor!)?.document.languageId, 'typescript');
|
|
|
|
const secondNotebookEditor = await vscode.window.showNotebookDocument(notebook, { viewColumn: vscode.ViewColumn.Beside });
|
|
assert.strictEqual(secondNotebookEditor !== undefined, true, 'notebook first');
|
|
assert.strictEqual(getFocusedCell(vscode.window.activeNotebookEditor!)?.document.getText(), 'test');
|
|
assert.strictEqual(getFocusedCell(vscode.window.activeNotebookEditor!)?.document.languageId, 'typescript');
|
|
|
|
assert.notStrictEqual(firstNotebookEditor, secondNotebookEditor);
|
|
assert.strictEqual(firstNotebookEditor?.notebook, secondNotebookEditor?.notebook, 'split notebook editors share the same document');
|
|
|
|
});
|
|
|
|
test.skip('#106657. Opening a notebook from markers view is broken ', async function () {
|
|
|
|
const document = await openRandomNotebookDocument();
|
|
const [cell] = document.getCells();
|
|
|
|
assert.strictEqual(vscode.window.activeNotebookEditor, undefined);
|
|
|
|
// opening a cell-uri opens a notebook editor
|
|
await vscode.window.showTextDocument(cell.document, { viewColumn: vscode.ViewColumn.Active });
|
|
// await vscode.commands.executeCommand('vscode.open', cell.document.uri, vscode.ViewColumn.Active);
|
|
|
|
assert.strictEqual(!!vscode.window.activeNotebookEditor, true);
|
|
assert.strictEqual(vscode.window.activeNotebookEditor!.notebook.uri.toString(), document.uri.toString());
|
|
});
|
|
|
|
test('Cannot open notebook from cell-uri with vscode.open-command', async function () {
|
|
|
|
const document = await openRandomNotebookDocument();
|
|
const [cell] = document.getCells();
|
|
|
|
await saveAllFilesAndCloseAll();
|
|
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!.notebook.uri.toString(), document.uri.toString());
|
|
});
|
|
|
|
test('#97830, #97764. Support switch to other editor types', async function () {
|
|
const notebook = await openRandomNotebookDocument();
|
|
const editor = await vscode.window.showNotebookDocument(notebook);
|
|
const edit = new vscode.WorkspaceEdit();
|
|
const focusedCell = getFocusedCell(editor);
|
|
assert.ok(focusedCell);
|
|
edit.replace(focusedCell.document.uri, focusedCell.document.lineAt(0).range, 'var abc = 0;');
|
|
await vscode.workspace.applyEdit(edit);
|
|
|
|
assert.strictEqual(getFocusedCell(editor)?.document.getText(), 'var abc = 0;');
|
|
|
|
// no kernel -> no default language
|
|
assert.strictEqual(getFocusedCell(editor)?.document.languageId, 'typescript');
|
|
|
|
await vscode.commands.executeCommand('vscode.openWith', notebook.uri, 'default');
|
|
assert.strictEqual(vscode.window.activeTextEditor?.document.uri.path, notebook.uri.path);
|
|
});
|
|
|
|
// open text editor, pin, and then open a notebook
|
|
test('#96105 - dirty editors', async function () {
|
|
const resource = await createRandomNotebookFile();
|
|
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.notStrictEqual(vscode.window.activeNotebookEditor, undefined, 'notebook first');
|
|
// assert.notStrictEqual(vscode.window.activeTextEditor, undefined);
|
|
|
|
});
|
|
|
|
test('#102411 - untitled notebook creation failed', async function () {
|
|
await vscode.commands.executeCommand('workbench.action.files.newUntitledFile', { viewType: 'notebookCoreTest' });
|
|
assert.notStrictEqual(vscode.window.activeNotebookEditor, undefined, 'untitled notebook editor is not undefined');
|
|
|
|
await closeAllEditors();
|
|
});
|
|
|
|
test('#102423 - copy/paste shares the same text buffer', async function () {
|
|
const notebook = await openRandomNotebookDocument();
|
|
await vscode.window.showNotebookDocument(notebook);
|
|
|
|
let activeCell = getFocusedCell(vscode.window.activeNotebookEditor);
|
|
assert.strictEqual(activeCell?.document.getText(), 'test');
|
|
|
|
await vscode.commands.executeCommand('notebook.cell.copyDown');
|
|
await vscode.commands.executeCommand('notebook.cell.edit');
|
|
activeCell = getFocusedCell(vscode.window.activeNotebookEditor);
|
|
assert.strictEqual(vscode.window.activeNotebookEditor!.notebook.getCells().indexOf(activeCell!), 1);
|
|
assert.strictEqual(activeCell?.document.getText(), 'test');
|
|
|
|
const edit = new vscode.WorkspaceEdit();
|
|
edit.insert(getFocusedCell(vscode.window.activeNotebookEditor)!.document.uri, new vscode.Position(0, 0), 'var abc = 0;');
|
|
await vscode.workspace.applyEdit(edit);
|
|
|
|
assert.strictEqual(vscode.window.activeNotebookEditor!.notebook.getCells().length, 3);
|
|
assert.notStrictEqual(vscode.window.activeNotebookEditor!.notebook.cellAt(0).document.getText(), vscode.window.activeNotebookEditor!.notebook.cellAt(1).document.getText());
|
|
|
|
await closeAllEditors();
|
|
});
|
|
|
|
test('#115855 onDidSaveNotebookDocument', async function () {
|
|
const resource = await createRandomNotebookFile();
|
|
const notebook = await vscode.workspace.openNotebookDocument(resource);
|
|
|
|
const notebookEdit = new vscode.NotebookEdit(new vscode.NotebookRange(1, 1), [new vscode.NotebookCellData(vscode.NotebookCellKind.Code, 'test 2', 'javascript')]);
|
|
const edit = new vscode.WorkspaceEdit();
|
|
edit.set(notebook.uri, [notebookEdit]);
|
|
await vscode.workspace.applyEdit(edit);
|
|
assert.strictEqual(notebook.isDirty, true);
|
|
|
|
const saveEvent = asPromise(vscode.workspace.onDidSaveNotebookDocument);
|
|
await notebook.save();
|
|
await saveEvent;
|
|
|
|
assert.strictEqual(notebook.isDirty, false);
|
|
});
|
|
|
|
test('Output changes are applied once the promise resolves', async function () {
|
|
|
|
let called = false;
|
|
|
|
const verifyOutputSyncKernel = new class extends Kernel {
|
|
|
|
constructor() {
|
|
super('verifyOutputSyncKernel', '');
|
|
}
|
|
|
|
override async _execute(cells: vscode.NotebookCell[]) {
|
|
const [cell] = cells;
|
|
const task = this.controller.createNotebookCellExecution(cell);
|
|
task.start();
|
|
await task.replaceOutput([new vscode.NotebookCellOutput([
|
|
vscode.NotebookCellOutputItem.text('Some output', 'text/plain')
|
|
])]);
|
|
assert.strictEqual(cell.notebook.cellAt(0).outputs.length, 1);
|
|
assert.deepStrictEqual(new TextDecoder().decode(cell.notebook.cellAt(0).outputs[0].items[0].data), 'Some output');
|
|
task.end(undefined);
|
|
called = true;
|
|
}
|
|
};
|
|
|
|
const notebook = await openRandomNotebookDocument();
|
|
await vscode.window.showNotebookDocument(notebook);
|
|
await assertKernel(verifyOutputSyncKernel, notebook);
|
|
await vscode.commands.executeCommand('notebook.cell.execute');
|
|
assert.strictEqual(called, true);
|
|
verifyOutputSyncKernel.controller.dispose();
|
|
});
|
|
|
|
test('executionSummary', async () => {
|
|
const notebook = await openRandomNotebookDocument();
|
|
const editor = await vscode.window.showNotebookDocument(notebook);
|
|
const cell = editor.notebook.cellAt(0);
|
|
|
|
assert.strictEqual(cell.executionSummary?.success, undefined);
|
|
assert.strictEqual(cell.executionSummary?.executionOrder, undefined);
|
|
await vscode.commands.executeCommand('notebook.cell.execute');
|
|
assert.strictEqual(cell.outputs.length, 1, 'should execute');
|
|
assert.ok(cell.executionSummary);
|
|
assert.strictEqual(cell.executionSummary!.success, true);
|
|
assert.strictEqual(typeof cell.executionSummary!.executionOrder, 'number');
|
|
});
|
|
|
|
test('initialize executionSummary', async () => {
|
|
|
|
const document = await openRandomNotebookDocument();
|
|
const cell = document.cellAt(0);
|
|
|
|
assert.strictEqual(cell.executionSummary?.success, undefined);
|
|
assert.strictEqual(cell.executionSummary?.timing?.startTime, 10);
|
|
assert.strictEqual(cell.executionSummary?.timing?.endTime, 20);
|
|
|
|
});
|
|
|
|
test('execution cancelled when delete while executing', async () => {
|
|
const document = await openRandomNotebookDocument();
|
|
const cell = document.cellAt(0);
|
|
|
|
let executionWasCancelled = false;
|
|
const cancelledKernel = new class extends Kernel {
|
|
constructor() {
|
|
super('cancelledKernel', '');
|
|
}
|
|
|
|
override async _execute(cells: vscode.NotebookCell[]) {
|
|
const [cell] = cells;
|
|
const exe = this.controller.createNotebookCellExecution(cell);
|
|
exe.token.onCancellationRequested(() => executionWasCancelled = true);
|
|
}
|
|
};
|
|
testDisposables.push(cancelledKernel.controller);
|
|
|
|
await vscode.window.showNotebookDocument(document);
|
|
await assertKernel(cancelledKernel, document);
|
|
await vscode.commands.executeCommand('notebook.cell.execute');
|
|
|
|
// Delete executing cell
|
|
const edit = new vscode.WorkspaceEdit();
|
|
edit.replaceNotebookCells(cell!.notebook.uri, new vscode.NotebookRange(cell!.index, cell!.index + 1), []);
|
|
await vscode.workspace.applyEdit(edit);
|
|
|
|
assert.strictEqual(executionWasCancelled, true);
|
|
});
|
|
|
|
test('appendOutput to different cell', async function () {
|
|
const notebook = await openRandomNotebookDocument();
|
|
const editor = await vscode.window.showNotebookDocument(notebook);
|
|
const cell0 = editor.notebook.cellAt(0);
|
|
const notebookEdit = new vscode.NotebookEdit(new vscode.NotebookRange(1, 1), [new vscode.NotebookCellData(vscode.NotebookCellKind.Code, 'test 2', 'javascript')]);
|
|
const edit = new vscode.WorkspaceEdit();
|
|
edit.set(notebook.uri, [notebookEdit]);
|
|
await vscode.workspace.applyEdit(edit);
|
|
const cell1 = editor.notebook.cellAt(1);
|
|
|
|
const nextCellKernel = new class extends Kernel {
|
|
constructor() {
|
|
super('nextCellKernel', 'Append to cell kernel');
|
|
}
|
|
|
|
override async _runCell(cell: vscode.NotebookCell) {
|
|
const task = this.controller.createNotebookCellExecution(cell);
|
|
task.start();
|
|
await task.appendOutput([new vscode.NotebookCellOutput([
|
|
vscode.NotebookCellOutputItem.text('my output')
|
|
])], cell1);
|
|
await task.appendOutput([new vscode.NotebookCellOutput([
|
|
vscode.NotebookCellOutputItem.text('my output 2')
|
|
])], cell1);
|
|
task.end(true);
|
|
}
|
|
};
|
|
testDisposables.push(nextCellKernel.controller);
|
|
|
|
await withEvent<vscode.NotebookDocumentChangeEvent>(vscode.workspace.onDidChangeNotebookDocument, async (event) => {
|
|
await assertKernel(nextCellKernel, notebook);
|
|
await vscode.commands.executeCommand('notebook.cell.execute');
|
|
await event;
|
|
assert.strictEqual(cell0.outputs.length, 0, 'should not change cell 0');
|
|
assert.strictEqual(cell1.outputs.length, 2, 'should update cell 1');
|
|
assert.strictEqual(cell1.outputs[0].items.length, 1);
|
|
assert.deepStrictEqual(new TextDecoder().decode(cell1.outputs[0].items[0].data), 'my output');
|
|
});
|
|
});
|
|
|
|
test('replaceOutput to different cell', async function () {
|
|
const notebook = await openRandomNotebookDocument();
|
|
const editor = await vscode.window.showNotebookDocument(notebook);
|
|
const cell0 = editor.notebook.cellAt(0);
|
|
const notebookEdit = new vscode.NotebookEdit(new vscode.NotebookRange(1, 1), [new vscode.NotebookCellData(vscode.NotebookCellKind.Code, 'test 2', 'javascript')]);
|
|
const edit = new vscode.WorkspaceEdit();
|
|
edit.set(notebook.uri, [notebookEdit]);
|
|
await vscode.workspace.applyEdit(edit);
|
|
const cell1 = editor.notebook.cellAt(1);
|
|
|
|
const nextCellKernel = new class extends Kernel {
|
|
constructor() {
|
|
super('nextCellKernel', 'Replace to cell kernel');
|
|
}
|
|
|
|
override async _runCell(cell: vscode.NotebookCell) {
|
|
const task = this.controller.createNotebookCellExecution(cell);
|
|
task.start();
|
|
await task.replaceOutput([new vscode.NotebookCellOutput([
|
|
vscode.NotebookCellOutputItem.text('my output')
|
|
])], cell1);
|
|
await task.replaceOutput([new vscode.NotebookCellOutput([
|
|
vscode.NotebookCellOutputItem.text('my output 2')
|
|
])], cell1);
|
|
task.end(true);
|
|
}
|
|
};
|
|
testDisposables.push(nextCellKernel.controller);
|
|
|
|
await withEvent<vscode.NotebookDocumentChangeEvent>(vscode.workspace.onDidChangeNotebookDocument, async (event) => {
|
|
await assertKernel(nextCellKernel, notebook);
|
|
await vscode.commands.executeCommand('notebook.cell.execute');
|
|
await event;
|
|
assert.strictEqual(cell0.outputs.length, 0, 'should not change cell 0');
|
|
assert.strictEqual(cell1.outputs.length, 1, 'should update cell 1');
|
|
assert.strictEqual(cell1.outputs[0].items.length, 1);
|
|
assert.deepStrictEqual(new TextDecoder().decode(cell1.outputs[0].items[0].data), 'my output 2');
|
|
});
|
|
});
|
|
});
|
|
|
|
(vscode.env.uiKind === vscode.UIKind.Web ? suite.skip : suite)('statusbar', () => {
|
|
const emitter = new vscode.EventEmitter<vscode.NotebookCell>();
|
|
const onDidCallProvide = emitter.event;
|
|
const suiteDisposables: vscode.Disposable[] = [];
|
|
suiteTeardown(async function () {
|
|
assertNoRpc();
|
|
|
|
await revertAllDirty();
|
|
await closeAllEditors();
|
|
|
|
disposeAll(suiteDisposables);
|
|
suiteDisposables.length = 0;
|
|
});
|
|
|
|
suiteSetup(() => {
|
|
suiteDisposables.push(vscode.notebooks.registerNotebookCellStatusBarItemProvider('notebookCoreTest', {
|
|
async provideCellStatusBarItems(cell: vscode.NotebookCell, _token: vscode.CancellationToken): Promise<vscode.NotebookCellStatusBarItem[]> {
|
|
emitter.fire(cell);
|
|
return [];
|
|
}
|
|
}));
|
|
|
|
suiteDisposables.push(vscode.workspace.registerNotebookContentProvider('notebookCoreTest', apiTestContentProvider));
|
|
});
|
|
|
|
test.skip('provideCellStatusBarItems called on metadata change', async function () { // TODO@roblourens https://github.com/microsoft/vscode/issues/139324
|
|
const provideCalled = asPromise(onDidCallProvide);
|
|
const notebook = await openRandomNotebookDocument();
|
|
await vscode.window.showNotebookDocument(notebook);
|
|
await provideCalled;
|
|
|
|
const edit = new vscode.WorkspaceEdit();
|
|
edit.replaceNotebookCellMetadata(notebook.uri, 0, { inputCollapsed: true });
|
|
vscode.workspace.applyEdit(edit);
|
|
await provideCalled;
|
|
});
|
|
});
|
|
|
|
(vscode.env.uiKind === vscode.UIKind.Web ? suite.skip : suite)('Notebook API tests (metadata)', 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.workspace.registerNotebookContentProvider('notebookCoreTest', apiTestContentProvider));
|
|
});
|
|
|
|
setup(async function () {
|
|
await saveAllFilesAndCloseAll();
|
|
});
|
|
|
|
teardown(async function () {
|
|
disposeAll(testDisposables);
|
|
testDisposables.length = 0;
|
|
await saveAllFilesAndCloseAll();
|
|
});
|
|
|
|
test('custom metadata should be supported', async function () {
|
|
const notebook = await openRandomNotebookDocument();
|
|
const editor = await vscode.window.showNotebookDocument(notebook);
|
|
|
|
assert.strictEqual(editor.notebook.metadata.custom?.testMetadata, false);
|
|
assert.strictEqual(getFocusedCell(editor)?.metadata.custom?.testCellMetadata, 123);
|
|
assert.strictEqual(getFocusedCell(editor)?.document.languageId, 'typescript');
|
|
});
|
|
});
|
|
|
|
suite('Notebook & LiveShare', function () {
|
|
|
|
const suiteDisposables: vscode.Disposable[] = [];
|
|
const notebookType = 'vsls-testing';
|
|
|
|
suiteTeardown(() => {
|
|
vscode.Disposable.from(...suiteDisposables).dispose();
|
|
});
|
|
|
|
suiteSetup(function () {
|
|
|
|
suiteDisposables.push(vscode.workspace.registerNotebookSerializer(notebookType, new class implements vscode.NotebookSerializer {
|
|
deserializeNotebook(content: Uint8Array, _token: vscode.CancellationToken): vscode.NotebookData | Thenable<vscode.NotebookData> {
|
|
const value = new TextDecoder().decode(content);
|
|
const cell1 = new vscode.NotebookCellData(vscode.NotebookCellKind.Code, value, 'fooLang');
|
|
cell1.outputs = [new vscode.NotebookCellOutput([vscode.NotebookCellOutputItem.stderr(value)])];
|
|
return new vscode.NotebookData([cell1]);
|
|
}
|
|
serializeNotebook(data: vscode.NotebookData, _token: vscode.CancellationToken): Uint8Array | Thenable<Uint8Array> {
|
|
return new TextEncoder().encode(data.cells[0].value);
|
|
}
|
|
}, {}, {
|
|
displayName: 'LS',
|
|
filenamePattern: ['*'],
|
|
}));
|
|
});
|
|
|
|
test('command: vscode.resolveNotebookContentProviders', async function () {
|
|
|
|
type Info = { viewType: string; displayName: string; filenamePattern: string[] };
|
|
|
|
const info = await vscode.commands.executeCommand<Info[]>('vscode.resolveNotebookContentProviders');
|
|
assert.strictEqual(Array.isArray(info), true);
|
|
|
|
const item = info.find(item => item.viewType === notebookType);
|
|
assert.ok(item);
|
|
assert.strictEqual(item?.viewType, notebookType);
|
|
});
|
|
|
|
test('command: vscode.executeDataToNotebook', async function () {
|
|
const value = 'dataToNotebook';
|
|
const data = await vscode.commands.executeCommand<vscode.NotebookData>('vscode.executeDataToNotebook', notebookType, new TextEncoder().encode(value));
|
|
assert.ok(data instanceof vscode.NotebookData);
|
|
assert.strictEqual(data.cells.length, 1);
|
|
assert.strictEqual(data.cells[0].value, value);
|
|
assert.strictEqual(new TextDecoder().decode(data.cells[0].outputs![0].items[0].data), value);
|
|
});
|
|
|
|
test('command: vscode.executeNotebookToData', async function () {
|
|
const value = 'notebookToData';
|
|
const notebook = new vscode.NotebookData([new vscode.NotebookCellData(vscode.NotebookCellKind.Code, value, 'fooLang')]);
|
|
const data = await vscode.commands.executeCommand<Uint8Array>('vscode.executeNotebookToData', notebookType, notebook);
|
|
assert.ok(data instanceof Uint8Array);
|
|
assert.deepStrictEqual(new TextDecoder().decode(data), value);
|
|
});
|
|
});
|