SONARPY-847 Deactivate Project Symbol Table in SonarLint for big projects (#928)

Author: guillaume-dequenne

sonar-python-plugin/src/main/java/org/sonar/plugins/python/indexer/SonarLintPythonIndexer.java

@@ -39,6 +39,8 @@ public class SonarLintPythonIndexer extends PythonIndexer implements ModuleFileL
   private final ModuleFileSystem moduleFileSystem;
   private static final Logger LOG = Loggers.get(SonarLintPythonIndexer.class);
   private boolean shouldBuildProjectSymbolTable = true;
+  private static final long DEFAULT_MAX_LINES_FOR_INDEXING = 150_000;
+  private static final String MAX_LINES_PROPERTY = "sonar.python.sonarlint.indexing.maxlines";
 
   public SonarLintPythonIndexer(ModuleFileSystem moduleFileSystem) {
     this.moduleFileSystem = moduleFileSystem;
@@ -50,12 +52,19 @@ public void buildOnce(SensorContext context) {
       return;
     }
     this.projectBaseDirAbsolutePath = context.fileSystem().baseDir().getAbsolutePath();
+    shouldBuildProjectSymbolTable = false;
     List<InputFile> files = getInputFiles(moduleFileSystem);
+    long nLines = files.stream().map(InputFile::lines).mapToLong(Integer::longValue).sum();
+    long maxLinesForIndexing = context.config().getLong(MAX_LINES_PROPERTY).orElse(DEFAULT_MAX_LINES_FOR_INDEXING);
+    if (nLines > maxLinesForIndexing) {
+      // Avoid performance issues for large projects
+      LOG.debug("Project symbol table deactivated due to project size (total number of lines is {}, maximum for indexing is {})", nLines, maxLinesForIndexing);
+      return;
+    }
     LOG.debug("Input files for indexing: " + files);
     // computes "globalSymbolsByModuleName"
     GlobalSymbolsScanner globalSymbolsStep = new GlobalSymbolsScanner(context);
     globalSymbolsStep.execute(files, context);
-    shouldBuildProjectSymbolTable = false;
   }
 
   private static List<InputFile> getInputFiles(ModuleFileSystem moduleFileSystem) {

sonar-python-plugin/src/test/java/org/sonar/plugins/python/PythonSensorTest.java

@@ -320,6 +320,22 @@ public void cross_files_issues_only_one_file_analyzed() {
     assertThat(issue.flows()).isEmpty();
   }
 
+  @Test
+  public void no_indexer_when_project_too_large_sonarlint() {
+    activeRules = new ActiveRulesBuilder()
+      .addRule(new NewActiveRule.Builder()
+        .setRuleKey(RuleKey.of(CheckList.REPOSITORY_KEY, "S930"))
+        .build())
+      .build();
+    context.setSettings(new MapSettings().setProperty("sonar.python.sonarlint.indexing.maxlines", 1));
+
+    InputFile mainFile = inputFile("main.py");
+    PythonIndexer pythonIndexer = pythonIndexer(Collections.singletonList(mainFile));
+    sensor(CUSTOM_RULES, pythonIndexer).execute(context);
+    assertThat(context.allIssues()).isEmpty();
+    assertThat(logTester.logs(LoggerLevel.DEBUG)).contains("Project symbol table deactivated due to project size (total number of lines is 4, maximum for indexing is 1)");
+  }
+
   @Test
   public void loop_in_class_hierarchy() {
     activeRules = new ActiveRulesBuilder()