Pass through _store

Author: Tyriar

src/vs/base/common/event.ts

@@ -54,16 +54,20 @@ export namespace Event {
 	}
 
 	/**
-	 * Given an event, returns another event which debounces calls and defers the listeners to a
-	 * later task via a shared `setTimeout`. The event is converted into a signal (`Event<void>`) to
-	 * avoid additional object creation as a result of merging events and to try prevent race
-	 * conditions that could arise when using related deferred and non-deferred events.
+	 * Given an event, returns another event which debounces calls and defers the listeners to a later task via a shared
+	 * `setTimeout`. The event is converted into a signal (`Event<void>`) to avoid additional object creation as a
+	 * result of merging events and to try prevent race conditions that could arise when using related deferred and
+	 * non-deferred events.
 	 *
-	 * This is useful for deferring non-critical work (eg. general UI updates) to ensure it does not
-	 * block critical work (eg. latency of keypress to text rendered).
+	 * This is useful for deferring non-critical work (eg. general UI updates) to ensure it does not block critical work
+	 * (eg. latency of keypress to text rendered).
+	 *
+	 * *NOTE* that this function returns an `Event` and it MUST be called with a `DisposableStore` whenever the returned
+	 * event is accessible to "third parties", e.g the event is a public property. Otherwise a leaked listener on the
+	 * returned event causes this utility to leak a listener on the original event.
 	 */
-	export function defer(event: Event<unknown>): Event<void> {
-		return debounce<unknown, void>(event, () => void 0, 0);
+	export function defer(event: Event<unknown>, disposable?: DisposableStore): Event<void> {
+		return debounce<unknown, void>(event, () => void 0, 0, undefined, undefined, disposable);
 	}
 
 	/**

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

@@ -148,7 +148,7 @@ export class CodeEditorWidget extends Disposable implements editorBrowser.ICodeE
 
 	private readonly _onDidChangeCursorPosition: Emitter<ICursorPositionChangedEvent> = this._register(new Emitter<ICursorPositionChangedEvent>({ deliveryQueue: this._deliveryQueue }));
 	public readonly onDidChangeCursorPosition: Event<ICursorPositionChangedEvent> = this._onDidChangeCursorPosition.event;
-	public readonly onDidChangeCursorPositionDeferred: Event<void> = Event.defer(this._onDidChangeCursorPosition.event);
+	public readonly onDidChangeCursorPositionDeferred: Event<void> = Event.defer(this._onDidChangeCursorPosition.event, this._store);
 
 	private readonly _onDidChangeCursorSelection: Emitter<ICursorSelectionChangedEvent> = this._register(new Emitter<ICursorSelectionChangedEvent>({ deliveryQueue: this._deliveryQueue }));
 	public readonly onDidChangeCursorSelection: Event<ICursorSelectionChangedEvent> = this._onDidChangeCursorSelection.event;

src/vs/workbench/browser/parts/editor/editorStatus.ts

@@ -673,7 +673,6 @@ export class EditorStatus extends Disposable implements IWorkbenchContribution {
 
 			// Hook Listener for Selection changes
 			this.activeEditorListeners.add(activeCodeEditor.onDidChangeCursorPositionDeferred(() => {
-				console.log('cursor position change');
 				this.onSelectionChange(activeCodeEditor);
 				this.currentProblemStatus.update(activeCodeEditor);
 			}));