Update CHANGELOG and language server

Author: znorman-harris

CHANGELOG.md

@@ -18,6 +18,16 @@ Document some advanced types so users may try them out and provide feedback. The
 
 IDL 9.1 introduces new, command-line based progress bars. We have a first-pass of support for these progress bars inside IDL Notebooks.
 
+## Unreleased
+
+Changed the language server startup process to remove all files from memory after initial startup. This reduces RAM by 0.25-0.5 GB of memory after startup, depending on the volume of code in workspaces and on your path.
+
+When we clean up the language server (happens every 5 minutes), we now check our in-memory cache and remove any files that haven't been accessed recently. Helps reduce overall RAM when VSCode is open for long periods at a time.
+
+Changed the way that the language server sends work to the threads that parse code. The main difference is that we no longer send the parsed version of code back to the main thread which we were doing.
+
+For large files, this had a significant impact on perceived performance as the worker threads could get locked serializing and de-serializing objects (also leads to more memory usage). Now, large files like slicer3.pro which are included in the IDL installation, provide auto-complete and hover help in about ~0.5 seconds instead of 5+ seconds.
+
 ## 4.6.1 - September 2024
 
 Added layer controls to the Notebook Map.

apps/parsing-worker/src/main.ts

@@ -13,7 +13,10 @@ import {
   IDLIndex,
   ReduceGlobals,
 } from '@idl/parsing/index';
-import { RemoveScopeDetail } from '@idl/parsing/syntax-tree';
+import {
+  IParsedLightWeight,
+  RemoveScopeDetail,
+} from '@idl/parsing/syntax-tree';
 import { IDL_TRANSLATION } from '@idl/translation';
 import {
   ChangeDetectionResponse,
@@ -181,17 +184,11 @@ client.on(
 /**
  * Clean up and return memory usage
  */
-client.on(LSP_WORKER_THREAD_MESSAGE_LOOKUP.CLEAN_UP, async () => {
+client.on(LSP_WORKER_THREAD_MESSAGE_LOOKUP.CLEAN_UP, async (message) => {
+  await WORKER_INDEX.clearParsedCache(message?.all);
   await WORKER_INDEX.cleanUp();
 });
 
-/**
- * Listen for messages about removing tokens from our in-memory cache
- */
-client.on(LSP_WORKER_THREAD_MESSAGE_LOOKUP.CLEAR_CACHE, async () => {
-  await WORKER_INDEX.clearParsedCache(true);
-});
-
 /**
  * Get auto complete for files we manage
  */
@@ -264,11 +261,15 @@ client.on(
       message
     );
 
-    // make non-circular
-    RemoveScopeDetail(parsed, cancel, true);
+    const lightParsed: IParsedLightWeight = {
+      disabledProblems: parsed.disabledProblems,
+      global: parsed.global,
+      parseProblems: parsed.parseProblems,
+      postProcessProblems: parsed.postProcessProblems,
+    };
 
     // return
-    return parsed;
+    return lightParsed;
   }
 );
 
@@ -291,8 +292,15 @@ client.on(
     // make non-circular
     RemoveScopeDetail(parsed, cancel, true);
 
+    const lightParsed: IParsedLightWeight = {
+      disabledProblems: parsed.disabledProblems,
+      global: parsed.global,
+      parseProblems: parsed.parseProblems,
+      postProcessProblems: parsed.postProcessProblems,
+    };
+
     // return
-    return parsed;
+    return lightParsed;
   }
 );
 
@@ -476,12 +484,13 @@ client.on(
       cancel
     );
 
-    // make non-circular
-    if (parsed !== undefined) {
-      RemoveScopeDetail(parsed, cancel, true);
-    }
-
-    return parsed;
+    const lightParsed: IParsedLightWeight = {
+      disabledProblems: parsed.disabledProblems,
+      global: parsed.global,
+      parseProblems: parsed.parseProblems,
+      postProcessProblems: parsed.postProcessProblems,
+    };
+    return lightParsed;
   }
 );
 

libs/parsing/index/src/lib/get-parsed/get-parsed-pro-code.ts

