Avoid editor.deltaDecorations (microsoft#153463)

Fixes microsoft#153215: Avoid `editor.deltaDecorations`

Author: alexdima

src/vs/editor/browser/editorBrowser.ts

@@ -856,20 +856,25 @@ export interface ICodeEditor extends editorCommon.IEditor {
 	 */
 	deltaDecorations(oldDecorations: string[], newDecorations: IModelDeltaDecoration[]): string[];
 
+	/**
+	 * Remove previously added decorations.
+	 */
+	removeDecorations(decorationIds: string[]): void;
+
 	/**
 	 * @internal
 	 */
-	setDecorations(description: string, decorationTypeKey: string, ranges: editorCommon.IDecorationOptions[]): void;
+	setDecorationsByType(description: string, decorationTypeKey: string, ranges: editorCommon.IDecorationOptions[]): void;
 
 	/**
 	 * @internal
 	 */
-	setDecorationsFast(decorationTypeKey: string, ranges: IRange[]): void;
+	setDecorationsByTypeFast(decorationTypeKey: string, ranges: IRange[]): void;
 
 	/**
 	 * @internal
 	 */
-	removeDecorations(decorationTypeKey: string): void;
+	removeDecorationsByType(decorationTypeKey: string): void;
 
 	/**
 	 * Get the layout info for the editor.

src/vs/editor/browser/services/abstractCodeEditorService.ts

@@ -161,7 +161,7 @@ export abstract class AbstractCodeEditorService extends Disposable implements IC
 			if (provider.refCount <= 0) {
 				this._decorationOptionProviders.delete(key);
 				provider.dispose();
-				this.listCodeEditors().forEach((ed) => ed.removeDecorations(key));
+				this.listCodeEditors().forEach((ed) => ed.removeDecorationsByType(key));
 			}
 		}
 	}

src/vs/editor/browser/widget/codeEditorWidget.ts

@@ -1298,7 +1298,17 @@ export class CodeEditorWidget extends Disposable implements editorBrowser.ICodeE
 		return this._modelData.model.deltaDecorations(oldDecorations, newDecorations, this._id);
 	}
 
-	public setDecorations(description: string, decorationTypeKey: string, decorationOptions: editorCommon.IDecorationOptions[]): void {
+	public removeDecorations(decorationIds: string[]): void {
+		if (!this._modelData || decorationIds.length === 0) {
+			return;
+		}
+
+		this._modelData.model.changeDecorations((changeAccessor) => {
+			changeAccessor.deltaDecorations(decorationIds, []);
+		});
+	}
+
+	public setDecorationsByType(description: string, decorationTypeKey: string, decorationOptions: editorCommon.IDecorationOptions[]): void {
 
 		const newDecorationsSubTypes: { [key: string]: boolean } = {};
 		const oldDecorationsSubTypes = this._decorationTypeSubtypes[decorationTypeKey] || {};
@@ -1340,7 +1350,7 @@ export class CodeEditorWidget extends Disposable implements editorBrowser.ICodeE
 		this._decorationTypeKeysToIds[decorationTypeKey] = this.deltaDecorations(oldDecorationsIds, newModelDecorations);
 	}
 
-	public setDecorationsFast(decorationTypeKey: string, ranges: IRange[]): void {
+	public setDecorationsByTypeFast(decorationTypeKey: string, ranges: IRange[]): void {
 
 		// remove decoration sub types that are no longer used, deregister decoration type if necessary
 		const oldDecorationsSubTypes = this._decorationTypeSubtypes[decorationTypeKey] || {};
@@ -1360,7 +1370,7 @@ export class CodeEditorWidget extends Disposable implements editorBrowser.ICodeE
 		this._decorationTypeKeysToIds[decorationTypeKey] = this.deltaDecorations(oldDecorationsIds, newModelDecorations);
 	}
 
-	public removeDecorations(decorationTypeKey: string): void {
+	public removeDecorationsByType(decorationTypeKey: string): void {
 		// remove decorations for type and sub type
 		const oldDecorationsIds = this._decorationTypeKeysToIds[decorationTypeKey];
 		if (oldDecorationsIds) {

src/vs/editor/contrib/gotoSymbol/browser/peek/referencesWidget.ts

@@ -100,10 +100,12 @@ class DecorationsManager implements IDisposable {
 			newDecorationsActualIndex.push(i);
 		}
 
-		const decorations = this._editor.deltaDecorations([], newDecorations);
-		for (let i = 0; i < decorations.length; i++) {
-			this._decorations.set(decorations[i], reference.children[newDecorationsActualIndex[i]]);
-		}
+		this._editor.changeDecorations((changeAccessor) => {
+			const decorations = changeAccessor.deltaDecorations([], newDecorations);
+			for (let i = 0; i < decorations.length; i++) {
+				this._decorations.set(decorations[i], reference.children[newDecorationsActualIndex[i]]);
+			}
+		});
 	}
 
 	private _onDecorationChanged(): void {
@@ -151,11 +153,11 @@ class DecorationsManager implements IDisposable {
 		for (let i = 0, len = toRemove.length; i < len; i++) {
 			this._decorations.delete(toRemove[i]);
 		}
-		this._editor.deltaDecorations(toRemove, []);
+		this._editor.removeDecorations(toRemove);
 	}
 
 	removeDecorations(): void {
-		this._editor.deltaDecorations([...this._decorations.keys()], []);
+		this._editor.removeDecorations([...this._decorations.keys()]);
 		this._decorations.clear();
 	}
 }

src/vs/monaco.d.ts

@@ -5316,6 +5316,10 @@ declare namespace monaco.editor {
 		 * @see {@link ITextModel.deltaDecorations}
 		 */
 		deltaDecorations(oldDecorations: string[], newDecorations: IModelDeltaDecoration[]): string[];
+		/**
+		 * Remove previously added decorations.
+		 */
+		removeDecorations(decorationIds: string[]): void;
 		/**
 		 * Get the layout info for the editor.
 		 */

src/vs/workbench/api/browser/mainThreadEditor.ts

@@ -415,7 +415,7 @@ export class MainThreadTextEditor {
 		if (!this._codeEditor) {
 			return;
 		}
-		this._codeEditor.setDecorations('exthost-api', key, ranges);
+		this._codeEditor.setDecorationsByType('exthost-api', key, ranges);
 	}
 
 	public setDecorationsFast(key: string, _ranges: number[]): void {
@@ -426,7 +426,7 @@ export class MainThreadTextEditor {
 		for (let i = 0, len = Math.floor(_ranges.length / 4); i < len; i++) {
 			ranges[i] = new Range(_ranges[4 * i], _ranges[4 * i + 1], _ranges[4 * i + 2], _ranges[4 * i + 3]);
 		}
-		this._codeEditor.setDecorationsFast(key, ranges);
+		this._codeEditor.setDecorationsByTypeFast(key, ranges);
 	}
 
 	public revealRange(range: IRange, revealType: TextEditorRevealType): void {

src/vs/workbench/contrib/comments/browser/commentReply.ts

@@ -191,7 +191,7 @@ export class CommentReply<T extends IRange | ICellRange> extends Disposable {
 				}
 			}];
 
-			this.commentEditor.setDecorations('review-zone-widget', COMMENTEDITOR_DECORATION_KEY, decorations);
+			this.commentEditor.setDecorationsByType('review-zone-widget', COMMENTEDITOR_DECORATION_KEY, decorations);
 		}
 	}
 

