Add protection for infinite index rebuilding

Author: ivankravets

src/misc.js

@@ -83,6 +83,10 @@ export function reportError(err) {
 
 export function getErrorReportUrl(title, description) {
   const errorToUrls = [
+    [
+      'Multiple requests to rebuild the project',
+      'https://github.com/platformio/platformio-vscode-ide/issues/2363',
+    ],
     [
       'WindowsError: [Error 5]',
       'https://github.com/platformio/platformio-vscode-ide/issues/884',

src/project/indexer.js

@@ -6,10 +6,13 @@
  * the root directory of this source tree.
  */
 
+import path from 'path';
 import { runPIOCommand } from '../core';
 
 export default class ProjectIndexer {
-  static AUTO_REBUILD_DELAY = 3000;
+  static AUTO_REBUILD_DELAY = 3; // 3 seconds
+  static FLOOD_TIME_WINDOW = 60 * 10; // 10 minutes
+  static FLOOD_MAX_ATTEMPTS = 30;
 
   constructor(projectDir, options, observer) {
     this.projectDir = projectDir;
@@ -18,6 +21,8 @@ export default class ProjectIndexer {
 
     this._rebuildTimeout = undefined;
     this._inProgress = false;
+    this._floodStartedAt = Date.now();
+    this._floodAttempts = 0;
   }
 
   dispose() {
@@ -27,26 +32,51 @@ export default class ProjectIndexer {
   }
 
   requestRebuild() {
+    if (Date.now() - this._floodStartedAt < ProjectIndexer.FLOOD_TIME_WINDOW * 1000) {
+      this._floodAttempts++;
+    } else {
+      this._floodAttempts = 0;
+      this._floodStartedAt = Date.now();
+    }
     if (this._rebuildTimeout) {
       clearTimeout(this._rebuildTimeout);
+      this._rebuildTimeout = undefined;
+    }
+
+    if (this._floodAttempts >= ProjectIndexer.FLOOD_MAX_ATTEMPTS) {
+      if (
+        this._floodAttempts === ProjectIndexer.FLOOD_MAX_ATTEMPTS &&
+        this.options.api.onDidNotifyError
+      ) {
+        const msg =
+          `Multiple requests to rebuild the project "${path.basename(
+            this.projectDir
+          )}" index have been detected!\n` +
+          `Automatic index rebuilding process has been terminated for ${
+            ProjectIndexer.FLOOD_TIME_WINDOW / 60
+          } minutes.`;
+        this.options.api.onDidNotifyError(msg, new Error(msg));
+      }
+      return;
     }
+
     this._rebuildTimeout = setTimeout(
       this.rebuild.bind(this),
-      ProjectIndexer.AUTO_REBUILD_DELAY
+      ProjectIndexer.AUTO_REBUILD_DELAY * 1000
     );
   }
 
   rebuild() {
     if (this._inProgress) {
       return;
     }
-    return this.options.api.withWindowProgress(async () => {
+    return this.options.api.withIndexRebuildingProgress(async () => {
       this._inProgress = true;
       try {
         await new Promise((resolve, reject) => {
           const args = ['init', '--ide', this.options.ide];
-          if (this.observer.activeEnvName) {
-            args.push('--environment', this.observer.activeEnvName);
+          if (this.observer.getActiveEnvName()) {
+            args.push('--environment', this.observer.getActiveEnvName());
           }
           runPIOCommand(
             args,
@@ -69,6 +99,6 @@ export default class ProjectIndexer {
         console.warn(err);
       }
       this._inProgress = false;
-    }, 'PlatformIO: Rebuilding IntelliSense Index');
+    });
   }
 }

src/project/observer.js

@@ -42,13 +42,13 @@ export default class ProjectObserver {
     if (this._updateDirWatchersTimeout) {
       clearTimeout(this._updateDirWatchersTimeout);
     }
+    if (this._indexer) {
+      this._indexer.dispose();
+    }
   }
 
   activate() {
     console.info('Activating project', this.projectDir);
-    if (!this._indexer && this.getSetting('autoRebuild')) {
-      this.getIndexer().rebuild();
-    }
   }
 
   deactivate() {
@@ -63,12 +63,27 @@ export default class ProjectObserver {
     this._cache.clear();
   }
 
-  get activeEnvName() {
+  rebuildIndex({ force = false, delayed = false } = {}) {
+    if (!force && !this.getSetting('autoRebuild')) {
+      return;
+    }
+    if (!this._indexer) {
+      this._indexer = new ProjectIndexer(this.projectDir, this.options, this);
+    }
+    return delayed ? this._indexer.requestRebuild() : this._indexer.rebuild();
+  }
+
+  getActiveEnvName() {
     return this._activeEnvName;
   }
 
-  set activeEnvName(activeEnvName) {
-    this._activeEnvName = activeEnvName;
+  async switchProjectEnv(name) {
+    const validNames = (await this.getProjectEnvs()).map((item) => item.name);
+    if (!validNames.includes(name)) {
+      name = undefined;
+    }
+    this._activeEnvName = name;
+    this.rebuildIndex({ delayed: true });
   }
 
   async getProjectEnvs() {
@@ -111,7 +126,7 @@ export default class ProjectObserver {
     const lazyLoading =
       options.preload ||
       this.getSetting('autoPreloadEnvTasks') ||
-      this.activeEnvName === name ||
+      this._activeEnvName === name ||
       (await this.getProjectEnvs()).length === 1;
     if (!lazyLoading) {
       return undefined;
@@ -134,28 +149,19 @@ export default class ProjectObserver {
     return this._cache.get(cacheKey);
   }
 
-  getIndexer() {
-    if (!this._indexer) {
-      this._indexer = new ProjectIndexer(this.projectDir, this.options, this);
-    }
-    return this._indexer;
-  }
-
-  rebuildIndex() {
-    return this.getIndexer().rebuild();
-  }
-
   onDidChangeProjectConfig() {
     this.resetCache();
+    // reset to `undefined` if env was removed from conf
+    // rebuildIndex
+    this.switchProjectEnv(this._activeEnvName);
+    this.requestUpdateDirWatchers();
     if ((this.options.api || {}).onDidChangeProjectConfig) {
       this.options.api.onDidChangeProjectConfig(this.projectDir);
     }
-    this.getIndexer().requestRebuild();
-    this.requestUpdateDirWatchers();
   }
 
   onDidChangeLibDirs() {
-    this.getIndexer().requestRebuild();
+    this.rebuildIndex({ delayed: true });
   }
 
   setupFSWatchers() {

src/project/pool.js

@@ -20,7 +20,16 @@ export default class ProjectPool {
     return this._activeProjectDir;
   }
 
+  getActiveObserver() {
+    return this._activeProjectDir
+      ? this.getObserver(this._activeProjectDir)
+      : undefined;
+  }
+
   getObserver(projectDir) {
+    if (!projectDir) {
+      return undefined;
+    }
     let observer = this._observers.find(
       (observer) => observer.projectDir === projectDir
     );
@@ -40,11 +49,9 @@ export default class ProjectPool {
     this._observers
       .filter((observer) => observer.projectDir !== projectDir)
       .forEach((observer) => observer.deactivate());
-    this.getObserver(projectDir).activate();
-  }
-
-  rebuildIndex(projectDir) {
-    return this.getObserver(projectDir).rebuildIndex();
+    const observer = this.getObserver(projectDir);
+    observer.activate();
+    return observer;
   }
 
   dispose() {