SONARPY-3233: ProjectLevelTypeTable has to be reset when updating files in SQ:IDE (#435)

joke1196 · sonartech · commit 2efd2657f21e · 2025-08-11T13:43:49.000Z
GitOrigin-RevId: 43ff74f2658d9a64a7e9b887cfbb6a85d257c3ec
diff --git a/python-commons/src/main/java/org/sonar/plugins/python/indexer/PythonIndexer.java b/python-commons/src/main/java/org/sonar/plugins/python/indexer/PythonIndexer.java
@@ -57,7 +57,7 @@ public abstract class PythonIndexer {
   private final Supplier<PythonParser> parserSupplier = PythonParser::create;
 
   private final ProjectLevelSymbolTable projectLevelSymbolTable = ProjectLevelSymbolTable.empty();
-  private final ProjectLevelTypeTable projectLevelTypeTable = new ProjectLevelTypeTable(projectLevelSymbolTable);
+  private ProjectLevelTypeTable projectLevelTypeTable = new ProjectLevelTypeTable(projectLevelSymbolTable);
 
   private final SignatureBasedAwsLambdaHandlersCollector signatureBasedAwsLambdaHandlersCollector = new SignatureBasedAwsLambdaHandlersCollector();
   private final ProjectConfigurationBuilder projectConfigurationBuilder;
@@ -78,6 +78,10 @@ public TypeTable projectLevelTypeTable() {
     return projectLevelTypeTable;
   }
 
+  protected void recreateProjectLevelTypeTable(){
+    projectLevelTypeTable = new ProjectLevelTypeTable(projectLevelSymbolTable);
+  }
+
   public String packageName(PythonInputFile inputFile) {
     if (!packageNames.containsKey(inputFile.wrappedFile().uri())) {
       String name = pythonPackageName(inputFile.wrappedFile().file(), projectBaseDirAbsolutePath);
diff --git a/python-commons/src/main/java/org/sonar/plugins/python/indexer/SonarLintPythonIndexer.java b/python-commons/src/main/java/org/sonar/plugins/python/indexer/SonarLintPythonIndexer.java
@@ -118,12 +118,14 @@ private static List<PythonInputFile> getInputFiles(ModuleFileSystem moduleFileSy
   void addFile(PythonInputFile inputFile) throws IOException {
     super.addFile(inputFile);
     indexedFiles.put(inputFile.wrappedFile().absolutePath(), inputFile.wrappedFile());
+    recreateProjectLevelTypeTable();
   }
 
   @Override
   void removeFile(PythonInputFile inputFile) {
     super.removeFile(inputFile);
     indexedFiles.remove(inputFile.wrappedFile().absolutePath());
+    recreateProjectLevelTypeTable();
   }
 
   @Override
diff --git a/python-commons/src/test/java/org/sonar/plugins/python/indexer/SonarLintPythonIndexerTest.java b/python-commons/src/test/java/org/sonar/plugins/python/indexer/SonarLintPythonIndexerTest.java
@@ -43,8 +43,12 @@
 import org.sonar.plugins.python.api.caching.PythonReadCache;
 import org.sonar.plugins.python.api.caching.PythonWriteCache;
 import org.sonar.plugins.python.api.symbols.Symbol;
-import org.sonar.python.project.config.ProjectConfigurationBuilder;
+import org.sonar.plugins.python.api.types.v2.FunctionType;
+import org.sonar.plugins.python.api.types.v2.ModuleType;
+import org.sonar.plugins.python.api.types.v2.PythonType;
+import org.sonar.plugins.python.api.types.v2.UnknownType;
 import org.sonar.python.caching.DummyCache;
+import org.sonar.python.project.config.ProjectConfigurationBuilder;
 import org.sonar.python.semantic.ProjectLevelSymbolTable;
 import org.sonarsource.sonarlint.plugin.api.module.file.ModuleFileEvent;
 
@@ -130,7 +134,7 @@ void test_indexer_file_removed_twice() {
   }
 
   @Test
-  void test_indexer_added_file() throws IOException {
+  void test_indexer_added_file() {
     PythonInputFile file3 = createInputFile("added.py");
     ModuleFileEvent moduleFileEvent = mock(ModuleFileEvent.class);
     when(moduleFileEvent.getType()).thenReturn(ModuleFileEvent.Type.CREATED);
@@ -145,7 +149,7 @@ void test_indexer_added_file() throws IOException {
   }
 
   @Test
-  void test_indexer_added_nonexistent_file() throws IOException {
+  void test_indexer_added_nonexistent_file() {
     InputFile nonExistentFile = TestInputFileBuilder.create("moduleKey", "nonexistent.py")
       .setModuleBaseDir(baseDir.toPath())
       .setCharset(StandardCharsets.UTF_8)
@@ -163,7 +167,7 @@ void test_indexer_added_nonexistent_file() throws IOException {
   }
 
   @Test
-  void test_indexer_modified_file() throws IOException {
+  void test_indexer_modified_file() {
     ModuleFileEvent moduleFileEvent = mock(ModuleFileEvent.class);
     when(moduleFileEvent.getType()).thenReturn(ModuleFileEvent.Type.MODIFIED);
     when(moduleFileEvent.getTarget()).thenReturn(file2.wrappedFile());
@@ -181,6 +185,67 @@ void test_indexer_non_python_file() {
     testNonPythonFile(null);
   }
 
+  @Test
+  void test_indexer_added_file_updates_type_table() {
+    
+    // Verify that the "added" module type is initially unknown
+    PythonType addedModuleTypeBefore = pythonIndexer.projectLevelTypeTable().getModuleType(List.of("added_type"));
+    assertThat(addedModuleTypeBefore).isInstanceOf(UnknownType.class);
+
+    // Create and add a new file
+    PythonInputFile file = inputFile("added_type.py");
+    ModuleFileEvent moduleFileEvent = mock(ModuleFileEvent.class);
+    when(moduleFileEvent.getType()).thenReturn(ModuleFileEvent.Type.CREATED);
+    when(moduleFileEvent.getTarget()).thenReturn(file.wrappedFile());
+    pythonIndexer.process(moduleFileEvent);
+
+    PythonType addedModuleTypeAfter = pythonIndexer.projectLevelTypeTable().getModuleType(List.of("added_type"));
+    assertThat(addedModuleTypeAfter).isInstanceOf(ModuleType.class);
+    assertThat(addedModuleTypeAfter.toString()).contains("added_type");
+
+    PythonType addedFunction = pythonIndexer.projectLevelTypeTable().getType("added_type.A.foo");
+    assertThat(addedFunction).isInstanceOf(FunctionType.class);
+    assertThat(addedFunction.toString()).contains("FunctionType[foo]");
+
+  }
+
+  @Test
+  void test_indexer_removed_file_updates_type_table() {
+    // Create and add a new file
+    PythonInputFile file = inputFile("removed_type.py");
+    ModuleFileEvent moduleFileEvent = mock(ModuleFileEvent.class);
+    when(moduleFileEvent.getType()).thenReturn(ModuleFileEvent.Type.CREATED);
+    when(moduleFileEvent.getTarget()).thenReturn(file.wrappedFile());
+    pythonIndexer.process(moduleFileEvent);
+
+    assertThat(projectLevelSymbolTable.getSymbolsFromModule("removed_type")).isNotNull();
+    PythonType addedModule = pythonIndexer.projectLevelTypeTable().getModuleType(List.of("removed_type"));
+    assertThat(addedModule).isInstanceOf(ModuleType.class);
+    assertThat(addedModule.toString()).contains("removed_type");
+
+    PythonType functionBar = pythonIndexer.projectLevelTypeTable().getType("removed_type.B.bar");
+    assertThat(functionBar).isInstanceOf(FunctionType.class);
+    assertThat(functionBar.toString()).contains("FunctionType[bar]");
+
+    when(moduleFileEvent.getType()).thenReturn(ModuleFileEvent.Type.DELETED);
+    when(moduleFileEvent.getTarget()).thenReturn(file.wrappedFile());
+    pythonIndexer.process(moduleFileEvent);
+    
+    PythonType removedModule = pythonIndexer.projectLevelTypeTable().getModuleType(List.of("removed_type"));
+    assertThat(removedModule).isInstanceOf(UnknownType.class);
+    PythonType removedClass = pythonIndexer.projectLevelTypeTable().getType("removed_type.B");
+    assertThat(removedClass).isInstanceOf(UnknownType.class);
+
+    // Modifying the file here would act a simply recreating it
+    when(moduleFileEvent.getType()).thenReturn(ModuleFileEvent.Type.MODIFIED);
+    when(moduleFileEvent.getTarget()).thenReturn(file.wrappedFile());
+    pythonIndexer.process(moduleFileEvent);
+
+    PythonType reAddedFun = pythonIndexer.projectLevelTypeTable().getType("removed_type.B.bar");
+    assertThat(reAddedFun).isInstanceOf(FunctionType.class);
+    assertThat(reAddedFun.toString()).contains("FunctionType[bar]");
+  }
+
   @Test
   void test_sonarlint_cache() throws IOException {
     PythonIndexer indexer = new SonarLintPythonIndexer(moduleFileSystem, new ProjectConfigurationBuilder());
diff --git a/python-commons/src/test/resources/org/sonar/plugins/python/indexer/added_type.py b/python-commons/src/test/resources/org/sonar/plugins/python/indexer/added_type.py
@@ -0,0 +1,3 @@
+class A:
+    def foo():
+        ...
diff --git a/python-commons/src/test/resources/org/sonar/plugins/python/indexer/removed_type.py b/python-commons/src/test/resources/org/sonar/plugins/python/indexer/removed_type.py
@@ -0,0 +1,3 @@
+class B:
+    def bar():
+        ...
diff --git a/python-frontend/src/main/java/org/sonar/python/semantic/v2/ProjectLevelTypeTable.java b/python-frontend/src/main/java/org/sonar/python/semantic/v2/ProjectLevelTypeTable.java
@@ -39,7 +39,7 @@ public class ProjectLevelTypeTable implements TypeTable {
   public ProjectLevelTypeTable(ProjectLevelSymbolTable projectLevelSymbolTable) {
     this.lazyTypesContext = new LazyTypesContext(this);
     this.symbolsModuleTypeProvider = new SymbolsModuleTypeProvider(projectLevelSymbolTable, lazyTypesContext);
-    this.rootModule = this.symbolsModuleTypeProvider.createBuiltinModule();
+    this.rootModule = this.symbolsModuleTypeProvider.getRootModule();
     this.createOrResolveSubModuleLock = new ReentrantLock();
   }
 
diff --git a/python-frontend/src/main/java/org/sonar/python/semantic/v2/SymbolsModuleTypeProvider.java b/python-frontend/src/main/java/org/sonar/python/semantic/v2/SymbolsModuleTypeProvider.java
@@ -56,7 +56,7 @@ public SymbolsModuleTypeProvider(ProjectLevelSymbolTable projectLevelSymbolTable
     this.rootModule = new ModuleType(null, null, null, rootModuleMembers);
   }
 
-  public ModuleType createBuiltinModule() {
+  public ModuleType getRootModule() {
     return rootModule;
   }
 
diff --git a/python-frontend/src/test/java/org/sonar/python/semantic/v2/TypeInferenceV2Test.java b/python-frontend/src/test/java/org/sonar/python/semantic/v2/TypeInferenceV2Test.java
@@ -3006,7 +3006,7 @@ void resolveIncorrectLazyType2() {
     ProjectLevelTypeTable projectLevelTypeTable = new ProjectLevelTypeTable(empty);
     LazyTypesContext lazyTypesContext = projectLevelTypeTable.lazyTypesContext();
     SymbolsModuleTypeProvider symbolsModuleTypeProvider = new SymbolsModuleTypeProvider(empty, lazyTypesContext);
-    ModuleType builtinModule = symbolsModuleTypeProvider.createBuiltinModule();
+    ModuleType builtinModule = symbolsModuleTypeProvider.getRootModule();
     symbolsModuleTypeProvider.convertModuleType(List.of("typing"), builtinModule);
 
     ClassSymbol symbol = Mockito.mock(ClassSymbolImpl.class);
@@ -3020,7 +3020,7 @@ void convertTypeshedModuleWithAliases() {
     ProjectLevelTypeTable projectLevelTypeTable = new ProjectLevelTypeTable(empty);
     LazyTypesContext lazyTypesContext = projectLevelTypeTable.lazyTypesContext();
     SymbolsModuleTypeProvider symbolsModuleTypeProvider = new SymbolsModuleTypeProvider(empty, lazyTypesContext);
-    ModuleType builtinModule = symbolsModuleTypeProvider.createBuiltinModule();
+    ModuleType builtinModule = symbolsModuleTypeProvider.getRootModule();
     PythonType responses = symbolsModuleTypeProvider.convertModuleType(List.of("fastapi", "responses"), builtinModule);
     assertThat(responses.resolveMember("FileResponse")).containsInstanceOf(ClassType.class);
     PythonType concurrency = symbolsModuleTypeProvider.convertModuleType(List.of("fastapi", "concurrency"), builtinModule);

Original file line number	Diff line number	Diff line change
`@@ -118,12 +118,14 @@ private static List<PythonInputFile> getInputFiles(ModuleFileSystem moduleFileSy`
`118`	`118`	`void addFile(PythonInputFile inputFile) throws IOException {`
`119`	`119`	`super.addFile(inputFile);`
`120`	`120`	`indexedFiles.put(inputFile.wrappedFile().absolutePath(), inputFile.wrappedFile());`
	`121`	`+ recreateProjectLevelTypeTable();`
`121`	`122`	`}`
`122`	`123`
`123`	`124`	`@Override`
`124`	`125`	`void removeFile(PythonInputFile inputFile) {`
`125`	`126`	`super.removeFile(inputFile);`
`126`	`127`	`indexedFiles.remove(inputFile.wrappedFile().absolutePath());`
	`128`	`+ recreateProjectLevelTypeTable();`
`127`	`129`	`}`
`128`	`130`
`129`	`131`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public class ProjectLevelTypeTable implements TypeTable {`
`39`	`39`	`public ProjectLevelTypeTable(ProjectLevelSymbolTable projectLevelSymbolTable) {`
`40`	`40`	`this.lazyTypesContext = new LazyTypesContext(this);`
`41`	`41`	`this.symbolsModuleTypeProvider = new SymbolsModuleTypeProvider(projectLevelSymbolTable, lazyTypesContext);`
`42`		`- this.rootModule = this.symbolsModuleTypeProvider.createBuiltinModule();`
	`42`	`+ this.rootModule = this.symbolsModuleTypeProvider.getRootModule();`
`43`	`43`	`this.createOrResolveSubModuleLock = new ReentrantLock();`
`44`	`44`	`}`
`45`	`45`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ public SymbolsModuleTypeProvider(ProjectLevelSymbolTable projectLevelSymbolTable`
`56`	`56`	`this.rootModule = new ModuleType(null, null, null, rootModuleMembers);`
`57`	`57`	`}`
`58`	`58`
`59`		`- public ModuleType createBuiltinModule() {`
	`59`	`+ public ModuleType getRootModule() {`
`60`	`60`	`return rootModule;`
`61`	`61`	`}`
`62`	`62`