User/morgilad/dispose disposables when disposing model

README.md

@@ -85,6 +85,10 @@ Every PR should come with a test that checks it.
 
 ## Changelog
 
+### 12.0.8
+
+-   fix: dispose all monaco models when disposing the worker to prevent memory leaks.
+
 ### 12.0.7
 
 -   revert: KQL color contrast for query operators change.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kusto/monaco-kusto",
-    "version": "12.0.7",
+    "version": "12.0.8",
     "description": "CSL, KQL plugin for the Monaco Editor",
     "author": {
         "name": "Microsoft"

package/src/kustoMode.ts

@@ -8,6 +8,7 @@ import type { IKustoWorkerImpl } from './kustoWorker';
 import { kustoLanguageDefinition } from './syntaxHighlighting/kustoMonarchLanguageDefinition';
 import { LANGUAGE_ID } from './globals';
 import { semanticTokensProviderRegistrarCreator } from './syntaxHighlighting/semanticTokensProviderRegistrar';
+import { IDisposable } from 'monaco-editor';
 
 export interface AugmentedWorker
     extends KustoWorker,
@@ -29,13 +30,10 @@ let workerPromise: Promise<AugmentedWorkerAccessor> = new Promise((resolve, reje
  * Called when Kusto language is first needed (a model has the language set)
  * @param defaults
  */
-export function setupMode(
-    defaults: LanguageServiceDefaults,
-    monacoInstance: typeof globalThis.monaco
-): AugmentedWorkerAccessor {
-    let onSchemaChange = new monaco.Emitter<Schema>();
+export function setupMode(defaults: LanguageServiceDefaults, monacoInstance: typeof globalThis.monaco): IDisposable {
+    const onSchemaChange = new monaco.Emitter<Schema>();
     // TODO: when should we dispose of these? seems like monaco-css and monaco-typescript don't dispose of these.
-    let disposables: monaco.IDisposable[] = [];
+    const disposables: monaco.IDisposable[] = [];
     const semanticTokensProviderRegistrar = semanticTokensProviderRegistrarCreator();
 
     const client = new WorkerManager(monacoInstance, defaults);
@@ -80,10 +78,7 @@ export function setupMode(
         )
     );
 
-    const monarchTokensProvider = monacoInstance.languages.setMonarchTokensProvider(
-        LANGUAGE_ID,
-        kustoLanguageDefinition
-    );
+    disposables.push(monacoInstance.languages.setMonarchTokensProvider(LANGUAGE_ID, kustoLanguageDefinition));
 
     disposables.push(
         new languageFeatures.DiagnosticsAdapter(
@@ -143,27 +138,41 @@ export function setupMode(
     kustoWorker = workerAccessor;
     resolveWorker(workerAccessor);
 
-    monacoInstance.languages.setLanguageConfiguration(LANGUAGE_ID, {
-        folding: {
-            offSide: false,
-            markers: { start: /^\s*[\r\n]/gm, end: /^\s*[\r\n]/gm },
-        },
-        comments: {
-            lineComment: '//',
-            blockComment: null,
+    disposables.push(monacoInstance.languages.setLanguageConfiguration(LANGUAGE_ID, kanguageConfiguration));
+
+    return asDisposable(disposables);
+}
+
+function asDisposable(disposables: IDisposable[]): IDisposable {
+    return {
+        dispose: () => {
+            return disposeAll(disposables);
         },
-        autoClosingPairs: [
-            { open: '{', close: '}' },
-            { open: '[', close: ']' },
-            { open: '(', close: ')' },
-            { open: "'", close: "'", notIn: ['string', 'comment'] },
-            { open: '"', close: '"', notIn: ['string', 'comment'] },
-        ],
-    });
-
-    return kustoWorker;
+    };
+}
+
+function disposeAll(disposables: IDisposable[]) {
+    disposables.forEach((d) => d.dispose());
 }
 
 export function getKustoWorker(): Promise<AugmentedWorkerAccessor> {
     return workerPromise.then(() => kustoWorker);
 }
+
+const kanguageConfiguration = {
+    folding: {
+        offSide: false,
+        markers: { start: /^\s*[\r\n]/gm, end: /^\s*[\r\n]/gm },
+    },
+    comments: {
+        lineComment: '//',
+        blockComment: null,
+    },
+    autoClosingPairs: [
+        { open: '{', close: '}' },
+        { open: '[', close: ']' },
+        { open: '(', close: ')' },
+        { open: "'", close: "'", notIn: ['string', 'comment'] },
+        { open: '"', close: '"', notIn: ['string', 'comment'] },
+    ],
+};

package/src/monaco.contribution.ts

@@ -94,14 +94,19 @@ export function getKustoWorker(): Promise<WorkerAccessor> {
     });
 }
 
-function withMode(callback: (module: typeof mode) => void): void {
-    import('./kustoMode').then(callback);
+function withMode<T>(callback: (module: typeof mode) => T): Promise<T> {
+    return import('./kustoMode').then(callback);
 }
 
 export const kustoDefaults = new LanguageServiceDefaultsImpl(defaultLanguageSettings);
 
-monaco.languages.onLanguage('kusto', () => {
-    withMode((mode) => mode.setupMode(kustoDefaults, monaco as typeof globalThis.monaco));
+let disposable: monaco.IDisposable;
+monaco.languages.onLanguage('kusto', async () => {
+    disposable = await withMode((mode) => mode.setupMode(kustoDefaults, monaco as typeof globalThis.monaco));
+});
+
+monaco.editor.onWillDisposeModel((model) => {
+    disposable.dispose();
 });
 
 monaco.languages.register({