feat: index persistance

Author: raideer

src/command/IndexWorkspaceCommand.ts

@@ -7,6 +7,6 @@ export default class IndexWorkspaceCommand extends Command {
   }
 
   public async execute(...args: any[]): Promise<void> {
-    await IndexRunner.indexWorkspace();
+    await IndexRunner.indexWorkspace(true);
   }
 }

src/indexer/IndexDataSerializer.ts

@@ -0,0 +1,25 @@
+import { SavedIndex } from 'types/indexer';
+
+export class IndexDataSerializer {
+  public serialize(data: SavedIndex): string {
+    return JSON.stringify(data, this.replacer);
+  }
+
+  public deserialize(data: string): SavedIndex {
+    return JSON.parse(data, this.reviver);
+  }
+
+  private replacer(key: string, value: any) {
+    if (value instanceof Map) {
+      return { __type: 'Map', value: Array.from(value.entries()) };
+    }
+    return value;
+  }
+
+  private reviver(key: string, value: any) {
+    if (value && typeof value === 'object' && value.__type === 'Map') {
+      return new Map(value.value);
+    }
+    return value;
+  }
+}

src/indexer/IndexManager.ts

@@ -56,7 +56,10 @@ class IndexManager {
     Logger.logWithTime('Indexing workspace', workspaceFolder.name);
 
     for (const indexer of this.indexers) {
-      if (!force && !this.shouldIndex(indexer)) {
+      this.indexStorage.loadIndex(workspaceFolder, indexer.getId(), indexer.getVersion());
+
+      if (!force && !this.shouldIndex(workspaceFolder, indexer)) {
+        Logger.logWithTime('Loaded index from storage', workspaceFolder.name, indexer.getId());
         continue;
       }
       progress.report({ message: `Indexing - ${indexer.getName()}`, increment: 0 });
@@ -88,6 +91,7 @@ class IndexManager {
       );
 
       this.indexStorage.set(workspaceFolder, indexer.getId(), indexData);
+      this.indexStorage.saveIndex(workspaceFolder, indexer.getId(), indexer.getVersion());
 
       clear([indexer.getId()]);
 
@@ -183,8 +187,8 @@ class IndexManager {
     clear([indexer.getId()]);
   }
 
-  protected shouldIndex(index: IndexerInstance): boolean {
-    return true;
+  protected shouldIndex(workspaceFolder: WorkspaceFolder, index: IndexerInstance): boolean {
+    return !this.indexStorage.hasIndex(workspaceFolder, index.getId());
   }
 }
 

src/indexer/IndexRunner.ts

@@ -14,7 +14,7 @@ class IndexRunner {
           title: '[Magento Toolbox]',
         },
         async progress => {
-          await IndexManager.indexWorkspace(workspaceFolder, progress);
+          await IndexManager.indexWorkspace(workspaceFolder, progress, force);
         }
       );
     }

src/indexer/IndexStorage.ts

@@ -1,8 +1,12 @@
 import { WorkspaceFolder } from 'vscode';
-import { IndexerKey, IndexerStorage, IndexedFilePath } from 'types/indexer';
+import { IndexerKey, IndexerStorage, IndexedFilePath, SavedIndex } from 'types/indexer';
+import { IndexDataSerializer } from './IndexDataSerializer';
+import Context from 'common/Context';
+import ExtensionState from 'common/ExtensionState';
 
 export default class IndexStorage {
   private _indexStorage: IndexerStorage = {};
+  private serializer = new IndexDataSerializer();
 
   public set(workspaceFolder: WorkspaceFolder, key: IndexerKey, value: Map<IndexedFilePath, any>) {
     if (!this._indexStorage[workspaceFolder.uri.fsPath]) {
@@ -23,11 +27,44 @@ export default class IndexStorage {
     this._indexStorage = {};
   }
 
-  public async load() {
-    // TODO: Implement
+  public hasIndex(workspaceFolder: WorkspaceFolder, key: IndexerKey) {
+    return !!this._indexStorage[workspaceFolder.uri.fsPath]?.[key];
   }
 
-  public async save() {
-    // TODO: Implement
+  public saveIndex(workspaceFolder: WorkspaceFolder, key: IndexerKey, version: number) {
+    const indexData = this._indexStorage[workspaceFolder.uri.fsPath][key];
+
+    const savedIndex: SavedIndex = {
+      version,
+      data: indexData,
+    };
+    const serialized = this.serializer.serialize(savedIndex);
+
+    ExtensionState.context.globalState.update(
+      `index-storage-${workspaceFolder.uri.fsPath}-${key}`,
+      serialized
+    );
+  }
+
+  public loadIndex(workspaceFolder: WorkspaceFolder, key: IndexerKey, version: number) {
+    const serialized = ExtensionState.context.globalState.get<string>(
+      `index-storage-${workspaceFolder.uri.fsPath}-${key}`
+    );
+
+    if (!serialized) {
+      return undefined;
+    }
+
+    const savedIndex = this.serializer.deserialize(serialized);
+
+    if (savedIndex.version !== version) {
+      return undefined;
+    }
+
+    if (!this._indexStorage[workspaceFolder.uri.fsPath]) {
+      this._indexStorage[workspaceFolder.uri.fsPath] = {};
+    }
+
+    this._indexStorage[workspaceFolder.uri.fsPath][key] = savedIndex.data;
   }
 }

src/indexer/Indexer.ts

@@ -6,4 +6,5 @@ export abstract class Indexer<D = any> {
   public abstract getName(): string;
   public abstract getPattern(uri: Uri): GlobPattern;
   public abstract indexFile(uri: Uri): Promise<D | undefined>;
+  public abstract getVersion(): number;
 }

src/indexer/autoload-namespace/AutoloadNamespaceIndexer.ts

@@ -7,6 +7,10 @@ import { IndexerKey } from 'types/indexer';
 export default class AutoloadNamespaceIndexer extends Indexer<Namespace[]> {
   public static readonly KEY = 'autoloadNamespace';
 
+  public getVersion(): number {
+    return 1;
+  }
+
   public getId(): IndexerKey {
     return AutoloadNamespaceIndexer.KEY;
   }

src/indexer/di/DiIndexer.ts

@@ -30,6 +30,10 @@ export default class DiIndexer extends Indexer<DiData> {
     });
   }
 
+  public getVersion(): number {
+    return 1;
+  }
+
   public getId(): IndexerKey {
     return DiIndexer.KEY;
   }

src/indexer/events/EventsIndexer.ts

@@ -22,6 +22,10 @@ export default class EventsIndexer extends Indexer<Event[]> {
     });
   }
 
+  public getVersion(): number {
+    return 1;
+  }
+
   public getId(): IndexerKey {
     return EventsIndexer.KEY;
   }

src/indexer/module/ModuleIndexer.ts

@@ -23,6 +23,10 @@ export default class ModuleIndexer extends Indexer<Module> {
     });
   }
 
+  public getVersion(): number {
+    return 1;
+  }
+
   public getId(): IndexerKey {
     return ModuleIndexer.KEY;
   }