Test notebook workspace edit API

[rebornix]

Refs: #105283

• anyOS @lszomoru
• anyOS @alexr00

Complexity: 4

Authors: @jrieken @rebornix

Create Issue

---

We have made good progress with notebook editing API (including changes to the d.ts and also internal infrastructure). Now changes from UI or extensions will all land in the same code path NotebookTextModel.applyEdits so we want to test how robust the API and the implementation is.

Interface

export interface WorkspaceEdit {
  replaceNotebookMetadata(uri: Uri, value: NotebookDocumentMetadata): void;
  replaceNotebookCells(uri: Uri, start: number, end: number, cells: NotebookCellData[], metadata?: WorkspaceEditEntryMetadata): void;
  replaceNotebookCellOutput(uri: Uri, index: number, outputs: (NotebookCellOutput | CellOutput)[], metadata?: WorkspaceEditEntryMetadata): void;
  replaceNotebookCellMetadata(uri: Uri, index: number, cellMetadata: NotebookCellMetadata, metadata?: WorkspaceEditEntryMetadata): void;
}

To test this set of API:

• Install GH Issue Notebook extension
• Create test.github-issues notebook file
• Create an extension with proposed api (https://github.com/microsoft/vscode-extension-samples/tree/master/proposed-api-sample)
• Register commands which can apply workspace editors, for example

subscriptions.push(vscode.commands.registerCommand('github-issues.testLockCell', async () => {
	const editor = vscode.notebook.activeNotebookEditor;
	if (!editor) {
		return;
	}

	const selection = editor.selection;
	if (!selection) {
		return;
	}

	const workspaceEdit = new vscode.WorkspaceEdit();
	workspaceEdit.replaceNotebookCellMetadata(editor.document.uri, selection.index, {
		...selection.metadata,
		editable: false
	});

	await vscode.workspace.applyEdit(workspaceEdit);
}));

• and then run the command in a GitHub issue notebook file

Please test at least following scenarios

• Insert/Delete/Replace cells
• Update cell outputs
• Update cell metadata
• Undo/Redo after workspace edits
• Performance (e.g., Notebook UI freeze when outputs keep updating #107613)

[alexr00]

I tested the following:

• Delete/Replace cells
• Update cell outputs
• Update cell metadata
• Undo/Redo after workspace edits
• Performance (e.g., Notebook UI freeze when outputs keep updating #107613)

I used this API to replace and delete cells:
https://github.com/Microsoft/vscode/blob/4482c8794fa5e6b77ae08be69784352b8cde32ea/src/vs/vscode.proposed.d.ts#L1437-L1437

I could not find a way to insert cells.

[rebornix]

@alexr00 to insert a cell you can

workspaceEdit.replaceNotebookCells(editor.document.uri, 0, 0, [
{
  cellKind: vscode.CellKind.Code,
  language: 'github-issues',
  metadata: {},
  outputs: [],
  source: 'test'
}
]);