src/vs/workbench/contrib/debug/browser/breakpointWidget.ts

@@ -238,7 +238,7 @@ export class BreakpointWidget extends ZoneWidget implements IPrivateBreakpointWi
 		const setDecorations = () => {
 			const value = this.input.getModel().getValue();
 			const decorations = !!value ? [] : createDecorations(this.themeService.getColorTheme(), this.placeholder);
-			this.input.setDecorations('breakpoint-widget', DECORATION_KEY, decorations);
+			this.input.setDecorationsByType('breakpoint-widget', DECORATION_KEY, decorations);
 		};
 		this.input.getModel().onDidChangeContent(() => setDecorations());
 		this.themeService.onDidColorThemeChange(() => setDecorations());

src/vs/workbench/contrib/debug/browser/repl.ts

@@ -718,7 +718,7 @@ export class Repl extends ViewPane implements IHistoryNavigationWidget {
 			});
 		}
 
-		this.replInput.setDecorations('repl-decoration', DECORATION_KEY, decorations);
+		this.replInput.setDecorationsByType('repl-decoration', DECORATION_KEY, decorations);
 	}
 
 	override saveState(): void {

src/vs/workbench/contrib/interactive/browser/interactiveEditor.ts

@@ -620,7 +620,7 @@ export class InteractiveEditor extends EditorPane {
 			});
 		}
 
-		this.#codeEditorWidget.setDecorations('interactive-decoration', DECORATION_KEY, decorations);
+		this.#codeEditorWidget.setDecorationsByType('interactive-decoration', DECORATION_KEY, decorations);
 	}
 
 	override focus() {