@@ -107,7 +107,7 @@ export async function GetParsedPROCode(
         const newPending: IGetParsedPROCodePending = {
           checksum,
           token: resp.token,
-          promise: resp.response,
+          promise: resp.response as any,
         };
 
         // save new pending file
@@ -144,7 +144,7 @@ export async function GetParsedPROCode(
       const newPending: IGetParsedPROCodePending = {
         checksum,
         token: resp.token,
-        promise: resp.response,
+        promise: resp.response as any,
       };
 
       // save new pending file

libs/parsing/index/src/lib/idl-index.class.ts

@@ -332,7 +332,7 @@ export class IDLIndex {
             this.indexerPool.workerio.postAndReceiveMessage(
               ids[i],
               LSP_WORKER_THREAD_MESSAGE_LOOKUP.CLEAN_UP,
-              undefined
+              { all: false }
             ).response
           );
         }
@@ -1933,10 +1933,9 @@ export class IDLIndex {
     await Promise.all(postProcessing);
 
     // send message to clean up
-    this.indexerPool.postToAll(
-      LSP_WORKER_THREAD_MESSAGE_LOOKUP.CLEAN_UP,
-      undefined
-    );
+    this.indexerPool.postToAll(LSP_WORKER_THREAD_MESSAGE_LOOKUP.CLEAN_UP, {
+      all: true,
+    });
 
     // save syntax problems for our file
     for (let i = 0; i < postProcessing.length; i++) {

libs/parsing/index/src/lib/idl-parsed-cache.class.ts

@@ -1,20 +1,15 @@
 import { CancellationToken } from '@idl/cancellation-tokens';
 import { IParsed, RemoveScopeDetail } from '@idl/parsing/syntax-tree';
 import copy from 'fast-copy';
+import { performance } from 'perf_hooks';
 import { DocumentSymbol, SemanticTokens } from 'vscode-languageserver';
 
 import { IDL_INDEX_OPTIONS } from './idl-index.interface';
-
-/**
- * If files have more than this many lines of code, we dont compress because
- * it is just too slow
- */
-const COMPRESSION_LINE_THRESHOLD = 2000;
-
-/**
- * Tags that we compress/uncompress
- */
-const COMPRESS_THESE = ['tree', 'global'];
+import {
+  ACCESS_EXPIRATION_MS,
+  COMPRESS_THESE,
+  COMPRESSION_LINE_THRESHOLD,
+} from './idl-parsed-cache.interface';
 
 /**
  * The keys that we compress so we can pick out a single field
@@ -36,6 +31,11 @@ export class IDLParsedCache {
    */
   private byFile: { [key: string]: IParsed } = {};
 
+  /**
+   * Track last time we accessed teh file
+   */
+  private lastAccess: { [key: string]: number } = {};
+
   /**
    * Compress
    */
@@ -96,11 +96,19 @@ export class IDLParsedCache {
     return parsed;
   }
 
+  /**
+   * Last time we accessed an item in our cache
+   */
+  private _trackAccess(file: string) {
+    this.lastAccess[file] = performance.now();
+  }
+
   /**
    * Add parsed to the cache
    */
   add(file: string, parsed: IParsed) {
     this.byFile[file] = this.compress(parsed);
+    this._trackAccess(file);
   }
 
   /**
@@ -115,6 +123,7 @@ export class IDLParsedCache {
    */
   checksumMatches(file: string, checksum: string) {
     if (file in this.byFile) {
+      this._trackAccess(file);
       return this.byFile[file].checksum === checksum;
     }
     return false;
@@ -125,8 +134,23 @@ export class IDLParsedCache {
    */
   cleanup(all = false) {
     if (all) {
-      delete this.byFile;
       this.byFile = {};
+      this.lastAccess = {};
+    } else {
+      /** Time right now */
+      const now = performance.now();
+
+      /** Current files */
+      const keys = Object.keys(this.byFile);
+
+      // process all the files we have
+      for (let i = 0; i < keys.length; i++) {
+        if (keys[i] in this.lastAccess) {
+          if (now - this.lastAccess[keys[i]] > ACCESS_EXPIRATION_MS) {
+            this.remove(keys[i]);
+          }
+        }
+      }
     }
   }
 
@@ -137,6 +161,7 @@ export class IDLParsedCache {
    */
   get(file: string): IParsed | undefined {
     if (file in this.byFile) {
+      this._trackAccess(file);
       return this.decompress(this.byFile[file]);
     }
     return undefined;
@@ -154,6 +179,7 @@ export class IDLParsedCache {
    */
   lines(file: string): number | undefined {
     if (file in this.byFile) {
+      this._trackAccess(file);
       return this.byFile[file].lines;
     }
   }
@@ -163,6 +189,7 @@ export class IDLParsedCache {
    */
   outline(file: string): DocumentSymbol[] | undefined {
     if (file in this.byFile) {
+      this._trackAccess(file);
       return this.byFile[file].outline;
     }
   }
@@ -175,6 +202,7 @@ export class IDLParsedCache {
    */
   semantic(file: string): SemanticTokens | undefined {
     if (file in this.byFile) {
+      this._trackAccess(file);
       return this.byFile[file].semantic.built;
     }
   }
@@ -185,6 +213,7 @@ export class IDLParsedCache {
    */
   text(file: string): string[] | undefined {
     if (file in this.byFile) {
+      this._trackAccess(file);
       return this.byFile[file].text;
     }
   }
@@ -194,6 +223,7 @@ export class IDLParsedCache {
    */
   remove(file: string) {
     delete this.byFile[file];
+    delete this.lastAccess[file];
   }
 
   /**
@@ -203,6 +233,7 @@ export class IDLParsedCache {
    */
   uses(file: string) {
     if (file in this.byFile) {
+      this._trackAccess(file);
       return this.byFile[file].uses;
     }
   }
@@ -213,6 +244,7 @@ export class IDLParsedCache {
    */
   updateProblems(file: string, parsed: IParsed) {
     if (file in this.byFile) {
+      this._trackAccess(file);
       this.byFile[file].parseProblems = parsed.parseProblems;
       this.byFile[file].postProcessProblems = parsed.postProcessProblems;
     }
@@ -223,6 +255,7 @@ export class IDLParsedCache {
    */
   updateSemantic(file: string, parsed: IParsed) {
     if (file in this.byFile) {
+      this._trackAccess(file);
       this.byFile[file].semantic = parsed.semantic;
     }
   }

libs/parsing/index/src/lib/idl-parsed-cache.interface.ts

@@ -0,0 +1,16 @@
+/**
+ * If files have more than this many lines of code, we dont compress because
+ * it is just too slow
+ */
+export const COMPRESSION_LINE_THRESHOLD = 2000;
+
+/**
+ * Tags that we compress/decompress
+ */
+export const COMPRESS_THESE = ['tree', 'global'];
+
+/**
+ * How long (ms) before we remove items from our cache without
+ * accessing it
+ */
+export const ACCESS_EXPIRATION_MS = 300000;

libs/parsing/syntax-tree/src/lib/parsed.interface.ts

@@ -16,10 +16,24 @@ import { ILocalTokens } from './populators/populate-local.interface';
  */
 export type ParsedType = 'def' | 'notebook' | 'pro';
 
+/**
+ * Lightweight parsed response for advanced use cases
+ */
+export interface IParsedLightWeight {
+  /** What problems are disabled? */
+  disabledProblems: IDisabledProblems;
+  /** Problems found within code from basic parsing */
+  parseProblems: SyntaxProblems;
+  /** Problems from post processing (type errors) which get reset every time we post-process */
+  postProcessProblems: SyntaxProblems;
+  /** Global tokens that we want to find in other places */
+  global: GlobalTokens;
+}
+
 /**
  * Data structure for parsed code
  */
-export interface IParsed extends IFoundTokens {
+export interface IParsed extends IFoundTokens, IParsedLightWeight {
   /**
    * type of parsed code
    */
@@ -37,16 +51,8 @@ export interface IParsed extends IFoundTokens {
    * If we have set a token cache or not
    */
   hasCache: boolean;
-  /** What problems are disabled? */
-  disabledProblems: IDisabledProblems;
-  /** Problems found within code from basic parsing */
-  parseProblems: SyntaxProblems;
-  /** Problems from post processing (type errors) which get reset every time we post-process */
-  postProcessProblems: SyntaxProblems;
   /** Tokens converted into syntax tree */
   tree: SyntaxTree;
-  /** Global tokens that we want to find in other places */
-  global: GlobalTokens;
   /** Local tokens that we have found */
   local: ILocalTokens;
   /** Compile options by routine */