Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

outputs now updating correctly when output items are updated. #13023

Merged
merged 1 commit into from
Oct 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -293,6 +293,7 @@ export function updateToEdit(update: CellExecuteUpdate, cellHandle: number): Cel
return {
editType: CellEditType.OutputItems,
items: update.items,
outputId: update.outputId,
append: update.append,
};
} else if (update.editType === CellExecutionUpdateType.ExecutionState) {
Expand Down
30 changes: 23 additions & 7 deletions packages/notebook/src/browser/view-model/notebook-cell-model.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import { MonacoEditorModel } from '@theia/monaco/lib/browser/monaco-editor-model
import { MonacoTextModelService } from '@theia/monaco/lib/browser/monaco-text-model-service';
import {
CellInternalMetadataChangedEvent, CellKind, NotebookCellCollapseState, NotebookCellInternalMetadata,
NotebookCellMetadata, NotebookCellOutputsSplice, CellOutput, CellData, NotebookCell
NotebookCellMetadata, NotebookCellOutputsSplice, CellOutput, CellData, NotebookCell, CellOutputItem
} from '../../common';
import { NotebookCellOutputModel } from './notebook-cell-output-model';

Expand Down Expand Up @@ -70,8 +70,8 @@ export class NotebookCellModel implements NotebookCell, Disposable {
protected readonly onDidChangeOutputsEmitter = new Emitter<NotebookCellOutputsSplice>();
readonly onDidChangeOutputs: Event<NotebookCellOutputsSplice> = this.onDidChangeOutputsEmitter.event;

protected readonly onDidChangeOutputItemsEmitter = new Emitter<void>();
readonly onDidChangeOutputItems: Event<void> = this.onDidChangeOutputItemsEmitter.event;
protected readonly onDidChangeOutputItemsEmitter = new Emitter<CellOutput>();
readonly onDidChangeOutputItems: Event<CellOutput> = this.onDidChangeOutputItemsEmitter.event;

protected readonly onDidChangeContentEmitter = new Emitter<'content' | 'language' | 'mime'>();
readonly onDidChangeContent: Event<'content' | 'language' | 'mime'> = this.onDidChangeContentEmitter.event;
Expand Down Expand Up @@ -216,7 +216,7 @@ export class NotebookCellModel implements NotebookCell, Disposable {
const currentOutput = this.outputs[splice.start + i];
const newOutput = splice.newOutputs[i];

this.replaceOutputItems(currentOutput.outputId, newOutput);
this.replaceOutputData(currentOutput.outputId, newOutput);
}

this.outputs.splice(splice.start + commonLen, splice.deleteCount - commonLen, ...splice.newOutputs.slice(commonLen).map(op => new NotebookCellOutputModel(op)));
Expand All @@ -227,15 +227,31 @@ export class NotebookCellModel implements NotebookCell, Disposable {
}
}

replaceOutputItems(outputId: string, newOutputItem: CellOutput): boolean {
replaceOutputData(outputId: string, newOutputData: CellOutput): boolean {
const output = this.outputs.find(out => out.outputId === outputId);

if (!output) {
return false;
}

output.replaceData(newOutputItem);
this.onDidChangeOutputItemsEmitter.fire();
output.replaceData(newOutputData);
this.onDidChangeOutputItemsEmitter.fire(output);
return true;
}

changeOutputItems(outputId: string, append: boolean, items: CellOutputItem[]): boolean {
const output = this.outputs.find(out => out.outputId === outputId);

if (!output) {
return false;
}

if (append) {
output.appendData(items);
} else {
output.replaceData({ outputId: outputId, outputs: items, metadata: output.metadata });
}
this.onDidChangeOutputItemsEmitter.fire(output);
return true;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
// *****************************************************************************

import { Disposable, Emitter } from '@theia/core';
import { CellOutput, CellOutputItem } from '../../common';
import { BinaryBuffer } from '@theia/core/lib/common/buffer';
import { CellOutput, CellOutputItem, isTextStreamMime } from '../../common';

export class NotebookCellOutputModel implements Disposable {

Expand All @@ -41,11 +42,13 @@ export class NotebookCellOutputModel implements Disposable {

replaceData(rawData: CellOutput): void {
this.rawOutput = rawData;
this.optimizeOutputItems();
this.didChangeDataEmitter.fire();
}

appendData(items: CellOutputItem[]): void {
this.rawOutput.outputs.push(...items);
this.optimizeOutputItems();
this.didChangeDataEmitter.fire();
}

Expand All @@ -66,4 +69,31 @@ export class NotebookCellOutputModel implements Disposable {
};
}

private optimizeOutputItems(): void {
if (this.outputs.length > 1 && this.outputs.every(item => isTextStreamMime(item.mime))) {
// Look for the mimes in the items, and keep track of their order.
// Merge the streams into one output item, per mime type.
const mimeOutputs = new Map<string, BinaryBuffer[]>();
const mimeTypes: string[] = [];
this.outputs.forEach(item => {
let items: BinaryBuffer[];
if (mimeOutputs.has(item.mime)) {
items = mimeOutputs.get(item.mime)!;
} else {
items = [];
mimeOutputs.set(item.mime, items);
mimeTypes.push(item.mime);
}
items.push(item.data);
});
this.outputs.length = 0;
mimeTypes.forEach(mime => {
this.outputs.push({
mime,
data: BinaryBuffer.concat(mimeOutputs.get(mime)!)
});
});
}
}

}
3 changes: 3 additions & 0 deletions packages/notebook/src/browser/view-model/notebook-model.ts
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,8 @@ export class NotebookModel implements Saveable, Disposable {
cellIndex = edit.index;
} else if ('handle' in edit) {
cellIndex = this.getCellIndexByHandle(edit.handle);
} else if ('outputId' in edit) {
cellIndex = this.cells.findIndex(cell => cell.outputs.some(output => output.outputId === edit.outputId));
}

return {
Expand Down Expand Up @@ -254,6 +256,7 @@ export class NotebookModel implements Saveable, Disposable {
break;
}
case CellEditType.OutputItems:
cell.changeOutputItems(edit.outputId, !!edit.append, edit.items);
break;
case CellEditType.Metadata:
this.updateNotebookMetadata(edit.metadata, computeUndoRedo);
Expand Down
4 changes: 3 additions & 1 deletion packages/notebook/src/common/notebook-common.ts
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ export interface NotebookCell {
internalMetadata: NotebookCellInternalMetadata;
text: string;
onDidChangeOutputs?: Event<NotebookCellOutputsSplice>;
onDidChangeOutputItems?: Event<void>;
onDidChangeOutputItems?: Event<CellOutput>;
onDidChangeLanguage: Event<string>;
onDidChangeMetadata: Event<void>;
onDidChangeInternalMetadata: Event<CellInternalMetadataChangedEvent>;
Expand Down Expand Up @@ -309,6 +309,7 @@ export interface CellExecuteOutputEdit {
export interface CellExecuteOutputItemEdit {
editType: CellExecutionUpdateType.OutputItems;
append?: boolean;
outputId: string,
items: CellOutputItem[];
}

Expand Down Expand Up @@ -337,6 +338,7 @@ export interface CellOutputEditByHandle {
export interface CellOutputItemEdit {
editType: CellEditType.OutputItems;
items: CellOutputItem[];
outputId: string;
append?: boolean;
}

Expand Down
1 change: 1 addition & 0 deletions packages/plugin-ext/src/common/plugin-api-rpc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2423,6 +2423,7 @@ export interface CellExecuteOutputEditDto {
export interface CellExecuteOutputItemEditDto {
editType: CellExecutionUpdateType.OutputItems;
append?: boolean;
outputId: string;
items: NotebookOutputItemDto[];
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,9 @@ export class CellOutputWebviewImpl implements CellOutputWebview, Disposable {
@postConstruct()
protected async init(): Promise<void> {
this.cell.onDidChangeOutputs(outputChange => this.updateOutput(outputChange));
this.cell.onDidChangeOutputItems(output => {
this.updateOutput({start: this.cell.outputs.findIndex(o => o.getData().outputId === o.outputId), deleteCount: 1, newOutputs: [output]});
});

this.webviewWidget = await this.widgetManager.getOrCreateWidget(WebviewWidget.FACTORY_ID, { id: this.id });
this.webviewWidget.setContentOptions({ allowScripts: true });
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -381,6 +381,7 @@ export async function outputWebviewPreload(ctx: PreloadContext): Promise<void> {
function clearOutput(outputId: string): void {
outputs.get(outputId)?.clear();
outputs.delete(outputId);
document.getElementById(outputId)?.remove();
}

function outputsChanged(changedEvent: webviewCommunication.OutputChangedMessage): void {
Expand Down
4 changes: 3 additions & 1 deletion packages/plugin-ext/src/plugin/notebook/notebook-kernels.ts
Original file line number Diff line number Diff line change
Expand Up @@ -483,11 +483,13 @@ class NotebookCellExecutionTask implements Disposable {
});
}

private async updateOutputItems(items: theia.NotebookCellOutputItem | theia.NotebookCellOutputItem[], output: theia.NotebookCellOutput, append: boolean): Promise<void> {
private async updateOutputItems(items: theia.NotebookCellOutputItem | theia.NotebookCellOutputItem[],
output: theia.NotebookCellOutput, append: boolean): Promise<void> {
items = NotebookCellOutputConverter.ensureUniqueMimeTypes(Array.isArray(items) ? items : [items], true);
return this.updateSoon({
editType: CellExecutionUpdateType.OutputItems,
items: items.map(NotebookCellOutputItem.from),
outputId: output instanceof NotebookCellOutput ? output.outputId : '',
append
});
}
Expand Down
1 change: 1 addition & 0 deletions packages/plugin-ext/src/plugin/type-converters.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1722,6 +1722,7 @@ export namespace NotebookDto {
return {
editType: data.editType,
append: data.append,
outputId: data.outputId,
items: data.items.map(fromNotebookOutputItemDto)
};
} else {
Expand Down
Loading