make sure super.dispose is called inside overridden dispose methods (#200342)

.eslintplugin/code-must-use-super-dispose.ts

@@ -0,0 +1,33 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as eslint from 'eslint';
+
+export = new class NoAsyncSuite implements eslint.Rule.RuleModule {
+
+	create(context: eslint.Rule.RuleContext): eslint.Rule.RuleListener {
+		function doesCallSuperDispose(node: any) {
+
+			if (!node.override) {
+				return;
+			}
+
+			const body = context.getSourceCode().getText(node)
+
+			if (body.includes('super.dispose')) {
+				return;
+			}
+
+			context.report({
+				node,
+				message: 'dispose() should call super.dispose()'
+			});
+		}
+
+		return {
+			['MethodDefinition[override][key.name="dispose"]']: doesCallSuperDispose,
+		};
+	}
+};

.eslintrc.json

@@ -73,6 +73,7 @@
 		"local/code-no-nls-in-standalone-editor": "warn",
 		"local/code-no-standalone-editor": "warn",
 		"local/code-no-unexternalized-strings": "warn",
+		"local/code-must-use-super-dispose": "warn",
 		"local/code-declare-service-brand": "warn",
 		"local/code-layering": [
 			"warn",
@@ -119,6 +120,7 @@
 				"**/*.test.ts"
 			],
 			"rules": {
+				"local/code-must-use-super-dispose": "off",
 				"local/code-no-test-only": "error",
 				"local/code-no-test-async-suite": "warn",
 				"local/code-no-unexternalized-strings": "off",

src/vs/base/browser/ui/breadcrumbs/breadcrumbsWidget.ts

@@ -14,7 +14,7 @@ import { ScrollbarVisibility } from 'vs/base/common/scrollable';
 import 'vs/css!./breadcrumbsWidget';
 
 export abstract class BreadcrumbsItem {
-	dispose(): void { }
+	abstract dispose(): void;
 	abstract equals(other: BreadcrumbsItem): boolean;
 	abstract render(container: HTMLElement): void;
 }

src/vs/base/parts/ipc/electron-sandbox/ipc.electron.ts

@@ -34,5 +34,6 @@ export class Client extends IPCClient implements IDisposable {
 
 	override dispose(): void {
 		this.protocol.disconnect();
+		super.dispose();
 	}
 }

src/vs/editor/browser/controller/mouseHandler.ts

@@ -687,6 +687,7 @@ class TopBottomDragScrollingOperation extends Disposable {
 
 	public override dispose(): void {
 		this._animationFrameDisposable.dispose();
+		super.dispose();
 	}
 
 	public setPosition(position: IMouseTargetOutsideEditor, mouseEvent: EditorMouseEvent): void {

src/vs/platform/log/common/bufferLog.ts

@@ -44,6 +44,7 @@ export class BufferLogger extends AbstractMessageLogger {
 
 	override dispose(): void {
 		this._logger?.dispose();
+		super.dispose();
 	}
 
 	override flush(): void {

src/vs/platform/log/common/log.ts

@@ -378,10 +378,6 @@ export class ConsoleMainLogger extends AbstractLogger implements ILogger {
 		}
 	}
 
-	override dispose(): void {
-		// noop
-	}
-
 	flush(): void {
 		// noop
 	}
@@ -445,9 +441,6 @@ export class ConsoleLogger extends AbstractLogger implements ILogger {
 		}
 	}
 
-	override dispose(): void {
-		// noop
-	}
 
 	flush(): void {
 		// noop
@@ -499,10 +492,6 @@ export class AdapterLogger extends AbstractLogger implements ILogger {
 		return toErrorMessage(msg, this.checkLogLevel(LogLevel.Trace));
 	}
 
-	override dispose(): void {
-		// noop
-	}
-
 	flush(): void {
 		// noop
 	}
@@ -564,6 +553,7 @@ export class MultiplexLogger extends AbstractLogger implements ILogger {
 		for (const logger of this.loggers) {
 			logger.dispose();
 		}
+		super.dispose();
 	}
 }
 

src/vs/platform/log/node/spdlogLog.ts

@@ -123,6 +123,7 @@ export class SpdLogLogger extends AbstractMessageLogger implements ILogger {
 		} else {
 			this._loggerCreationPromise.then(() => this.disposeLogger());
 		}
+		super.dispose();
 	}
 
 	private disposeLogger(): void {

src/vs/platform/userDataSync/common/userDataSyncServiceIpc.ts

@@ -291,6 +291,7 @@ class ManualSyncTaskChannelClient extends Disposable implements IUserDataManualS
 
 	override dispose(): void {
 		this.channel.call('dispose');
+		super.dispose();
 	}
 
 }

src/vs/server/node/serverServices.ts

@@ -320,10 +320,6 @@ class ServerLogger extends AbstractLogger {
 		}
 	}
 
-	override dispose(): void {
-		// noop
-	}
-
 	flush(): void {
 		// noop
 	}

src/vs/workbench/api/common/extHostDocumentData.ts

@@ -42,6 +42,7 @@ export class ExtHostDocumentData extends MirrorTextModel {
 		super(uri, lines, eol, versionId);
 	}
 
+	// eslint-disable-next-line local/code-must-use-super-dispose
 	override dispose(): void {
 		// we don't really dispose documents but let
 		// extensions still read from them. some

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

@@ -53,7 +53,7 @@ class OutlineItem extends BreadcrumbsItem {
 		super();
 	}
 
-	override dispose(): void {
+	dispose(): void {
 		this._disposables.dispose();
 	}
 
@@ -113,7 +113,7 @@ class FileItem extends BreadcrumbsItem {
 		super();
 	}
 
-	override dispose(): void {
+	dispose(): void {
 		this._disposables.dispose();
 	}
 
@@ -331,6 +331,9 @@ export class BreadcrumbsControl {
 					equals(other: BreadcrumbsItem): boolean {
 						return other === this;
 					}
+					dispose(): void {
+
+					}
 				}]);
 			} else {
 				this._widget.setEnabled(true);

src/vs/workbench/contrib/bulkEdit/browser/preview/bulkEditPane.ts

@@ -102,6 +102,7 @@ export class BulkEditPane extends ViewPane {
 	override dispose(): void {
 		this._tree.dispose();
 		this._disposables.dispose();
+		super.dispose();
 	}
 
 	protected override renderBody(parent: HTMLElement): void {

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

@@ -174,6 +174,7 @@ export class StartDebugActionViewItem extends BaseActionViewItem {
 
 	override dispose(): void {
 		this.toDispose = dispose(this.toDispose);
+		super.dispose();
 	}
 
 	private updateOptions(): void {

src/vs/workbench/contrib/notebook/test/browser/testNotebookEditor.ts

@@ -222,6 +222,7 @@ function _createTestNotebookEditor(instantiationService: TestInstantiationServic
 	let visibleRanges: ICellRange[] = [{ start: 0, end: 100 }];
 
 	const notebookEditor: IActiveNotebookEditorDelegate = new class extends mock<IActiveNotebookEditorDelegate>() {
+		// eslint-disable-next-line local/code-must-use-super-dispose
 		override dispose() {
 			viewModel.dispose();
 		}

src/vs/workbench/services/activity/browser/activityService.ts

@@ -47,6 +47,7 @@ class ViewContainerActivityByView extends Disposable {
 
 	override dispose() {
 		this.activityDisposable.dispose();
+		super.dispose();
 	}
 }
 

src/vs/workbench/services/extensions/common/rpcProtocol.ts

@@ -170,6 +170,8 @@ export class RPCProtocol extends Disposable implements IRPCProtocol {
 			delete this._pendingRPCReplies[msgId];
 			pending.resolveErr(errors.canceled());
 		});
+
+		super.dispose();
 	}
 
 	public drain(): Promise<void> {